Digital Product Passport API documentation

Create, update and publish Digital Product Passports from your own systems. Every endpoint belongs to a single organization, and a credential only ever sees the organizations it has been granted.

API version: 2026-08-01
Base URL: https://passportcraft.com/api/v1
OpenAPI 3.1.0 document: openapi.json
Endpoints: 28

Paths, methods, scopes, field names, error codes and validation rule names are published in English, because English is the language of the interface itself — they are what a caller types or matches on. So is every code sample and JSON payload, and the exact sentence an error response carries: /v1 does not read Accept-Language, so translating what the API literally sends would misdescribe it. Everything written about them follows the language of this page.

Get a key

Test keys work on every plan, and a test key can neither read nor change your real passports.

Create a test key

Start here

Getting startedMint a key, make a first call, then create and publish a passport.AuthenticationHow a key is presented, how test and live stay apart, and which scope each endpoint demands.ConventionsIdempotency, pagination, conditional writes and the limits that apply everywhere.ErrorsEvery refusal carries a stable code. All 41 are listed with the status they arrive with.

Reference

One page per resource. Each endpoint carries its scope, its parameters, its request body, a response example and the refusals it can return.