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

Authorizations

X-Api-SignaturestringRequired

Partner Auth: EIP-191 signature by the partner's registered backend key, with X-Api-Deadline and optional X-Api-PublicKey headers. See the Signature and verify guide.

Header parameters

tokenIdstringRequired

The user's URID (NFT token id).

networkstringRequired

Network identifier: 5000 for mainnet, 5003 for testnet.

signstringRequired

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

hashstringRequired

SHA3/Keccak256 hash of the original request payload.

deadlinestringRequired

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

Body

userIdstringOptional

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

levelNamestringOptional

Specific Sumsub level name. Empty uses the default.

ttlintegerOptional

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

isRetryVerificationbooleanOptional

True for KYC retry scenarios.

retryLevelintegerOptional

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

stepTypestringOptional

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

failureReasonstringOptional

Failure reason, used for logging.

Responses

200

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.

application/json

Standard response envelope for the user API (api.ur.app).

retCodeinteger · int64Required

0 on success; non-zero indicates failure.

retMsgstringRequired

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

resultanyOptional

Business payload. Shape depends on the endpoint; some endpoints return it as a JSON-encoded string.

timeNowinteger · int64Optional

Server timestamp in milliseconds.

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

POST /api/v1/sumsub/create-access-token HTTP/1.1
Host: api.ur.app
X-Api-Signature: YOUR_API_KEY
tokenId: text
network: text
sign: text
hash: text
deadline: text
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

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.

{
  "retCode": 0,
  "retMsg": "success",
  "result": "{\"token\":\"act-abc123xyz...\",\"userId\":\"12345\"}",
  "timeNow": 1703123456789
}