{ "openapi": "3.0.1", "info": { "title": "VAT Number Checker & EORI Checker: VIES, HMRC, EOS", "description": "Check trading partners' EU VAT numbers with VIES and GB, EU and XI EORI numbers with HMRC and EOS. Local format checks first, one row per number, no API key.", "version": "0.1", "x-build-id": "Gv8tuSfm8JO0j7yl7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yourevenings~eu-uk-vat-eori-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yourevenings-eu-uk-vat-eori-checker", "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/yourevenings~eu-uk-vat-eori-checker/runs": { "post": { "operationId": "runs-sync-yourevenings-eu-uk-vat-eori-checker", "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/yourevenings~eu-uk-vat-eori-checker/run-sync": { "post": { "operationId": "run-sync-yourevenings-eu-uk-vat-eori-checker", "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 and Northern Ireland (XI) VAT numbers of your customers or suppliers, with the country prefix (for example IE6388047V, DE123456789, XI123456789). Greek numbers may start EL or GR. GB numbers get a local check-digit result only. Up to 500 numbers per run, VAT and EORI together.", "items": { "type": "string" } }, "eoriNumbers": { "title": "EORI numbers", "type": "array", "description": "GB EORI numbers (checked with HMRC) and EU or XI EORI numbers (checked with the European Commission's EOS service), with the country prefix.", "items": { "type": "string" } }, "requesterVatNumber": { "title": "Your own VAT number (optional)", "type": "string", "description": "Your EU or XI VAT number. When set, VIES returns a consultation number for each valid answer: your proof that you checked the number on that date." }, "includeTraderDetails": { "title": "Include trader name and address", "type": "boolean", "description": "Off by default. When on, the official name and address are returned only when the name is clearly an organisation (it contains a legal form such as Ltd, GmbH or SA). Names that may belong to a private person are withheld.", "default": false }, "useDailyCache": { "title": "Cache EORI checks for the day", "type": "boolean", "description": "EORI numbers already checked today are answered from the cache (free, marked fromCache). VAT numbers are always answered from the cache when checked today, whatever this setting, because VIES asks that a number is not checked several times a day.", "default": true }, "monitorMode": { "title": "Monitor mode", "type": "boolean", "description": "Compare each answer with the last run and mark it first_check, unchanged, became_valid or became_invalid. Outages never count as a change.", "default": false }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Named key-value store for the daily cache and monitor history. Use a different name per list you monitor.", "default": "vat-eori-checker-state" }, "maxNumbers": { "title": "Maximum numbers per run", "minimum": 1, "maximum": 500, "type": "integer", "description": "Numbers after this are skipped (a free status row says so). VIES answers about one number a second, so raise the run timeout for long lists.", "default": 500 } } }, "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 } } } } } } } } } }