---
title: "Render the passport's QR code."
method: GET
path: "/api/v1/passports/{id}/qr"
tags: ["Passports"]
---
# Render the passport's QR code.
`GET /api/v1/passports/{id}/qr`
## Request
- Base URL: `https://app.tracepass.eu`
- URL: `https://app.tracepass.eu/api/v1/passports/{id}/qr`
- Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL `https://app.tracepass.eu/api/oauth/authorize`, token URL `https://app.tracepass.eu/api/oauth/token`, scopes: `passports:read`)
Returns the QR code for a passport. Default response is a
raw SVG image so `` works directly. Use
`?format=png` for a raster PNG, or `?format=json` for an
envelope containing both the SVG markup and a base64
PNG data URI plus the encoded URL + status.
Counts as one v1 passport-read against the daily budget
(same counter as the data endpoint).
## Query parameters
- `format` 'svg' | 'png' | 'json'
- `symbology` 'qr' | 'datamatrix'
- `useCompanyBranding` 'true'
- `color` string
- `backgroundColor` string
## Response `200`
QR rendering.
- QrJsonEnvelope: `format=json` response from the QR endpoints. Carries the SVG markup, a base64-encoded PNG data URI, and the encoded URL + passport status — useful for clients that want both renderings in one round-trip plus the metadata the QR encodes. `publicUrl` is the URL the QR encodes. For GS1 passports this is the Digital Link URI (`id.tracepass.eu/01//21/`). For iec61406, did, and doi passports it is the `/x//` resolver form (`id.tracepass.eu/x/did/`). All five schemes resolve to the same public viewer.
- `passportId` string, required: MongoDB ObjectId hex string (24 chars).
- `gtin` string: GS1 GTIN with a valid check digit. Accepts 8 digits (GTIN-8), 12 digits (GTIN-12/UPC-A), 13 digits (GTIN-13/EAN-13), or 14 digits (GTIN-14). All forms are left-padded to 14 digits before storage; stored and returned values are always 14 digits.
- `serial` string
- `identifier` string: For non-GS1 passports: the `identifierKey` string, e.g. `did:did:example:123abc`. Present when `gtin`/`serial` are absent.
- `publicUrl` string, uri, required
- `symbology` 'qr' | 'datamatrix': The symbology rendered. `qrSvg` and `qrPngDataUri` keep their names for compatibility and hold the Data Matrix image when this is `datamatrix`.
- `status` 'draft' | 'in_review' | 'approved' | 'published' | 'suspended' | 'expired' | 'archived', required
- `qrSvg` string, required: Inline `