Skip to main content
POST
/
v2
/
kyc
/
new-level-1
/
web-sdk
Get level-1 KYC web-SDK URL
curl --request POST \
  --url https://api.example.com/v2/kyc/new-level-1/web-sdk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "redirectUrl": "<string>"
}
'
{
  "attemptId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kycUrl": "<string>"
}

​
Get level-1 KYC web-SDK URL

POST request to /v2/kyc/new-level-1/web-sdk

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
subAccountId
string<uuid>

Operate against a sub-account of the authenticated main account.

Body

application/json

Body is the same for both account types; the server selects the flow internally.

Common body for both account types. The server selects the appropriate KYC web SDK flow based on the authenticated account type.

​
redirectUrl
string<uri>

URL the SDK redirects to after the flow completes.

​
lang
enum<string>
Available options:
pt,
en,
es

Response

Hosted KYC URL(s). Shape depends on the account type.

Response shape depends on the authenticated account type.

​
attemptId
string<uuid>
​
kycUrl
string<uri>

Hosted URL for the individual KYC flow.