Blacklist

The blacklist feature allows token issuers to block specific addresses from holding or transferring tokens. This feature is only available for public tokens (tokens created with is_private = false).

How It Works

  • Default State: All addresses can freely use the token

  • After Blacklisting: Blocked addresses cannot receive or send the token

  • Authority: Only the token's master authority can manage the blacklist

Use Cases

  • Compliance: Block sanctioned addresses (OFAC, EU sanctions)

  • Security: Block compromised or malicious addresses

  • Risk Management: Prevent known bad actors from using the token

  • Regulatory: Meet jurisdictional requirements for token operations

Key Points

  • Blacklist is permanent until explicitly removed

  • Blacklisted addresses cannot:

    • Receive tokens (transfers will fail)

    • Send tokens (transfers will be blocked)

    • Participate in token-related activities

  • Adding/removing addresses requires gas fees

  • All blacklist changes emit on-chain events for transparency

Common Scenarios

Regulatory Compliance

Financial institutions use blacklists to comply with anti-money laundering (AML) regulations by blocking addresses associated with illegal activities.

Emergency Response

When a security breach occurs, quickly blacklist compromised addresses to prevent further damage.

Exchange Integration

Exchanges can blacklist addresses involved in hacks or scams to protect their users.

Important Notes

  • Public Tokens Only: Cannot use blacklist on private tokens

  • No Retroactive Effect: Existing balances remain, but become frozen

  • Careful Management: Incorrectly blacklisting addresses can lock user funds

  • Legal Considerations: Ensure blacklisting policies comply with local laws

post
/v1/tokens/manage_blacklist
Body

Payload for blacklist operations

actionstring · enumRequired

The action of the transaction: Add or Remove from blacklist.

Possible values:
addressstringRequired

The address to be added to or removed from blacklist.

Example: 0x9E1E9688A44D058fF181Ed64ddFAFbBE5CC742Ab
chain_idinteger · int64Required

The chain id of the transaction.

Example: 1212101
nonceinteger · int64Required

The nonce of the transaction.

Example: 0
tokenstringRequired

The token address of the transaction.

Example: 0x6ADE9688A44D058fF181Ed64ddFAFbBE5CC742Ac
Responses
chevron-right
200Success
application/json

Represents a transaction hash returned by the API.

hashstringRequiredExample: 0xf55f9525be94633b56f954d3252d52b8ef42f5fd5f9491b243708471c15cc40c
post
/v1/tokens/manage_blacklist

Last updated