Passports

Read the condition-classification flags for a passport.

Returns the resolved condition profile for a passport — Record<flagKey, { value, status, source }>. Condition flags are reviewer-approved yes/no facts (e.g. hasBMS, rechargeable, externalStorageOnly, isStationaryBess for batteries) that gate conditional legal duties: an approved flag whose gate applies makes the gated field required, and an empty such field is a hard publish block (conditional_missing). Absent or pending_review flags never block publishing.

Valid flag keys are category-specific (battery: hasBMS, rechargeable, externalStorageOnly, isStationaryBess). Categories with no flags in the registry return an empty profile.

The audit array is stripped from the v1 response; use the dashboard to inspect per-flag history.

Read-only. Counts as one v1 passport read against the daily cap.

get/api/v1/passports/{id}/condition-flags

Request

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

Response

Condition profile.

passportIdstring required

MongoDB ObjectId hex string (24 chars).

conditionProfileConditionProfile required

A map of flagKey → ConditionFlag representing the resolved condition profile for a passport. Valid flag keys are category-specific: battery supports hasBMS, rechargeable, externalStorageOnly, and isStationaryBess. Categories with no flags return an empty object. The audit array is stripped from v1 responses.

Example response

{
  "passportId": "6650a1b2c3d4e5f6a7b8c9d0",
  "conditionProfile": {
    "hasBMS": {
      "value": true,
      "status": "approved",
      "source": "api:tp_abc123"
    },
    "rechargeable": {
      "value": true,
      "status": "approved",
      "source": "api:tp_abc123"
    }
  }
}

Changes

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