Address Book
Address Book resources represent approved destinations and fiat settlement accounts available to the API user's organization.
Child page | Resource | REST base path | JavaScript SDK |
|---|---|---|---|
Contact | Blockchain addresses and approved contact destinations. | /api/external/contacts/ | getContacts, getContactById, createContact, updateContact, and approval helpers. |
Bank Account | Fiat settlement and beneficiary bank accounts. | /api/external/bank_accounts/ | getBankAccounts, getBankAccountById, createBankAccount, and approval helpers. |
Shared rules
• Both resources are organization-scoped. Use only IDs returned under the current API credential and explicit sub-organization scope.
• List APIs use cursor pagination and return results, nextCursor, and hasNext.
• Create and update operations can enter an approval flow. Check the returned status instead of assuming the resource is immediately active.
• Bank-account fields are sensitive. Do not include full account or routing numbers in logs or analytics.
Open the relevant child page for its complete REST parameters, response types, request examples, and JavaScript SDK functions.