Add to Blacklist

Adds a user address to a token's blacklist.

Request

POST /v2/admin/kyc/tokens/{tokenID}/blacklist

Parameters

Name	Type	In	Description
tokenID	string	path	Required. The ID of the token
user_address	string	body	Required. The wallet address to blacklist

Headers

Name	Description
Authorization	Required. Bearer token for authentication
Content-Type	Required. Must be application/json

Request Body

{
  "user_address": "0x1234567890123456789012345678901234567890"
}

Example

curl --request POST \
  --url '{{baseUrl}}/v2/admin/kyc/tokens/67d8774e903bfcbe7eb5d93e/blacklist' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
  --header 'Content-Type: application/json' \
  --data '{
    "user_address": "0x1234567890123456789012345678901234567890"
  }'

Response

A successful request returns an HTTP 201 status code with the action response.

{
  "requires_approval": false,
  "completed": true
}

Response Fields

Field	Type	Description
requires_approval	boolean	Whether the action requires approval
completed	boolean	Whether the action was completed immediately

Status Codes

Status Code	Description
201	Success - Address added to blacklist
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid or missing authentication token
404	Not Found - Token ID does not exist
409	Conflict - Address already exists in blacklist
500	Internal Server Error