The Ripple Custody (Wallet) address book provides a place to securely store external counterparty and address information.
The address book acts as another layer of security for your digital assets by ensuring that only legitimate and authorized addresses can receive assets from your wallets.
| Action | Console role | Console procedure | API procedure |
|---|---|---|---|
| Create a counterparty | Owner, Administrator | Create a counterparty | Create a counterparty |
| List and get counterparties | All except Viewer | List and get counterparties | List and get counterparties |
| Update a counterparty | - | - | Update a counterparty |
| Add an address | Owner, Administrator | Add an address | Add an address to a counterparty |
| List addresses | All except Viewer | List addresses | List addresses |
| Delete an address | Owner, Administrator | Delete a counterparty or address | Get or delete an address |
| Delete a counterparty | Owner, Administrator | Delete a counterparty or address | Delete a counterparty |
| Require approval for new addresses | Owner, Administrator | Require approval for new entries | - |
For all console procedures, see Manage address book via the console. For all API procedures, see Manage the address book via the API.
A counterparty is an external party involved in a transaction.
There are 3 types of counterparty:
- Decentralized Application (dApp): A dApp operates on a blockchain network through smart contracts.
- Individual: A single person (e.g., a friend).
- Organization: A company or entity (e.g., a merchant, exchange, or other business).
This is a unique digital address that is used to identify an on-chain wallet.
It is similar to an account number that identifies other parties in traditional banking transactions, but instead it exists on the blockchain network.
For example, an address may look like this: 0x55502b9d5a68b0F8a48384352295BeD968aD8AA4.
A counterparty can have multiple blockchain addresses. Be careful that you are transacting with the correct address.
For the XRP Ledger, the r-address and an optional destination tag together identify an address. You can distinguish two counterparties that share the same r-address by their destination tags. See Manage address book via the console for details.
- Global by default Address book entries are global by default, meaning they can be linked to any wallet across the platform via its policies. This feature increases efficiency by removing the need to create separate address books for each wallet.
- Enables counterparty record keeping and management The address book enables users to clearly and easily keep track of all counterparties and corresponding addresses in a single location.
- Ensures regulatory compliance The address book ensures users are compliant with the EU’s Transfer of Funds regulations. These regulations, which came into effect on 30 December 2024, require custodians and wallet providers to provide and check for ‘travel rule data’, or counterparty information, for inbound and outbound transactions.
EU regulation dictates that you must ensure counterparty information is accurate and true when making transactions. The Address book provides a method to accurately record and store this information.