---
title: Suspend a passport
description: Reversibly suspend a passport — public viewer returns HTTP 423 with structured body. Use for recalls, disputes, holds, product-quality investigations.
canonical: "https://www.tracepass.eu/docs/suspend-passport"
locale: en
source: "https://www.tracepass.eu/docs/suspend-passport"
---

# Suspend a passport

> Reversibly suspend a passport — public viewer returns HTTP 423 with structured body. Use for recalls, disputes, holds, product-quality investigations.

```http
POST /api/v1/passports/{id}/suspend
```

Reversible suspend. The public viewer flips to the suspended state page (HTTP 423 with structured body); QR scans effectively die without the URL going to 404. Use for recalls, disputes, internal holds, or product-quality investigations. Republish from the dashboard once resolved.

Optional body `{ reason: string }` — surfaces in the `passport.suspended` webhook payload and the dashboard audit trail (truncated at 500 chars). Empty body is fine; the suspend still fires the webhook. Counts as one v1 write. Honours `Idempotency-Key`. The matching `POST /api/v1/passports/by-serial/{serial}/suspend` is the by-serial alternate.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Authorization` | header | string | yes | `Bearer <token>` — either a `tp_` API key (Developer → API Keys; simplest, for server-to-server) or an OAuth 2.0 access token (Developer → OAuth Apps; for user-authorized apps, scoped + revocable). The Authentication page has the full OAuth flow and scope list. |
| `Idempotency-Key` | header | string | no | UUID v4. |
| `id` | path | ObjectId | yes | Passport ID. |
| `reason` | body | string (≤ 500) | no | Free-text suspension reason. |

## Examples

```bash
curl -sS -X POST \
  https://app.tracepass.eu/api/v1/passports/6650b2c3d4e5f6a7b8c9d0e1/suspend \
  -H "Authorization: Bearer tp_REDACTED_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "reason": "Quality investigation pending — batch BB-2026-04-12." }'
```

```typescript
await fetch(
  `https://app.tracepass.eu/api/v1/passports/${id}/suspend`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.TRACEPASS_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ reason: "Quality investigation pending" }),
  },
);
```

```python
import os, requests
res = requests.post(
    f"https://app.tracepass.eu/api/v1/passports/{passport_id}/suspend",
    headers={"Authorization": f"Bearer {os.environ['TRACEPASS_API_KEY']}"},
    json={"reason": "Quality investigation pending"},
)
res.raise_for_status()
```

## Responses

### 200 — Suspended

```json
{
  "_id": "6650b2c3d4e5f6a7b8c9d0e1",
  "status": "suspended",
  "suspendedAt": "2026-05-09T16:00:00.000Z",
  "suspensionReason": "Quality investigation pending — batch BB-2026-04-12."
}
```

### 422 — Wrong status

```json
{ "error": "Cannot suspend passport in status 'archived'" }
```

### 404 — Not found

```json
{ "error": "Passport not found" }
```

## Related

- [Archive a passport (irreversible)](https://www.tracepass.eu/docs/archive-passport.md)
- [Get passport](https://www.tracepass.eu/docs/get-passport.md)