Endpoints

Every endpoint has full schemas in the API reference and an interactive executor in the playground. This page is a map, not a reference — use it to pick which surface you need.

Public (no key)

Endpoint	Use
`GET /v1/check`	Verify a domain or licence number in one round trip. Confidence-scored. See the confidence guide.
`GET /v1/jurisdictions`	List the six jurisdictions we cover, with name / country / currency / licence types.
`GET /v1/operators/search?q=…`	Type-ahead search by operator display name or trading name. Unauthenticated: capped at 3 rows.

Authenticated (Bearer token)

Endpoint	Use
`GET /v1/jurisdictions/:code`	Single jurisdiction detail.
`GET /v1/jurisdictions/:code/operators`	Paginated operators under that jurisdiction. Sort = display_name asc.
`GET /v1/operators/:slug`	Full operator detail — metadata + licences + domains.
`GET /v1/operators/:slug/licenses`	Licences for one operator. Append `?include_history=true` for the status-change log.
`GET /v1/licenses/:license_id`	Licence by uuid. Useful when you want a pinned detail page.
`GET /v1/licenses/:license_id/history`	Status-change timeline for a single licence.

System

Endpoint	Use
`GET /v1/health`	Liveness probe. 200 if postgres + redis are reachable.
`GET /v1/health/coverage`	Per-jurisdiction scraper freshness — last successful scrape, age in hours, fresh vs stale flag per our SLA (UKGC 24 h, MGA / CW / KH 48 h). Public at 10 req / IP / hour.
`GET /openapi.json`	Canonical OpenAPI 3.1 spec. Consume it, generate a client, etc.

Response shape conventions

Top-level list endpoints return an envelope: { q, total, limit, offset, <rows>, _meta }. These support pagination via ?limit= + ?offset=. Example: GET /v1/jurisdictions/:code/operators, GET /v1/operators/search, GET /v1/operators/:slug/licenses, GET /v1/licenses/:id/history.
Single-row endpoints return the row directly — no wrapping envelope.
Nested arrays on detail endpoints are bare arrays, not paginated. GET /v1/operators/:slug returns a full operator with its licenses[] + domains[] inline, without limit / offset. Need pagination over an operator’s licences? Use GET /v1/operators/:slug/licenses instead — the paginated form ships a proper envelope.
Timestamps are ISO-8601 UTC (2026-04-19T12:00:00Z).
Dates are YYYY-MM-DD.
UUIDs are lowercase, hyphenated, v4.