Skip to content

API reference

The Witness gateway exposes a client-facing JSON HTTP API. Hashes and signatures are lowercase hexadecimal strings without a 0x prefix in the documented wire format. See the HTTP API for the route and schema reference.

Pages

  • HTTP API — client-facing routes and methods.
  • CLI — commands that call the HTTP API.
  • Configuration — informational and verification config surfaces.
  • Proof format — bundle and signature JSON shapes.
  • Error handling — status codes and verdict semantics.

Common rules

  • The path and query hash form is a 32-byte SHA-256 value encoded as 64 hex characters.
  • GET /v1/config is informational and does not contain witness public keys.
  • GET /v1/network is secret-free verification material; it excludes witness endpoints, bearer tokens, inbound federation secrets, and anchor-provider configuration.
  • POST /v1/verify returns the gateway's opinion. Prefer local verification against a reviewed configuration for a trust-minimizing verdict.
  • Operator routes such as federation ingress, admin, and metrics are not part of this client-facing reference.