FaceCard Docs
API reference

Health, JWKS and OpenAPI

The public routes that need no credential.

Health

GET /health

curl https://api.facecard.dev/health
{ "status": "ok", "db": "ok", "version": "<git sha>" }

Returns 200 when the database answers. If the database is down it returns 503 with "db": "down". This route is outside /v1 and has no authentication, so it is safe for uptime monitors.

JWKS

GET /.well-known/jwks.json

The public keys that verify user tokens. The signing key rotates, so select the key by kid. During a rotation the set holds the current and the previous public key. The response is cacheable for a few minutes. See User tokens and JWKS.

curl https://api.facecard.dev/.well-known/jwks.json

OpenAPI

GET /openapi.json returns the OpenAPI 3.1 description of this API. Use it to generate a client or to diff against these docs.

curl https://api.facecard.dev/openapi.json

On this page