Changelog
Back to All
added

Correlation ID Support Now Available

about 1 month ago by Dionysi Ntreou

Today, we are excited to announce the release of Correlation ID Support in Palisade, enabling you to track and correlate related operations across wallets, vaults, and transfer transactions with a single, user-defined identifier.

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.

🚧

Correlation IDs are user-defined and must be unique to your tracking use case

Why

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.

What are Correlation IDs?

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.

Key Features

  • Comprehensive Entity Support: Attach correlation IDs to wallet creation/updates, vault creation/updates, and transfer transactions
  • Flexible Querying: Retrieve all entities sharing a correlation ID across different entity types
  • Advanced Filtering: Combine correlation ID queries with blockchain-specific or vault-specific filters
  • Improved Auditability: Track complete operational flows from initiation to completion

Supported Operations

Attach Correlation IDs to:

  • Wallet creation and update
  • Vault creation and update
  • Transfer transactions

Query by Correlation ID to:

  • Retrieve all transfer transactions with a given Correlation ID
  • Retrieve all vaults with a given Correlation ID
  • Retrieve all wallets with a given Correlation ID

Advanced Filtering:

  • Get all wallets on a specific blockchain with a given Correlation ID
  • Retrieve all wallets within a specific vault with a Correlation ID
  • Retrieve all wallets matching both blockchain and vault combination with a Correlation ID

API Examples

Create a Vault with a Correlation ID:

POST /v2/vaults
Content-Type: application/json
{
  "name": "Treasury Vault",
  "description": "Vault for main treasury operations",
  "correlation_id": "treasury-group-001"
}

Update an Existing Vault with a Correlation ID:

PUT /v2/vaults/{id}
Content-Type: application/json
{
  "name": "Updated Vault Name",
  "description": "Updated description",
  "correlation_id": "treasury-group-001"
}

Create a Wallet with a Correlation ID:

POST /v2/vaults/{vault_id}/wallets
Content-Type: application/json
{
  "blockchain": "ethereum",
  "type": "HSM",
  "name": "Main ETH Wallet",
  "correlation_id": "eth-treasury-2025"
}

Update a Wallet with a Correlation ID:

PUT /v2/vaults/{vault_id}/wallets/{wallet_id}
Content-Type: application/json
{
  "name": "Updated Wallet",
  "description": "Updated description",
  "correlation_id": "eth-treasury-2025"
}

Query by Correlation ID

Get All Transactions by Correlation ID:

GET /v2/transactions?correlation_id=eth-treasury-2025

Get All Vaults by Correlation ID:

GET /v2/vaults?correlation_id=treasury-group-001

Get All Wallets by Correlation ID:

GET /v2/wallets?correlation_id=eth-treasury-2025

How to Get Started

  1. Define Your Correlation Strategy: Determine how you want to group related operations (e.g., by user session, business process, or time period)
  2. Include Correlation IDs: Add the correlation_id field to your vault, wallet, and transaction creation requests
  3. Query Related Entities: Use the correlation ID query parameters to retrieve all related entities
  4. Implement Tracing: Build operational dashboards and audit trails using correlation IDs as the linking mechanism

API Endpoints

Manage correlation IDs through our existing entity endpoints with the new correlation_id parameter. For complete API documentation, visit our developer documentation.

Best Practices

  • Unique Identifiers: Ensure correlation IDs are unique within your tracking scope to avoid confusion
  • Consistent Naming: Use a consistent naming convention for correlation IDs (e.g., prefixes for different operation types)
  • Documentation: Document your correlation ID strategy for team members and audit purposes
  • Cleanup Strategy: Consider implementing a strategy for managing old correlation IDs as your system scales