{ "openapi": "3.0.1", "info": { "title": "XML & E-invoice Validator (XSD, Peppol, XRechnung, Factur-X)", "description": "Validate XML documents and e-invoices by URL against XSD, DTD, RelaxNG and Schematron business rules: Peppol BIS, EN 16931, XRechnung, Factur-X, FatturaPA, KSeF and more. One row per document with the verdict, line numbers and rule ids.", "version": "1.0", "x-build-id": "Azawhx5ddjNHqLDQq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xmlvalid~xml-einvoice-validator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xmlvalid-xml-einvoice-validator", "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/xmlvalid~xml-einvoice-validator/runs": { "post": { "operationId": "runs-sync-xmlvalid-xml-einvoice-validator", "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/xmlvalid~xml-einvoice-validator/run-sync": { "post": { "operationId": "run-sync-xmlvalid-xml-einvoice-validator", "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": { "startUrls": { "title": "Document URLs", "type": "array", "description": "Public http(s) addresses of the XML documents, e-invoices (UBL, CII), Factur-X / ZUGFeRD PDFs or .zip archives to validate. They are downloaded by xmlvalid.com.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "xml": { "title": "Or paste an XML document", "type": "string", "description": "One document to validate, pasted here, in addition to the URLs." }, "schema": { "title": "Schema", "type": "string", "description": "\"auto\" picks the catalog profile an e-invoice names (Peppol BIS, XRechnung, Factur-X, CIUS…) and otherwise checks well-formedness and the document's own DOCTYPE. Or a catalog name such as peppol-bis-3-invoice, xrechnung-3-cii, ubl-2.1-invoice or fatturapa-1.2.3: see https://xmlvalid.com/schemas.", "default": "auto" }, "apiKey": { "title": "Your xmlvalid API key (optional)", "type": "string", "description": "With a key of your own (xv_…, from https://xmlvalid.com/dashboard/api) the validations count towards your xmlvalid plan, including saved schemas (my-12), and are not charged per document here." }, "maxErrors": { "title": "Findings listed per document", "minimum": 0, "maximum": 500, "type": "integer", "description": "How many errors and warnings each row lists (all are counted).", "default": 20 }, "shareReport": { "title": "Make a shareable report link", "type": "boolean", "description": "One public HTML report for all documents, open for 30 days, in the run's OUTPUT. Holds the verdicts and findings, not the documents.", "default": false }, "concurrency": { "title": "Documents at a time", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many documents are validated in parallel.", "default": 3 } } }, "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 } } } } } } } } } }