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

Check KYC data completeness for an external wallet user

Pure read of the last handoff attempt's verdict, mirroring the Managed Custody check endpoint; an incomplete session returns code 20004 with missingFields. Use it as a fallback to the fma.kyc.reuse_check.result webhook while the user remediates in your Sumsub workflow.

post
/api/v1/sumsub/kyc-check
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
urIdinteger · int64Required

The user's URID (NFT token id).

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/kyc-check
POST /api/v1/sumsub/kyc-check 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: 19

{
  "urId": 6233490772
}
200

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

{
  "code": 0,
  "message": "",
  "data": {
    "state": "SignFormA",
    "complete": true,
    "sessionId": "1c1f3904-6f2a-4c1e-9b7d-2f3a4b5c6d7e"
  }
}

Last updated