Skip to main content
POST
Whitelist a wallet on a token

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Exchange the client id and secret Securitize issued you for a bearer token at the token URL (the host root, not under the base URL), with grant_type=client_credentials; the token lasts 2 hours and goes in the Authorization: Bearer header of every request. No scope is needed. The token identifies your partner account, so you never send a partner id, and every record you create is scoped to you.

Path Parameters

investorId
string
required

The investorId Securitize returned when you created the investor. Not your externalInvestorId.

Identifier assigned by Securitize, opaque and specific to your partner account. Store it as an opaque string.

Minimum string length: 1
Example:

"6aca84e5dc49fe8369dd1da4"

Body

application/json

The token and the investor's EVM wallet to whitelist on it.

tokenAddress
string
required

The token's contract address, as Securitize gave it to you.

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

"0x5aaeb6053f3e94c9b9a09f33669435e7ef1beaed"

walletAddress
string
required

The investor's EVM wallet.

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

"0x5aaeb6053f3e94c9b9a09f33669435e7ef1beaed"

Response

Accepted. Read status; poll the list until it leaves processing.

A whitelisting request and its current state.

tokenAddress
string
required

The token, in lower case.

walletAddress
string
required

The wallet, in lower case.

status
enum<string>
required
  • processing — on its way to the chain. Keep polling the list.
  • whitelisted — registered on-chain: the wallet can receive the token.
  • rejected — the address failed Securitize's risk check. Use another wallet; repeating returns rejected again.
  • failed — not registered on-chain. Repeat the request once; if it still reads failed, contact Securitize support.

Treat any other value as "not whitelisted".

Available options:
processing,
whitelisted,
rejected,
failed