Skip to main content

List Token Whitelist Groups

Lists the KYC groups attached to a token's whitelist, newest first. Each row is an attachment: its id is the attachment's own id (the internal_id of its node transactions), and kyc_group_id is the group's id, which the add and remove endpoints take in the path.

An attachment appears as soon as it is accepted (and stays if its transaction fails), and leaves only once a removal is confirmed. Your node must be the token's node or one of its ancestors.

Required permission: kyc:token:whitelist-group:view

Request​

GET /v2/admin/tokens/{token_id}/kyc/whitelist/groups

Parameters​

NameTypeInDescription
token_idstringpathRequired. The asset token's id
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/whitelist/groups?page=1&per_page=10' \
--header 'Authorization: Bearer <access_token>'

Response​

Status 200.

{
"data": [
{
"id": "68d4b2c3d5e6f70089b0c1d2",
"token_id": "68ae06cfcccf4e8fc19362d1",
"kyc_group_id": "68d2e7a9c1b4f30045e1a9b2",
"type": "whitelist",
"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 attachments on this page, newest first
data[].idstringThe attachment's id
data[].token_idstringThe asset token
data[].kyc_group_idstringThe attached group's id
data[].typestringwhitelist
data[].created_atstringWhen the group was attached (ISO 8601)
data[].updated_atstringWhen the attachment 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.