Skip to main content
POST
Create a KYC link
This endpoint always requires x-api-key. The email is normalized before lookup, and needKyc defaults to true.
This operation can create an investor account and send an invitation email. The returned Sumsub URL grants access to a verification flow; do not log it, commit it, or expose it to another user.
When needKyc is false, the investor is created without a KYC requirement and url is null.

Client examples

Response

Authorizations

x-api-key
string
header
required

Body

application/json
email
string<email>
required
needKyc
boolean
default:true

Response

Investor access resolved and invitation state returned.

email
string<email>
required
needKyc
boolean
required
userCreated
boolean
required
invitationSent
boolean
required
url
string<uri> | null
required

Sumsub verification URL. Null when KYC is not required. Treat this value as sensitive.