Zum Hauptinhalt springen
GET
Get Declaration of Conformity by ID

Autorisierungen

Authorization
string
header
erforderlich

API key generated in Settings > API Keys. Include as Authorization: Bearer <key>.

Pfadparameter

id
string<uuid>
erforderlich

Abfrageparameter

fields
string

Comma-separated list of the resource's top-level keys to return (per element for a list), e.g. id,name; omit for the full body. Top-level only; whitespace is trimmed and duplicates count once. fields never adds keys: a selected optional key that is absent on a row stays absent. 400 when passed more than once, when empty, or when it names an unknown key (the error names it and lists the allowed ones).

Antwort

Declaration details

id
string
erforderlich

UUID of the declaration — what GET /api/v1/ppwr/declarations/{id} takes.

version
number
erforderlich

Version number; a successor that supersedes this declaration carries a higher one.

status
string
erforderlich

Status of the declaration: draft, issued, superseded or withdrawn. One of: draft, issued, superseded, withdrawn.

origin
string
erforderlich

generated (drawn up in the app) or collected (the manufacturer's uploaded DoC). One of: generated, collected.

referenceNumber
string | null
erforderlich

Reference number printed on the declaration, or null (e.g. for a draft).

issuedAt
string | null
erforderlich

When the declaration was issued (ISO 8601, UTC); null for a draft.

withdrawnAt
string | null
erforderlich

When the declaration was withdrawn (ISO 8601, UTC); null unless withdrawn.

supersededAt
string | null
erforderlich

When a newer declaration replaced this one for its last unit (ISO 8601, UTC); null unless status is superseded, and can also be null for a declaration superseded before 2026-10 whose successors were since deleted. A family declaration that loses only some units to a newer one stays issued with supersededAt: null — those units leave its activeSpecIds.

supersedesId
string | null
erforderlich

UUID of the earlier declaration this one replaces, or null.

verified
boolean
erforderlich

A generated DoC always; a collected DoC once its verification passed and while its file is on record.

isFallback
boolean
erforderlich

An importer substitute DoC (Ersatz-Konformitätserklärung).

pdfUrl
string | null
erforderlich

Path of the PDF download (GET, same API key); null for a draft, and for a collected declaration whose uploaded file is no longer on record (the download would answer 404) — verified is then false too.

specIds
string[]
erforderlich

Every packaging unit the declaration covers (a family DoC covers several).

activeSpecIds
string[]
erforderlich

The units it is currently the active DoC for.