{ "openapi": "3.0.1", "info": { "title": "Swiss VAT (MWST/TVA) & UID Validator – Official Register", "description": "Bulk-validate Swiss UID and VAT numbers (CHE-xxx.xxx.xxx MWST/TVA/IVA) against the official federal UID register, the source VIES does not cover. Returns VAT status, company name, legal form, address, commercial-register number and LEI. Name search included.", "version": "1.0", "x-build-id": "npWxF5qWi1nJKxcho" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/characteristic_division~swiss-uid-vat-validator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-characteristic_division-swiss-uid-vat-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/characteristic_division~swiss-uid-vat-validator/runs": { "post": { "operationId": "runs-sync-characteristic_division-swiss-uid-vat-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/characteristic_division~swiss-uid-vat-validator/run-sync": { "post": { "operationId": "run-sync-characteristic_division-swiss-uid-vat-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", "properties": { "identifiers": { "title": "UID / VAT numbers", "maxItems": 10000, "type": "array", "description": "Swiss UID or VAT numbers in any common format: CHE-105.829.940, CHE105829940, CHE-105.829.940 MWST / TVA / IVA, or just the 9 digits. Duplicates are looked up once. Numbers with a wrong check digit are rejected instantly (no register call).", "items": { "type": "string" } }, "companyNames": { "title": "Company names (optional search)", "maxItems": 2000, "type": "array", "description": "Find UIDs / VAT numbers by company name (e.g. to enrich a supplier list). Each name returns up to 'Max results per name' matches with a relevance rating.", "items": { "type": "string" } }, "maxResultsPerName": { "title": "Max results per name", "minimum": 1, "maximum": 30, "type": "integer", "description": "Maximum matches returned for each company name (register maximum is 30).", "default": 5 }, "searchMode": { "title": "Name search mode", "enum": [ "Auto", "Normal", "Fuzzy" ], "type": "string", "description": "Auto = register default; Normal = exact-ish; Fuzzy = tolerant to typos.", "default": "Auto" }, "includeInactive": { "title": "Include deleted/inactive companies in name search", "type": "boolean", "description": "Identifier lookups always report the status. For name search, inactive (deleted) entities are skipped unless this is on.", "default": false }, "includeSoleProprietorNames": { "title": "Show names/street of sole proprietorships", "type": "boolean", "description": "Sole proprietorships (legal form 0101) are named after a natural person. By default their name and street address are redacted (GDPR/nDSG data minimisation); VAT status, town and canton are still returned. Enable only if you have a legitimate purpose.", "default": false }, "requestIntervalMs": { "title": "Delay between register requests (ms)", "minimum": 3000, "maximum": 60000, "type": "integer", "description": "The public UID service allows 20 requests/minute. Values below 3000 are raised to 3000.", "default": 3100 } } }, "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 } } } } } } } } } }