Get the current onboarding session

Returns the current onboarding state for the user. Poll it after the user starts the Sumsub SDK to detect the SignFormA state; the state can lag the SDK UI by a few seconds because Sumsub webhooks drive the transitions. Returns NO_ACTIVE_SESSION (code 30031) when the user has no active session, including after the session reaches a terminal outcome.

get

/api/fma/v1/kyc/session/current

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-IdstringOptional

The user's URID. Send at least one of X-Ur-Id or X-External-User-Id.

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.

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.

get/api/fma/v1/kyc/session/current

GET /api/fma/v1/kyc/session/current HTTP/1.1
Host: openapi.ur.app
X-Api-Signature: text
X-Api-Deadline: text
X-Api-PublicKey: text
Accept: */*

200

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

{
  "code": 0,
  "message": "",
  "data": {
    "sessionId": "223d567f-ea11-4629-ba2a-94664edc26f6",
    "flowId": 11188,
    "retryLevel": 0,
    "state": "SignFormA",
    "dataChannel": "sdk",
    "createdAt": 1781000449,
    "lastUserActivityAt": 1781000789
  }
}