Passports

Update one field on a passport.

Patch a single field on a passport. The value is validated against the field key (must exist on the passport's template) and persisted with an audit-trail entry naming the credential (via API key <prefix> or via OAuth app <client>) and, when the X-Source header is set, the calling client (e.g. (mcp)). The channel is recorded only; it never changes the status.

Status: an API key writes approved. An OAuth token writes with its user's dashboard rights, so a role below admin lands pending_review. A value sent with source: "ai_suggested" always lands pending_review, and is refused (400) on a field that only the economic operator may state or that must be measured (e.g. battery stateOfHealth). Send such a value with another source if your organisation is making that statement.

An alternate addressing form exists at PATCH /api/v1/passports/by-serial/{serial}/fields/{key} with the same body shape.

patch/api/v1/passports/{id}/fields/{key}

Request

  • Base URL: https://app.tracepass.eu
  • URL: https://app.tracepass.eu/api/v1/passports/{id}/fields/{key}
  • 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:write)

Request body

valueunknown required
source'manual' | 'ai_suggested' | 'reference_db' | 'supplier'

Tag the origin of the value. Default manual. ai_suggested lands in the review queue; the others write with the caller's own rights (see the operation). A response may still show ai_approved or system: TracePass sets those, and a request claiming them is refused (400).

sourceLocalestring

ISO 639-1 locale of the value. One of the 24 EU locales. Defaults to the passport's sourceLocale.

Response

Field updated.

versioninteger required

Example response

{
  "field": {
    "sourceProvider": "eprel",
    "sourceUrl": "https://eprel.ec.europa.eu/qr/450201"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.