Skip to main content
POST
/
prepare-transactions
/
claimTokens
claimTokens
curl --request POST \
  --url https://api.sandbox.brickken.com/prepare-transactions/claimTokens \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "method": "claimTokens",
  "chainId": "aa36a7",
  "tokenSymbol": "EXMPL",
  "investorEmail": "investor@example.com",
  "investorAddress": "0x1111111111111111111111111111111111111111"
}
'
{
  "transactions": [
    {}
  ],
  "txId": "<string>"
}
Prepares unsigned transactions for claiming tokens from a completed Security Token Offering (STO) investment. This endpoint is equivalent to calling /prepare-transactions with method=claimTokens.

​
Notes

  • Tokens can only be claimed after the STO has ended successfully
  • The investor must have participated in the STO
  • Each investor can only claim their allocated tokens once
  • The claiming process transfers the purchased tokens to the investor’s address

Authorizations

​
x-api-key
string
header
required

Body

application/json

Request body for claimTokens. signerAddress is optional when investorAddress signs the transaction.

​
method
enum<string>
required

Required. Must be claimTokens.

Available options:
claimTokens
​
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.

​
investorEmail
string<email>
required

Required. Investor email.

​
investorAddress
string
required

Required. Investor wallet address. Used as signerAddress when signerAddress is omitted.

Pattern: ^0x[a-fA-F0-9]{40}$
​
signerAddress
string

Optional. Wallet address that will sign the prepared transaction. If omitted, the API uses investorAddress for this method.

​
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