Skip to main content
GET
/
get-whitelist-status
Get Whitelist Status
curl --request GET \
  --url https://api.sandbox.brickken.com/get-whitelist-status \
  --header 'x-api-key: <api-key>'
{
  "whitelistStatus": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.brickken.com/llms.txt

Use this file to discover all available pages before exploring further.

Checks if an address is whitelisted for a specific token.

​
Query Parameters

  • tokenSymbol (required): Token symbol
  • investorAddress (required): Wallet address to check

​
Example

curl --request GET \
  --url 'https://api.sandbox.brickken.com/get-whitelist-status?tokenSymbol=EXMPL&investorAddress=0x742d35Cc6634C0532925a3b8D4C9db96c4b4d8b' \
  --header 'x-api-key: YOUR_API_KEY'

​
Response

{
  "isWhitelisted": true,
  "address": "0x742d35Cc6634C0532925a3b8D4C9db96c4b4d8b",
  "tokenSymbol": "EXMPL"
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
tokenSymbol
string
required

The symbol of the token.

​
investorAddress
string
required

The Ethereum address of the investor.

Response

200 - application/json

Successful response

​
whitelistStatus
boolean

Whitelist status of the investor.