KYC HTTP API overview
All operations below use the path prefix /v2/admin/kyc. They are exposed by the Integration service and are called with an OAuth client access token (Authorization: Bearer ), for example from the client-credentials or resource-owner flow configured for your integration client.
Create KYC Group
Creates a new KYC group in the system.
Get KYC Groups
Retrieves a list of all KYC groups with pagination.
Get KYC Group by ID
Retrieves detailed information about a specific KYC group.
Get KYC Group by ID
Retrieves detailed information about a specific KYC group.
List All KYC Groups
Retrieves a paginated list of all KYC groups in the system.
Delete KYC Group
Deletes a KYC group from the system.
Get KYC Group Members
Retrieves all members of a specific KYC group with pagination.
List KYC Group Members
Retrieves a paginated list of all members in a specific KYC group.
Add Member to KYC Group
Adds a user address to a KYC group.
Add Multiple Members to KYC Group
Adds multiple user addresses to a KYC group in a single request.
Remove Member from KYC Group
Removes a user address from a KYC group.
Get Token Blacklist
Retrieves all blacklisted addresses for a specific token with pagination.
List Token Blacklist
Retrieves a paginated list of all blacklisted addresses for a specific token.
Add to Blacklist
Adds a user address to a token's blacklist.
Add Multiple to Blacklist
Adds multiple user addresses to a token's blacklist in a single request.
Remove from Blacklist
Removes a user address from a token's blacklist.
Get Token Whitelist
Retrieves all whitelisted addresses for a specific token with pagination.
List Token Whitelist
Retrieves a paginated list of all whitelisted addresses for a specific token.
Add to Whitelist
Adds a user address to a token's whitelist.
Add Multiple to Whitelist
Adds multiple user addresses to a token's whitelist in a single request.
Remove from Whitelist
Removes a user address from a token's whitelist.
Get Token Distribution Group
Retrieves all addresses in the distribution group for a specific token with pagination.
List Token Distribution Group
Retrieves a paginated list of all addresses in the distribution group for a specific token.
Add to Distribution Group
Adds a user address to a token's distribution group.
Add Multiple to Distribution Group
Adds multiple user addresses to a token's distribution group in a single request.
Remove from Distribution Group
Removes a user address from a token's distribution group.
List Token Blacklist Groups
Retrieves a paginated list of all blacklisted KYC groups for a specific token.
Add Token Blacklist Group
Adds a KYC group to a token's blacklist.
Remove Token Blacklist Group
Removes a KYC group from a token's blacklist by KycTokenGroup ID.
List Token Whitelist Groups
Retrieves a paginated list of all whitelisted KYC groups for a specific token.
Add Token Whitelist Group
Adds a KYC group to a token's whitelist.
Remove Token Whitelist Group
Removes a KYC group from a token's whitelist by KycTokenGroup ID.
List Token Addresses
Retrieves a paginated list of all addresses for a token with optional filters by type and address.