Skip to content
BatteryPass Docs
Portal
Get startedGuidesRecipesIntegrationsAPI referenceChangelog
Passports

The passport's registration with the EU registry

Scope: readSee also:Authentication ·Errors ·Pagination ·Rate limits
GET
/batteries/{batteryId}/passport/registration

Any member. The EU digital product passport registry has no interface for economic operators yet (docs/regulatory-reference.md), so the registration is not_available and nothing is submitted. A passport is never shown as registered without the registry's confirmation.

Authorization

apiKey
headerAuthorizationBearer <token>

Organisation API key sent as Authorization: Bearer bp_live_… (ADR-017). Accepted only by the operations that list this scheme, with the scope in their x-api-key-scope.

Path Parameters

batteryId*string
Formatuuid

Response Body

The registration status.

application/json
  1. response
attempts?integer
available*boolean

Whether the platform can submit to the registry at all.

detail?string

Why the registration is not available or failed (English).

external_id?string
last_attempt_at?string
Formatdate-time
passport_version?integer

The version the latest submission concerns.

registry*"eu_dpp"
Value in"eu_dpp"
state*RegistrySubmissionState

not_available: the registry has no interface yet, nothing is submitted. The other states belong to a registry adapter that does not exist yet: not_submitted (available, nothing sent for this passport), pending (queued), submitted (sent, no answer), confirmed (the registry confirmed receipt), failed.

Value in"not_available""not_submitted""pending""submitted""confirmed""failed"
Example Request
curl -X GET 'https://example.com/api/v1/batteries/497f6eca-6276-4993-bfeb-53cbbbba6f08/passport/registration'
Example Response
{  "attempts": 0,  "available": true,  "detail": "string",  "external_id": "string",  "last_attempt_at": "2019-08-24T14:15:22Z",  "passport_version": 0,  "registry": "eu_dpp",  "state": "not_available"}

The passport of a unit GET

Any member. A unit whose identifiers are not locked and that was never published has a passport in status `draft` without `passport_id`.

The published versions of a unit's passport, newest first GET

Any member. With `at`, only versions published at or before that instant: the first item is the version that was valid then (history by date for the portal, with every tier).