Hand off a Sumsub share token

Submits a single-use Sumsub share token minted in your tenant for UR's clientId. UR copies the applicant into its own Sumsub tenant, validates the copied data, and returns a conclusive verdict synchronously; UR does not re-run the KYC checks. Requires an onboarding session created by create-account and a GREEN applicant in your tenant. The envelope code is authoritative: passed maps to 0, incomplete to 20004, and terminal verdicts to eligibility codes 30010 to 30012.

post

/api/fma/v1/kyc/reuse-share-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-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.

Body

shareTokenstringRequired

Single-use Sumsub share token minted in your tenant with forClientId set to UR's clientId, valid for about 20 minutes. Mint a fresh token for every handoff attempt.

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/reuse-share-token

POST /api/fma/v1/kyc/reuse-share-token HTTP/1.1
Host: openapi.ur.app
X-Api-Signature: text
X-Api-Deadline: text
X-Api-PublicKey: text
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "shareToken": "act-share-5f4e8c1b..."
}

200

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

{
  "code": 0,
  "message": "",
  "data": {
    "status": "passed",
    "applicantId": "64f1a2b3c4d5e6f7a8b9c0d1",
    "attempt": 1
  }
}