Sign in

v24

latestOpenAPI 3.1.0raw.githubusercontent.com2025-12-1152106250.5 KB
Lookup

Lookup Peppol ID

Lookup Peppol ID. The peppol_id must be in the form of <scheme>:<id>. The scheme is a 4-digit code representing the identifier scheme, and the id is the actual identifier value. For example, for a Belgian company it is 0208:0123456789 (where 0208 is the scheme for Belgian enterprises, followed by the 10 digits of the official BTW / KBO number).

get/api/lookup

Query parameters

peppol_idstring required

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

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

Response

Successful Response

statusstring required

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

errorsstring[] required

List of error messages if any errors occurred during the lookup

executionTimeMsnumber required

Total execution time of the lookup operation in milliseconds

Example response

{
  "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",
                  "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",
      "error": "Certificate expired"
    }
  ],
  "executionTimeMs": 895.32
}