---
title: "Lookup Peppol ID"
method: GET
path: "/api/lookup"
tags: ["Lookup"]
---

# Lookup Peppol ID

`GET /api/lookup`

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).

## Query parameters

- `peppol_id` string, required — Peppol ID in the format `<scheme>:<id>`. Example: `0208:1018265814` for a Belgian company.

## Response `200`

Successful Response

- PeppolIdLookupResponse — 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, required — Metadata about the Peppol ID lookup query.
    - `identifierScheme` string, required — Scheme of the identifier, typically 'iso6523-actorid-upis'
    - `identifierValue` string, required — The actual Peppol ID value being queried
    - `smlDomain` string, required — Domain of the SML (Service Metadata Locator) used for the lookup
    - `timestamp` string, required — ISO 8601 timestamp of when the query was executed
    - `version` string, required — Version of the API used for the lookup
  - `status` string, required — Overall status of the lookup: 'success' or 'error'
  - `errors` string[], required — List of error messages if any errors occurred during the lookup
  - `dnsInfo` DnsInfo, required — Information about the DNS lookup for the Peppol participant.
    - `status` string, required — Status of the DNS lookup: 'success', 'error', or 'pending'
    - `smlHostname` string, required — Hostname of the SML used for the query
    - `dnsRecords` DnsRecord[], required — List of DNS records found for the Peppol participant
      - `ip` string, required — IP address found in the DNS record
    - `error` string, nullable — Error message if the DNS lookup failed
  - `serviceMetadata` ServiceMetadata, required — Service metadata information for a Peppol participant.
    - `status` string, required — Status of the service metadata lookup: 'success', 'error', or 'pending'
    - `queryTimeMs` number, required — Time taken to query the service metadata in milliseconds
    - `endpoints` Endpoint[], required — List of endpoints found for the Peppol participant
      - `status` string, required — Status of the endpoint lookup: 'success', 'error', or 'pending'
      - `url` string, required — URL of the endpoint
      - `documentTypes` SupportedDocumentType[], required — List of document types supported by this endpoint
        - `scheme` string, required — Scheme of the document type identifier
        - `value` string, required — Value of the document type identifier
      - `processes` Process[], nullable — List of processes supported by this endpoint
        - `processId` ProcessIdentifier, required — Process identifier in the Peppol network.
          - `scheme` string, required — Scheme of the process identifier
          - `value` string, required — Value of the process identifier
        - `endpoints` ProcessEndpoint[], required — List of endpoints supporting this process
          - `transportProfile` string, required — Transport profile used by this endpoint
          - `address` string, required — URL or address of the endpoint
          - `serviceActivationDate` string, nullable — ISO 8601 date when the service was activated
          - `serviceExpirationDate` string, nullable — ISO 8601 date when the service will expire
          - `serviceDescription` string, nullable — Human-readable description of the service
          - `technicalContactUrl` string, nullable — URL for technical contact information
          - `technicalInformationUrl` string, nullable — URL for technical documentation
          - `certificate` Certificate — Certificate information for a Peppol endpoint.
            - `status` string, required — Status of the certificate validation: 'success', 'error', or 'pending'
            - `details` object, nullable — Details about the certificate including subject, issuer, validity dates, etc.
            - `error` string, nullable — Error message if certificate validation failed
      - `error` string, nullable — Error message if endpoint lookup failed
    - `error` string, nullable — Error message if service metadata lookup failed
  - `businessCard` AppSchemasPeppolIdBusinessCard, required — Business card information for a Peppol participant.
    - `status` string, required — Status of the business card lookup: 'success', 'error', or 'pending'
    - `entities` BusinessEntity[], required — List of business entities associated with the Peppol ID
      - `name` string, nullable — Name of the business entity
      - `countryCode` string, nullable — ISO 3166-1 alpha-2 country code of the business entity
      - `registrationDate` string, nullable — ISO 8601 date of when the entity was registered in Peppol
      - `additionalInformation` string[], nullable — Additional information about the business entity
    - `queryTimeMs` number, required — Time taken to query the business card in milliseconds
    - `error` string, nullable — Error message if business card lookup failed
  - `certificates` Certificate[], required — List of certificates found for the Peppol participant
    - `status` string, required — Status of the certificate validation: 'success', 'error', or 'pending'
    - `details` object, nullable — Details about the certificate including subject, issuer, validity dates, etc.
    - `error` string, nullable — Error message if certificate validation failed
  - `executionTimeMs` number, required — Total execution time of the lookup operation in milliseconds

## Other responses

- `422` — Unprocessable Entity: Invalid Peppol ID
- `500` — Internal Server Error: Unexpected server error

---

[API](https://skmtc.net/e-invoice-be/apis/e-invoice-be-peppol-access-point-api.md) · [All operations](https://skmtc.net/e-invoice-be/apis/e-invoice-be-peppol-access-point-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/e-invoice-be/e-invoice-be-peppol-access-point-api/revisions/a5b8396effe8/schema)