REST-API · POST /check · kostenpflichtig
Anfrage
So rufen Sie die Route auf
Adresse: POST https://einvoicetools.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://einvoicetools.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.