{ "openapi": "3.0.1", "info": { "title": "VAT Validator API - VIES Check, Company Name & Address", "description": "When VIES goes down it answers nothing, and a checker that calls that INVALID is guessing. This one separates a wrong number, an unregistered one and VIES being unreachable. Offline checksum first, unanswered numbers are free.", "version": "0.1", "x-build-id": "z45lShVu375ysmoTI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/stas_k~vat-validator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-stas_k-vat-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/stas_k~vat-validator/runs": { "post": { "operationId": "runs-sync-stas_k-vat-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/stas_k~vat-validator/run-sync": { "post": { "operationId": "run-sync-stas_k-vat-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": { "vatNumbers": { "title": "VAT numbers to check", "type": "string", "description": "One per line, with the country prefix: DE259137088, FR 40 303265045, NL004495445B01. Spaces, dots and dashes are ignored. Up to 4,000 per run." }, "text": { "title": "Or paste a document (optional)", "type": "string", "description": "Used only when 'VAT numbers to check' is empty: numbers are pulled out of an invoice, an email or any pasted text, in the order they appear. A bare number without a country prefix glued to it is checked but never charged." }, "countryHint": { "title": "Country prefix for bare numbers (optional)", "type": "string", "description": "Two-letter code, used only for numbers that come without a prefix, for example a column of German numbers pasted without DE." }, "checkVies": { "title": "Ask VIES (live registry, recommended)", "type": "boolean", "description": "On by default. Turn it off for a pure offline run: shape and checksum only, no VIES calls, and the status says so.", "default": true }, "cacheMinutes": { "title": "Cache VIES answers for (minutes)", "type": "integer", "description": "0 turns the cache off. A cached answer is not charged: the number is the same public record, whoever asked first.", "default": 1440 }, "maxConcurrency": { "title": "Parallel VIES requests", "type": "integer", "description": "VIES limits simultaneous requests; 3 is safe, 8 is the ceiling here. One question takes 2 to 6 seconds, so 3 handles roughly 2,000 numbers per hour and 8 roughly 4,000 in most of an hour. Lower it if you see many UNVERIFIED rows.", "default": 3 }, "timeBudgetSeconds": { "title": "Time budget (seconds)", "type": "integer", "description": "The run stops starting new VIES calls after this many seconds and reports the rest as NOT_ATTEMPTED, uncharged. Keep it below timeoutSecs of the run.", "default": 3300 }, "viesTimeoutSeconds": { "title": "VIES timeout (seconds)", "type": "integer", "description": "VIES is often slow. A timeout does not become 'invalid': the row is UNVERIFIED and not charged.", "default": 30 } } }, "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 } } } } } } } } } }