Whitelist

The whitelist feature enables token issuers to explicitly grant access to specific addresses for holding and transferring tokens. This feature is only available for private tokens (tokens created with is_private = true).

How It Works

  • Default State: No addresses can use the token

  • After Whitelisting: Only approved addresses can receive and send the token

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

Use Cases

  • Security Tokens: Restrict access to accredited investors only

  • Private Sales: Control participation in token sales

  • Enterprise Tokens: Limit usage to verified business partners

  • Membership Tokens: Grant access to exclusive community members

Key Points

  • Only whitelisted addresses can interact with the token

  • Non-whitelisted addresses cannot:

    • Receive tokens (transfers will fail)

    • Send tokens (blocked at protocol level)

    • View or interact with token functions

  • Whitelist status can be revoked at any time

  • All whitelist changes are recorded on-chain

Common Scenarios

KYC/AML Compliance

Private tokens often require Know Your Customer (KYC) verification before whitelisting, ensuring only verified users can participate.

Phased Access

Projects can gradually whitelist addresses for controlled token distribution phases (private sale → public sale → general access).

Geographic Restrictions

Whitelist only addresses from permitted jurisdictions to comply with regional regulations.

Important Notes

  • Private Tokens Only: Cannot use whitelist on public tokens

  • Strict Access Control: No exceptions for non-whitelisted addresses

  • Planning Required: Must whitelist addresses before they can receive tokens

  • Operational Overhead: Requires active management as new users join

post
/v1/tokens/manage_whitelist
Body

Payload for whitelist operations

actionstring · enumRequired

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

Possible values:
addressstringRequired

The address to be added to or removed from whitelist.

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_whitelist

Last updated