Lookup Peppol ID

curl --request GET \
  --url https://api.e-invoice.be/api/lookup

{
  "queryMetadata": {
    "identifierScheme": "iso6523-actorid-upis",
    "identifierValue": "0192:991825827",
    "smlDomain": "edelivery.tech.ec.europa.eu",
    "timestamp": "2023-04-12T14:32:10.123456",
    "version": "1.0.0"
  },
  "status": "success",
  "errors": [
    "DNS lookup failed",
    "Business card not available"
  ],
  "dnsInfo": {
    "status": "success",
    "smlHostname": "edelivery.tech.ec.europa.eu",
    "dnsRecords": [
      {
        "ip": "193.140.151.175"
      }
    ],
    "error": "DNS lookup failed: no such domain"
  },
  "serviceMetadata": {
    "status": "success",
    "queryTimeMs": 245.67,
    "endpoints": [
      {
        "status": "success",
        "url": "https://ap.e-invoice.be/as4",
        "documentTypes": [
          {
            "scheme": "busdox-docid-qns",
            "value": "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1"
          }
        ],
        "processes": [
          {
            "processId": {
              "scheme": "cenbii-procid-ubl",
              "value": "urn:fdc:peppol.eu:2017:poacc:billing:01:1.0"
            },
            "endpoints": [
              {
                "transportProfile": "peppol-transport-as4-v2_0",
                "address": "https://ap.e-invoice.be/as4",
                "serviceActivationDate": "2022-01-01T00:00:00Z",
                "serviceExpirationDate": "2025-01-01T00:00:00Z",
                "serviceDescription": "Company XYZ's AP service",
                "technicalContactUrl": "https://support.e-invoice.be",
                "technicalInformationUrl": "https://api.e-invoice.be",
                "certificate": {
                  "status": "success",
                  "details": {},
                  "error": "Certificate expired"
                }
              }
            ]
          }
        ],
        "error": "Connection timeout"
      }
    ],
    "error": "Service unavailable"
  },
  "businessCard": {
    "status": "success",
    "entities": [
      {
        "name": "Example Corporation Ltd",
        "countryCode": "NO",
        "registrationDate": "2021-06-15T00:00:00Z",
        "additionalInformation": [
          "VAT: BE1018265814",
          "Organization number: 1018.265.814"
        ]
      }
    ],
    "queryTimeMs": 123.45,
    "error": "Business card not found"
  },
  "certificates": [
    {
      "status": "success",
      "details": {},
      "error": "Certificate expired"
    }
  ],
  "executionTimeMs": 895.32
}

GET

api

lookup

Lookup Peppol ID

curl --request GET \
  --url https://api.e-invoice.be/api/lookup

{
  "queryMetadata": {
    "identifierScheme": "iso6523-actorid-upis",
    "identifierValue": "0192:991825827",
    "smlDomain": "edelivery.tech.ec.europa.eu",
    "timestamp": "2023-04-12T14:32:10.123456",
    "version": "1.0.0"
  },
  "status": "success",
  "errors": [
    "DNS lookup failed",
    "Business card not available"
  ],
  "dnsInfo": {
    "status": "success",
    "smlHostname": "edelivery.tech.ec.europa.eu",
    "dnsRecords": [
      {
        "ip": "193.140.151.175"
      }
    ],
    "error": "DNS lookup failed: no such domain"
  },
  "serviceMetadata": {
    "status": "success",
    "queryTimeMs": 245.67,
    "endpoints": [
      {
        "status": "success",
        "url": "https://ap.e-invoice.be/as4",
        "documentTypes": [
          {
            "scheme": "busdox-docid-qns",
            "value": "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1"
          }
        ],
        "processes": [
          {
            "processId": {
              "scheme": "cenbii-procid-ubl",
              "value": "urn:fdc:peppol.eu:2017:poacc:billing:01:1.0"
            },
            "endpoints": [
              {
                "transportProfile": "peppol-transport-as4-v2_0",
                "address": "https://ap.e-invoice.be/as4",
                "serviceActivationDate": "2022-01-01T00:00:00Z",
                "serviceExpirationDate": "2025-01-01T00:00:00Z",
                "serviceDescription": "Company XYZ's AP service",
                "technicalContactUrl": "https://support.e-invoice.be",
                "technicalInformationUrl": "https://api.e-invoice.be",
                "certificate": {
                  "status": "success",
                  "details": {},
                  "error": "Certificate expired"
                }
              }
            ]
          }
        ],
        "error": "Connection timeout"
      }
    ],
    "error": "Service unavailable"
  },
  "businessCard": {
    "status": "success",
    "entities": [
      {
        "name": "Example Corporation Ltd",
        "countryCode": "NO",
        "registrationDate": "2021-06-15T00:00:00Z",
        "additionalInformation": [
          "VAT: BE1018265814",
          "Organization number: 1018.265.814"
        ]
      }
    ],
    "queryTimeMs": 123.45,
    "error": "Business card not found"
  },
  "certificates": [
    {
      "status": "success",
      "details": {},
      "error": "Certificate expired"
    }
  ],
  "executionTimeMs": 895.32
}

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

Show child attributes

queryMetadata.identifierScheme

string

required

Scheme of the identifier, typically 'iso6523-actorid-upis'

Example:

"iso6523-actorid-upis"

queryMetadata.identifierValue

string

required

The actual Peppol ID value being queried

Example:

"0192:991825827"

queryMetadata.smlDomain

string

required

Domain of the SML (Service Metadata Locator) used for the lookup

Example:

"edelivery.tech.ec.europa.eu"

queryMetadata.timestamp

string

required

ISO 8601 timestamp of when the query was executed

Example:

"2023-04-12T14:32:10.123456"

queryMetadata.version

string

required

Version of the API used for the lookup

Example:

"1.0.0"

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:

[
  "DNS lookup failed",
  "Business card not available"
]

dnsInfo

DnsInfo · object

required

Information about the DNS lookup performed

Show child attributes

dnsInfo.status

string

required

Status of the DNS lookup: 'success', 'error', or 'pending'

Example:

"success"

dnsInfo.smlHostname

string

required

Hostname of the SML used for the query

Example:

"edelivery.tech.ec.europa.eu"

dnsInfo.dnsRecords

DnsRecord · object[]

required

List of DNS records found for the Peppol participant

Show child attributes

dnsInfo.dnsRecords.ip

string

required

IP address found in the DNS record

Example:

"193.140.151.175"

dnsInfo.error

string | null

Error message if the DNS lookup failed

Example:

"DNS lookup failed: no such domain"

serviceMetadata

ServiceMetadata · object

required

Service metadata information for the Peppol participant

Show child attributes

serviceMetadata.status

string

required

Status of the service metadata lookup: 'success', 'error', or 'pending'

Example:

"success"

serviceMetadata.queryTimeMs

number

required

Time taken to query the service metadata in milliseconds

Example:

245.67

serviceMetadata.endpoints

Endpoint · object[]

required

List of endpoints found for the Peppol participant

Show child attributes

serviceMetadata.endpoints.status

string

required

Status of the endpoint lookup: 'success', 'error', or 'pending'

Example:

"success"

serviceMetadata.endpoints.url

string

required

URL of the endpoint

Example:

"https://ap.e-invoice.be/as4"

serviceMetadata.endpoints.documentTypes

SupportedDocumentType · object[]

required

List of document types supported by this endpoint

Show child attributes

serviceMetadata.endpoints.documentTypes.scheme

string

required

Scheme of the document type identifier

Example:

"busdox-docid-qns"

serviceMetadata.endpoints.documentTypes.value

string

required

Value of the document type identifier

Example:

"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1"

serviceMetadata.endpoints.processes

Process · object[] | null

List of processes supported by this endpoint

Show child attributes

serviceMetadata.endpoints.processes.processId

ProcessIdentifier · object

required

Identifier of the process

Show child attributes

serviceMetadata.endpoints.processes.processId.scheme

string

required

Scheme of the process identifier

Example:

"cenbii-procid-ubl"

serviceMetadata.endpoints.processes.processId.value

string

required

Value of the process identifier

Example:

"urn:fdc:peppol.eu:2017:poacc:billing:01:1.0"

serviceMetadata.endpoints.processes.endpoints

ProcessEndpoint · object[]

required

List of endpoints supporting this process

Show child attributes

serviceMetadata.endpoints.processes.endpoints.transportProfile

string

required

Transport profile used by this endpoint

Example:

"peppol-transport-as4-v2_0"

serviceMetadata.endpoints.processes.endpoints.address

string

required

URL or address of the endpoint

Example:

"https://ap.e-invoice.be/as4"

serviceMetadata.endpoints.processes.endpoints.serviceActivationDate

string | null

ISO 8601 date when the service was activated

Example:

"2022-01-01T00:00:00Z"

serviceMetadata.endpoints.processes.endpoints.serviceExpirationDate

string | null

ISO 8601 date when the service will expire

Example:

"2025-01-01T00:00:00Z"

serviceMetadata.endpoints.processes.endpoints.serviceDescription

string | null

Human-readable description of the service

Example:

"Company XYZ's AP service"

serviceMetadata.endpoints.processes.endpoints.technicalContactUrl

string | null

URL for technical contact information

Example:

"https://support.e-invoice.be"

serviceMetadata.endpoints.processes.endpoints.technicalInformationUrl

string | null

URL for technical documentation

Example:

"https://api.e-invoice.be"

serviceMetadata.endpoints.processes.endpoints.certificate

Certificate · object

Certificate information for this endpoint

Show child attributes

serviceMetadata.endpoints.processes.endpoints.certificate.status

string

required

Status of the certificate validation: 'success', 'error', or 'pending'

Example:

"success"

serviceMetadata.endpoints.processes.endpoints.certificate.details

Details · object

Details about the certificate including subject, issuer, validity dates, etc.

serviceMetadata.endpoints.processes.endpoints.certificate.error

string | null

Error message if certificate validation failed

Example:

"Certificate expired"

serviceMetadata.endpoints.error

string | null

Error message if endpoint lookup failed

Example:

"Connection timeout"

serviceMetadata.error

string | null

Error message if service metadata lookup failed

Example:

"Service unavailable"

businessCard

BusinessCard · object

required

Business card information for the Peppol participant

Show child attributes

businessCard.status

string

required

Status of the business card lookup: 'success', 'error', or 'pending'

Example:

"success"

businessCard.entities

BusinessEntity · object[]

required

List of business entities associated with the Peppol ID

Show child attributes

businessCard.entities.name

string | null

Name of the business entity

Example:

"Example Corporation Ltd"

businessCard.entities.countryCode

string | null

ISO 3166-1 alpha-2 country code of the business entity

Example:

"NO"

businessCard.entities.registrationDate

string | null

ISO 8601 date of when the entity was registered in Peppol

Example:

"2021-06-15T00:00:00Z"

businessCard.entities.additionalInformation

string[] | null

Additional information about the business entity

Example:

[
  "VAT: BE1018265814",
  "Organization number: 1018.265.814"
]

businessCard.queryTimeMs

number

required

Time taken to query the business card in milliseconds

Example:

123.45

businessCard.error

string | null

Error message if business card lookup failed

Example:

"Business card not found"

certificates

Certificate · object[]

required

List of certificates found for the Peppol participant

Show child attributes

certificates.status

string

required

Status of the certificate validation: 'success', 'error', or 'pending'

Example:

"success"

certificates.details

Details · object

Details about the certificate including subject, issuer, validity dates, etc.

certificates.error

string | null

Error message if certificate validation failed

Example:

"Certificate expired"

executionTimeMs

number

required

Total execution time of the lookup operation in milliseconds

Example:

895.32

Validate Peppol ID Lookup Peppol participants

⌘I

Overview

Schemas

Documents

Inbox

Outbox

Validate

Lookup

Tenant

Webhooks

Conversion

Lookup Peppol ID

Query Parameters

Response