Skip to content

API documentation

Freebird has separate V4 issuer, verifier, and operator surfaces.

Pages

  • HTTP API: bounded public verification and discovery routes, plus the distinction between public and admin surfaces.
  • TypeScript SDK: supported client flows and safe token handling.
  • Admin CLI: issuer operator commands.
  • Configuration: the main settings needed for local and production deployments.

For a runnable local setup, see the quick start. For issuer operations, invitations, WebAuthn, vouching, and audit workflows, use Admin Operations.

Scope and compatibility

These pages intentionally cover the bounded API surface rather than reproduce every internal or version-specific payload. Clients should use discovery and the SDK where available, validate response shapes, and treat unsupported token unsupported token families as rejected.