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

Get Sumsub status by network

Returns the latest Sumsub webhook-derived KYC state for the given tokenId and network; poll it after starting Sumsub on an external network to display review progress without creating a new access token. data is an empty object when UR has not yet received a Sumsub webhook for that tokenId and network.

post
/v1/sumsub-status-by-network
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
tokenIdstringRequired

URID NFT token id.

networkstringRequired

Network or chain identifier, for example 5000 or 11155111.

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/v1/sumsub-status-by-network
POST /v1/sumsub-status-by-network 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: 36

{
  "tokenId": "12345",
  "network": "5000"
}
200

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

{
  "code": 0,
  "message": "success",
  "data": {
    "type": "applicantWorkflowCompleted",
    "reviewStatus": "completed",
    "reviewAnswer": "GREEN",
    "reviewRejectType": "",
    "levelName": "id-and-liveness V4",
    "rejectLabels": [],
    "applicantId": "64f1a2b3c4d5e6f7a8b9c0d1",
    "applicantType": "individual",
    "createdAtMs": 1703123456789
  }
}

Last updated