Dokumentation

API-Referenz

POST/api/v1/license-plate-reservations

Kennzeichen reservieren

Die Reservierung bindet Check, Halter und gewählte Fahrzeugkonfiguration. Ein Testschlüssel simuliert den Ablauf ohne Behördenportal. Erforderlich ist license_plates:write.

Beschreibung

Startet eine Reservierung aus einem verfügbaren Check und einem gespeicherten Halter.

Parameter

Idempotency-KeyheaderPflicht

Eindeutiger Schlüssel für diese Reservierung.

Beispiel: reserve-hb-ab-123-customer-1842

Request-Body

Der Body wird als application/json übertragen. Verwenden Sie ausschließlich die dokumentierten Feldnamen.

Request-Felder

FeldTypAngabeBeschreibung
check_idstringPflichtID eines noch gültigen, verfügbaren und reservierbaren Kennzeichenchecks.
holder_idstringPflichtHalter-ID aus Ihrem Konto und derselben Umgebung.
Request-Beispieljson
{
  "check_id": "lpc_test_3c4d5e6f708192a3b4c5d6e7",
  "holder_id": "hld_test_1a2b3c4d5e6f708192a3b4c5"
}

Responses

202

Reservierungsauftrag angenommen; Status über die Ressourcen-ID verfolgen.

404

check_id oder holder_id ist unbekannt.

409

Die Kombination des Checks wird bereits von einem anderen Auftrag reserviert.

422

Check ist abgelaufen oder nicht reservierbar, oder Halterdaten und Nutzungsangaben passen nicht zusammen.

Response-Body

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

Response-Felder

FeldTypAngabeBeschreibung
idstringImmerÖffentliche Reservierungs-ID.
objectstringImmerKonstanter Wert license_plate_reservation.
environmentenumImmertest oder live.
livemodebooleanImmertrue für Live-Ressourcen.
statusenumImmerprocessing, reserved, used, failed oder expired.
holder_idstringImmerVerwendete Halter-ID.
holder_revisionintegerImmerIm Antrag gespeicherte Version der Halterdaten.
check_idstringImmerZugrunde liegender Kennzeichencheck.
plateobjectImmerReservierte Kennzeichenkombination.
pinstring|nullOptionalReservierungs-PIN nach erfolgreicher Reservierung.
valid_untildate-time|nullOptionalGültigkeitsende der Reservierung.
reserved_atdate-time|nullOptionalZeitpunkt der erfolgreichen Reservierung.
confirmation_availablebooleanImmerGibt an, ob die PDF-Bestätigung abgerufen werden kann.
resultobjectOptionalErgebnisdetails des Reservierungslaufs.
failureobjectOptionalFehlercode und Meldung bei einem Fehlschlag.
poll_after_secondsintegerOptionalEmpfohlenes Intervall bis zum nächsten Abruf.
acceptedbooleanOptionalNur in der direkten Antwort eines Schreibzugriffs.
created_at, updated_atdate-timeImmerErstellungs- und Änderungszeitpunkt.
202 Response-Beispieljson
{
  "id": "lpr_test_4d5e6f708192a3b4c5d6e7f8",
  "object": "license_plate_reservation",
  "environment": "test",
  "livemode": false,
  "status": "reserved",
  "holder_id": "hld_test_1a2b3c4d5e6f708192a3b4c5",
  "holder_revision": 1,
  "check_id": "lpc_test_3c4d5e6f708192a3b4c5d6e7",
  "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
    }
  },
  "pin": "TEST1234",
  "valid_until": "2026-09-09T23:59:59+02:00",
  "reserved_at": "2026-08-26T10:22:00+02:00",
  "confirmation_available": true,
  "result": {
    "message": "Das Wunschkennzeichen wurde im Testmodus reserviert.",
    "officially_confirmed": true
  },
  "created_at": "2026-08-26T10:22:00+02:00",
  "updated_at": "2026-08-26T10:22:00+02:00",
  "accepted": true
}

Reservierungsstatus

202 Accepted bestätigt die Annahme des Requests. Die Reservierung ist erst bei status: reserved mit PIN und Gültigkeitsdatum abgeschlossen.

Reservierung verifiziert den Halter nicht

Die Reservierung akzeptiert verifizierte wie unverifizierte Halter und speichert deren Datenstand zum Zeitpunkt der Reservierung; der Verifizierungsstatus ändert sich dadurch nicht. Ob der Halter für den späteren Antrag verifiziert sein muss, hängt davon ab, ob Sie mit Vollmacht auf Digital-Zulassen oder mit eigenem KBA-Großkundenzugang einreichen. Für AB gilt keine Verifizierungspflicht.

Testsimulation

Zum Öffnen eines Treffers Enter drücken.