{ "openapi": "3.0.1", "info": { "title": "VIES EU VAT Batch Validator + Audit Evidence", "description": "Batch-validate EU VAT numbers via the official European Commission VIES REST API. Returns VALID / INVALID / retry status, the VIES consultation number and a snapshot date as audit evidence for intra-EU B2B (reverse charge / WDT).", "version": "0.1", "x-build-id": "mK0NluAVkNRCed4Rr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/burly_bat~vies-eu-vat-batch-validator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-burly_bat-vies-eu-vat-batch-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/burly_bat~vies-eu-vat-batch-validator/runs": { "post": { "operationId": "runs-sync-burly_bat-vies-eu-vat-batch-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/burly_bat~vies-eu-vat-batch-validator/run-sync": { "post": { "operationId": "run-sync-burly_bat-vies-eu-vat-batch-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": [ "records" ], "properties": { "records": { "title": "VAT numbers to validate", "type": "array", "description": "Each record needs a full EU VAT number (e.g. \"PL5260001246\") or a countryCode + number pair. Optional rowId/reference are echoed back for mapping." }, "verificationDate": { "title": "Verification (snapshot) date", "type": "string", "description": "Date recorded as the audit snapshot (\"valid on date X\") in YYYY-MM-DD. Defaults to today. VIES always answers for the current day." }, "mode": { "title": "Mode", "enum": [ "validate", "monitor" ], "type": "string", "description": "validate = one-off batch check. monitor = scheduled re-validation of a contractor list (same checks, monitoring framing).", "default": "validate" }, "requesterVatNumber": { "title": "Your EU VAT number (for consultation number)", "type": "string", "description": "Optional. Your own valid EU VAT number (e.g. \"PL5260001246\"). When provided, VIES returns a consultation number (requestIdentifier) as proof you checked the counterparty.", "default": "" }, "maxChecks": { "title": "Maximum checks", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on records validated in one run.", "default": 200 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Gentle throttling between VIES requests. VIES has undisclosed, strict rate limits and blocks floods. Keep this conservative.", "default": 400 }, "maxRetries": { "title": "Retries for temporary failures", "minimum": 0, "maximum": 8, "type": "integer", "description": "Retry attempts with exponential backoff for UNAVAILABLE_RETRY outcomes (MS_UNAVAILABLE / SERVICE_UNAVAILABLE / TIMEOUT / concurrency limits).", "default": 3 }, "useTestService": { "title": "Use VIES test service", "type": "boolean", "description": "Route checks to the VIES test endpoint (special demo numbers, e.g. 100 = valid, 200 = invalid). Use for safe smoke tests without hitting real data / rate limits.", "default": false }, "sourceMode": { "title": "Source mode", "enum": [ "live", "offline" ], "type": "string", "description": "Use offline for local fixture-based checks (no network).", "default": "live" } } }, "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 } } } } } } } } } }