Vaults
API endpoints to create, list, update, and manage vaults: multichain balance sheets with quarantine, segregated balances, and an immutable audit ledger.
On this page
Quarantine
Incoming funds land in the vault’s quarantined balance and stay out of available until released. Release them with Release Quarantine (POST /vaults/{vaultId}/quarantines/{quarantineId}/release) — manually, or gated by a quarantine-release policy. Requires the Vaults:Quarantines:Release permission.
Inspect quarantines with List Vault Quarantines (GET /vaults/{vaultId}/quarantines) and Get Vault Quarantine (GET /vaults/{vaultId}/quarantines/{quarantineId}) — the latter returns the stored screening result alongside the quarantine. Both require the Vaults:Read permission.
Locks
A lock reserves funds from the vault’s available balance, so a counterparty can trust they are set aside — for off-chain settlement, escrow, or collateral. Locked funds move from available to locked and cannot be spent until the lock is released, at which point they return to available.- Create a lock with Create Vault Lock (
POST /vaults/{vaultId}/locks): specify thenetwork, the assettid(for examplenative:ethorerc20:0x...), and anamountin the asset’s minimum denomination. An optionalexternalIdis unique per vault and cannot be reused, even after the lock is released. - Release a lock with Release Vault Lock (
POST /vaults/{vaultId}/locks/{lockId}/release), returning the funds to available. Only the lock’s creator can release it. List and inspect locks with List Vault Locks and Get Vault Lock. - Transfer a lock with Transfer Vault Lock (
POST /vaults/{vaultId}/locks/{lockId}/transfer), sending part or all of the locked amount to the lock’s beneficiary. Only the lock’s owner can transfer it. Vault lock policies don’t apply, but the outgoing transfer is evaluated against theWallets:Signpolicies that match the vault’s wallet, like any vault transfer. - Locks are EVM-only today; the endpoint rejects other networks (vault addresses themselves also support Bitcoin and Solana).
- Lock creation can be gated by a balance-lock policy; when one applies, creation returns
202and the lock isn’t created until the approval completes.
Vaults:Locks:Create, Vaults:Locks:Release, Vaults:Locks:Transfer. Replacing a lock with Replace Vault Lock needs both Vaults:Locks:Release and Vaults:Locks:Create.
Policies for vaults
Three vault activities can be governed by the Policy Engine, using the same approval-quorum framework as transfers and scoped by vault tags:Vaults:ReleaseQuarantine: governs moving funds from quarantined to available. Rule:AlwaysTrigger(require approval), orChainalysisQuarantineScreening(evaluate the KYT result recorded with the quarantine, then approve or block). Action:RequestApprovalorBlock.Vaults:CreateLock: governs lock creation. Rule:AlwaysTrigger. Action:RequestApprovalorBlock.Vaults:ReplaceLock: governs lock replacement. Rule:AlwaysTrigger. Action:RequestApprovalorBlock.
Webhooks
Vaults emitvault.created, vault.updated, vault.tags.modified, and vault.event.created events. Because a vault’s addresses are managed wallets, the same activity also emits the underlying wallet.* events — a deposit emits wallet.blockchainevent.detected and wallet.blockchain_event.transfer.included, and a vault transfer emits the full wallet.transfer.requested → broadcasted → confirmed sequence. If you subscribe to both, expect both, and key off the wallet or transfer id to avoid double-counting. See Webhook Events.
Vault object
Example
Vault object.
Last modified on November 13, 2026