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

# Validate Peppol ID

> Validate if a Peppol ID exists in the Peppol network and retrieve supported document types. 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/validate/peppol-id
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/validate/peppol-id:
    get:
      tags:
        - Validate
      summary: Validate Peppol ID
      description: >-
        Validate if a Peppol ID exists in the Peppol network and retrieve
        supported document types. 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: validate_peppol_id_api_validate_peppol_id_get
      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/PeppolIdValidationResponse'
        '422':
          description: 'Unprocessable Entity: Invalid Peppol ID format'
          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:
    PeppolIdValidationResponse:
      properties:
        is_valid:
          type: boolean
          title: Is Valid
          description: Whether the Peppol ID is valid and registered in the Peppol network
          example: true
        dns_valid:
          type: boolean
          title: Dns Valid
          description: Whether the DNS resolves to a valid SMP
          example: true
        business_card_valid:
          type: boolean
          title: Business Card Valid
          description: Whether a business card is set at the SMP
          example: true
        supported_document_types:
          items:
            type: string
          type: array
          title: Supported Document Types
          description: List of document types that this Peppol ID supports
          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
        business_card:
          anyOf:
            - $ref: '#/components/schemas/app__schemas__validation__BusinessCard'
            - type: 'null'
          description: Business card information for the Peppol ID
          example:
            country_code: BE
            name: Example Corporation Ltd
            registration_date: '2021-06-15'
      type: object
      required:
        - is_valid
        - dns_valid
        - business_card_valid
        - supported_document_types
      title: PeppolIdValidationResponse
      description: >-
        Response for a Peppol ID validation request.


        This model represents the validation result of a Peppol ID in the Peppol
        network,

        including whether the ID is valid and what document types it supports.
    ErrorResponse:
      properties:
        detail:
          type: string
          title: Detail
      type: object
      required:
        - detail
      title: ErrorResponse
      description: Error response model.
    app__schemas__validation__BusinessCard:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        country_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Country Code
        registration_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Registration Date
      type: object
      title: BusinessCard

````