TracePass
Започнете
Паспорти

Спиране на паспорт

Реверсибилно спиране. Публичният преглед се превключва на страницата за suspended състояние (HTTP 423 със структурирано тяло); QR сканиранията ефективно умират, без URL-ът да става 404. Използвайте за изтегляния, спорове, вътрешни holds или разследвания за качество. Republish от таблото след разрешаване.

POST/api/v1/passports/{id}/suspend
Изтегли OpenAPI 3.1
POST/api/v1/passports/{id}/suspend

Спиране на паспорт

Реверсибилно спиране. Публичният преглед се превключва на страницата за suspended състояние (HTTP 423 със структурирано тяло); QR сканиранията ефективно умират, без URL-ът да става 404. Използвайте за изтегляния, спорове, вътрешни holds или разследвания за качество. Republish от таблото след разрешаване.

Незадължително тяло { reason: string } — показва се в payload на passport.suspended webhook и одитната следа на таблото (труниран на 500 знака). Празно тяло е OK; suspend все още изпраща webhook. Брои се като едно v1 записване. Поддържа Idempotency-Key. Съответстващият POST /api/v1/passports/by-serial/{serial}/suspend е by-serial алтернатива.

Отказва се след пускане на пазара. Паспорт, регистриран като пуснат на пазара или с текуща регистрация, връща 409 passport_placed_on_market: той трябва да остане публичен, затова коригирайте данните му.

Параметри в пътя

  • idзадължително

    string (24 hex chars)

    ID на паспорта.

Хедъри

  • Authorizationзадължително

    string

    Bearer <token> — или tp_ API ключ (Developer → API Keys; най-просто, за server-to-server), или OAuth 2.0 access token (Developer → OAuth Apps; за приложения, авторизирани от потребител, scoped и отзоваеми). Страницата Authentication съдържа пълния OAuth поток и списъка със scopes.

    e.g. Bearer tp_REDACTED_xxxxxxxxxxxx

  • Idempotency-Key

    string

    UUID v4.

Полета в тялото

  • reason

    string (≤ 500)

    Свободен текст с причина.

    e.g. Quality investigation pending — batch BB-2026-04-12.

Заявка

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." }'

Отговор

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

Свързани endpoints