Dokumentation

API-Referenz

POST/api/v1/license-plate-checks

Kennzeichen prüfen

Die Antwort enthält den Checkstatus und die Verfügbarkeit der Kombination. Mit Testschlüssel wird kein Behördenportal aufgerufen. Erforderlich ist license_plates:write.

Beschreibung

Prüft eine konkrete oder wildcard-basierte Kennzeichenkombination im zuständigen Behördenkontext.

Parameter

Idempotency-KeyheaderPflicht

Eindeutiger Schlüssel für diesen Check.

Beispiel: plate-check-hb-ab-123-v1

Request-Body

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

Request-Felder

FeldTypAngabeBeschreibung
postal_codestringPflichtFünfstellige deutsche Postleitzahl.
location_idintegerOptionalOrts-ID aus der Zulassungsstellenabfrage.
citystringOptionalOrt als Alternative zu location_id.
plate.districtstringPflichtUnterscheidungszeichen mit ein bis drei Buchstaben.
plate.lettersstringPflichtBuchstabenteil; im Wildcard-Modus sind ? und * zulässig.
plate.numberstringPflichtZiffernteil; im Wildcard-Modus sind ? und * zulässig.
vehicle_typeenumOptionalcar, motorcycle oder trailer; Standard car.
markerenumOptionalnone, electric oder historic; Standard none.
season.enabledbooleanOptionalAktiviert ein Saisonkennzeichen.
season.start_month, season.end_monthintegerBedingtBei aktiviertem Saisonkennzeichen: Beginn und Ende zwischen 1 und 12.
search_modeenumOptionalexact oder wildcard; Standard exact.
test_scenarioenumOptionalNur im Testmodus: available, unavailable oder indeterminate.
Request-Beispieljson
{
  "postal_code": "28195",
  "city": "Bremen",
  "plate": {
    "district": "HB",
    "letters": "AB",
    "number": "123"
  },
  "vehicle_type": "car",
  "marker": "none",
  "season": {
    "enabled": false
  },
  "search_mode": "exact"
}

Responses

200

Check abgeschlossen; availability enthält das Ergebnis.

422

Kombination, Bezirk oder Fahrzeugkonfiguration ist unzulässig.

503

Der API-Dienst ist vorübergehend nicht verfügbar. Ein nicht belastbarer Portalcheck wird dagegen als 200 mit availability: indeterminate zurückgegeben.

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

Verfügbarkeit auswerten

Bezirk prüfen

license_plate_wrong_district bedeutet, dass die Kombination nicht zur gewählten Zulassungsstelle passt. Bezirk oder Zulassungsstelle müssen korrigiert werden.

Wildcard-Suche liefert reservierbare Kandidaten

Mit search_mode: wildcard dürfen plate.letters und plate.number die Zeichen ? und * enthalten. Der Sammelcheck selbst ist nicht reservierbar. Wählen Sie einen Eintrag aus candidates und verwenden Sie dessen id anschließend als check_id der Reservierung.

Deterministische Testszenarien

Nur mit einem dz_test_…-Schlüssel dürfen Sie optional test_scenario als available, unavailable oder indeterminate senden. Ohne Angabe verwendet der Testmodus available. Produktive Requests dürfen dieses Feld nicht enthalten.

Zum Öffnen eines Treffers Enter drücken.