post
https://api.lirium-sandbox.com/v1/customers//address_book
Add a new address to a customer's address book.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Creates a new entry in a customer's address book. Address book entries allow customers to save frequently used cryptocurrency addresses for quick access when creating send orders.
One entry per address and networkAn entry is identified by its
addressandnetwork, not by currency. An address saved on a network can be used to send any currency on that network (for example, the sameethereumaddress for bothUSDTandUSDC), so you only add it once.
- The same address on a different network (for example,
ethereumandpolygon) is a separate entry.- Adding an address that is already an entry for that network returns
400withaddress_book_item_already_exist.- Adding an address that was previously deleted restores it with the new
label,ownership_typeandbeneficiary_full_name.
Request
POST /customers/{customer_id}/address_book
Request Body
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| address | string | Yes | The cryptocurrency address to save | "bc1qmv4pr0hs4gd3s7chgacccr3m9ajf7xdcf7mfrm" |
| network | string | Yes | The blockchain network for the address | "bitcoin" |
| label | string | No | A friendly label for the address | "My BTC wallet" |
| ownership_type | string | No | Relationship between the customer and the address owner. Possible values: self, third_party | "third_party" |
| beneficiary_full_name | string | No | Full name of the beneficiary. Used when ownership_type is third_party | "John Doe" |
Response Fields
| Field | Type | Description | Example |
|---|---|---|---|
| id | string | Unique identifier for the address book entry | "ewteqwtqewtqwetqwetqwetq" |
| address | string | The saved cryptocurrency address | "bc1qmv4pr0hs4gd3s7chgacccr3m9ajf7xdcf7mfrm" |
| network | string | The blockchain network | "bitcoin" |
| label | string | null | The friendly label | "My BTC wallet" |
| created | string | ISO 8601 creation timestamp | "2021-01-25T20:38:31+00:00" |
| last_used | string | null | ISO 8601 timestamp of last use | null |
| ownership_type | string | null | Ownership relationship: self or third_party | "third_party" |
| beneficiary_full_name | string | null | Full name of the beneficiary | "John Doe" |
Error Responses
| Status | Error Code | Description |
|---|---|---|
| 400 | invalid_parameters | Request validation failed |
| 400 | invalid_address | The address is not valid for the given network |
| 400 | address_book_item_already_exist | The customer already has an entry with this address on this network |
| 404 | not_found | Customer not found |