v1

latestOpenAPI 3.0.0Apache 2.02026-07-267057121.5 KB

Look up a Peppol participant

Checks whether a company is registered and reachable in the Peppol network. Exactly one of peppol_id or vat must be provided.

When vat is used, the service derives the Peppol participant identifier using the country-specific scheme rules (e.g. 9920: for Spain, 0208: for Belgium). If no scheme can be determined for the given country the request will fail with 400 Bad Request.

A 200 response with found: false means the participant ID was resolved but is not yet registered in the network — this is not an error condition.

get/apps/peppol/v1/lookup

Query parameters

peppol_idstring
Example:0002:123456789

Full Peppol participant identifier in scheme:value format, e.g. 0002:123456789. Mutually exclusive with vat.

vatstring
Example:FR123456789

VAT number prefixed with the ISO 3166-1 alpha-2 country code, e.g. FR123456789 or DE123456789. Mutually exclusive with peppol_id.

Response

Lookup completed — check found to determine network presence.

peppol_idstring required

Resolved Peppol participant identifier in scheme:value format. Populated even when found is false.

foundboolean required

Whether the participant is currently registered in the Peppol network.

Example response

{
  "peppol_id": "0002:123456789",
  "found": true
}