GET /check/{register} – eine Route je Register

REST-API · GET /check/{register} · kostenpflichtig

Eine Route je Register: die Kennung einfach in der Adresse.

Für jede Art von Kennung gibt es eine eigene Route, die Sie mit einer einfachen GET-Anfrage aufrufen. Die Kennung steht als Parameter value in der Adresse. Das ist praktisch für Tabellenkalkulationen, kleine Skripte und Werkzeuge, die nur GET können.

Antwort, Kontingent und Protokoll sind dieselben wie bei POST /check.


Anfrage

So rufen Sie die Route auf

Adresse: GET https://invoicepress.de/wp-json/einvoice-api/v1/check/{register}

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: keiner; alle Angaben stehen in der Adresse.

Parameter

value – Die Kennung, die geprüft werden soll.

icd (nur bei /check/peppol) – Der ISO-6523-Code der Kennung, etwa 0208.

Die Routen

/check/vat – USt-IdNr. (EU), geprüft über VIES.

/check/siren – SIREN (Frankreich), geprüft über INSEE.

/check/siret – SIRET (Frankreich), geprüft über INSEE.

/check/lei – LEI, geprüft über GLEIF.

/check/abn – ABN (Australien), geprüft über Australian Business Register.

/check/nip – NIP (Polen), geprüft über Weiße Liste.

/check/peppol – Peppol-ID, geprüft über Peppol Directory. Braucht zusätzlich icd, den ISO-6523-Code der Kennung, etwa 0208.

/check/eori – EORI-Nummer, geprüft über EORI-Dienst der EU.


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 – Der Parameter value fehlt.

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

Status 429 – Das Kontingent ist verbraucht.


Beispiel

Ein Aufruf mit curl

curl -X GET "https://invoicepress.de/wp-json/einvoice-api/v1/check/lei?value=529900T8BM49AURSDO55" \
     -H "Authorization: Bearer <Schlüssel>"

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.