whitelist

Prepare a whitelist update

curl --request POST \
  --url https://api.sandbox.brickken.com/prepare-transactions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "method": "whitelist",
  "chainId": "aa36a7",
  "signerAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
  "tokenSymbol": "EXMPL",
  "userToWhitelist": [
    {
      "investorAddress": "0x1111111111111111111111111111111111111111",
      "investorEmail": "investor@example.com",
      "whitelistStatus": true
    }
  ]
}
'

import requests

url = "https://api.sandbox.brickken.com/prepare-transactions"

payload = {
    "method": "whitelist",
    "chainId": "aa36a7",
    "signerAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    "tokenSymbol": "EXMPL",
    "userToWhitelist": [
        {
            "investorAddress": "0x1111111111111111111111111111111111111111",
            "investorEmail": "investor@example.com",
            "whitelistStatus": True
        }
    ]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    method: 'whitelist',
    chainId: 'aa36a7',
    signerAddress: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',
    tokenSymbol: 'EXMPL',
    userToWhitelist: [
      {
        investorAddress: '0x1111111111111111111111111111111111111111',
        investorEmail: 'investor@example.com',
        whitelistStatus: true
      }
    ]
  })
};

fetch('https://api.sandbox.brickken.com/prepare-transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.brickken.com/prepare-transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'method' => 'whitelist',
    'chainId' => 'aa36a7',
    'signerAddress' => '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',
    'tokenSymbol' => 'EXMPL',
    'userToWhitelist' => [
        [
                'investorAddress' => '0x1111111111111111111111111111111111111111',
                'investorEmail' => 'investor@example.com',
                'whitelistStatus' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.brickken.com/prepare-transactions"

	payload := strings.NewReader("{\n  \"method\": \"whitelist\",\n  \"chainId\": \"aa36a7\",\n  \"signerAddress\": \"0x742d35Cc6634C0532925a3b844Bc454e4438f44e\",\n  \"tokenSymbol\": \"EXMPL\",\n  \"userToWhitelist\": [\n    {\n      \"investorAddress\": \"0x1111111111111111111111111111111111111111\",\n      \"investorEmail\": \"investor@example.com\",\n      \"whitelistStatus\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.brickken.com/prepare-transactions")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"method\": \"whitelist\",\n  \"chainId\": \"aa36a7\",\n  \"signerAddress\": \"0x742d35Cc6634C0532925a3b844Bc454e4438f44e\",\n  \"tokenSymbol\": \"EXMPL\",\n  \"userToWhitelist\": [\n    {\n      \"investorAddress\": \"0x1111111111111111111111111111111111111111\",\n      \"investorEmail\": \"investor@example.com\",\n      \"whitelistStatus\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.brickken.com/prepare-transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"method\": \"whitelist\",\n  \"chainId\": \"aa36a7\",\n  \"signerAddress\": \"0x742d35Cc6634C0532925a3b844Bc454e4438f44e\",\n  \"tokenSymbol\": \"EXMPL\",\n  \"userToWhitelist\": [\n    {\n      \"investorAddress\": \"0x1111111111111111111111111111111111111111\",\n      \"investorEmail\": \"investor@example.com\",\n      \"whitelistStatus\": true\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "transactions": [
    {
      "from": "0x1234567890abcdef1234567890abcdef12345678",
      "to": "0xabcdef1234567890abcdef1234567890abcdef12",
      "value": "0x00",
      "nonce": 3792,
      "chainId": 11155111,
      "data": "0xd362e8a70000000000000000000000000000000000000000000000000000000000000040...",
      "type": 2,
      "maxPriorityFeePerGas": "1150000",
      "maxFeePerGas": "1156037",
      "gasLimit": "0xccef"
    }
  ],
  "txId": "0x46adea7bdf49c576a760102e0d6bc9ecd650b3998588cd3d7f576a7973426aad",
  "info": {
    "tokenizerEmail": "tokenizer@example.com",
    "tokenSymbol": "EXMPL",
    "investorEmail": "investor@example.com"
  }
}

POST

prepare-transactions

Prepare a whitelist update

curl --request POST \
  --url https://api.sandbox.brickken.com/prepare-transactions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "method": "whitelist",
  "chainId": "aa36a7",
  "signerAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
  "tokenSymbol": "EXMPL",
  "userToWhitelist": [
    {
      "investorAddress": "0x1111111111111111111111111111111111111111",
      "investorEmail": "investor@example.com",
      "whitelistStatus": true
    }
  ]
}
'

import requests

url = "https://api.sandbox.brickken.com/prepare-transactions"

payload = {
    "method": "whitelist",
    "chainId": "aa36a7",
    "signerAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    "tokenSymbol": "EXMPL",
    "userToWhitelist": [
        {
            "investorAddress": "0x1111111111111111111111111111111111111111",
            "investorEmail": "investor@example.com",
            "whitelistStatus": True
        }
    ]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    method: 'whitelist',
    chainId: 'aa36a7',
    signerAddress: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',
    tokenSymbol: 'EXMPL',
    userToWhitelist: [
      {
        investorAddress: '0x1111111111111111111111111111111111111111',
        investorEmail: 'investor@example.com',
        whitelistStatus: true
      }
    ]
  })
};

fetch('https://api.sandbox.brickken.com/prepare-transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.brickken.com/prepare-transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'method' => 'whitelist',
    'chainId' => 'aa36a7',
    'signerAddress' => '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',
    'tokenSymbol' => 'EXMPL',
    'userToWhitelist' => [
        [
                'investorAddress' => '0x1111111111111111111111111111111111111111',
                'investorEmail' => 'investor@example.com',
                'whitelistStatus' => true
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.brickken.com/prepare-transactions"

	payload := strings.NewReader("{\n  \"method\": \"whitelist\",\n  \"chainId\": \"aa36a7\",\n  \"signerAddress\": \"0x742d35Cc6634C0532925a3b844Bc454e4438f44e\",\n  \"tokenSymbol\": \"EXMPL\",\n  \"userToWhitelist\": [\n    {\n      \"investorAddress\": \"0x1111111111111111111111111111111111111111\",\n      \"investorEmail\": \"investor@example.com\",\n      \"whitelistStatus\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.brickken.com/prepare-transactions")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"method\": \"whitelist\",\n  \"chainId\": \"aa36a7\",\n  \"signerAddress\": \"0x742d35Cc6634C0532925a3b844Bc454e4438f44e\",\n  \"tokenSymbol\": \"EXMPL\",\n  \"userToWhitelist\": [\n    {\n      \"investorAddress\": \"0x1111111111111111111111111111111111111111\",\n      \"investorEmail\": \"investor@example.com\",\n      \"whitelistStatus\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.brickken.com/prepare-transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"method\": \"whitelist\",\n  \"chainId\": \"aa36a7\",\n  \"signerAddress\": \"0x742d35Cc6634C0532925a3b844Bc454e4438f44e\",\n  \"tokenSymbol\": \"EXMPL\",\n  \"userToWhitelist\": [\n    {\n      \"investorAddress\": \"0x1111111111111111111111111111111111111111\",\n      \"investorEmail\": \"investor@example.com\",\n      \"whitelistStatus\": true\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "transactions": [
    {
      "from": "0x1234567890abcdef1234567890abcdef12345678",
      "to": "0xabcdef1234567890abcdef1234567890abcdef12",
      "value": "0x00",
      "nonce": 3792,
      "chainId": 11155111,
      "data": "0xd362e8a70000000000000000000000000000000000000000000000000000000000000040...",
      "type": 2,
      "maxPriorityFeePerGas": "1150000",
      "maxFeePerGas": "1156037",
      "gasLimit": "0xccef"
    }
  ],
  "txId": "0x46adea7bdf49c576a760102e0d6bc9ecd650b3998588cd3d7f576a7973426aad",
  "info": {
    "tokenizerEmail": "tokenizer@example.com",
    "tokenSymbol": "EXMPL",
    "investorEmail": "investor@example.com"
  }
}

Prepares unsigned transactions for whitelisting or blacklisting users. Use POST /prepare-transactions with method=whitelist.

Next step

Preparing does not touch the chain. The response gives you txId and an array of unsigned transactions — you still have to sign and submit them.

Sign every returned transaction

Sign each entry locally with the wallet that sends the transaction — signerAddress, or investorAddress for newInvest and claimTokens. It must be whitelisted by Brickken, and it needs native gas on the target chain.

Submit the signed payloads

POST them to /send-transactions as { txId, signedTransactions } and Brickken broadcasts for you.If you would rather broadcast yourself, prepare with executionMode: "client-broadcast" and confirm afterwards with { txId, txHash } instead.

Poll until it confirms

Call GET /get-transaction-status with the txId. A pending status means it is broadcast but not yet mined — do not resubmit.

Full walkthrough: Tokenize an asset and run an STO.

Authorizations

x-api-key

string

header

required

Body

application/json

method

enum<string>

default:whitelist

required

Required. Operation to prepare. Must be whitelist for this endpoint.

Available options:

whitelist

Example:

"whitelist"

chainId

string

required

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

Example:

"aa36a7"

signerAddress

string

required

Required. Tokenizer wallet that signs the whitelist transaction.

Example:

"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"

tokenSymbol

string

required

Required. Symbol of the token whose whitelist is updated.

Example:

"EXMPL"

userToWhitelist

object[]

required

Required. Users to whitelist or blacklist.

Minimum array length: 1

Show child attributes

Example:

[
  {
    "investorAddress": "0x1111111111111111111111111111111111111111",
    "investorEmail": "investor@example.com",
    "whitelistStatus": true
  }
]

newInvestor

object

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

Show child attributes

Response

200 - application/json

Successful response

transactions

object[]

required

Array of unsigned transaction objects ready for signing

Show child attributes

txId

string

required

Unique identifier for this transaction batch (required for /send-transactions). This is NOT a blockchain transaction hash.

Example:

"0x46adea7bdf49c576a760102e0d6bc9ecd650b3998588cd3d7f576a7973426aad"

info

object

Metadata about the operation

Show child attributes

Overview

Guides

KYC

Prepare Transactions

Send Transactions

Read Endpoints

Token Documents

Next step

Authorizations

Body

Response

​Next step

Authorizations

Body

Response

Next step