Skip to main content
GET
Get Whitelist Status
Checks the token contract directly to determine whether an address is whitelisted.

Query Parameters

  • tokenSymbol (required): Token symbol
  • address (required): Wallet address to check. investorAddress is accepted as a legacy alias — send either one.

Example

Response

address is returned in checksummed form, and source is always blockchain because the flag is read from the token contract rather than from Brickken’s database.

Authorizations

x-api-key
string
header
required

Query Parameters

tokenSymbol
string
required

The symbol of the token.

address
string
required

Wallet address to check. investorAddress is accepted as a legacy alias.

investorAddress
string

Legacy alias of address. Send either one, not both.

Response

200 - application/json

Successful response

isWhitelisted
boolean

Whether the address is whitelisted on the token contract.

address
string

Checksummed address that was checked.

tokenSymbol
string

Token symbol that was checked.

source
enum<string>

Origin of the value. Always blockchain.

Available options:
blockchain