Changelog and versioning
How the API changes, how to pin a version, and what has changed so far.
How versioning works
- The major version is in the path. Within
/v1, changes are additive only. - A date pins the details. The first request from a key with no pin of its own pins your organisation's version. Send
Vojo-Versionto choose one for a single request. See Versioning. - Deprecations get notice. A deprecated endpoint sends
DeprecationandSunsetheaders, with at least 180 days' notice.
Because /v1 grows by addition, your client should ignore fields it doesn't recognise.
Changelog
2026-11-08: real-time scores
- New webhook event
verification.score.preliminary: a play's score as soon as its Passport report is complete, before it's final. verification.scoreis renamedverification.score.final. The old name still works with the same payload, and an endpoint subscribed to both receives one event per play.
2026-10-07: early access
The first /v1 API version, for CMS integrators.
- Secret-key authentication, scopes, cursor pagination,
Idempotency-Keyon creates, andapplication/problem+jsonerrors. - Screens, screen size ranges, sites (create and list), wrappers, plays and play events, evidence composition, webhook endpoints, and the organisation.
- Webhook secret rolls with an overlap period, and two
v1signatures during that overlap. - A
verification.scoresubscription made through/v1sends plays whose score becomes final after you subscribe, and never backfills.
The rest of the /v1 contract isn't served yet and returns 404. The API reference marks those endpoints.
These pages were built from API contract 1.0.0 and webhooks contract 1.3.0.