For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create a Sumsub access token

Issues a short-lived Sumsub access token bound to UR's Sumsub tenant, with a fixed 20 minute TTL. Call this after create-account on the SDK path and relay the token to the Sumsub mobile or web SDK on the user device; re-issue a token bound to the same applicant if the user pauses. Requires an active onboarding session on the SDK data channel; X-Ur-Id must be present.

post
/api/fma/v1/kyc/sumsub-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
X-Ur-IdstringRequired

The user's URID. Required for this endpoint; requests without it fail with INVALID_PARAM.

X-External-User-IdstringOptional

Your partner-side user id. Send at least one of X-Ur-Id or X-External-User-Id.

X-Api-SignaturestringRequired

Partner Auth EIP-191 signature over the canonical message plus the deadline.

X-Api-DeadlinestringRequired

Unix timestamp in seconds after which the signature is no longer valid.

X-Api-PublicKeystringRequired

Partner public key used to verify the signature.

Body
object · KycSumsubAccessTokenRequestOptional

Empty body by design. UR reads urId from the X-Ur-Id header and resolves the active onboarding session server-side.

Responses
200

Business result envelope. code 0 means success; business rejections return HTTP 200 with a non-zero code.

application/json
codeintegerOptional

Business result code. 0 means success; business rejections return HTTP 200 with a non-zero code.

messagestringOptional

Human-readable diagnostic for non-zero codes.

post/api/fma/v1/kyc/sumsub-access-token
POST /api/fma/v1/kyc/sumsub-access-token HTTP/1.1
Host: openapi.ur.app
X-Api-Signature: text
X-Ur-Id: text
X-Api-Deadline: text
X-Api-PublicKey: text
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

Business result envelope. code 0 means success; business rejections return HTTP 200 with a non-zero code.

{
  "code": 0,
  "message": "ok",
  "data": {
    "token": "_act-jwt-eyJhbGciOiJub25lIn0...."
  }
}

Last updated