Skip to main content

Get Token KYC Address

Reads one KYC address rule of a token by the rule's id (from the token's list reads). The token is part of the key: a rule that belongs to another token is reported as not found.

Your node must be the token's node or one of its ancestors.

Required permission: kyc:token:view

Request​

GET /v2/admin/tokens/{token_id}/kyc/addresses/{address_id}

Parameters​

NameTypeInDescription
token_idstringpathRequired. The asset token's id
address_idstringpathRequired. The rule's id

Headers​

NameDescription
AuthorizationRequired. Bearer <access_token>

Example​

curl --request GET \
--url '{{baseUrl}}/v2/admin/tokens/68ae06cfcccf4e8fc19362d1/kyc/addresses/68d3a1b2c4e5f60078a9b0c1' \
--header 'Authorization: Bearer <access_token>'

Response​

Status 200.

{
"id": "68d3a1b2c4e5f60078a9b0c1",
"token_id": "68ae06cfcccf4e8fc19362d1",
"node_id": "665ae536a6392b75cfd40352",
"address": "0x1234567890123456789012345678901234567890",
"type": "whitelist",
"created_at": "2026-10-02T09:14:31.512Z",
"updated_at": "2026-10-02T09:14:31.512Z"
}

Response Fields​

FieldTypeDescription
idstringThe rule's id
token_idstringThe asset token the rule belongs to
node_idstringThe node that owns the token. Absent on rules recorded before rules carried a node
addressstringThe wallet address, exactly as it was sent
typestringwhitelist, blacklist or distribution
created_atstringWhen the rule was added (ISO 8601)
updated_atstringWhen the rule last changed (ISO 8601)

Errors​

StatusCodeDescription
40010016token_id is not a valid id
40010001 (domain 5)Token not found
40310005 (domain 2)The token belongs to a node outside your node's subtree
40010015No rule with this id on this token (kyc token address not found)

See Errors for the error format and common codes.