Endpoint reference
Where the generated, always-current list lives.
The endpoint reference is generated from the OpenAPI specification the API itself produces, so it cannot drift from the implementation:
/api/docs— the interactive reference, served in development./api/docs.json— the raw OpenAPI document. Point your own tooling at it, or generate a client from it.
Paths are documented with JSDoc next to the routes they describe, so a route and its documentation move together in the same commit or not at all. Hand-written reference pages drift; this is why there are none here.
The shape of it
| Prefix | Who it is for |
|---|---|
/api/v1/* |
Your own integrations. The only public contract |
/api/public/* |
Verification. No account, ever |
/api/verifier/* |
People who check credentials rather than issue them |
/v1/openbadge/* and /openbadge/v3/* |
Open Badges. Public, CORS open to any origin |
The Open Badges paths sit outside /api because they are fixed by the specification rather than
chosen by us: a did:web resolves to a URL derived from the DID itself, and 2.0 assertion URLs are
baked into image files that outlive any routing preference we might have.
Reading this documentation as a machine
Every page here is also plain markdown — add .md to its address. llms.txt is the index with a
one-line description of each page, and llms-full.txt is the entire corpus in one file.