{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/wallet/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Manage vaults","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-vaults","__idx":0},"children":["Manage vaults"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create vaults to group related wallets, then find, view, update, and tag them in the console or through the Ripple Custody (Wallet) Vaults endpoints. For background on vaults and common ways to organize them, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/vaults"},"children":["Vaults overview"]},". To create wallets inside a vault, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/wallets/manage-wallets"},"children":["Manage wallets via the console"]}," or ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/wallets/manage-wallets-api"},"children":["Manage wallets via the API"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Plan your vault structure first"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Wallets, once created inside a vault, can't be moved to another vault. Decide how you want to organize your wallets before you create them. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/vaults#vault-organization-strategies"},"children":["Vault organization strategies"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"vault-actions","__idx":1},"children":["Vault 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":"Console role"},"children":["Console role"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Console procedure"},"children":["Console procedure"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API procedure"},"children":["API procedure"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a vault"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Owner, Administrator, Proposer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#create-a-vault-via-the-console"},"children":["Create a vault"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#create-a-vault-via-the-api"},"children":["Create a vault via the API"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List vaults"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All roles"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#list-vaults-via-the-console"},"children":["List vaults"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#list-vaults-via-the-api"},"children":["List vaults via the API"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get a vault"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All roles"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#view-a-vault-via-the-console"},"children":["View a vault"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get-a-vault-via-the-api"},"children":["Get a vault via the API"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update a vault"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Owner, Administrator, Proposer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#edit-or-delete-a-vault-via-the-console"},"children":["Edit or delete a vault"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#update-a-vault-via-the-api"},"children":["Update a vault via the API"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check vault balances"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All roles"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/wallets/understanding-balances#viewing-balances"},"children":["Viewing balances"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/wallets/manage-wallets-api#get-vault-balances-via-the-api"},"children":["Get vault balances"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tag a vault"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Owner, Administrator, Proposer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#tag-a-vault-via-the-console"},"children":["Tag a vault"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#tag-a-vault-via-the-api"},"children":["Tag a vault via the API"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Permissions:"]}," In the console, owners, administrators, and proposers can create vaults and update vault settings, and every role can view vaults. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/organization-and-access/users-and-roles#vaults"},"children":["User roles and permissions"]},". The API procedures need an API credential of type ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WALLETS"]},". See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#prerequisites"},"children":["Prerequisites"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"manage-vaults-via-the-console","__idx":2},"children":["Manage vaults via the console"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-a-vault-via-the-console","__idx":3},"children":["Create a vault via the console"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required role:"]}," Owner, Administrator, or Proposer."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Vaults"]}," in the console sidebar."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create vault"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter the vault ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["name"]}," (up to 50 characters). The name should help identify the vault."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Optionally, enter the vault ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["description"]}," (up to 100 characters). The description should make the purpose of the vault clear."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Optionally, enter a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Correlation ID"]}," and an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["External ID"]}," to identify the vault in your own systems."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create vault"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/get-started-create-vault.5c815647afddede86dc8ee8e3131da18c264c6f3e69a5b29387368642641b71c.9fccc40d.png","alt":"The Create vault form with Name, Description, Correlation ID, and External ID fields"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For a guided first run, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/get-started/console/create-your-first-vault"},"children":["Create your first vault"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-vaults-via-the-console","__idx":4},"children":["List vaults via the console"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Vaults"]}," in the console sidebar."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Vaults"]}," page shows your organization's total balance under the page heading, and a table of vaults with each vault's ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Name"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Balance"]},", and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ID"]},". Select the copy icon in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ID"]}," column to copy a vault ID."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Optionally, to find a vault, enter text in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Search vaults"]}," box. The search matches vault ID, name, description, external ID, and correlation ID."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Optionally, to narrow the list, select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Filters"]},", and then select a category under ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Filter by"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Correlation ID"]}," or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["External ID"]},": choose ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Include"]}," or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Exclude"]},", and enter the value."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Date created"]},": choose ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Today"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last 48 hours"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last 7 days"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last 30 days"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["This month"]},", or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom"]},". For ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom"]},", set the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["From"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["To"]}," dates."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each active filter appears as a chip above the table. To remove one filter, remove its chip. To remove them all, select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Clear filters"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Optionally, to sort the list by vault name, select the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Name"]}," column heading."]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/vaults-list-search-filters.bcb006c7d7b8937ddb8b9e2380b03a43011f8652326de32e3ce5b1a2f2cfaec1.9fccc40d.png","alt":"The Vaults page with the organization balance, a search in the Search vaults box, the open Filters menu with Correlation ID, Date created, and External ID, and the vault table"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"view-a-vault-via-the-console","__idx":5},"children":["View a vault via the console"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Go to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Vaults"]}," in the console sidebar."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select the vault's name in the table."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The vault page shows the vault's total balance under its name, cards for up to three of its wallets, and a table of all the vault's wallets. To find, filter, and sort those wallets, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/wallets/manage-wallets#list-wallets-via-the-console"},"children":["List wallets"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To see the vault's ID, correlation ID, and external ID, select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings"]},". The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["General"]}," tab shows these values, and you can copy each one."]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/vault-page-overview.885b1d4701e170d6b1a1944b2fb1bb041b396efe7eb629927da10b3643a962f8.9fccc40d.png","alt":"A vault page with the vault balance, the Settings and Create wallet buttons, a wallet card, and the wallet table with its Search wallets box and Filters button"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"edit-or-delete-a-vault-via-the-console","__idx":6},"children":["Edit or delete a vault via the console"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required role:"]}," Owner, Administrator, or Proposer."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To change a vault's name, description, or correlation ID:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open the vault and select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Go to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Details"]}," tab."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Update the fields and select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save changes"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/vault-settings-details.adb4c3be3ecc8bbb36e608178a15dcc706be76c3dc63acb2fac5bbca00641f3e.9fccc40d.png","alt":"The Details tab of Vault settings with the Name, Description, and Correlation ID fields"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can't delete a vault, either from the console or through the API. You can also change a vault's details through the API. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#update-a-vault-via-the-api"},"children":["Update a vault via the API"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"tag-a-vault-via-the-console","__idx":7},"children":["Tag a vault via the console"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required role:"]}," Owner, Administrator, or Proposer. Only owners and administrators can remove a tag."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tags are free-form labels you can use to group and find vaults. A vault can have up to 10 tags, and each tag can be up to 64 characters long."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Open the vault and select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Go to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Tags"]}," tab."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add a tag in one of these ways:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To create a tag, enter it in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create a new tag"]}," and select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To reuse a tag that's already on another vault in your organization, select it under ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add from existing"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The tag appears under ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Selected tags"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To remove a tag from the vault, select the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["×"]}," on the tag under ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Selected tags"]},"."]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The console saves each tag change as soon as you make it. You don't need to select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save changes"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/vault-settings-tags.e7e9e452377d2e5194ce21ad1a47c1f24a506809c445aef08484db4499846f0f.9fccc40d.png","alt":"The Tags tab of Vault settings with selected tags, the Create a new tag field, and existing tags to add"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"manage-vaults-via-the-api","__idx":8},"children":["Manage vaults via the API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the Ripple Custody (Wallet) Vaults endpoints to create vaults, retrieve and filter them, and update their details."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"prerequisites","__idx":9},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["An API credential of type ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WALLETS"]},"."]}," Its grantable permissions cover vaults, wallets, and balances. Create credentials in the console. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/organization-and-access/api-credentials/manage-api-credentials"},"children":["Manage API credentials"]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/organization-and-access/api-credentials#credential-types"},"children":["Credential types"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["An access token."]}," Exchange your credential's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientSecret"]}," for a bearer token. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/get-started/use-the-api#step-2-authenticate"},"children":["Getting started with the API"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the base URLs, token lifetime, pagination, filtering, and error format that every endpoint shares, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/api-and-developer-experience/api-conventions"},"children":["API conventions"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-a-vault-via-the-api","__idx":10},"children":["Create a vault via the API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/api-docs/palisade-api/palisade-api/vaults/vaultservice_createvault"},"children":["Create a vault"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," request to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/vaults"]},". Only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," is required. The optional fields are:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},": a description of the vault's purpose."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]},": an identifier from your own systems. It must be unique within your organization. If you send a create request with an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]}," that's already in use, the API returns the existing vault with HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," instead of creating a new one."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["correlationId"]},": an identifier you can use to correlate this request with related actions."]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.sandbox.palisade.co/v2/vaults \\\n  -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"name\": \"Treasury vault\",\n    \"description\": \"A vault used by the treasury department\",\n    \"externalId\": \"treasury-001\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"ce4918bf-a199-4ce2-85a3-d0d296855384\",\n  \"organizationId\": \"7c2d9e41-5b8a-4f3c-9d6e-2a1b0c8f4e73\",\n  \"name\": \"Treasury vault\",\n  \"description\": \"A vault used by the treasury department\",\n  \"externalId\": \"treasury-001\",\n  \"createdBy\": \"9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d\",\n  \"createdAt\": \"2026-07-23T10:22:22.420Z\",\n  \"updatedAt\": \"2026-07-23T10:22:22.420Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Save the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},". You need it to create wallets in the vault."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-vaults-via-the-api","__idx":11},"children":["List vaults via the API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/api-docs/palisade-api/palisade-api/vaults/vaultservice_listvaults"},"children":["List vaults"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/api-docs/palisade-api/palisade-api/vaults/vaultservice_listvaults2"},"children":["List vaults with a request body"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," request to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/vaults"]},". You can narrow and page the results with these query parameters:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search"]},": a case-insensitive match over vault ID, name, description, external ID, and correlation ID."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Field filters on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["correlationId"]},", using the operators ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eq"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["notEq"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contains"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["startsWith"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["endsWith"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["in"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["notIn"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isNull"]},". For example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter.name.contains=treasury"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Timestamp filters on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdAt"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updatedAt"]},", using the operators ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eq"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["notEq"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["before"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["after"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gte"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lte"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["between.start"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["between.end"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isNull"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["relativeDays"]},". For example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter.createdAt.relativeDays=-7"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pagination.pageSize"]}," (default 50, maximum 1,000) and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pagination.pageToken"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pagination.orderBy"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["created_at"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updated_at"]},") and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pagination.order"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SORT_ORDER_ASC"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SORT_ORDER_DESC"]},")."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The filters you set are combined with AND."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl \"https://api.sandbox.palisade.co/v2/vaults?pagination.pageSize=10&search=Treasury\" \\\n  -H \"Authorization: Bearer $ACCESS_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"filter\": {\n    \"nextPageToken\": \"cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=\",\n    \"total\": 12\n  },\n  \"vaults\": [\n    {\n      \"id\": \"ce4918bf-a199-4ce2-85a3-d0d296855384\",\n      \"organizationId\": \"7c2d9e41-5b8a-4f3c-9d6e-2a1b0c8f4e73\",\n      \"name\": \"Treasury vault\",\n      \"description\": \"A vault used by the treasury department\",\n      \"externalId\": \"treasury-001\",\n      \"createdBy\": \"9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d\",\n      \"createdAt\": \"2026-07-23T10:22:22.420Z\",\n      \"updatedAt\": \"2026-07-23T10:22:22.420Z\"\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To fetch the next page, pass the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter.nextPageToken"]}," value as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pagination.pageToken"]},". Pages after the first also include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter.previousPageToken"]},". The last page has no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nextPageToken"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Complex filters in a request body"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For filters that are awkward to express as query parameters, send a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," request to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/vaults:list"]}," instead. It accepts the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pagination"]}," options as a JSON body and returns the same response."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.sandbox.palisade.co/v2/vaults:list \\\n  -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"filter\": { \"name\": { \"in\": [\"Treasury vault\", \"Outbound vault\"] } },\n    \"pagination\": { \"pageSize\": 50, \"orderBy\": \"name\", \"order\": \"SORT_ORDER_ASC\" }\n  }'\n","lang":"bash"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-a-vault-via-the-api","__idx":12},"children":["Get a vault via the API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/api-docs/palisade-api/palisade-api/vaults/vaultservice_getvault"},"children":["Get a vault"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/api-docs/palisade-api/palisade-api/balances/balanceservice_getvaultbalances"},"children":["Get vault balances"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," request to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/vaults/{id}"]}," to retrieve a single vault."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl https://api.sandbox.palisade.co/v2/vaults/ce4918bf-a199-4ce2-85a3-d0d296855384 \\\n  -H \"Authorization: Bearer $ACCESS_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response is the same vault object that the create request returns."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"update-a-vault-via-the-api","__idx":13},"children":["Update a vault via the API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/api-docs/palisade-api/palisade-api/vaults/vaultservice_updatevault"},"children":["Update a vault"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," request to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/vaults/{id}"]}," to change a vault's name and description. The request requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", even if you're only changing the description. The update replaces both fields: if you omit ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},", the update clears the vault's existing description. You can also pass an optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["correlationId"]},"; if you omit it, the update clears the vault's existing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["correlationId"]},". To change one field, send the current values of the others. The request ignores ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X PUT https://api.sandbox.palisade.co/v2/vaults/$VAULT_ID \\\n  -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"name\": \"Treasury vault\",\n    \"description\": \"Primary vault for treasury operations\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response is the updated vault object."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"No delete endpoint"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API doesn't provide an endpoint to change a vault's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]}," or to delete a vault. A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," request to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/vaults/{id}"]}," returns HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["501"]}," with the message ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Method Not Allowed"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"tag-a-vault-via-the-api","__idx":14},"children":["Tag a vault via the API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Tags are free-form labels you can use to group and find vaults. Tags don't have permissions of their own: adding a vault tag needs ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vault:update"]},", listing needs ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vault:read"]}," (or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["key:read"]}," for a single vault's tags), and deleting a vault tag needs ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["key:delete"]},". A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WALLETS"]}," credential without ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["key:delete"]}," can add and list tags but gets ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAL000.002"]},") when it deletes one."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"add-a-tag-via-the-api","__idx":15},"children":["Add a tag via the API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/api-docs/palisade-api/palisade-api/vault-tags/vaultservice_addvaulttag"},"children":["Add a vault tag"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," request to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/vaults/{vaultId}/tags"]},". The request requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tag"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.sandbox.palisade.co/v2/vaults/$VAULT_ID/tags \\\n  -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{ \"tag\": \"treasury\" }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"[\n  {\n    \"vaultId\": \"ce4918bf-a199-4ce2-85a3-d0d296855384\",\n    \"tags\": [\"treasury\"]\n  }\n]\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"list-tags-via-the-api","__idx":16},"children":["List tags via the API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/api-docs/palisade-api/palisade-api/vault-tags/vaultservice_listvaulttags"},"children":["List vault tags"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/api-docs/palisade-api/palisade-api/vault-tags/vaultservice_listglobalvaulttags"},"children":["List all vault tags"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," request to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/vaults/{vaultId}/tags"]}," for one vault's tags, or to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/vaults/tags"]}," for every vault tag in your organization. Both return an array of objects that each contain a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vaultId"]}," and its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"delete-a-tag-via-the-api","__idx":17},"children":["Delete a tag via the API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/api-docs/palisade-api/palisade-api/vault-tags/vaultservice_deletevaulttag"},"children":["Delete a vault tag"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," request to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/vaults/{vaultId}/tags"]}," with the tag in the required ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tag"]}," query parameter. A successful response is an empty JSON object."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X DELETE \"https://api.sandbox.palisade.co/v2/vaults/$VAULT_ID/tags?tag=treasury\" \\\n  -H \"Authorization: Bearer $ACCESS_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"errors","__idx":18},"children":["Errors"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Failed requests return an HTTP error status and an error object with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}," fields. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/api-and-developer-experience/error-codes"},"children":["Error codes"]},". For the causes of and fixes for the errors these endpoints return, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/api-and-developer-experience/error-codes#troubleshoot-common-errors"},"children":["Troubleshoot common errors"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"best-practices","__idx":19},"children":["Best practices"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Separate operational wallets from cold storage"]}," — use different vaults with different quorums and approval requirements."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":20},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/wallets/manage-wallets"},"children":["Manage wallets via the console"]}," or ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/wallets/manage-wallets-api"},"children":["Manage wallets via the API"]},": create wallets inside your vault."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/vaults-and-wallets/wallets/manage-wallets-api#check-balances-via-the-api"},"children":["Check balances via the API"]},": read balances at the organization, vault, and wallet level."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/wallet/api-docs/palisade-api/palisade-api"},"children":["Ripple Custody (Wallet) API reference"]},": the full request and response schemas."]}]}]},"headings":[{"value":"Manage vaults","id":"manage-vaults","depth":1},{"value":"Vault actions","id":"vault-actions","depth":2},{"value":"Manage vaults via the console","id":"manage-vaults-via-the-console","depth":2},{"value":"Create a vault via the console","id":"create-a-vault-via-the-console","depth":3},{"value":"List vaults via the console","id":"list-vaults-via-the-console","depth":3},{"value":"View a vault via the console","id":"view-a-vault-via-the-console","depth":3},{"value":"Edit or delete a vault via the console","id":"edit-or-delete-a-vault-via-the-console","depth":3},{"value":"Tag a vault via the console","id":"tag-a-vault-via-the-console","depth":3},{"value":"Manage vaults via the API","id":"manage-vaults-via-the-api","depth":2},{"value":"Prerequisites","id":"prerequisites","depth":3},{"value":"Create a vault via the API","id":"create-a-vault-via-the-api","depth":3},{"value":"List vaults via the API","id":"list-vaults-via-the-api","depth":3},{"value":"Get a vault via the API","id":"get-a-vault-via-the-api","depth":3},{"value":"Update a vault via the API","id":"update-a-vault-via-the-api","depth":3},{"value":"Tag a vault via the API","id":"tag-a-vault-via-the-api","depth":3},{"value":"Add a tag via the API","id":"add-a-tag-via-the-api","depth":4},{"value":"List tags via the API","id":"list-tags-via-the-api","depth":4},{"value":"Delete a tag via the API","id":"delete-a-tag-via-the-api","depth":4},{"value":"Errors","id":"errors","depth":3},{"value":"Best practices","id":"best-practices","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Manage vaults","seo":{"title":"Manage vaults"}},"lastModified":"2026-10-09T11:09:54.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/wallet/vaults-and-wallets/vaults/manage-vaults","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}