reference

API reference

The VEREID API is documented in OpenAPI 3.1. Render it locally with any compatible tool, or browse the raw spec.

Interactive reference

The interactive reference is rendered client-side by Scalar API Reference from the spec hosted at /openapi.yaml.

Download the spec

openapi.yaml — full OpenAPI 3.1 source

Authentication

All endpoints require an API key. Pass it as a bearer token:

Authorization: Bearer vk_live_••••••••••••

Keys are bcrypt-hashed at rest with a 12-character public prefix (vk_live_ / vk_test_) so leaked keys are revocable by prefix without scanning the entire database. Each key carries a scope list — see OIDC claims for how scopes intersect with end-user grants.

Versioning

The API is versioned in the URL (/v1/...). Breaking changes ship as /v2 with a six-month overlap; non-breaking additions land in /v1 immediately. The latest changes are on the changelog.

Errors

All errors return a problem document (RFC 9457):

{
  "type": "https://docs.vereid.com/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "detail": "verification.tier must be one of T1..T6",
  "instance": "req_01HZ3X4P9K"
}