{ "openapi": "3.0.1", "info": { "title": "EU VAT Number Validator - Bulk VIES Check", "description": "Bulk EU VAT number check against the official VIES service: valid or invalid, registered name and address, optional consultation number. $0.003 per check; malformed numbers and member-state downtime are free.", "version": "0.1", "x-build-id": "j2keN1eUSSiYMpuTa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lukehunter~eu-vat-number-validator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lukehunter-eu-vat-number-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/lukehunter~eu-vat-number-validator/runs": { "post": { "operationId": "runs-sync-lukehunter-eu-vat-number-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/lukehunter~eu-vat-number-validator/run-sync": { "post": { "operationId": "run-sync-lukehunter-eu-vat-number-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", "type": "array", "description": "EU VAT numbers with country prefix, e.g. [\"DE123456789\", \"ATU12345678\", \"EL123456789\", \"XI123456789\"]. Spaces, dots and dashes are removed and case is ignored (\"de 123 456 789\" works). Malformed numbers are free and never sent to VIES. Max 10,000 per run.", "items": { "type": "string" } }, "rows": { "title": "Rows with a VAT field (optional)", "type": "array", "description": "Objects that carry a VAT number, e.g. [{\"domain\": \"example.com\", \"vatId\": \"DE123456789\"}]. The number is read from \"vatField\", or from vatId, vatNumber, vat, vat_id, vatNo, ustId or taxId. Rows without one are skipped. Merged with vatNumbers." }, "datasetId": { "title": "Dataset ID (optional)", "type": "string", "description": "ID of an Apify dataset whose items have a VAT field, to chain runs, e.g. the default dataset of an Impressum Scraper run (field vatId). Read at the start of the run, up to 10,000 items. Merged with vatNumbers and rows." }, "vatField": { "title": "VAT field name (optional)", "type": "string", "description": "Field that holds the VAT number in rows or the dataset, e.g. \"vatId\". Leave empty to try vatId, vatNumber, vat, vat_id, vatNo, ustId and taxId in that order." }, "requesterVatNumber": { "title": "Your own VAT number (optional)", "type": "string", "description": "Your own EU VAT number, e.g. \"DE123456789\". When set, VIES returns a consultation number (requestIdentifier) for each check, which you can keep as proof of the check. Not output and not logged. Leave empty for a plain check." }, "maxItems": { "title": "Maximum checks", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on charged checks (definitive valid or invalid answers), 1 to 10,000, e.g. 100. At $0.003 per check, 100 checks cost $0.30. Numbers not checked because the cap was reached come back as not-processed rows, free.", "default": 100 }, "delaySeconds": { "title": "Seconds between requests", "minimum": 1, "maximum": 10, "type": "number", "description": "Pause between VIES requests, 1 to 10, e.g. 2. The default of 1 means one request per second, which keeps the load on the official service low. It can be raised, never lowered. 1,000 numbers take about 17 minutes at 1.", "default": 1 } } }, "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 } } } } } } } } } }