Dokumentation

API-Referenz

GET/api/v1/license-plate-checks/{check_id}

Kennzeichencheck abrufen

Verwenden Sie diesen Endpunkt, um einen gespeicherten Check vor dem Anlegen einer Reservierung erneut zu lesen. Erforderlich ist license_plates:read.

Beschreibung

Liefert Status und Ergebnis eines Kennzeichenchecks.

Parameter

check_idpathPflicht

Öffentliche Check-ID.

Beispiel: lpc_test_3c4d5e6f708192a3b4c5d6e7

Responses

200

Aktueller Check.

404

Check fehlt oder gehört zu einem anderen Mandanten beziehungsweise einer anderen Umgebung.

Response-Body

Content-Type: application/json. Die erfolgreiche Antwort enthält die nachfolgend beschriebenen Felder.

Response-Felder

FeldTypAngabeBeschreibung
idstringImmerÖffentliche Check-ID.
objectstringImmerKonstanter Wert license_plate_check.
environmentenumImmertest oder live.
livemodebooleanImmertrue für Live-Ressourcen.
statusstringImmerAktuell completed.
availabilityenumImmeravailable, unavailable oder indeterminate.
plateobjectImmerNormalisierte Kennzeichenkombination mit Markierung, Fahrzeugtyp und Saison.
reservablebooleanImmerGibt an, ob genau dieser Check reserviert werden kann.
expires_atdate-timeImmerEnde des Gültigkeitsfensters.
messagestringOptionalLesbare Ergebnismeldung.
reasonstringOptionalMaschinenlesbarer Grund für das Ergebnis.
duration_msintegerOptionalDauer des Checks in Millisekunden.
officeobjectOptionalVerwendeter Behördenkontext.
candidatesarrayOptionalEinzelne reservierbare Checks aus einer Wildcard-Suche.
created_at, updated_atdate-timeImmerErstellungs- und Änderungszeitpunkt.
200 Response-Beispieljson
{
  "id": "lpc_test_3c4d5e6f708192a3b4c5d6e7",
  "object": "license_plate_check",
  "environment": "test",
  "livemode": false,
  "status": "completed",
  "availability": "available",
  "plate": {
    "district": "HB",
    "letters": "AB",
    "number": "123",
    "formatted": "HB AB 123",
    "marker": "none",
    "vehicle_type": "car",
    "season": {
      "enabled": false,
      "start_month": null,
      "end_month": null
    }
  },
  "reservable": true,
  "expires_at": "2026-08-26T10:50:00+02:00",
  "message": "Das Wunschkennzeichen ist verfügbar.",
  "created_at": "2026-08-26T10:20:00+02:00",
  "updated_at": "2026-08-26T10:20:00+02:00"
}

Gültigkeitsfenster

Ein Check ist nur bis expires_at Grundlage für eine Reservierung. Danach ist die tatsächliche Verfügbarkeit erneut zu prüfen.

Zum Öffnen eines Treffers Enter drücken.