{"templateId":"markdown","versions":[{"version":"v1.41","label":"v1.41 STS","link":"/products/custody/accounts-and-assets/accounts/manage-accounts-api","default":true,"active":false,"folderId":"c15a2701"},{"version":"v1.40","label":"v1.40 STS","link":"/products/custody/v1.40/accounts-and-assets/accounts/manage-accounts-api","default":false,"active":true,"folderId":"c15a2701"},{"version":"v1.34","label":"v1.34 LTS","link":"/products/custody/v1.34/accounts-and-assets/accounts/manage-accounts-api","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.26","label":"v1.26 LTS","link":"/products/custody/v1.26/accounts-and-assets/accounts/manage-accounts-api","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.19","label":"v1.19 LTS","link":"/products/custody/v1.19/accounts-and-assets/accounts/manage-accounts-api","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.15","label":"v1.15 LTS","link":"/products/custody/v1.15/accounts-and-assets/accounts/manage-accounts-api","default":false,"active":false,"folderId":"c15a2701"}],"sharedDataIds":{"sidebar":"sidebar-products/custody/@v1.15/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Manage accounts with the API","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"manage-accounts-with-the-api","__idx":0},"children":["Manage accounts with the API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this page for account operations with the ","Ripple Custody"," API. For UI procedures, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/accounts-and-assets/accounts/manage-accounts-ui"},"children":["Manage accounts in the UI"]},". For the account model, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/accounts-and-assets/accounts/overview"},"children":["Accounts"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"account-actions","__idx":1},"children":["Account actions"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Action"},"children":["Action"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API procedure"},"children":["API procedure"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API reference"},"children":["API reference"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create an account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#create-an-account-with-the-api"},"children":["Create an account with the API"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/intents/createintent"},"children":["Propose an intent"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/intents/intentdryrun"},"children":["Perform a dry run"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["View account details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#view-account-details"},"children":["View account details"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/accounts/getaccounts"},"children":["List accounts"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/accounts/getaccount"},"children":["Get account details"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/accounts/getaccountaddress"},"children":["Retrieve account address"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update account details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#update-account-details"},"children":["Update account details"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/intents/createintent"},"children":["Propose an intent"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/intents/intentdryrun"},"children":["Perform a dry run"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Add ledgers to an account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#add-ledgers-to-an-account"},"children":["Add ledgers to an account"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/intents/createintent"},"children":["Propose an intent"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/intents/intentdryrun"},"children":["Perform a dry run"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lock or unlock an account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#lock-or-unlock-an-account"},"children":["Lock or unlock an account"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/intents/createintent"},"children":["Propose an intent"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/intents/intentdryrun"},"children":["Perform a dry run"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check account balances"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#check-account-balances"},"children":["Check account balances"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/accounts/getaccountbalances"},"children":["Get account balances"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Force an account balance update"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#force-an-account-balance-update"},"children":["Force an account balance update"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/accounts/forceupdateaccountbalances"},"children":["Update account balances forcefully"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure compliance settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#configure-compliance-settings"},"children":["Configure compliance settings"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/accounts/getcomplianceconfiguration"},"children":["Get compliance configuration"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/accounts/upsertcomplianceconfiguration"},"children":["Set compliance configuration"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/accounts/listcomplianceconfigurations"},"children":["List compliance configurations"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Account changes use the standard intent flow. For signing, approval, and status checks, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/governance/intents/manage-intents-and-approvals"},"children":["Manage intents and approvals"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/identity-and-access/authentication/authenticate-api-requests#signing-intents-state-mutation-operations"},"children":["Sign intents"]},", and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/governance/intents/manage-intents-and-approvals#check-state-with-the-api"},"children":["Check updates"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-operations","__idx":2},"children":["Common operations"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Intent type"},"children":["Intent type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Use when"},"children":["Use when"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_CreateAccount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Register a new account for one or more ledgers."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_UpdateAccount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Change mutable account details such as alias, description, or custom properties."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Add account ledgers"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_AddAccountLedgers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Add compatible ledgers to an existing account."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lock account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_LockAccount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Prevent outbound activity for an account."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unlock account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_UnlockAccount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Re-enable a locked account."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create-an-account-with-the-api","__idx":3},"children":["Create an account with the API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create an account by submitting a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_CreateAccount"]}," intent."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API reference:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/intents/dry-run\nPOST /v1/intents\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The examples in this section show the intent ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payload"]}," block. When you dry run or propose the intent, include this payload inside the standard request body with the intent ID in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," for dry runs or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["request.id"]}," for signed proposals. For the full request shapes, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/governance/intents/intent-request-structure"},"children":["Intent request structure"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you create an account, prepare:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Prerequisite"},"children":["Prerequisite"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Additional information"},"children":["Additional information"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Vault ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/vaults/getvaults"},"children":["List vaults"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Key strategy"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Use the supported derivations returned by ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/vaults/getvault"},"children":["Get vault details"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ledger IDs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/ledgers/getledgers"},"children":["List ledgers"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["New IDs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Prepare an account ID and intent ID in standard UUID format."]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"payload\": {\n    \"id\": \"3b6d578e-7396-495d-8392-61b7ede174b3\",\n    \"alias\": \"btc-zero\",\n    \"providerDetails\": {\n      \"vaultId\": \"00000000-0000-0000-0000-000000000000\",\n      \"keyStrategy\": \"VaultHard\",\n      \"type\": \"Vault\"\n    },\n    \"ledgerIds\": [\"bitcoin-testnet\"],\n    \"lock\": \"Unlocked\",\n    \"description\": \"a bitcoin account for testing\",\n    \"customProperties\": {\n      \"testnet_account\": \"true\"\n    },\n    \"type\": \"v0_CreateAccount\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Field notes:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["providerDetails"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Vault and key strategy details. For more information, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/accounts-and-assets/accounts/account-key-derivation-and-ledger-compatibility"},"children":["Key derivation"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ledgerIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["One or more ledger IDs associated with the account."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lock"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Locked"]}," to create an inactive account and unlock it later."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_CreateAccount"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Ledger-specific account limitations"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Accounts you create on the Hedera ledger follow a specific account initialization process. For more information, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/accounts-and-assets/accounts/ledger-specific-settings/hedera-api"},"children":["Initialize Hedera accounts"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Accounts you create on the Algorand ledger can only be used in offline mode on testnet and mainnet. They are in offline mode so cannot be used for consensus, although you can still use them to send and receive funds."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"view-account-details","__idx":4},"children":["View account details"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use account read operations to find account IDs, retrieve account details, and retrieve ledger addresses."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API reference:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /v1/domains/{domainId}/accounts\nGET /v1/domains/{domainId}/accounts/{accountId}\nGET /v1/domains/{domainId}/accounts/{accountId}/addresses/{accountAddressId}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If you do not know the account ID, call ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/accounts/getaccounts"},"children":["List accounts"]},". You can filter accounts by criteria such as ledger ID."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Call ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/accounts/getaccount"},"children":["Get account details"]}," with the account ID."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To retrieve a specific account address, call ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/accounts/getaccountaddress"},"children":["Retrieve account address"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Depending on the account type, account details include:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Account type"},"children":["Account type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Details returned"},"children":["Details returned"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Single-ledger account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ledger address in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ledgerId"]}," field. In ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["providerDetails"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keyInformation"]}," contains public key data and the derivation path for the ledger."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Multi-ledger account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The list of ledgers in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additionalDetails.ledgers"]},", including each ledger status. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keys"]}," array contains public key data and derivation paths for supported ledger curves."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Multi-ledger account ledger statuses include:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Activated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ledger is active for the account."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Activating"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ledger is currently being activated for the account."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Available"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ledger is available to be activated for the account."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Unavailable"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ledger is not compatible with the account's vault or key strategy."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"update-account-details","__idx":5},"children":["Update account details"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_UpdateAccount"]}," to update mutable account details such as alias, description, and custom properties."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API reference:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/intents/dry-run\nPOST /v1/intents\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit an update intent with the current account reference:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"payload\": {\n    \"reference\": {\n      \"id\": \"3b6d578e-7396-495d-8392-61b7ede174b3\",\n      \"revision\": 2\n    },\n    \"alias\": \"btc-zero\",\n    \"description\": \"Updated account description\",\n    \"customProperties\": {},\n    \"type\": \"v0_UpdateAccount\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"add-ledgers-to-an-account","__idx":6},"children":["Add ledgers to an account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_AddAccountLedgers"]}," to add compatible ledgers to an existing account."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API reference:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/intents/dry-run\nPOST /v1/intents\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit an add-ledgers intent with the current account reference:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"payload\": {\n    \"reference\": {\n      \"id\": \"3b6d578e-7396-495d-8392-61b7ede174b3\",\n      \"revision\": 2\n    },\n    \"ledgerIds\": [\"ethereum-mainnet\"],\n    \"type\": \"v0_AddAccountLedgers\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"lock-or-unlock-an-account","__idx":7},"children":["Lock or unlock an account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_LockAccount"]}," when an account should not be used for outbound activity. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_UnlockAccount"]}," only after confirming the account should be re-enabled."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API reference:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/intents/dry-run\nPOST /v1/intents\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"payload\": {\n    \"reference\": {\n      \"id\": \"3b6d578e-7396-495d-8392-61b7ede174b3\",\n      \"revision\": 2\n    },\n    \"type\": \"v0_LockAccount\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_UnlockAccount"]}," with the same reference shape to re-enable the account."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"check-account-balances","__idx":8},"children":["Check account balances"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you send assets, check the amount available to send. Balances depend on transaction state and ledger-specific behavior."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API reference:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /v1/domains/{domainId}/accounts/{accountId}/balances\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Account balances include:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Amount"},"children":["Amount"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Total amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Total balance reported by the blockchain."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reserved amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Balance allocated but not available for spending, including amounts and fees for transactions that are initiated but not yet executed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Quarantined amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Incoming transfers that are not yet released from quarantine. For more information, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/transactions/send-and-receive/receive-assets-api#release-quarantined-assets"},"children":["Release quarantined assets"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Available amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Balance available for new transactions."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Call ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/accounts/getaccountbalances"},"children":["Get account balances"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"force-an-account-balance-update","__idx":9},"children":["Force an account balance update"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An account can receive funds directly from the blockchain that are not registered automatically in ","Ripple Custody",". For example, staking rewards might not be reflected until balances are refreshed."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API reference:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/domains/{domainId}/accounts/{accountId}/balances/refresh\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To force an account balance update, call ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/accounts/forceupdateaccountbalances"},"children":["Update account balances forcefully"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"configure-compliance-settings","__idx":10},"children":["Configure compliance settings"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use account-level compliance settings to control how incoming transfers are processed. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipQuarantineFrom"]}," setting allows internal transfers to bypass quarantine screening. For more information, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/compliance/transaction-screening/concept#skip-quarantine-for-internal-transfers"},"children":["Skip quarantine for internal transfers"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API reference:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /v1/domains/{domainId}/accounts/{accountId}/compliance-configuration\nPUT /v1/domains/{domainId}/accounts/{accountId}/compliance-configuration\nGET /v1/domains/{domainId}/compliance-configurations\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before configuring compliance settings, prepare:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Prerequisite"},"children":["Prerequisite"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Additional information"},"children":["Additional information"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/accounts/getaccounts"},"children":["List accounts"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Compliance role"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact your domain administrator."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To retrieve the current configuration for an account, call ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/accounts/getcomplianceconfiguration"},"children":["Get compliance configuration"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To create or update the configuration, call ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/accounts/upsertcomplianceconfiguration"},"children":["Set compliance configuration"]}," with the desired ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipQuarantineFrom"]}," value and revision:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"skipQuarantineFrom\": \"Domain\",\n  \"revision\": 1\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Behavior"},"children":["Behavior"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All incoming transfers are quarantined normally."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Domain"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Skip quarantine for transfers from accounts in the same domain."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Instance"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Skip quarantine for transfers from any account in the same ","Ripple Custody"," instance."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Always retrieve the current configuration before updating so you can use the correct revision number. To disable skip quarantine, set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipQuarantineFrom"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["None"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To retrieve all compliance configurations in a domain, call ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.40/reference/api/openapi/accounts/listcomplianceconfigurations"},"children":["List compliance configurations"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"operational-checklist","__idx":11},"children":["Operational checklist"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before submitting an account-management intent:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Confirm the target domain."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Confirm the vault ID, key strategy, and ledger IDs."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Confirm the policy that will govern the account intent."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Dry run the payload."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Verify the executed change by viewing account details."]}]}]},"headings":[{"value":"Manage accounts with the API","id":"manage-accounts-with-the-api","depth":1},{"value":"Account actions","id":"account-actions","depth":2},{"value":"Common operations","id":"common-operations","depth":2},{"value":"Create an account with the API","id":"create-an-account-with-the-api","depth":2},{"value":"View account details","id":"view-account-details","depth":2},{"value":"Update account details","id":"update-account-details","depth":2},{"value":"Add ledgers to an account","id":"add-ledgers-to-an-account","depth":2},{"value":"Lock or unlock an account","id":"lock-or-unlock-an-account","depth":2},{"value":"Check account balances","id":"check-account-balances","depth":2},{"value":"Force an account balance update","id":"force-an-account-balance-update","depth":2},{"value":"Configure compliance settings","id":"configure-compliance-settings","depth":2},{"value":"Operational checklist","id":"operational-checklist","depth":2}],"frontmatter":{"seo":{"title":"Manage accounts with the API"}},"lastModified":"2026-08-05T09:55:07.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/custody/v1.40/accounts-and-assets/accounts/manage-accounts-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}