Sign in
Managed Custody KYC

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

Headers

X-Ur-Idstring

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

X-External-User-Idstring

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

X-Api-Signaturestring required

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

X-Api-Deadlinestring required

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

X-Api-PublicKeystring required

Partner public key used to verify the signature.

Response

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

codeinteger

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

messagestring

Human-readable diagnostic for non-zero codes.

Changes