Passports

Read condition-classification flags (by serial).

Same contract as GET /api/v1/passports/{id}/condition-flags, addressed by your own serial number instead of our internal id. Pass ?gtin=<gtin> if a serial is not unique within your account (same disambiguation rule as all other by-serial routes; 409 ambiguous_serial without it).

get/api/v1/passports/by-serial/{serial}/condition-flags

Request

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