POST /check – Kennung beim Register prüfen

REST-API · POST /check · kostenpflichtig

Kennung prüfen: direkt beim zuständigen Register.

Diese Route prüft eine Kennung bei ihrem öffentlichen Register und sagt Ihnen, ob es sie gibt und was das Register dazu bestätigt. Das ist nützlich, bevor Sie einen Lieferanten anlegen, eine Rechnung freigeben oder eine Rechnung an einen neuen Kunden schicken.

Geprüft werden acht Arten von Kennungen: USt-IdNr. über VIES, das Abfragesystem der EU; SIREN und SIRET über das Register SIRENE des INSEE; LEI über die GLEIF; ABN über das Australian Business Register; NIP über die polnische Weiße Liste; Peppol-IDs über das Peppol Directory; EORI-Nummern über den EORI-Dienst der Europäischen Kommission. An das Register geht nur die Kennung selbst.


Anfrage

So rufen Sie die Route auf

Adresse: POST https://invoicepress.de/wp-json/einvoice-api/v1/check

Schlüssel: Senden Sie Ihren API-Schlüssel in der Kopfzeile Authorization: Bearer <Schlüssel>. Ohne gültigen Schlüssel antwortet die Route mit dem Status 401.

Inhalt: Der Inhalt der Anfrage ist JSON mit scheme (die Art der Kennung: vat, siren, siret, lei, abn, nip, peppol oder eori), value (die Kennung) und wahlweise context für Zusatzangaben, die eine Art braucht.


Antwort

Was zurückkommt

status – valid, invalid oder unknown, wenn das Register gerade keine Auskunft gibt.

source – Welches Register geantwortet hat, etwa vies, insee oder gleif.

evidence – Die Angaben, die das Register bestätigt, etwa Name und Anschrift. Was darin steht, hängt vom Register ab.

checkedAt, cached, ttl – Zeitpunkt der Prüfung und ob die Antwort aus dem Zwischenspeicher kommt. Antworten des INSEE bleiben 35 Tage im Zwischenspeicher, die der übrigen Register einen Tag.

reason – Der Grund, wenn das Ergebnis nicht valid ist.

Wenn etwas nicht geht

Status 400 – Die Art der Kennung oder die Kennung fehlt, oder die Art wird nicht unterstützt.

Status 401 – Der Schlüssel fehlt, ist unbekannt oder gesperrt.

Status 429 – Das Kontingent ist verbraucht. Die Kopfzeile Retry-After sagt, wann es wieder geht.


Beispiel

Ein Aufruf mit curl

curl -X POST "https://invoicepress.de/wp-json/einvoice-api/v1/check" \
     -H "Authorization: Bearer <Schlüssel>" \
     -H "Content-Type: application/json" \
     -d '{"scheme":"vat","value":"DE136695976"}'

Kosten

Kontingent und Tarif

Die Route ist kostenpflichtig. Jede geprüfte Kennung zählt als eine Kennungsprüfung gegen das Monatskontingent Ihres Tarifs. Zum Ausprobieren gibt es den kostenlosen Tarif „Frei“ mit eigenem Schlüssel; er reicht für etwa zwei Kennungsprüfungen am Tag. Antworten mit einem Fehlerstatus zählen nicht.