Skip to content
Passports

The QR code of the unit's GS1 Digital Link

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

Any member. Rendered on demand from gs1_digital_link (error correction M, quiet zone of four modules). Only once the identifiers are locked (409 conflict before).

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

Query Parameters

format?string
Default"png"
Value in"png""svg"
size?integer

Width and height of the PNG in pixels (ignored for SVG, which scales).

Range128 <= value <= 2048
Default512

Response Body

The image.

response?unknown
Example Request
curl -X GET 'https://example.com/api/v1/batteries/497f6eca-6276-4993-bfeb-53cbbbba6f08/passport/qr'
Example Response
null