API reference

List self-hosted wallet ownership requests

200 List of address proofserror Error object

Ask the owner of a self-hosted wallet to prove control of it

Body { network, address, label }. Returns the message to sign and the link (url, valid 14 days) to send the owner. EVM (personal_sign or EIP-1271), Solana, Bitcoin, Litecoin and Dogecoin signed messages. Webhook address.ownership_verified.

201 Address proof with urlerror Error object

Record the owner's signature of an ownership message

Body { signature }. Verified against the address before the proof counts.

200 Address prooferror Error object

List the address book

200 List of trusted addresseserror Error object

Add a trusted destination

Body { network, address, label, note? }. Validated and sanctions-screened; trusted only after the policy's security cooldown. Webhook address.added.

201 Trusted addresserror Error object

Revoke a trusted destination

200 Revokederror Error object

Audit trail (SIEM feed)

The organization's audit events in chain order. Poll with after=<last seq received>. Each event carries seq (gapless per organization), prev_hash and hash = sha256 of the previous hash, the seq and every field.

200 A list of audit_event objects, has_more and next_after.error Error object

Verify the audit hash chain

Recomputes every hash, link and sequence number. Store head.hash outside Chainvara to detect a later rewrite.

200 audit_verification: valid, events, head, problems.error Error object

Every deposit address of one of your users

Body { external_user_id, networks?, label? }: one wallet per network, idempotent (calling again returns the same addresses). Deposits arrive as deposit.received webhooks carrying the same external_user_id.

200 deposit_addresses (all existed)201 deposit_addresses (some created)error Error object

Store or fetch an embedded wallet's encrypted recovery backup

step store { external_user_id, network, backup } or fetch { external_user_id, network }. The backup is encrypted on the device under a 125-bit recovery code Chainvara never sees.

200 OKerror Error object

Embedded wallet: joint key generation with the end user's device

Calls relayed by your backend for the device SDK (/sdk/chainvara-embedded.js). Solana (FROST): start (device_round1) then finish (device_round2, public_key). EVM networks (threshold ECDSA): start → commit (device_message, device_commitment) → prove (device_proof) → finish (public_key); each answer carries the next session_id. Bodies up to 2 MB.

200 Round answer201 Wallet createderror Error object

Embedded wallet: sign an approved transfer with the end user's device

Solana: start (device_commitments) returns the signing package and the transfer to show; the device checks the exact transaction, then finish (device_share) broadcasts. EVM: start (sign_id) returns the unsigned transaction, which the device decodes and hashes itself; sign (device_message1, device_message2); finish (device_message) broadcasts.

200 Submittederror Error object

List events

200 OKerror Error object

Payment requests sent and received on the Chainvara network

200 OKerror Error object

Request a payment from a connected organization

The payer pays it to your published address on that network, from their console or API, under their own policy and approvals.

201 Createderror Error object

Pay an incoming payment request

201 OKerror Error object

Decline (payer) or cancel (requester) an open request

200 OKerror Error object

Bilateral obligations with connected organizations

200 OKerror Error object

Record an obligation

Counts in the net position only once the counterparty confirms it.

201 Createderror Error object

Confirm or dispute (counterparty), or cancel (recorder) a pending obligation

200 OKerror Error object

Net position per counterparty and asset

200 OKerror Error object

Net settlements

200 OKerror Error object

Settle the whole net position with one transfer (net debtor only)

201 Createderror Error object

Network fee estimates

A typical transfer's fee at each fee_level (low, medium, high), in the native coin's smallest unit.

200 network_feeserror Error object

Networks and assets for this environment

200 OKerror Error object

List operations

Token, staking and swap operations (plain transfers are under /transfers).

200 OKerror Error object

Request an operation

Create, mint, burn or profile a token, swap, stake or unstake. Same policy, approvals, co-signer and vault signing as transfers. Token decimals are read from the chain; a swap's guaranteed minimum comes from a fresh quote.

200 Idempotent replay201 Createderror Error object

Organizations you can pay by handle

Connected organizations of the payment network and the networks they receive on. Pay one with destination "@handle" on POST /transfers or /payouts.

200 OKerror Error object

List payout batches

Recent batches with per-status counts.

200 OKerror Error object

Create a payout batch

Up to 500 lines { destination, amount, note? } from one wallet and asset. Every line is validated first; if any is invalid nothing is created and the errors are listed per line. Send an Idempotency-Key so a retry never pays twice.

201 payout_batcherror Error object

Retrieve a payout batch with every transfer and its status

200 payout_batcherror Error object

The policy in force

Limits, tiers, address book, Travel Rule, KYT and transaction rules, with the version and the latest versions.

200 policyerror Error object

Replay a candidate policy on recent requests

Body { policy } in the shape GET /policy returns. Validated, then replayed on the last 200 requests (24-hour totals and velocity recomputed). Nothing is published.

200 policy_impact: checked, stricter, looser, unchanged, changeserror Error object

Latest USD prices

200 OKerror Error object

Valued ledger and monthly totals

200 OKerror Error object

Realized gains and positions with cost basis

Pooled per asset across the organization's wallets (moves between own wallets excluded). Unknown costs are null, never guessed.

200 OKerror Error object

Create a proof-of-reserves snapshot

Body { customers: [{ user_id, balances: { BTC: "0.25" } }] }. Commits liabilities in a Merkle sum tree (ids hashed) and reads reserves from your wallets.

201 por_snapshoterror Error object

A customer's inclusion proof

200 por_proof: give it to that customer to check on the public pageerror Error object

Sanctions screening of any address (OFAC SDN)

200 screening_resulterror Error object

Screening of the senders of your deposits

Every incoming movement's sender is screened (sanctions and your KYT providers). Never credit a flagged deposit before deposit.released.

200 OKerror Error object

Security posture of the key's environment

Score 0-100 and every check with its fix, for SIEM and GRC dashboards.

200 security_postureerror Error object

Swap quote

200 OKerror Error object

Issued tokens

Tokens the organization created, with live supply, market price, market cap and public profile.

200 OKerror Error object

List transfers

Newest first. When has_more, pass next_cursor as starting_after for the next page (stable while new transfers arrive).

200 OKerror Error object

Request a transfer

Evaluated against the environment policy (limits, allow/blocklists, approval tiers). Approved transfers are signed in the vault and broadcast by the worker when execution is enabled.

200 Idempotent replay201 Createderror Error object

Preview a transfer

Same body as POST /transfers. Returns the policy decision, destination status, USD value, network fee and a chain simulation (funds, fees, gas estimate). Nothing is created, signed or sent.

200 transfer_previewerror Error object

Replace a transfer's accounting tags

Body { tags: ["payroll", "vendor:acme"] }. Tags are never part of what was approved or signed.

200 OKerror Error object

Retrieve a transfer with its timeline

200 OKerror Error object

Cancel a transfer before submission

200 OKerror Error object

Speed up a stuck EVM, Bitcoin or Litecoin transaction

EVM: re-signs the same transaction (same nonce, recipient, amount and data). Bitcoin and Litecoin: replace-by-fee spending the same coins, the higher fee taken from the change. Fees rise by at least 12.5% or to the network price, at most ten times the approved fee. Webhook transfer.sped_up.

200 OKerror Error object

Cancel a stuck EVM, Bitcoin or Litecoin transaction on chain

EVM: spends the same nonce on a 0-value transaction to the wallet itself. Bitcoin and Litecoin: spends the same coins back to the wallet. Whichever transaction is included first decides: the transfer ends confirmed, or canceled with nothing sent.

200 OKerror Error object

Travel Rule messages exchanged with network organizations

200 OKerror Error object

Acknowledge an incoming Travel Rule message

200 OKerror Error object

List vaults

200 List of vaultserror Error object

Create a vault

Body { name, description? }.

201 Vaulterror Error object

Freeze a vault

Body { reason }. Nothing can leave the vault, approved transfers included, until an owner, admin or CFO unfreezes it in the console. Webhook vault.frozen.

200 Vaulterror Error object

List wallets

200 OKerror Error object

Create a wallet

Generates a new key in the vault (omit `address`), or watches an existing address (pass `address`). With `external_user_id`, creation is idempotent per network: one wallet per end user.

200 Existing end-user wallet returned201 Createderror Error object

Retrieve a wallet

200 OKerror Error object

Wallet balances

200 OKerror Error object

On-chain history

200 OKerror Error object

Token approvals that can still be used (EVM)

ERC-20 allowances, NFT operators and Permit2 allowances, read live, riskiest first; at_risk = min(allowance, balance).

200 allowanceserror Error object

Revoke a token approval

Body { kind: erc20 | nft_operator | permit2, token, spender }. Requested as a contract_call operation under the policy and co-signer.

201 OKerror Error object

Move a wallet into a vault

Body { vault_id } (null: out of its vault).

200 wallet_vaulterror Error object

Refresh both key shares of an MPC wallet (same address, old shares void)

200 OKerror Error object