Skip to content
Public

The public passport of a unit, looked up by GTIN and serial number

public, no keySee also:Authentication ·Errors ·Pagination ·Rate limits
GET
/public/dpps/by-product-id/{productId}

No authentication. Same response as getPublicPassport.

Path Parameters

productId*string

{gtin}:{serial} (EN 18222 style), e.g. 04012345000023:SV2027-000184; the GTIN may have 8, 12, 13 or 14 digits.

Length10 <= length <= 70

Response Body

The passport.

application/json
  1. response

The public passport JSON. document is the signed public projection (ADR-013); the other members can change over the passport's life and are not signed.

document?

A passport version projected to an access tier. The public projection is stored and signed at publication (ADR-013); verify it by canonicalising this object with RFC 8785 (JCS), hashing it with SHA-256 and checking the Ed25519 signature.

links*
passport_id*string
status*PassportStatus

Status of a unit's passport (docs/domain-model.md §7).

Value in"draft""qr_locked""published""update_needed""suspended""withdrawn""deleted_recycled"
valid_until?string

Set when this version was replaced by a later one (history by date).

Formatdate-time
verification?
Example Request
curl -X GET 'https://example.com/api/v1/public/dpps/by-product-id/stringstri'
Example Response
{  "document": {    "category": {      "key": "string",      "label": {        "de": "string",        "en": "string"      }    },    "economic_operator": {      "address": {        "city": "string",        "confirmed_source": "manual",        "country": "string",        "extra_line": "string",        "place_id": "string",        "postal_code": "string",        "region": "string",        "street": "string"      },      "contact_person": "string",      "name": "string",      "spare_parts_contact": "string",      "support_email": "user@example.com",      "website": "string"    },    "gs1_digital_link": "string",    "gtin": "string",    "model_name": "string",    "passport_id": "string",    "predecessor_passport_id": "string",    "restricted_fields_present": [      "string"    ],    "sections": [      {        "fields": [          {            "documents": [              {                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",                "kind": "declaration_of_conformity",                "mime": "string",                "sha256": "string",                "size_bytes": 0,                "title": "string",                "url": "string"              }            ],            "key": "string",            "label": {              "de": "string",              "en": "string"            },            "legal": {              "property1": "string",              "property2": "string"            },            "level": "model",            "schema": {              "enum": [                null              ],              "enum_labels": [                {                  "de": "string",                  "en": "string"                }              ],              "items": {},              "label": {                "de": "string",                "en": "string"              },              "max": 0,              "max_bytes": 0,              "max_items": 0,              "max_length": 0,              "mime": [                "string"              ],              "min": 0,              "pattern": "string",              "properties": [                {                  "name": "string",                  "schema": {}                }              ],              "type": "string",              "unit": "string"            },            "status": "provided",            "tier": "public",            "trigger": {              "de": "string",              "en": "string"            },            "unit": "string",            "value": null          }        ],        "key": "string",        "label": {          "de": "string",          "en": "string"        }      }    ],    "serial_number": "string",    "tier": "public",    "version": {      "no": 1,      "published_at": "2019-08-24T14:15:22Z",      "registry_version": "string"    }  },  "links": {    "gs1_digital_link": "string",    "json": "string",    "keys": "string",    "page": "string",    "predecessor": "string",    "restricted": "string",    "successors": [      "string"    ]  },  "passport_id": "string",  "status": "draft",  "valid_until": "2019-08-24T14:15:22Z",  "verification": {    "algorithm": "Ed25519",    "canonicalization": "RFC8785",    "hash": "string",    "key_id": "string",    "keys_url": "string",    "signature": "string",    "signed_at": "2019-08-24T14:15:22Z"  }}