Create a recipient address

POST {{baseUrl}}/v1/businessAccount/wallets/addresses/recipient

Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in pending status.

Body Params

idempotencyKey string (REQUIRED) Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

address string (REQUIRED) An alphanumeric string representing a blockchain address. Will be in different formats for different chains. It is important to preserve the exact formatting and capitalization of the address.

addressTag string The secondary identifier for a blockchain address. An example of this is the memo field on the Stellar network, which can be text, id, or hash format.

chain string (REQUIRED) A blockchain that a given currency is available on.

currency string A currency associated with a balance or address.

description string (REQUIRED) An identifier or sentence that describes the recipient.

Request Body

{"idempotencyKey"=>"{{$guid}}", "address"=>"0x5b36fBbD0899c0a050626f610A80bCaDa4A4dFc3", "chain"=>"ETH", "description"=>"My USDC address at a cryptocurrency exchange", "currency"=>"ETH"}

HEADERS

RESPONSES

status: OK

{"data":{"id":"d5264546-f364-57d4-9d56-2ceb5efbd86c","address":"0x5b36fbbd0899c0a050626f610a80bcada4a4dfc3","chain":"ETH","currency":"ETH","description":"My USDC address at a cryptocurrency exchange"}}