Skip to main content

List Token KYC Addresses

Lists every KYC address rule on a token — whitelist, blacklist and distribution group together — newest first. Narrow it with type and address. Like the per-list reads, this is the platform's record: see Asynchronous writes.

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

Parameters​

NameTypeInDescription
token_idstringpathRequired. The asset token's id
typestringqueryOptional. whitelist, blacklist or distribution. The value is not validated: any other value matches nothing
addressstringqueryOptional. An address to look up. It matches the whole address, ignoring letter case; it is not a partial match
pageintegerqueryRequired. Page number, starting at 1
per_pageintegerqueryRequired. Items per page, 1–100

Headers​

NameDescription
AuthorizationRequired. Bearer <access_token>

Example​

curl --request GET \
--url '{{baseUrl}}/v2/admin/tokens/68ae06cfcccf4e8fc19362d1/kyc/addresses?type=blacklist&page=1&per_page=10' \
--header 'Authorization: Bearer <access_token>'

Response​

Status 200.

{
"data": [
{
"id": "68d3a1b2c4e5f60078a9b0c1",
"token_id": "68ae06cfcccf4e8fc19362d1",
"address": "0x1234567890123456789012345678901234567890",
"type": "blacklist",
"created_at": "2026-10-02T09:14:31.512Z",
"updated_at": "2026-10-02T09:14:31.512Z"
}
],
"total": 1,
"page": 1,
"per_page": 10
}

Response Fields​

FieldTypeDescription
dataarrayThe rules on this page, newest first
data[].idstringThe rule's id
data[].token_idstringThe asset token the rule belongs to
data[].addressstringThe wallet address, exactly as it was sent
data[].typestringwhitelist, blacklist or distribution
data[].created_atstringWhen the rule was added (ISO 8601)
data[].updated_atstringWhen the rule last changed (ISO 8601)
totalintegerItems matching the filters
pageintegerPage number
per_pageintegerPage size

Errors​

StatusCodeDescription
40010015Validation failed — see details
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

See Errors for the error format and common codes.