> ## Documentation Index
> Fetch the complete documentation index at: https://docs.e-invoice.be/llms.txt
> Use this file to discover all available pages before exploring further.

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



## OpenAPI

````yaml /openapi.json get /api/lookup
openapi: 3.1.0
info:
  title: e-invoice.be Peppol Access Point API
  version: 1.1.0
  x-logo:
    url: https://e-invoice.be/einvoice.svg
servers:
  - url: https://api.e-invoice.be
    description: Production
security: []
paths:
  /api/lookup:
    get:
      tags:
        - Lookup
      summary: Lookup Peppol ID
      description: >-
        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).
      operationId: get_lookup_peppol_id
      parameters:
        - name: peppol_id
          in: query
          required: true
          schema:
            type: string
            description: >-
              Peppol ID in the format `<scheme>:<id>`. Example:
              `0208:1018265814` for a Belgian company.
            title: Peppol Id
          description: >-
            Peppol ID in the format `<scheme>:<id>`. Example: `0208:1018265814`
            for a Belgian company.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PeppolIdLookupResponse'
        '422':
          description: 'Unprocessable Entity: Invalid Peppol ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: 'Internal Server Error: Unexpected server error'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    PeppolIdLookupResponse:
      properties:
        queryMetadata:
          $ref: '#/components/schemas/QueryMetadata'
          description: Metadata about the query that was performed
        status:
          type: string
          title: Status
          description: 'Overall status of the lookup: ''success'' or ''error'''
          examples:
            - success
        errors:
          items:
            type: string
          type: array
          title: Errors
          description: List of error messages if any errors occurred during the lookup
          examples:
            - - DNS lookup failed
              - Business card not available
        dnsInfo:
          $ref: '#/components/schemas/DnsInfo'
          description: Information about the DNS lookup performed
        serviceMetadata:
          $ref: '#/components/schemas/ServiceMetadata'
          description: Service metadata information for the Peppol participant
        businessCard:
          $ref: '#/components/schemas/app__schemas__peppol_id__BusinessCard'
          description: Business card information for the Peppol participant
        certificates:
          items:
            $ref: '#/components/schemas/Certificate'
          type: array
          title: Certificates
          description: List of certificates found for the Peppol participant
        executionTimeMs:
          type: number
          title: Executiontimems
          description: Total execution time of the lookup operation in milliseconds
          examples:
            - 895.32
      type: object
      required:
        - queryMetadata
        - status
        - errors
        - dnsInfo
        - serviceMetadata
        - businessCard
        - certificates
        - executionTimeMs
      title: PeppolIdLookupResponse
      description: >-
        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.
    ErrorResponse:
      properties:
        detail:
          type: string
          title: Detail
      type: object
      required:
        - detail
      title: ErrorResponse
      description: Error response model.
    QueryMetadata:
      properties:
        identifierScheme:
          type: string
          title: Identifierscheme
          description: Scheme of the identifier, typically 'iso6523-actorid-upis'
          examples:
            - iso6523-actorid-upis
        identifierValue:
          type: string
          title: Identifiervalue
          description: The actual Peppol ID value being queried
          examples:
            - '0208:1018265814'
        smlDomain:
          type: string
          title: Smldomain
          description: Domain of the SML (Service Metadata Locator) used for the lookup
          examples:
            - participant.sml.prod.tech.peppol.org
        timestamp:
          type: string
          title: Timestamp
          description: ISO 8601 timestamp of when the query was executed
          examples:
            - '2026-01-12T14:32:10.123456'
        version:
          type: string
          title: Version
          description: Version of the API used for the lookup
          examples:
            - 1.0.0
      type: object
      required:
        - identifierScheme
        - identifierValue
        - smlDomain
        - timestamp
        - version
      title: QueryMetadata
      description: Metadata about the Peppol ID lookup query.
    DnsInfo:
      properties:
        status:
          type: string
          title: Status
          description: 'Status of the DNS lookup: ''success'', ''error'', or ''pending'''
          examples:
            - success
        smpHostname:
          anyOf:
            - type: string
            - type: 'null'
          title: Smphostname
          description: Hostname of the SMP (Service Metadata Publisher) discovered via DNS
          examples:
            - smp.e-invoice.be
        smlHostname:
          type: string
          title: Smlhostname
          description: Hostname of the SML used for the query
          examples:
            - participant.sml.prod.tech.peppol.org
        dnsRecords:
          items:
            $ref: '#/components/schemas/DnsRecord'
          type: array
          title: Dnsrecords
          description: List of DNS records found for the Peppol participant
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
          description: Error message if the DNS lookup failed
          examples:
            - 'DNS lookup failed: no such domain'
        lookupMethod:
          anyOf:
            - type: string
            - type: 'null'
          title: Lookupmethod
          description: 'DNS lookup method used: ''naptr'' (new spec) or ''busdox'' (legacy)'
          examples:
            - naptr
      type: object
      required:
        - status
        - smlHostname
        - dnsRecords
      title: DnsInfo
      description: Information about the DNS lookup for the Peppol participant.
    ServiceMetadata:
      properties:
        status:
          type: string
          title: Status
          description: >-
            Status of the service metadata lookup: 'success', 'error', or
            'pending'
          examples:
            - success
        queryTimeMs:
          type: number
          title: Querytimems
          description: Time taken to query the service metadata in milliseconds
          examples:
            - 245.67
        endpoints:
          items:
            $ref: '#/components/schemas/Endpoint'
          type: array
          title: Endpoints
          description: List of endpoints found for the Peppol participant
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
          description: Error message if service metadata lookup failed
          examples:
            - Service unavailable
      type: object
      required:
        - status
        - queryTimeMs
        - endpoints
      title: ServiceMetadata
      description: Service metadata information for a Peppol participant.
    app__schemas__peppol_id__BusinessCard:
      properties:
        status:
          type: string
          title: Status
          description: 'Status of the business card lookup: ''success'', ''error'', or ''pending'''
          examples:
            - success
        entities:
          items:
            $ref: '#/components/schemas/BusinessEntity'
          type: array
          title: Entities
          description: List of business entities associated with the Peppol ID
        queryTimeMs:
          type: number
          title: Querytimems
          description: Time taken to query the business card in milliseconds
          examples:
            - 123.45
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
          description: Error message if business card lookup failed
          examples:
            - Business card not found
      type: object
      required:
        - status
        - entities
        - queryTimeMs
      title: BusinessCard
      description: Business card information for a Peppol participant.
    Certificate:
      properties:
        status:
          type: string
          title: Status
          description: >-
            Status of the certificate validation: 'success', 'error', or
            'pending'
          examples:
            - success
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Details about the certificate including subject, issuer, validity
            dates, etc.
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
          description: Error message if certificate validation failed
          examples:
            - Certificate expired
      type: object
      required:
        - status
      title: Certificate
      description: Certificate information for a Peppol endpoint.
    DnsRecord:
      properties:
        ip:
          type: string
          title: Ip
          description: IP address found in the DNS record
          examples:
            - 193.140.151.175
      type: object
      required:
        - ip
      title: DnsRecord
      description: DNS record information for a Peppol participant.
    Endpoint:
      properties:
        status:
          type: string
          title: Status
          description: 'Status of the endpoint lookup: ''success'', ''error'', or ''pending'''
          examples:
            - success
        url:
          type: string
          title: Url
          description: URL of the endpoint
          examples:
            - https://ap.e-invoice.be/as4
        documentTypes:
          items:
            $ref: '#/components/schemas/SupportedDocumentType'
          type: array
          title: Documenttypes
          description: List of document types supported by this endpoint
        processes:
          anyOf:
            - items:
                $ref: '#/components/schemas/Process'
              type: array
            - type: 'null'
          title: Processes
          description: List of processes supported by this endpoint
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
          description: Error message if endpoint lookup failed
          examples:
            - Connection timeout
      type: object
      required:
        - status
        - url
        - documentTypes
      title: Endpoint
      description: Information about a Peppol participant's endpoint.
    BusinessEntity:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Name of the business entity
          examples:
            - Example Corporation Ltd
        countryCode:
          anyOf:
            - type: string
            - type: 'null'
          title: Countrycode
          description: ISO 3166-1 alpha-2 country code of the business entity
          examples:
            - 'NO'
        registrationDate:
          anyOf:
            - type: string
            - type: 'null'
          title: Registrationdate
          description: ISO 8601 date of when the entity was registered in Peppol
          examples:
            - '2021-06-15T00:00:00Z'
        additionalInformation:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Additionalinformation
          description: Additional information about the business entity
          examples:
            - - 'VAT: BE1018265814'
              - 'Organization number: 1018.265.814'
      type: object
      title: BusinessEntity
      description: Business entity information in the Peppol network.
    SupportedDocumentType:
      properties:
        scheme:
          type: string
          title: Scheme
          description: Scheme of the document type identifier
          examples:
            - busdox-docid-qns
        value:
          type: string
          title: Value
          description: Value of the document type identifier
          examples:
            - >-
              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
      type: object
      required:
        - scheme
        - value
      title: SupportedDocumentType
      description: Document type supported by a Peppol participant.
    Process:
      properties:
        processId:
          $ref: '#/components/schemas/ProcessIdentifier'
          description: Identifier of the process
        endpoints:
          items:
            $ref: '#/components/schemas/ProcessEndpoint'
          type: array
          title: Endpoints
          description: List of endpoints supporting this process
      type: object
      required:
        - processId
        - endpoints
      title: Process
      description: Process information in the Peppol network.
    ProcessIdentifier:
      properties:
        scheme:
          type: string
          title: Scheme
          description: Scheme of the process identifier
          examples:
            - cenbii-procid-ubl
        value:
          type: string
          title: Value
          description: Value of the process identifier
          examples:
            - urn:fdc:peppol.eu:2017:poacc:billing:01:1.0
      type: object
      required:
        - scheme
        - value
      title: ProcessIdentifier
      description: Process identifier in the Peppol network.
    ProcessEndpoint:
      properties:
        transportProfile:
          type: string
          title: Transportprofile
          description: Transport profile used by this endpoint
          examples:
            - peppol-transport-as4-v2_0
        address:
          type: string
          title: Address
          description: URL or address of the endpoint
          examples:
            - https://ap.e-invoice.be/as4
        serviceActivationDate:
          anyOf:
            - type: string
            - type: 'null'
          title: Serviceactivationdate
          description: ISO 8601 date when the service was activated
          examples:
            - '2022-01-01T00:00:00Z'
        serviceExpirationDate:
          anyOf:
            - type: string
            - type: 'null'
          title: Serviceexpirationdate
          description: ISO 8601 date when the service will expire
          examples:
            - '2025-01-01T00:00:00Z'
        serviceDescription:
          anyOf:
            - type: string
            - type: 'null'
          title: Servicedescription
          description: Human-readable description of the service
          examples:
            - Company XYZ's AP service
        technicalContactUrl:
          anyOf:
            - type: string
            - type: 'null'
          title: Technicalcontacturl
          description: URL for technical contact information
          examples:
            - https://support.e-invoice.be
        technicalInformationUrl:
          anyOf:
            - type: string
            - type: 'null'
          title: Technicalinformationurl
          description: URL for technical documentation
          examples:
            - https://api.e-invoice.be
        certificate:
          anyOf:
            - $ref: '#/components/schemas/Certificate'
            - type: 'null'
          description: Certificate information for this endpoint
      type: object
      required:
        - transportProfile
        - address
      title: ProcessEndpoint
      description: Endpoint information for a specific Peppol process.

````