Sign in

v1

latestOpenAPI 3.0.02026-07-22243670.8 KB
KYC

Generate a Sumsub KYC access token

Generates a short-lived Sumsub WebSDK access token for the current user so an identity verification flow can be started. Requires a user-scoped access token (authorization code grant); partner-only tokens (client credentials grant) are rejected.

post/v1/kyc-token

Request body

level_name'Sorting_KYC_Level' | 'BasicKYCLevel' | 'AccreditationIndividual_FullVerification'

The Sumsub verification level to start. Determines which screens the Sumsub WebSDK shows.

resetboolean

Reset the Sumsub applicant before issuing the token, so an already-approved level can be executed again (e.g. to update stale PII). Send the kyc_reset value from the requirement status. Must not be sent when refreshing an expired token mid-flow, or the user's in-progress submission is wiped.

Example request

{
  "level_name": "Sorting_KYC_Level"
}

Response

Successful response.

object'kyc_token' required

String representing the object's type. Objects of the same type share the same value.

tokenstring required

Short-lived Sumsub WebSDK access token scoped to the current user