Skip to main content
GET
Lookup Peppol ID

Query Parameters

peppol_id
string
required

Peppol ID in the format <scheme>:<id>. Example: 0208:1018265814 for a Belgian company.

Response

Successful Response

Response from a Peppol ID lookup operation.

This model represents the complete result of validating and looking up a Peppol ID in the Peppol network, including DNS information, service metadata, business card details, and certificate information.

Example: A successful lookup for a Peppol ID "0192:991825827" would return DNS information, service metadata with supported document types and processes, business card information with organization details, and certificate data.

queryMetadata
QueryMetadata · object
required

Metadata about the query that was performed

status
string
required

Overall status of the lookup: 'success' or 'error'

Example:

"success"

errors
string[]
required

List of error messages if any errors occurred during the lookup

Example:
dnsInfo
DnsInfo · object
required

Information about the DNS lookup performed

serviceMetadata
ServiceMetadata · object
required

Service metadata information for the Peppol participant

businessCard
BusinessCard · object
required

Business card information for the Peppol participant

certificates
Certificate · object[]
required

List of certificates found for the Peppol participant

executionTimeMs
number
required

Total execution time of the lookup operation in milliseconds

Example:

895.32