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": "<string>",
  "chainId": "<string>",
  "gasLimit": "<string>",
  "rpcUrl": "<string>",
  "tokenSymbol": "<string>",
  "userToWhitelist": [
    {}
  ],
  "newInvestor": {}
}'
{
  "transactions": [
    {}
  ],
  "txId": "<string>"
}
Prepares unsigned transactions for whitelisting or blacklisting users. This endpoint is equivalent to calling /prepare-transactions with method=whitelist.

​
Request Body

ParameterTypeRequiredDescription
signerAddressstringYesAddress that will sign the transaction
chainIdstringYesBlockchain network identifier (hex format)
methodstringYesTransaction method type (should be “whitelist”)
tokenSymbolstringYesSymbol of the token for whitelisting
userToWhitelistarrayYesArray of users to whitelist/blacklist
gasLimitstringNoOptional gas limit
rpcUrlstringNoOptional RPC URL
newInvestorobjectNoNew investor information

​
userToWhitelist Object Structure

ParameterTypeRequiredDescription
whitelistStatusstringYes”true” to whitelist, “false” to blacklist
investorAddressstringYesAddress of the investor

​
newInvestor Object Structure

ParameterTypeRequiredDescription
namestringNoFirst name of the investor
surnamestringNoLast name of the investor

​
Example Request

{
  "signerAddress": "0x742d35Cc6634C0532925a3b8D4C9db96c4b4d8b",
  "chainId": "aa36a7",
  "method": "whitelist",
  "tokenSymbol": "EXMPL",
  "userToWhitelist": [
    {
      "whitelistStatus": "true",
      "investorAddress": "0x456..."
    }
  ],
  "newInvestor": {
    "name": "John",
    "surname": "Doe"
  }
}

​
Response

Returns an array of unsigned transactions that need to be signed and a transaction ID for tracking. 
{
  "transactions": [
    {
      "from": "0x742d35Cc6634C0532925a3b8D4C9db96c4b4d8b",
      "to": "0xTargetAddress",
      "value": {"type": "BigNumber", "hex": "0x00"},
      "nonce": 1,
      "chainId": 11155111,
      "data": "0x...",
      "type": 2,
      "maxPriorityFeePerGas": {"type": "BigNumber", "hex": "0x..."},
      "maxFeePerGas": {"type": "BigNumber", "hex": "0x..."},
      "gasLimit": {"type": "BigNumber", "hex": "0x..."}
    }
  ],
  "txId": "unique-transaction-id"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

Request body for whitelist method.

​
method
string

The operation to be performed.

Example:

"whitelist"

​
signerAddress
string
​
chainId
string
​
gasLimit
string
​
rpcUrl
string
​
tokenSymbol
string
​
userToWhitelist
object[]
​
newInvestor
object

Response

200 - application/json

Successful response

​
transactions
object[]
required
​
txId
string
required