getAddressBookRecipient

Circle Mint

Core Functionality

Balances

Payouts

Wires

CBIT

PIX

Transfers

Addresses

Deposits

Accounts API

Wallets

Transfers

API Overview

Health

Management

Encryption

Subscriptions

Stablecoins

Channels

Payments API

Payments

Pull Crypto Payments

Crypto Payment Intents

Cards

Payment Tokens

Settlements

Chargebacks

Balances

Checkout Sessions

Payouts API

Payouts

Crypto Address Book

Crypto Exchange Rates

Get a recipient

GEThttps://api.circle.com/v1/addressBook/recipients/{id}

Path parameters

uuid

Required

Universally unique identifier (UUID v4) of a resource.

Response

200GetAddressBookRecipientResponse

Response Body

object

data

object

Show 8 properties

string

Unique system generated identifier for the entity.

chain

string

Required

A blockchain that a given currency is available on.

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.

metadata

object

Required

Show 3 properties

status

string

Status of the address book recipient.

createDate

string

ISO-8601 UTC date/time format.

updateDate

string

ISO-8601 UTC date/time format.

401NotAuthorized

404NotFound

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
4    "chain": "ALGO",
5    "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F",
6    "addressTag": "123456789",
7    "metadata": {
8      "nickname": "sample nickname",
9      "email": "[email protected]",
10      "bns": "sample.circle"
11    },
12    "status": "pending",
13    "createDate": "2020-04-10T02:13:30.000Z",
14    "updateDate": "2020-04-10T02:13:30.000Z"
15  }
16}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy