Skip to main content
POST
/
prepare-transactions
/
whitelist
whitelist
curl --request POST \
  --url https://api.sandbox.brickken.com/prepare-transactions/whitelist \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "method": "whitelist",
  "signerAddress": "0x742d35Cc6634C0532925a3b8D4C9db96c4b4d8b",
  "chainId": "aa36a7",
  "tokenSymbol": "EXMPL",
  "userToWhitelist": [
    {
      "investorAddress": "0x1111111111111111111111111111111111111111",
      "investorEmail": "investor@example.com",
      "whitelistStatus": true
    }
  ]
}
'
{
  "transactions": [
    {}
  ],
  "txId": "<string>"
}
Prepares unsigned transactions for whitelisting or blacklisting users. This endpoint is equivalent to calling /prepare-transactions with method=whitelist.

Authorizations

​
x-api-key
string
header
required

Body

application/json

Request body for whitelist. userToWhitelist must contain at least one investor address and target status.

​
method
enum<string>
required

Required. Must be whitelist.

Available options:
whitelist
​
signerAddress
string
required

Required. Wallet address that will sign the prepared transaction.

​
chainId
string
required

Required. Blockchain network identifier. Hex format is recommended, for example Sepolia aa36a7.

​
tokenSymbol
string
required

Required. Token symbol. Must be 2 to 5 uppercase letters or numbers.

​
userToWhitelist
object[]
required

Required. Users to whitelist or blacklist.

Minimum array length: 1
​
newInvestor
object

Optional. Default profile data used when creating missing investor users.

​
gasLimit
string

Optional. Gas limit override. If omitted, the API estimates gas automatically.

​
privateRpcUrl
string

Optional. Private RPC URL override. If omitted, the API uses the configured RPC for chainId.

​
nonce
integer

Optional. Nonce override. If omitted, the API reads the pending nonce from the RPC.

Response

200 - application/json

Successful response

​
transactions
object[]
required
​
txId
string
required