{"templateId":"markdown","versions":[{"version":"v1.41","label":"v1.41 STS","link":"/products/custody/v1.41/get-started/deployment/register-vault","default":true,"active":false,"folderId":"c15a2701"},{"version":"v1.40","label":"v1.40 STS","link":"/products/custody/v1.40/get-started/deployment/register-vault","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.34","label":"v1.34 LTS","link":"/products/custody/v1.34/get-started/deployment/register-vault","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.26","label":"v1.26 LTS","link":"/products/custody/v1.26/get-started/deployment/register-vault","default":false,"active":true,"folderId":"c15a2701"},{"version":"v1.19","label":"v1.19 LTS","link":"/products/custody/v1.19/get-started/deployment/register-vault","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.15","label":"v1.15 LTS","link":"/products/custody/v1.15/get-started/deployment/register-vault","default":false,"active":false,"folderId":"c15a2701"}],"sharedDataIds":{"sidebar":"sidebar-products/custody/@v1.15/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Register a vault in Ripple Custody","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":"register-a-vault-in-ripple-custody","__idx":0},"children":["Register a vault in Ripple Custody"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All newly deployed vaults must be registered in ","Ripple Custody"," before they can be used."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Note:"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["At the time you open a new vault, it is important to set the key management system (KMS) — either ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["HSM"]}," (hardware-security module) or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MPC"]}," (multi-party computation) — to enable correct behavior of the system. This does not affect existing vaults. For more information about MPC key management, contact your Ripple liaison."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"obtain-the-vault-public-key","__idx":1},"children":["Obtain the vault public key"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To register the vault, you first need to obtain the public key for either an on-premise or a managed vault. Follow the process accordingly."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"obtain-the-key-for-an-on-premise-vault","__idx":2},"children":["Obtain the key for an on-premise vault"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To obtain the public key for an on-premise vault:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Access the vault logs according to the method supported for your architecture."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Search for the generated public key:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"sh","header":{"controls":{"copy":{}}},"source":"\n[INFO] [] [InitSvc]: Vault Core pubKeySig (der base64): MCowBQYDK2VwAyEA0rG1QbK6fGtkgsf7XXdbTFJVojK30tNEKrcjicKeVbI=\n\n","lang":"sh"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"obtain-the-key-for-a-managed-vault","__idx":3},"children":["Obtain the key for a managed vault"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To obtain the public key for a vault that is managed by an agent, call the following API operation:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"sh","header":{"controls":{"copy":{}}},"source":"<VAULT_HOST_ADDRESS>/internal/v1/system/information\n","lang":"sh"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The vault host returns the following response:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"publicKey\":<VAULT_PUBLIC_KEY>\",\n    \"registeredInHarmonize\":false,\n    \"vaultId\":\"<VAULT_ID>\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information about managed vaults, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.26/get-started/deployment/deploy-kms/cloud/ibm/connect"},"children":["Deploy an agent"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"register-the-vault","__idx":4},"children":["Register the vault"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To register the vault, create a vault entity, as described in the following sections:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.26/ui/environment/vault/register"},"children":["Ripple Custody UI > Register vaults"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.26/api/environment/vault/register"},"children":["Ripple Custody API > Register vaults"]}]}]}]},"headings":[{"value":"Register a vault in Ripple Custody","id":"register-a-vault-in-ripple-custody","depth":1},{"value":"Obtain the vault public key","id":"obtain-the-vault-public-key","depth":2},{"value":"Obtain the key for an on-premise vault","id":"obtain-the-key-for-an-on-premise-vault","depth":3},{"value":"Obtain the key for a managed vault","id":"obtain-the-key-for-a-managed-vault","depth":3},{"value":"Register the vault","id":"register-the-vault","depth":2}],"frontmatter":{"seo":{"title":"Register a vault in Ripple Custody"}},"lastModified":"2025-11-04T23:32:34.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/custody/v1.26/get-started/deployment/register-vault","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}