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

Hand off a Sumsub share token for an external wallet user

External Wallet Access variant of the shared-token handoff: Partner Auth signs the raw body and urId travels in the body, not a header. The first handoff lazily creates the onboarding session; UR copies the applicant, validates the data, and returns the same passed, incomplete, or terminal verdict as the Managed Custody handoff.

post
/api/v1/sumsub/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-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. Mint a fresh token for every handoff attempt.

urIdinteger · int64Required

The user's URID (NFT token id). Travels in the body in External Wallet Access Mode.

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/v1/sumsub/reuse-share-token
POST /api/v1/sumsub/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: 56

{
  "shareToken": "act-share-5f4e8c1b...",
  "urId": 6233490772
}
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",
    "sessionId": "1c1f3904-6f2a-4c1e-9b7d-2f3a4b5c6d7e",
    "attempt": 1
  }
}

Last updated