Skip to main content
Inclusion proof for a specific note commitment.
The sibling path proving a commitment sits in the tree. The SDK feeds this straight into the VALID_INPUT and VALID_SPEND circuits. This is an authenticated read. Complete Transport & Attestation before sending the bearer token.

Authorizations

Authorization
string
header
required

Short-lived (≤ 1h) bearer token from POST /auth/token.

Expiry is EXACT — there is no grace period past expires_in, on REST or on the streaming transport. Refresh on a margin.

A structurally valid, unexpired token is still refused when it has been revoked (401), when the operator has invalidated the tokens the account was holding (401), or when the account is suspended (403). Suspension also blocks issuing a new one, so re-authenticating does not clear it.

Query Parameters

commitment
string
required

32-byte hex note commitment.

tree_id
integer
default:0

Which Merkle shard the commitment lives in. Default 0.

Response

Inclusion proof.

note_commitment
string
required
leaf_index
integer
required
merkle_root
string
required
siblings
string[]
required
Required array length: 20 elements

32-byte hex.