Remove from Whitelist
Removes one address from a token's whitelist.
Asynchronous: the on-chain call is queued and the address stays in Get Token Whitelist until it is confirmed. It is recorded as a node transaction of type 44 (RemoveMemberFromWhitelist) on the platform owner node, with internal_id set to the rule's id; see Asynchronous writes.
The address in the path must match the stored address exactly, letter case included: copy it from the list. 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:whitelist:delete
Request
DELETE /v2/admin/tokens/{token_id}/kyc/whitelist/{user_address}
Parameters
| Name | Type | In | Description |
|---|---|---|---|
token_id | string | path | Required. The asset token's id |
user_address | string | path | Required. The address to remove, exactly as stored |
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/0x1234567890123456789012345678901234567890?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 | 10016 | token_id is not a valid id |
| 400 | 10001 (domain 5) | Token not found |
| 403 | 10005 (domain 2) | The token belongs to a node outside your node's subtree |
| 400 | 20003001 | The address is not on this list of the token |
| 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.