---
title: TracePass API documentation
description: REST API reference for the TracePass Digital Product Passport platform.
canonical: "https://www.tracepass.eu/docs"
locale: en
source: "https://www.tracepass.eu/docs"
---

# TracePass API documentation

> REST API reference for the TracePass Digital Product Passport platform.

Reference for the TracePass REST API — products, Digital Product Passports, parties, batches, and the JSON-LD tenant export.

## Quickstart

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

- [Quickstart](https://www.tracepass.eu/docs/quickstart.md)

## Authentication

Two auth methods — API key (Bearer) and OAuth 2.0 with PKCE — plus Idempotency-Key for safe retries and per-plan rate limits on the v1 surface.

- [Authentication](https://www.tracepass.eu/docs/authentication.md)

## Passports

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

- [Create a passport](https://www.tracepass.eu/docs/create-passport.md)
- [Get a single passport](https://www.tracepass.eu/docs/get-passport.md)
- [Render the passport QR](https://www.tracepass.eu/docs/passport-qr.md)
- [Check passport compliance](https://www.tracepass.eu/docs/passport-compliance.md)
- [List passports](https://www.tracepass.eu/docs/list-passports.md)
- [Update one field on a passport](https://www.tracepass.eu/docs/update-field.md)
- [Upsert an economic-operator party](https://www.tracepass.eu/docs/upsert-party.md)
- [Suspend a passport](https://www.tracepass.eu/docs/suspend-passport.md)
- [Archive a passport (irreversible)](https://www.tracepass.eu/docs/archive-passport.md)
- [Delete a passport permanently](https://www.tracepass.eu/docs/delete-passport.md)
- [Batch-create passports](https://www.tracepass.eu/docs/batch-create-passports.md)

## Products

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

- [Create a product](https://www.tracepass.eu/docs/create-product.md)
- [Get a single product](https://www.tracepass.eu/docs/get-product.md)
- [List products](https://www.tracepass.eu/docs/list-products.md)
- [Update a product](https://www.tracepass.eu/docs/update-product.md)
- [Upload a product image](https://www.tracepass.eu/docs/upload-product-image.md)
- [Archive a product](https://www.tracepass.eu/docs/archive-product.md)
- [Delete a product permanently](https://www.tracepass.eu/docs/delete-product.md)

## Templates

The DPP category field schemas — discover what a compliant passport in each category requires before you build it: field counts and the governing regulation.

- [List category templates](https://www.tracepass.eu/docs/list-templates.md)
- [Get a category template](https://www.tracepass.eu/docs/get-template.md)

## Webhooks

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

- [Webhooks](https://www.tracepass.eu/docs/webhooks.md)

## Exports

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

- [Bulk JSON-LD tenant export](https://www.tracepass.eu/docs/tenant-export.md)

## EPCIS 2.0

GS1 EPCIS 2.0 supply-chain events — export a passport's event history, capture events from partners and ERP systems, and query the event store.

- [Export a passport's EPCIS events](https://www.tracepass.eu/docs/passport-epcis-export.md)
- [Capture EPCIS events](https://www.tracepass.eu/docs/capture-events.md)
- [Poll a capture job](https://www.tracepass.eu/docs/capture-job.md)
- [Query EPCIS events](https://www.tracepass.eu/docs/query-events.md)

## MCP server

MCP server — AI assistants (Claude, Cursor, IDE agents) manage products, passports, EPCIS events directly. Hosted endpoint or local npm package.

- [MCP server](https://www.tracepass.eu/docs/mcp.md)

## n8n community node

Automate TracePass workflows in n8n without code — products, passports, EPCIS events. Free community node, installable from any n8n instance.

- [n8n community node](https://www.tracepass.eu/docs/n8n.md)

## Errors & rate limits

Reference: HTTP status codes (4xx vs 5xx), error envelope shape, free-tier daily call caps, and 429 retry guidance with exponential back-off.

- [Errors & rate limits](https://www.tracepass.eu/docs/errors.md)
