List Token Whitelist Groups

Retrieves a paginated list of all whitelisted KYC groups for a specific token.

Request

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

Parameters

Name	Type	In	Description
tokenID	string	path	Required. The ID of the token
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/whitelist/groups?page=1&per_page=10' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'

Response

{
  "data": [
    {
      "id": "67d8774e903bfcbe7eb5d93e",
      "token_id": "67d8774e903bfcbe7eb5d93e",
      "kyc_group_id": "67d8774e903bfcbe7eb5d93f",
      "type": "whitelist",
      "kyc_group": {
        "id": "67d8774e903bfcbe7eb5d93f",
        "group_id": 1,
        "name": "Premium Investors",
        "created_at": "2025-01-15T10:30:00.000Z",
        "updated_at": "2025-01-15T10:30:00.000Z",
        "deleted_at": null
      },
      "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 whitelist group 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 Whitelist Group Object Fields

Field	Type	Description
id	string	Unique identifier for the token group entry
token_id	string	ID of the token
kyc_group_id	string	ID of the KYC group
type	string	Group type (always "whitelist")
kyc_group	object/null	KYC group details (may be null)
created_at	string	ISO 8601 timestamp when the group was added
updated_at	string	ISO 8601 timestamp when the entry was updated
deleted_at	string/null	ISO 8601 timestamp when the group was removed (null if not deleted)

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