latestOpenAPI 3.1.02026-08-108094177.6 KB

087dcf516ce2

External Wallet Access Mode

Create a Sumsub SDK token

Creates an access token to initialize the Sumsub SDK for KYC verification. The NFC scan step requires the Sumsub mobile SDK; it is not available in the web SDK. Omit userId unless UR gave you an explicit tenant pattern.

post/api/v1/sumsub/create-access-token

Headers

tokenIdstring required

The user's URID (NFT token id).

networkstring required

Network identifier: 5000 for mainnet, 5003 for testnet.

signstring required

Signature generated by the user's wallet key (EIP-191).

hashstring required

SHA3/Keccak256 hash of the original request payload.

deadlinestring required

Signature expiry: server timestamp plus a validity window (max 20 minutes).

Request body

userIdstring

Optional. Server derives the Sumsub user id from Full Auth context when omitted.

levelNamestring

Specific Sumsub level name. Empty uses the default.

ttlinteger

Token time-to-live in seconds. Default configured by the server.

isRetryVerificationboolean

True for KYC retry scenarios.

retryLevelinteger

Retry level (1-7); valid only when isRetryVerification is true.

stepTypestring

Specific verification step to reset, e.g. IDENTITY.

failureReasonstring

Failure reason, used for logging.

Response

Response envelope. For the user API, retCode 0 means success; for the partner API, code 0 means success. Business rejections return HTTP 200 with a non-zero code.

retCodeinteger required

0 on success; non-zero indicates failure.

retMsgstring required

Human-readable message; error details when retCode is non-zero.

{"stackTrail":"components:schemas:EwaEnvelope:properties:result","oasType":"schema","type":"unknown","description":"Business payload. Shape depends on the endpoint; some endpoints return it as a JSON-encoded string."}

timeNowinteger

Server timestamp in milliseconds.