{ "openapi": "3.0.1", "info": { "title": "EU Counterparty VAT Compliance Monitor", "description": "Check supplier and customer VAT numbers against VIES, retain each official response, distinguish invalid numbers from unavailable checks, and receive structured change alerts for compliance workflows.", "version": "0.2", "x-build-id": "3NjZgUQhaND44IKBk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/reapx~eu-vat-status-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-reapx-eu-vat-status-monitor", "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/reapx~eu-vat-status-monitor/runs": { "post": { "operationId": "runs-sync-reapx-eu-vat-status-monitor", "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/reapx~eu-vat-status-monitor/run-sync": { "post": { "operationId": "run-sync-reapx-eu-vat-status-monitor", "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": [ "companies" ], "properties": { "mode": { "title": "Operation Mode", "enum": [ "CHECK", "MONITOR" ], "type": "string", "description": "CHECK mode runs a one-time audit batch. MONITOR mode updates stateful watchlists.", "default": "MONITOR" }, "companies": { "title": "Companies / VAT Watchlist", "minItems": 1, "maxItems": 250, "type": "array", "description": "List of companies or VAT numbers to check (1 to 250 items).", "items": { "type": "object", "required": [ "vat" ], "properties": { "id": { "title": "Stable Entity ID", "type": "string", "description": "Optional stable caller ID (e.g. supplier-0042) to detect VAT number changes across runs." }, "label": { "title": "Label", "type": "string", "description": "Caller company name or reference label." }, "vat": { "title": "VAT Number", "type": "string", "description": "EU VAT number (e.g. IE6388047V, DE123456789, EL999999999)." }, "expectedName": { "title": "Expected Company Name", "type": "string", "description": "Optional name to compare against official VIES response." }, "expectedAddress": { "title": "Expected Address", "type": "string", "description": "Optional address to compare against official VIES response." }, "domain": { "title": "Website Domain", "type": "string", "description": "Optional website domain (e.g. google.com) used only when includeWebsiteSignals is enabled." } } } }, "monitorId": { "title": "Monitor ID / Watchlist Name", "type": "string", "description": "Name of the named state watchlist (1–40 alphanumeric characters). Required for MONITOR mode.", "default": "default" }, "includeWebsiteSignals": { "title": "Include Secondary Website Signals", "type": "boolean", "description": "Fetches published VAT numbers from counterparty websites as secondary evidence (max 50 entities).", "default": false }, "webhookUrl": { "title": "Compliance Webhook URL", "type": "string", "description": "Optional public HTTPS URL to receive webhook alerts on compliance status changes." }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 4, "type": "integer", "description": "Maximum concurrent requests to official VIES endpoint (1 to 4).", "default": 2 }, "maxRunSeconds": { "title": "Max Run Duration (Seconds)", "minimum": 60, "maximum": 3600, "type": "integer", "description": "Hard run deadline. Remaining items are emitted as NOT_ATTEMPTED if time expires.", "default": 1800 } } }, "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 } } } } } } } } } }