Brickken APIInstall

Summary

Check whitelist status of an investor for a given token.

Inputs

• tokenSymbol (required) — Symbol of the token to query.
• investorAddress (required) — Address of the investor to check whitelist status.
• requestOptions — Additional HTTP request configuration options (batching, proxy, SSL verification, timeout).
• allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation fails.
• proxy — HTTP proxy to use (e.g., http://username:password@myproxy:3128).
• timeout — Request timeout in milliseconds.

Output shape

a JSON object containing the whitelist status

The response typically includes a boolean indicating if the address is whitelisted; may also contain additional metadata but is not paginated.

Examples

Example 1: Check if a specific investor is whitelisted for a token

tokenSymbol=ERC20, investorAddress=0x123... , requestOptions={batching:{batchSize:1}}