Manage the Address Book
API Users can propose address book changes. Address book changes are subject to the approval of the admin quorum.
Create a new contact
To create a new contact, call the Create Contact endpoint. In the request, specify the name
and the address
of the new contact, the chain type
of the contact (for example, evm
, solana
, utxo
, and so on). Optionally, if you want the contact to be valid only for specific chains (within the specified chain type) or specific assets, you can specify a list of chains
(for example, evm_1,
solana_mainnet
, and so on) or assets
this contact should be valid for.
Since address book changes are sensitive operations, they require request signing. For example, to add a Bitcoin address to the address book:
{
"name": "My Bitcoin Contact",
"type": "utxo",
"address": "1JvTPkdZPhtDR7D7qAdAJ923MzFKhmN6k4",
"chain": "bitcoin_mainnet"
}
Control the scope of the address
An address can be scoped to a single chain, all chains of a particular type (for example, EVM), or a specific asset. For example:
{
"name": "My EVM Contact",
"type": "evm",
"address": "0x3fEBb139Ba00332E0B2DE6994B0bdAA505bf318D",
"chains": []
}
Update an existing contact
To update an existing contact, call the Edit Contact endpoint. The edit request has the same format as the creation request, above.
Abort a proposal
After an address book change has been proposed, and until it has been approved by the admin quorum, you can abort the proposal using the Abort Contact endpoint.
List contacts
You can list all contacts in your workspace using the List Contacts endpoint. This API returns contacts in all states: pending
, active
, and deleted
. If you want to get only the active contacts you can use the states
query parameter.