Skip to main content
POST
Register a blockchain address

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
accountAlias
string
required

The alias of the account the address is registered under. The account must already exist.

Maximum string length: 255
Example:

"user@example.com"

address
string
required

The blockchain address to register. An account alias can hold several addresses, one per asset.

Required string length: 10 - 255
Example:

"0x46Be1B5b35708e369b943CE6094c6f0484d480A7"

asset
enum<string>

The token tied to a specific blockchain held at the address. It determines which network the address resolves on.

Available options:
POL,
USDT_POLYGON,
USDC_POLYGON,
SBC_POLYGON,
ETH,
USDT_ETHEREUM,
USDC_ETHEREUM,
PYUSD_ETHEREUM,
DAI_ETHEREUM,
EURC_ETHEREUM,
SBC_ETHEREUM,
TRX,
USDT_TRON,
SBC_TRON,
ETH_BASE,
USDC_BASE,
USDB_BASE,
EURC_BASE,
SBC_BASE,
ETH_OPTIMISM,
USDT_OPTIMISM,
USDC_OPTIMISM,
BTC,
CELO,
CUSD_CELO,
USDC_CELO,
SBC_CELO,
SOL,
USDC_SOLANA,
USDT_SOLANA,
PYUSD_SOLANA,
USDP_SOLANA,
EURC_SOLANA,
SBC_SOLANA
Example:

"USDC_POLYGON"

Response

201 - application/json

Crypto address registered successfully.

id
string
required

Identifier of the registered address. Use it to fetch, update or decommission the address.

accountAlias
string | null

The alias of the account the address is registered under.

status
enum<string> | null

The status of the address. Only an active address is returned when the alias is resolved.

Available options:
Active,
Suspended,
Decommissioned
address
string | null

The registered blockchain address.

asset
enum<string> | null

The token tied to a specific blockchain held at the address. It determines which network the address resolves on.

Available options:
POL,
USDT_POLYGON,
USDC_POLYGON,
SBC_POLYGON,
ETH,
USDT_ETHEREUM,
USDC_ETHEREUM,
PYUSD_ETHEREUM,
DAI_ETHEREUM,
EURC_ETHEREUM,
SBC_ETHEREUM,
TRX,
USDT_TRON,
SBC_TRON,
ETH_BASE,
USDC_BASE,
USDB_BASE,
EURC_BASE,
SBC_BASE,
ETH_OPTIMISM,
USDT_OPTIMISM,
USDC_OPTIMISM,
BTC,
CELO,
CUSD_CELO,
USDC_CELO,
SBC_CELO,
SOL,
USDC_SOLANA,
USDT_SOLANA,
PYUSD_SOLANA,
USDP_SOLANA,
EURC_SOLANA,
SBC_SOLANA
createdAt
string | null

When the address was registered.

updatedAt
string | null

When the address was last updated.