List Token Addresses

Retrieves a paginated list of all addresses for a token with optional filters by type and address.

Request

GET /v2/admin/kyc/tokens/{tokenID}

Parameters

Name	Type	In	Description
tokenID	string	path	Required. The ID of the token
type	string	query	Optional. Address type filter (blacklist, whitelist, distribution)
address	string	query	Optional. Search by address
page	integer	query	Required. Page number (default: 1)
per_page	integer	query	Required. Items per page (default: 10, max: 100)

Headers

Name	Description
Authorization	Required. Bearer token for authentication

Example

curl --request GET \
  --url '{{baseUrl}}/v2/admin/kyc/tokens/67d8774e903bfcbe7eb5d93e?type=blacklist&page=1&per_page=10' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'

Response

{
  "data": [
    {
      "id": "67d8774e903bfcbe7eb5d93e",
      "token_id": "67d8774e903bfcbe7eb5d93e",
      "address": "0x1234567890123456789012345678901234567890",
      "type": "blacklist",
      "created_at": "2025-01-15T10:30:00.000Z",
      "updated_at": "2025-01-15T10:30:00.000Z",
      "deleted_at": null
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 10,
    "total": 1
  }
}

Response Fields

Field	Type	Description
data	array	Array of token address objects
pagination	object	Pagination information
pagination.page	integer	Current page number
pagination.per_page	integer	Number of items per page
pagination.total	integer	Total number of items

Token Address Object Fields

Field	Type	Description
id	string	Unique identifier for the address entry
token_id	string	ID of the token
address	string	Wallet address
type	string	Address type (blacklist, whitelist, or distribution)
created_at	string	ISO 8601 timestamp when the address was added
updated_at	string	ISO 8601 timestamp when the entry was updated
deleted_at	string/null	ISO 8601 timestamp when the address was removed (null if not deleted)

Address Types

Value	Description
blacklist	Address is blacklisted for the token
whitelist	Address is whitelisted for the token
distribution	Address is in the distribution group for the token

Status Codes

Status Code	Description
200	Success
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid or missing authentication token
404	Not Found - Token ID does not exist
500	Internal Server Error