{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/wallet/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Correlation ID Support Now Available","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com/products/custody","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":"correlation-id-support-now-available","__idx":0},"children":["Correlation ID Support Now Available"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Today, we are excited to announce the release of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Correlation ID Support"]}," in Wallet-as-a-Service (Palisade), enabling you to track and correlate related operations across wallets, vaults, and transfer transactions with a single, user-defined identifier."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This new feature empowers you to build more traceable applications that can easily group and query related entities, streamlining debugging, auditability, and operational visibility across the platform."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Correlation IDs are user-defined and must be unique to your tracking use case."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"why","__idx":1},"children":["Why"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In complex environments with high-volume wallet and vault operations, tracking related entities and transactions across the system can be challenging. Whether you're tracing fund flows from a user registration event or auditing vault initialization processes, having a consistent way to correlate operations is essential for operational excellence."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"what-are-correlation-ids","__idx":2},"children":["What are Correlation IDs?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Correlation IDs are user-defined identifiers that can be attached to specific actions and entities during creation or update operations. Once associated, this ID serves as a linking mechanism to query and retrieve all related records, making it easier to investigate or trace groups of related operations."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"key-features","__idx":3},"children":["Key Features"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Comprehensive Entity Support"]},": Attach correlation IDs to wallet creation/updates, vault creation/updates, and transfer transactions."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Flexible Querying"]},": Retrieve all entities sharing a correlation ID across different entity types."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Advanced Filtering"]},": Combine correlation ID queries with blockchain-specific or vault-specific filters."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Improved Auditability"]},": Track complete operational flows from initiation to completion."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"supported-operations","__idx":4},"children":["Supported Operations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Attach Correlation IDs to:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Wallet creation and update."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Vault creation and update."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Transfer transactions."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query by Correlation ID to:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Retrieve all transfer transactions with a given Correlation ID."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Retrieve all vaults with a given Correlation ID."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Retrieve all wallets with a given Correlation ID."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Advanced Filtering:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Get all wallets on a specific blockchain with a given Correlation ID."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Retrieve all wallets within a specific vault with a Correlation ID."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Retrieve all wallets matching both blockchain and vault combination with a Correlation ID."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"api-examples","__idx":5},"children":["API Examples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create a Vault with a Correlation ID:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"POST /v2/vaults\nContent-Type: application/json\n{\n  \"name\": \"Treasury Vault\",\n  \"description\": \"Vault for main treasury operations\",\n  \"correlation_id\": \"treasury-group-001\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Update an Existing Vault with a Correlation ID:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"PUT /v2/vaults/{id}\nContent-Type: application/json\n{\n  \"name\": \"Updated Vault Name\",\n  \"description\": \"Updated description\",\n  \"correlation_id\": \"treasury-group-001\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create a Wallet with a Correlation ID:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"POST /v2/vaults/{vault_id}/wallets\nContent-Type: application/json\n{\n  \"blockchain\": \"ethereum\",\n  \"type\": \"HSM\",\n  \"name\": \"Main ETH Wallet\",\n  \"correlation_id\": \"eth-treasury-2025\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Update a Wallet with a Correlation ID:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"PUT /v2/vaults/{vault_id}/wallets/{wallet_id}\nContent-Type: application/json\n{\n  \"name\": \"Updated Wallet\",\n  \"description\": \"Updated description\",\n  \"correlation_id\": \"eth-treasury-2025\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"query-by-correlation-id","__idx":6},"children":["Query by Correlation ID"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get All Transactions by Correlation ID:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v2/transactions?correlation_id=eth-treasury-2025\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get All Vaults by Correlation ID:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v2/vaults?correlation_id=treasury-group-001\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get All Wallets by Correlation ID:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v2/wallets?correlation_id=eth-treasury-2025\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"how-to-get-started","__idx":7},"children":["How to Get Started"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Define Your Correlation Strategy"]},": Determine how you want to group related operations (e.g., by user session, business process, or time period)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Include Correlation IDs"]},": Add the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["correlation_id"]}," field to your vault, wallet, and transaction creation requests."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query Related Entities"]},": Use the correlation ID query parameters to retrieve all related entities."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Implement Tracing"]},": Build operational dashboards and audit trails using correlation IDs as the linking mechanism."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"api-endpoints","__idx":8},"children":["API Endpoints"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Manage correlation IDs through our existing entity endpoints with the new ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["correlation_id"]}," parameter. For complete API documentation, see the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/wallet/api-docs/palisade-api/palisade-api"},"children":["Wallet-as-a-Service (Palisade) API"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"best-practices","__idx":9},"children":["Best Practices"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Unique Identifiers"]},": Ensure correlation IDs are unique within your tracking scope to avoid confusion."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Consistent Naming"]},": Use a consistent naming convention for correlation IDs (e.g., prefixes for different operation types)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Documentation"]},": Document your correlation ID strategy for team members and audit purposes."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Cleanup Strategy"]},": Consider implementing a strategy for managing old correlation IDs as your system scales."]}]}]},"headings":[{"value":"Correlation ID Support Now Available","id":"correlation-id-support-now-available","depth":1},{"value":"Why","id":"why","depth":2},{"value":"What are Correlation IDs?","id":"what-are-correlation-ids","depth":3},{"value":"Key Features","id":"key-features","depth":3},{"value":"Supported Operations","id":"supported-operations","depth":3},{"value":"API Examples","id":"api-examples","depth":3},{"value":"Query by Correlation ID","id":"query-by-correlation-id","depth":3},{"value":"How to Get Started","id":"how-to-get-started","depth":3},{"value":"API Endpoints","id":"api-endpoints","depth":3},{"value":"Best Practices","id":"best-practices","depth":3}],"frontmatter":{"title":"Correlation ID Support Now Available","seo":{"title":"Correlation ID Support Now Available"}},"lastModified":"2026-01-29T15:53:00.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/wallet/changelogs/correlation-id-support","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}