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

Blacklist request for managing token blacklists

Responses
200Success
application/json
post
/v1/tokens/manage_blacklist
PreviousBurnNextWhitelist

Last updated