Skip to main content
POST
Get KYC verification link

Authorizations

Authorization
string
header
required

API key (sk_test_... or sk_live_...)

Path Parameters

customerCode
string<uuid>
required

Customer UUID

Body

application/json
callback_url
string<uri>

Optional. HTTPS URL your customer is redirected to after the verification. If omitted, your customer is not redirected back to your application at the end of the flow

Example:

"https://yourapp.com/kyc/done"

lang
string
default:en

2-letter language code of the verification screen

Example:

"en"

force
boolean
default:false

Set to true to get a new link even if the current one is still valid

Response

Existing link still valid, returned as is

success
boolean
Example:

true

data
object