Skip to main content

List KYC Tokens

The platform's KYC token catalog: every deployed KYC token, on every network, each row naming the network it lives on. Use it to pick the kyc_token_id a setup is wired to or a KYC group is created on, and to see what is deployed where. Only deployed tokens are listed: a token whose deploy is still running, or has failed, does not appear.

Rows are ordered by network, and oldest deployment first within a network, so a network's first row is the token a setup gets when it names none. A network with no rows cannot host a setup, because a setup's contracts are deployed with a KYC token address.

Required permission: kyc:token:view

Request​

GET /v2/admin/kyc-tokens

Parameters​

NameTypeInDescription
network_idstringqueryOptional. Narrow the catalog to one network. An id that names no network is refused (10015) rather than answered with an empty page
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/kyc-tokens?network_id=68a1f0c2d4e5f60718293a4b&page=1&per_page=20' \
--header 'Authorization: Bearer <access_token>'

Response​

Status 200.

{
"data": [
{
"id": "68c4a1f2b9e3d70012a5c3e8",
"network_id": "68a1f0c2d4e5f60718293a4b",
"network_name": "Polygon Amoy",
"chain_id": "68a0e1d2c3b4a59687786950",
"evm_network_id": 80002,
"address": "0x5b0c3f1e2d4a6b8c9e0f1a2b3c4d5e6f7a8b9c0d",
"wallet_id": "68a2b3c4d5e6f708192a3b4c",
"name": "Apex KYC Polygon",
"version": "1.0.0",
"deployed_at": "2026-10-02T09:21:07.004Z"
}
],
"total": 1,
"page": 1,
"per_page": 20
}

Response Fields​

FieldTypeDescription
dataarrayThe KYC tokens on this page
data[].idstringThe KYC token's id: the kyc_token_id used by setups and KYC groups
data[].network_idstringThe network the token is deployed on
data[].network_namestringThat network's name
data[].chain_idstringThe platform's id of the network's chain
data[].evm_network_idintegerThe EVM network id (for example 1 Ethereum, 137 Polygon)
data[].addressstringThe KYC token's address (its proxy): the address a setup's contracts point at
data[].wallet_idstringThe token's owner wallet, which signs every group change and token rule written on this KYC token
data[].namestringDisplay name
data[].versionstringKYC token implementation version
data[].deployed_atstringWhen the deploy completed (ISO 8601)
totalintegerItems matching the filters
pageintegerPage number
per_pageintegerPage size

Errors​

StatusCodeDescription
40010015Validation failed — see details. Also network not found when network_id names no network
40010016network_id is not a valid id

See Errors for the error format and common codes.