Get Address Book

Retrieve a customer's address book entries and suggestions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns all address book entries for a customer, split into two lists: saved entries (address_book) and system-generated suggestions (suggestion) based on past transaction history.

Request

GET /customers/{customer_id}/address_book

Response Fields

The response contains two arrays:

address_book — Addresses explicitly saved by the customer or partner.

suggestion — Addresses derived from the customer's transaction history that haven't been explicitly saved.

Both arrays contain objects with the same fields:

FieldTypeDescriptionExample
idstringUnique identifier for the entry"ewteqwtqewtqwetqwetqwetq"
addressstringThe cryptocurrency address"bc1qmv4pr0hs4gd3s7chgacccr3m9ajf7xdcf7mfrm"
networkstringThe blockchain network"bitcoin"
labelstring | nullA friendly label for the address"my bitcoin address"
createdstringISO 8601 creation timestamp"2021-01-25T20:38:31+00:00"
last_usedstring | nullISO 8601 timestamp of last usenull
ownership_typestring | nullOwnership relationship: self or third_party"self"
beneficiary_full_namestring | nullFull name of the beneficiary when ownership_type is third_partynull

Error Responses

StatusError CodeDescription
400invalid_parametersRequest validation failed
404not_foundCustomer not found
Path Params
string
required
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json