Passports

Update one field on a passport (by serial).

Same body, same response, and same semantics as PATCH /api/v1/passports/{id}/fields/{key}.

patch/api/v1/passports/by-serial/{serial}/fields/{key}

Request

  • Base URL: https://app.tracepass.eu
  • URL: https://app.tracepass.eu/api/v1/passports/by-serial/{serial}/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.