{
  "openapi": "3.0.1",
  "info": {
    "title": "Peppol e-invoicing checker — participant lookup",
    "description": "Check if a customer or supplier is registered on Peppol and which e-invoice document types they accept. Direct SML/SMP lookup, access point and certificate details, Directory business card, change tracking.",
    "version": "0.1",
    "x-build-id": "BwygBdN1vrEi7zITU"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/kondasviktor~peppol-e-invoicing-participant-checker/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-kondasviktor-peppol-e-invoicing-participant-checker",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/kondasviktor~peppol-e-invoicing-participant-checker/runs": {
      "post": {
        "operationId": "runs-sync-kondasviktor-peppol-e-invoicing-participant-checker",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/kondasviktor~peppol-e-invoicing-participant-checker/run-sync": {
      "post": {
        "operationId": "run-sync-kondasviktor-peppol-e-invoicing-participant-checker",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "participants": {
            "title": "Peppol IDs or VAT numbers",
            "type": "array",
            "description": "One per line. A Peppol ID looks like <code>0088:5790000436507</code> (four-digit scheme code, colon, identifier; <code>iso6523-actorid-upis::</code> in front is fine). A VAT number needs its country prefix, e.g. <code>BE0123456789</code> or <code>NO974760673MVA</code> — the Actor works out which Peppol identifiers that company could be registered under and checks them all. For national company ids or names use <b>Records</b> below.",
            "items": {
              "type": "string"
            }
          },
          "records": {
            "title": "Records (optional)",
            "type": "array",
            "description": "Detailed entries as JSON objects, e.g. from your ERP export. Fields (all optional, use what you have): <code>reference</code> (your customer/supplier number — echoed back in the result), <code>peppolId</code>, <code>vatNumber</code>, <code>companyId</code> + <code>country</code> (e.g. Norwegian organisation number, Dutch KvK, French SIREN, Belgian enterprise number…), <code>scheme</code> (four-digit Peppol scheme code to use with <code>companyId</code>), <code>name</code> (+ optional <code>country</code>) to search the Peppol Directory by company name. Example: <code>{\"reference\": \"C-1001\", \"country\": \"NO\", \"companyId\": \"974760673\"}</code>",
            "default": []
          },
          "maxParticipants": {
            "title": "Max paid results",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Hard cap on paid results — participants found registered. Free rows (not registered, invalid input, lookup failures) do not count. This is also your cost cap: 100 results = $1.00.",
            "default": 100
          },
          "network": {
            "title": "Peppol network",
            "enum": [
              "production",
              "test"
            ],
            "type": "string",
            "description": "<b>production</b> is the live Peppol network. <b>test</b> uses Peppol's test network (SMK) — for ERP integrators checking their test setup.",
            "default": "production"
          },
          "includeBusinessCard": {
            "title": "Include business card from the Peppol Directory",
            "type": "boolean",
            "description": "Company name, country, address line, websites and registration date, when the participant published them (publication is optional). One extra, rate-limited request per result.",
            "default": true
          },
          "includeEndpointDetails": {
            "title": "Include access point details",
            "type": "boolean",
            "description": "Access point host, transport profile (AS4 / AS2) and certificate validity dates, with a warning when the certificate or SMP registration is expired or about to expire.",
            "default": true
          },
          "includeContacts": {
            "title": "Include contact persons from business cards",
            "type": "boolean",
            "description": "Off by default: Directory business cards may contain names, e-mail addresses and phone numbers of individuals. Only switch on if you have a lawful basis to process them.",
            "default": false
          },
          "maxCandidatesPerName": {
            "title": "Max matches per name search",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "For records with a <code>name</code>: how many Directory matches to verify (each verified match is one result).",
            "default": 3
          },
          "expiryWarningDays": {
            "title": "Expiry warning (days)",
            "minimum": 0,
            "maximum": 365,
            "type": "integer",
            "description": "Flag access point certificates and SMP registrations that expire within this many days.",
            "default": 30
          },
          "trackHistory": {
            "title": "Track changes between runs",
            "type": "boolean",
            "description": "Compare with the previous run of the same list and report <code>newly_registered</code>, <code>deregistered</code>, <code>document_types_changed</code> or <code>endpoint_changed</code>. The history is stored in a key-value store in YOUR account.",
            "default": true
          },
          "historyStoreName": {
            "title": "History store name",
            "type": "string",
            "description": "Name of the key-value store that holds the previous results. Use a different name per list you monitor. 3–63 characters: lowercase letters, digits and hyphens.",
            "default": "peppol-participant-history"
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}