Get Token Whitelist

Retrieves all whitelisted addresses for a specific token with pagination.

Request

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

Parameters

Name	Type	In	Description
tokenID	string	path	Required. The ID of the token
search	string	query	Optional. Search by address
page	integer	query	Required. Page number (minimum: 1)
per_page	integer	query	Required. Items per page (minimum: 1, maximum: 100)

Headers

Name	Description
Authorization	Required. Bearer token for authentication

Example

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

Response

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

Response Fields

Field	Type	Description
data	array	Array of KYC token address objects
pagination	object	Pagination information

KYC Token Address Object Fields

Field	Type	Description
id	string	Unique identifier for the address entry
token_id	string	ID of the token
address	string	User wallet address
type	string	Address type (always "whitelist" for this endpoint)
created_at	string	ISO 8601 timestamp when the address was added
updated_at	string	ISO 8601 timestamp when the address was updated
deleted_at	string/null	ISO 8601 timestamp when the address was removed (null if not removed)

Pagination Object Fields

Field	Type	Description
page	integer	Current page number
per_page	integer	Number of items per page
total	integer	Total number of items

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