Get Inclusion Proof

Returns a Merkle inclusion proof for the given leaf index to the current WorldIDRegistry tree. In addition, it also includes the entire list of Authenticator public keys registered for the World ID.

POST /inclusion-proof

Get Inclusion Proof

cURL

curl --request POST \
  --url https://api.example.com/inclusion-proof \
  --header 'Content-Type: application/json' \
  --data '
{
  "leaf_index": "0x1"
}
'

200

{
  "authenticator_pubkeys": [
    "<string>"
  ],
  "leaf_index": "0x2a",
  "root": "0x1a2b3c4d5e6f7890",
  "siblings": [
    "<string>"
  ]
}

Body

application/json

Query for the indexer based on a leaf index.

Used for getting inclusion proofs and signature nonces.

leaf_index · string<hex> · required

The leaf index to query (from the WorldIDRegistry).

Accepts decimal or 0x/0X-prefixed hex input.

Example:

"0x1"

Response

200 - application/json

Merkle inclusion proof with authenticator public keys

OpenAPI schema representation of the AccountInclusionProof response.

authenticator_pubkeys · string<hex>[] · required

The compressed authenticator public keys for the account (array of hex strings)

leaf_index · string<hex> · required

The World ID's leaf position in the Merkle tree

Example:

"0x2a"

root · string<hex> · required

The root hash of the Merkle tree (hex string)

Example:

"0x1a2b3c4d5e6f7890"

siblings · string<hex>[] · required

The sibling path up to the Merkle root (array of hex strings)