{ "openapi": "3.0.1", "info": { "title": "EU Company Register: UK, FR, NO, FI, PL, CZ, SK, IE, RO, CH", "description": "Look up companies by name or registration number in official registers (UK, France, Norway, Finland, Poland, Czechia, Slovakia, Ireland, Romania, Switzerland, GLEIF) and confirm an EU VAT number on VIES when a state has no free register. Company data only.", "version": "0.1", "x-build-id": "lPBCsppmM8t8lvOJm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mikee368~eu-company-register-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mikee368-eu-company-register-lookup", "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/mikee368~eu-company-register-lookup/runs": { "post": { "operationId": "runs-sync-mikee368-eu-company-register-lookup", "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/mikee368~eu-company-register-lookup/run-sync": { "post": { "operationId": "run-sync-mikee368-eu-company-register-lookup", "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": { "queries": { "title": "Company names or registration numbers", "type": "array", "description": "Company names or registration numbers, one per line. Recognised IDs (validated by check digit): SIREN/SIRET or FR VAT, Norwegian org.nr. or NO…MVA, Y-tunnus or FI VAT, UK company number, LEI, Polish NIP/REGON/KRS, Czech IČO, Slovak IČO, Irish CRO number, Romanian CUI, Swiss UID, and an EU VAT number (VIES) for a state with no free register. IDs go only to the matching register. Names go to every selected register that supports name search. Poland and Romania have no free name search.", "default": [ "nokia" ], "items": { "type": "string" } }, "sources": { "title": "Registers", "type": "array", "description": "Which official registers to query.", "items": { "type": "string", "enum": [ "UK_COMPANIES_HOUSE", "FR_SIRENE", "NO_BRREG", "FI_PRH", "PL_REJESTR", "CZ_ARES", "SK_RPO", "IE_CRO", "RO_ANAF", "CH_UID", "EU_VIES", "GLEIF_LEI" ], "enumTitles": [ "UK Companies House (free API key needed)", "France SIRENE / RNE", "Norway Brønnøysund", "Finland PRH / YTJ", "Poland KRS and VAT white list (NIP, KRS, REGON)", "Czechia ARES (name or IČO)", "Slovakia RPO (name or IČO, CC BY 4.0)", "Ireland CRO open data (CC BY 4.0)", "Romania ANAF (CUI only, 1 request/s)", "Switzerland UID register (20 requests/min)", "EU VIES fallback (VAT number, no national register)", "GLEIF LEI (global)" ] }, "default": [ "GLEIF_LEI" ] }, "maxResultsPerQuery": { "title": "Max results per query per register", "minimum": 1, "maximum": 100, "type": "integer", "description": "Best-ranked matches kept for each query in each register (exact name first, then names starting with the query, then whole-word matches).", "default": 2 }, "maxItemsPerSource": { "title": "Max companies per register (whole run)", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Overall cap per register across all queries, which also caps cost.", "default": 5 }, "matchMode": { "title": "Name matching", "enum": [ "strict", "balanced", "loose" ], "type": "string", "description": "strict = exact, starts-with or whole-word name matches only (relevance ≥ 75); balanced = also partial words such as 'Nokian …' for 'nokia' (≥ 50); loose = everything the register's search returns.", "default": "strict" }, "includeNonCompanies": { "title": "Include non-company entities", "type": "boolean", "description": "Also return associations, foundations, works councils (CSE), trade unions, housing companies, funds and public bodies. Off by default.", "default": false }, "excludeSoleTraders": { "title": "Exclude sole traders", "type": "boolean", "description": "Skip one-person businesses (e.g. Norwegian ENK, French entrepreneur individuel), whose names are personal data. Recommended for GDPR.", "default": true }, "onlyActive": { "title": "Only active companies", "type": "boolean", "description": "Drop dissolved, struck-off, bankrupt or lapsed entities.", "default": false }, "dateFrom": { "title": "Incorporated on or after", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional. Only companies registered/incorporated on or after this date (YYYY-MM-DD). Useful for new-company lead lists." }, "enrichLei": { "title": "Add LEI to national results", "type": "boolean", "description": "Look up each national result in GLEIF by its registration number and add the LEI (free, no key; GLEIF allows ~60 requests/minute, so this adds ~1 s per company).", "default": false }, "mergeDuplicates": { "title": "Merge GLEIF duplicates", "type": "boolean", "description": "If GLEIF returns a company that a national register already returned (same LEI or registration number), keep one row: the national data plus the LEI, with 'sources' listing both.", "default": true }, "companiesHouseApiKey": { "title": "Companies House API key (optional)", "type": "string", "description": "Free key from developer.company-information.service.gov.uk. Without it the UK register is skipped." } } }, "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 } } } } } } } } } }