v1

latestOpenAPI 3.1.02026-07-2671312207.4 KB

KYC Token

Generate KYC token

Creates a KYC verification session token. Pass the returned authToken to your frontend or SDK to launch the verification flow.

post/api/v2/token

Request body

clientIdstring required

A unique string identifying the client on your side.

tokenType'IDENTIFICATION' | 'DOCUMENT' required

IDENTIFICATION — document scan + selfie (default)
DOCUMENT — document scan only

externalRefstring nullable

Optional internal reference. Returned as-is in webhooks.

generateDigitStringboolean

If true, generates an 8-digit mobile app code returned as digitString.

expiryTimeinteger

Token validity in seconds. Maximum 2,592,000 (30 days).

localestring nullable

UI language code (e.g. en, de, ko).

countrystring nullable

Restrict accepted document-issuing country (ISO alpha-2).

sessionLengthinteger

Seconds the user has to complete verification once started.

documentsstring[] nullable

Restrict accepted document types (e.g. PASSPORT, ID_CARD).

firstNamestring nullable

Pre-fill client first name. Mismatch triggers SUSPECTED status.

lastNamestring nullable

Pre-fill client last name. Mismatch triggers SUSPECTED status.

dateOfBirthstring date nullable

Pre-fill client date of birth.

nationalitystring nullable

Pre-fill client nationality.

documentNumberstring nullable

Pre-fill document number.

personalNumberstring nullable

Pre-fill personal/national ID number.

sex'M' | 'F' nullable

Pre-fill client sex.

dateOfExpirystring date nullable

Pre-fill document expiry date.

dateOfIssuestring nullable

Pre-fill document issue date.

addressstring nullable

Client address for Proof of Address verification.

successUrlstring uri nullable

Redirect URL on successful verification.

errorUrlstring uri nullable

Redirect URL on failed verification.

unverifiedUrlstring uri nullable

Redirect URL when verification result is unverified.

callbackUrlstring uri nullable

Override webhook callback URL for this session only.

showInstructionsboolean

reviewSuccessfulboolean

Enable manual review for successful verifications.

reviewFailedboolean

Enable manual review for failed verifications.

questionnairestring nullable

Questionnaire key for this session. Pass null to disable.

questionnaireRequiredboolean

riskAssessmentProfilestring uuid nullable

themestring uuid nullable

registryCentersCountriesstring[] nullable

verifyEmailboolean

verifyPhoneboolean

verifyBankboolean

verifyBankAccountsboolean

verifyBankBalancesboolean

verifyBankTransactionsboolean

bankCardVerificationboolean

bankCardPdfUploadboolean

verifyAddressboolean

checkAmlboolean

checkCriminalboolean

checkLivenessboolean

checkFaceBlacklistboolean

checkDocFaceBlacklistboolean

checkPersonBlacklistboolean

checkDuplicateFacesboolean

checkDuplicateDocFacesboolean

checkDuplicatePersonalDataboolean

checkDriverLicenseboolean

checkLidboolean

checkIpProxyboolean

allowBsnMaskingboolean

nfcRequiredboolean

autoAmlMonitoringboolean

driverLicenseBackboolean

faceMatchingThresholdModifiernumber

additionalStepsobject

Request extra document steps. See Additional Steps documentation.

additionalDataobject

Data for COMPARE-type additional steps.

utilityBillboolean nullable

nfcOptionalboolean

ageLimitinteger

Minimum required age. Below this triggers SUSPECTED status.

ageMaxinteger

Maximum allowed age. Above this triggers SUSPECTED status.

Response

Token created successfully.

messagestring

authTokenstring required

Pass this to the frontend, SDK, or redirect URL to start verification.

redirectUrlstring nullable

Direct URL to the hosted verification flow. Redirect the user here or embed in an iFrame.

scanRefstring required

Unique session ID. Store this to correlate with webhook results.

clientIdstring nullable

personScanRefstring nullable

firstNamestring nullable

lastNamestring nullable

successUrlstring nullable

errorUrlstring nullable

unverifiedUrlstring nullable

callbackUrlstring nullable

localestring nullable

countrystring nullable

expiryTimeinteger

Token expiry time in seconds.

sessionLengthinteger

documentsstring[]

allowedDocumentsobject

dateOfBirthstring nullable

dateOfExpirystring nullable

dateOfIssuestring nullable

nationalitystring nullable

personalNumberstring nullable

documentNumberstring nullable

sexstring nullable

addressstring nullable

showInstructionsboolean

tokenType'IDENTIFICATION' | 'DOCUMENT' required

{"stackTrail":"paths:/api/v2/token:post:responses:201:content:application/json:schema:properties:utilityBill","oasType":"schema","type":"unknown","nullable":true}

additionalStepsobject

additionalDataobject

externalRefstring nullable

questionnairestring nullable

registryCentersCountriesstring[]

riskAssessmentProfilestring uuid nullable

themestring uuid nullable

allowBsnMaskingboolean

verifyBankTransactionsboolean

bankCardVerificationboolean

bankCardPdfUploadboolean

checkLidboolean

checkDriverLicenseboolean

verifyAddressboolean

checkFaceBlacklistboolean

verifyEmailboolean

checkPersonBlacklistboolean

checkDuplicateDocFacesboolean

reviewSuccessfulboolean

reviewFailedboolean

verifyBankboolean

autoAmlMonitoringboolean

verifyPhoneboolean

faceMatchingThresholdModifiernumber

checkCriminalboolean

checkAmlboolean

checkDuplicateFacesboolean

driverLicenseBackboolean

verifyBankAccountsboolean

checkDuplicatePersonalDataboolean

verifyBankBalancesboolean

nfcRequiredboolean

checkIpProxyboolean

checkDocFaceBlacklistboolean

checkLivenessboolean

digitStringstring nullable

8-digit mobile code. Only present when generateDigitString was true.