{ "openapi": "3.0.1", "info": { "title": "EU VAT Number Validator — VIES, Bulk, With Company Name", "description": "Validate EU VAT numbers in bulk against the European Commission's VIES service. Returns the registered company name and address where the member state discloses them, a consultation number that is legal proof of the check, and an optional trader name and address match. Checks the national.", "version": "0.1", "x-build-id": "Q3DFgLKfTTB5kzIzo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dalbian~eu-vat-number-validator-vies/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dalbian-eu-vat-number-validator-vies", "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/dalbian~eu-vat-number-validator-vies/runs": { "post": { "operationId": "runs-sync-dalbian-eu-vat-number-validator-vies", "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/dalbian~eu-vat-number-validator-vies/run-sync": { "post": { "operationId": "run-sync-dalbian-eu-vat-number-validator-vies", "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": "One VAT number per line, in any form: DE811907980, DE 811 907 980, de-811.907.980. Spaces, dots and hyphens are stripped and the country code is uppercased. Greece may be written either GR or EL. Northern Ireland is XI.", "default": [ "IE6388047V", "DE811907980" ], "items": { "type": "string" } }, "traderDetails": { "title": "Company details to verify (optional)", "type": "array", "description": "Switches on the trader match. One object per VAT number, in the same order as the list above, with any of name, street, postalCode, city, companyType — for example [{\"name\": \"TELEFONICA SA\", \"city\": \"MADRID\"}]. VIES answers VALID or INVALID per field without ever revealing the registered value. Use an empty object {} for a number you do not want matched. Requires the requester VAT number below." }, "requesterVatNumber": { "title": "Your own VAT number", "type": "string", "description": "Your company's own valid EU VAT number, for example IT00159560366. Supplying it makes VIES return a requestIdentifier — the consultation number you keep as evidence that you checked. It is also required for the trader match. Leave empty for an anonymous check." }, "checkServiceStatusFirst": { "title": "Check member state availability first", "type": "boolean", "description": "Ask VIES which national databases are up before validating, and record the answer on the summary row. Costs one request and tells you in advance whether a country in your batch is reachable.", "default": true }, "skipFormatInvalid": { "title": "Skip numbers that cannot be valid", "type": "boolean", "description": "Do not spend a VIES call on a number whose length or characters are wrong for its country — those can never be valid. Numbers that fail only the check digit are still sent to VIES, because a check-digit rule can have exceptions and VIES is the authority.", "default": true }, "skipChecksumInvalid": { "title": "Also skip numbers that fail the check digit", "type": "boolean", "description": "Faster and cheaper on a dirty list, but riskier: a number that fails the check digit is almost always a typo, yet the Actor will not have asked VIES to confirm it. Off by default.", "default": false }, "concurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 4, "type": "integer", "description": "VIES enforces a concurrency limit per member state and rejects excess traffic with MS_MAX_CONCURRENT_REQ. Two is the setting that finishes fastest in practice; raising it mostly buys retries.", "default": 2 } } }, "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 } } } } } } } } } }