v1

latestOpenAPI 3.1.02026-07-26165182724.7 KB

Start KYC

Users need to complete due diligence (KYC) before they can be assigned wallets and cards

post/user/kyc/start

Headers

api-keystring required

Authorizationstring required

Request body

userIdstring required

Unique Id of the user

tierinteger

The Tier of KYC - 1 or 2

shareTokenstring

Optional SumSub Reusable KYC share token from a donor partner; reuses an existing verification instead of collecting new documents. Requires Reusable KYC to be enabled for the application.

Response

200

providerstring

tokenstring

userIdstring

verificationLinkstring

Example response

{
  "provider": "SUMSUB",
  "token": "_act-sbx-cc6a85f3-4315-4d26-b507-3e5ea31ff2f9",
  "userId": "2f1853b2-927a-4aa9-8bb1-3e51fb119ace",
  "verificationLink": "https://in.sumsub.com/idensic/l/#/sbx_Eke06K3fpzlbWuf3"
}