{ "openapi": "3.0.1", "info": { "title": "Peppol Directory Lookup — company records and document types", "description": "Find company records in the official Peppol Directory by VAT/enterprise number or name. Returns declared document types and explicit found/not-found/invalid-format/error states. Does not establish network reachability.", "version": "1.1", "x-build-id": "pkEz6dDoos2QJzLP6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetchlab~peppol-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetchlab-peppol-lookup", "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/fetchlab~peppol-lookup/runs": { "post": { "operationId": "runs-sync-fetchlab-peppol-lookup", "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/fetchlab~peppol-lookup/run-sync": { "post": { "operationId": "run-sync-fetchlab-peppol-lookup", "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": { "identifiers": { "title": "VAT / enterprise numbers", "uniqueItems": true, "type": "array", "description": "One value per line. Accepted formats: VAT number with country prefix (BE0202239951, NL123456789B01, FR12345678901, DE123456789), Belgian enterprise number (0202.239.951 or 0202239951), or a full Peppol participant ID (0208:0202239951). Spaces, dots and dashes are ignored.", "items": { "type": "string" } }, "names": { "title": "Company names (search)", "uniqueItems": true, "type": "array", "description": "Optional. Company names to search for (partial matches). Use the 'Country' field below to narrow the search. Each name returns up to 'Max results per name' participants.", "items": { "type": "string" } }, "country": { "title": "Country for name searches", "pattern": "^([A-Za-z]{2})?$", "type": "string", "description": "Optional ISO 3166-1 alpha-2 country code (BE, NL, FR, DE…) to restrict name searches. Leave empty to search all countries.", "default": "BE" }, "defaultCountry": { "title": "Default country for bare numbers", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Country assumed for identifiers typed without a country prefix (e.g. '0202239951'). Default: BE (Belgian enterprise number).", "default": "BE" }, "maxResultsPerName": { "title": "Max results per name", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of participants fetched from the Directory for each name search (before grouping by company).", "default": 10 }, "includeDocumentTypes": { "title": "Include full document type details", "type": "boolean", "description": "Include the raw Peppol document type identifiers next to the human-readable summary. Turn off for a lighter output.", "default": true }, "tryAllSchemes": { "title": "Try all identifier schemes", "type": "boolean", "description": "For each country several Peppol identifier schemes exist (e.g. Belgium: 0208 enterprise number and 9925 VAT). When on, all schemes are tried until a match is found. When off, only the most common scheme is tried (faster).", "default": true }, "groupNameResults": { "title": "Group name results by company", "type": "boolean", "description": "The Peppol Directory often lists the same company under several identifiers (enterprise number, VAT number). When on, a name search returns one row per company with all its Peppol IDs in 'participantIds'. Turn off to get one row per identifier.", "default": true } } }, "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 } } }, "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 } } } } } } } } } }