Remove Token Whitelist Group
Detaches a KYC group from a token's whitelist. The path names the same (token, group) pair as Add Token Whitelist Group: group_id is the group's id (the kyc_group_id of the attachment), not the attachment's own id.
Asynchronous: the on-chain call is queued and the attachment stays in List Token Whitelist Groups until it is confirmed. It is recorded as a node transaction of type 52 (RemoveKycGroupFromWhitelist) on the platform owner node, with internal_id set to the attachment's id; see Asynchronous writes.
Pass the token's own setup_id (from Get Token): the call runs on the KYC token that setup is wired to and is signed by that KYC token's owner wallet. Your node must be the token's node or one of its ancestors.
Required permission: kyc:token:whitelist-group:delete
Request
DELETE /v2/admin/tokens/{token_id}/kyc/whitelist/groups/{group_id}
Parameters
| Name | Type | In | Description |
|---|---|---|---|
token_id | string | path | Required. The asset token's id |
group_id | string | path | Required. The KYC group's id (24-character hex), not its numeric group_id |
setup_id | string | query | Required. The setup whose KYC token the removal runs on: the token's own setup_id |
Headers
| Name | Description |
|---|---|
Authorization | Required. Bearer <access_token> |
Example
curl --request DELETE \
--url '{{baseUrl}}/v2/admin/tokens/68ae06cfcccf4e8fc19362d1/kyc/whitelist/groups/68d2e7a9c1b4f30045e1a9b2?setup_id=68b1c2d3e4f5a6b7c8d9e0f1' \
--header 'Authorization: Bearer <access_token>'
Response
Status 200.
{
"requires_approval": false,
"completed": true
}
Response Fields
| Field | Type | Description |
|---|---|---|
requires_approval | boolean | Always false: KYC writes have no approval step |
completed | boolean | true once the request is accepted and the on-chain call is queued. It does not mean the chain has confirmed it |
Errors
| Status | Code | Description |
|---|---|---|
| 400 | 10015 | Validation failed — see details |
| 400 | 20004001 | The group is not attached to this list of the token |
| 400 | 10001 (domain 5) | Token not found |
| 403 | 10005 (domain 2) | The token belongs to a node outside your node's subtree |
| 400 | 20001001 | KYC group not found |
| 400 | 10015 | setup_id names no setup, or the setup has no network or no KYC token (message says which) |
See Errors for the error format and common codes.