REST-API · GET /check/{register} · paid route
For every kind of identifier there is a route of its own that you call with a simple GET request. The identifier stands as the parameter value in the address. That is handy for spreadsheets, small scripts and tools that can only do GET.
Answer, quota and log are the same as with POST /check.
Request
Address: GET https://invoicepress.de/wp-json/einvoice-api/v1/check/{register}
Key: Send your API key in the header Authorization: Bearer <key>. Without a valid key the route answers with status 401.
Body: none; everything stands in the address.
value – The identifier to check.
icd (only for /check/peppol) – The ISO 6523 code of the identifier, e.g. 0208.
/check/vat – VAT number (EU), checked through VIES.
/check/siren – SIREN (France), checked through INSEE.
/check/siret – SIRET (France), checked through INSEE.
/check/lei – LEI, checked through GLEIF.
/check/abn – ABN (Australia), checked through Australian Business Register.
/check/nip – NIP (Poland), checked through White List.
/check/peppol – Peppol ID, checked through Peppol Directory. Also needs icd, the ISO 6523 code of the identifier, e.g. 0208.
/check/eori – EORI number, checked through EU EORI service.
Answer
status – valid, invalid, or unknown when the register gives no answer at the moment.
source – Which register answered, e.g. vies, insee or gleif.
evidence – The details the register confirms, such as name and address. What it contains depends on the register.
checkedAt, cached, ttl – Time of the check and whether the answer comes from the cache. Answers from INSEE stay in the cache for 35 days, those of the other registers for one day.
reason – The reason when the result is not valid.
Status 400 – The parameter value is missing.
Status 401 – The key is missing, unknown or blocked.
Status 429 – The quota is used up.
Example
curl -X GET "https://invoicepress.de/wp-json/einvoice-api/v1/check/lei?value=529900T8BM49AURSDO55" \
-H "Authorization: Bearer <key>"
Cost
This route is a paid route. Every identifier checked counts as one identifier check against the monthly quota of your plan. To try it, there is the free plan “Free” with a key of your own; it covers about two identifier checks a day. Answers with an error status are not counted.