API documentation

Build with the TracePass v1 API

Reference for every public REST endpoint TracePass exposes — passport CRUD, parties, products, webhooks, bulk JSON-LD export. Hand-written OpenAPI 3.1 spec available for download; works with Postman, Insomnia, Bruno, and any OpenAPI client generator.

Download OpenAPI 3.1 JSON mirror →

Quickstart

Create your first passport in five minutes — register, mint an API key, post a single passport, scan the QR.

Browse Quickstart

Authentication

API-key authentication, Idempotency-Key semantics, and per-plan rate limits for the v1 surface.

Browse Authentication

Passports

8 endpoints

Create, update, suspend, archive, and bulk-import Digital Product Passports. Includes the parties block for economic-operator chains.

Browse Passports

Products

5 endpoints

The catalog layer — products, images, batches. One product can have many passports (one per serialised unit).

Browse Products

Webhooks

HMAC-signed event delivery for passport lifecycle events. Retry ladder, signature verification, replay protection.

Browse Webhooks

Exports

1 endpoint

Bulk JSON-LD tenant export — every product, passport, and template you own as one canonical document.

Browse Exports

Errors & rate limits

Reference: HTTP status codes, error envelope shape, plan-tier rate limits, retry guidance.

Browse Errors & rate limits