{ "openapi": "3.0.1", "info": { "title": "EU VAT Number Validator & VIES Compliance Check API", "description": "Check and validate EU VAT numbers against the official European Commission VIES system — instant valid/invalid status, registered trader name & address, and deregistration-change monitoring for B2B compliance, KYB checks and invoice workflows. Official EC API; no login, no scraping, pay per lookup.", "version": "0.1", "x-build-id": "76wAfVGdAAgyqBcOp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gp005~vat-vies-validator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gp005-vat-vies-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/gp005~vat-vies-validator/runs": { "post": { "operationId": "runs-sync-gp005-vat-vies-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/gp005~vat-vies-validator/run-sync": { "post": { "operationId": "run-sync-gp005-vat-vies-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", "required": [ "vatNumbers" ], "properties": { "vatNumbers": { "title": "EU VAT numbers", "type": "array", "description": "List of full EU VAT numbers to validate against the official European Commission VIES system, each with its 2-letter country code prefix. Spaces, dots and dashes are ignored (e.g. \"IE 8256796U\", \"DE123456789\", \"FR-12345678901\"). Returns valid/invalid status plus registered trader name and address.", "items": { "type": "string" } }, "monitorChanges": { "title": "Monitor status changes (deregistration detection)", "type": "boolean", "description": "When enabled, the actor stores a snapshot of each lookup result (valid status, trader name, address) in its key-value store and compares it on every re-run. A VAT number that flips from valid to invalid (deregistered), or whose trader details change, produces a status-changed record and a 'vat-status-changed' charge event. Schedule the actor on a cron and use the 'statusChanged' field as your alert trigger.", "default": false }, "cacheTtlHours": { "title": "Server-side cache TTL (hours)", "minimum": 0, "maximum": 720, "type": "integer", "description": "How long (in hours) to serve repeat lookups for the SAME VAT number from the actor's internal cache instead of calling VIES again — reduces load on the EU service and lowers your cost (cached results are charged at the reduced cache-hit rate). 0 disables caching (always a fresh VIES lookup). Monitor mode always forces a fresh lookup so deregistration is never masked by the cache.", "default": 24 }, "maxConcurrency": { "title": "Max concurrent VIES requests", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum concurrent requests to the European Commission VIES service. Keep at 1-2 to stay polite to the official EC service and avoid rate limits; raise to 5 only for large batch validation runs.", "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 } } } } } } } } } }