Get user account status

Returns the account status, KYC flow progress, Sumsub KYC info, novice guidance progress, and CRS requirements. Status codes: 0 Na, 1 SoftBlocked, 2 Tourist, 3 Blocked, 4 Closed, 5 Live.

get

/api/v2/account-status

Header parameters

tokenIdstringRequired

The user's URID (NFT token id).

networkstringRequired

Network identifier: 5000 for mainnet, 5003 for testnet.

Responses

200

Response envelope. For the user API, retCode 0 means success; for the partner API, code 0 means success. Business rejections return HTTP 200 with a non-zero code.

application/json

Standard response envelope for the user API (api.ur.app).

retCodeinteger · int64Required

0 on success; non-zero indicates failure.

retMsgstringRequired

Human-readable message; error details when retCode is non-zero.

resultanyOptional

Business payload. Shape depends on the endpoint; some endpoints return it as a JSON-encoded string.

timeNowinteger · int64Optional

Server timestamp in milliseconds.

get/api/v2/account-status

GET /api/v2/account-status HTTP/1.1
Host: api.ur.app
tokenId: text
network: text
Accept: */*

200

Response envelope. For the user API, retCode 0 means success; for the partner API, code 0 means success. Business rejections return HTTP 200 with a non-zero code.

{
  "retCode": 0,
  "retMsg": "success",
  "result": "{\"status\":5,\"statusStr\":\"Live\",\"kycFlow\":{\"currentStep\":4,\"currentStepStr\":\"Review\"},\"sumsubKycInfo\":{\"latestKycHasCompleted\":true,\"reviewStatus\":\"completed\",\"reviewAnswer\":\"GREEN\"}}",
  "timeNow": 1703123456789
}