API Reference

Every endpoint, schema, and error shape below is generated by the DUST API itself and served live, so it always matches the deployed API.

Embedded reference

Loading the API reference…The reference is taking longer than usual to load. You can open it in a new tab while it finishes.

Open the full reference in a new tab

Where to start

• Quickstart — your first authenticated request, end to end.
• Authentication — API keys, token exchange, and context headers.
• Conventions — pagination and the request context shared by every endpoint.
• Errors — the error envelope, the codes you will actually hit, and how to recover.
• DICE guides — how the same records look and behave in the web app.

Tip

The TypeScript client is generated from this same spec, so its types always match what the reference documents.

Spec copies

Two copies of the spec are available:

Source	URL	Freshness
DUST API (live)	https://apid.dustid.io/api/openapi.json	Always matches the deployed API.
This docs site	/openapi.json	Generated when this site is built, from the same source as the API.

Prefer the live copy when generating clients or validating requests — it always matches the deployed API. The site copy is regenerated with every docs release and is convenient when you are already browsing here.