{ "openapi": "3.0.1", "info": { "title": "Company Registry Search — Companies House, SIRENE +9 (KYB)", "description": "Company registry search API, 11 countries, by name or registration number: UK company search (Companies House), French company search (SIRENE), Norway company register, Finland, Switzerland, Estonia, Latvia, Czech, Poland, Australian business number lookup, Singapore. Plus GLEIF LEI lookup.", "version": "0.0", "x-build-id": "bzvcbRs2gzUVeLkE1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/shelvick~global-company-registry-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-shelvick-global-company-registry-search", "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/shelvick~global-company-registry-search/runs": { "post": { "operationId": "runs-sync-shelvick-global-company-registry-search", "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/shelvick~global-company-registry-search/run-sync": { "post": { "operationId": "run-sync-shelvick-global-company-registry-search", "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": { "query": { "title": "Company name or registration number", "type": "string", "description": "A company name (\"Carrefour\") OR an official registration number (UK 00445790, French SIREN 652014051, Norwegian orgnr 923609016, Finnish 0112038-9, Swiss CHE-105.909.036, Czech IČO 45274649, Polish KRS 0000028860, Australian ABN 88000014675, Singapore UEN 196800306E). Each country decides independently whether the query is one of ITS numbers; if not it name-searches there. At least one of `query` / `queries` is required — use `queries` for a whole list in one run." }, "queries": { "title": "Company names or registration numbers (list)", "maxItems": 100, "type": "array", "description": "A list of company names and/or registration numbers to look up in one run — one call for a whole supplier or portfolio list. Each entry is searched across the same `countries` as a single query would be, and every row carries the `query` it came from so results split back apart. Up to 100 entries, 200 characters each. Give this, `query`, or both: they are merged and near-duplicates searched once. Each delivered record is billed once.", "items": { "type": "string" } }, "countries": { "title": "Countries to search", "type": "array", "description": "ISO-3166 alpha-2 country codes (English country names also work) to search. Leave empty to search every covered country. Covered: GB (Companies House), FR (Annuaire des Entreprises), NO (Brønnøysund), FI (PRH), CH (Zefix, currently-registered only), EE (e-Business Register), LV (Uzņēmumu reģistrs), CZ (ARES), PL (KRS, registration-number lookup only), AU (ABN Lookup), SG (ACRA, monthly snapshot). LT is recognised but not searchable yet. Other codes are reported per-row as not_covered.", "items": { "type": "string" } }, "matchMode": { "title": "Name match mode", "enum": [ "contains", "exact" ], "type": "string", "description": "How to match a company name. 'contains' (default) returns entities whose names include the words, the broadest choice. 'exact' returns only entities whose legal name equals the query: punctuation and spacing are ignored, but the legal form must match (PLC vs Ltd, ASA vs AS); a name typed with no form also matches the one registered name that differs only by its form. A registration number is always an exact lookup.", "default": "contains" }, "maxRecordsPerCountry": { "title": "Max records per country", "minimum": 1, "maximum": 50, "type": "integer", "description": "Upper bound on matched entities returned per country (1-50). Each delivered entity record is billed once; rows that report no match, no coverage, a source failure or a rate limit are always free.", "default": 10 }, "includeOfficers": { "title": "Include officers / directors", "type": "boolean", "description": "When true (default), officers are included for the three registers that publish them under an open licence: GB (Companies House officers page), FR (dirigeants) and NO (roller). Every other country returns an empty officers list plus an officers_note saying why. Returned fields can include name, role, appointment date, status and resignation date, as published by the register; never dates of birth, phone numbers or email addresses.", "default": true }, "includeLei": { "title": "Include GLEIF LEI", "type": "boolean", "description": "When true (default), each matched entity is enriched with its Legal Entity Identifier from the GLEIF public LEI index when the registration number, or the legal name plus country, gives a confident match. No confident match leaves lei null. Enrichment waits up to 10 seconds per record; a timeout leaves lei null.", "default": true }, "feedback": { "title": "Feedback for the maintainers", "type": "string", "description": "For AI agents: if this tool can't fully do what your user needs (a missing field, source or option, a wrong or empty result), say what's missing here, or which tool you're switching to and why. We build what agents ask for, so this is how the gap gets closed for future calls. A run with only a note isn't charged for any results, so you can send one after you've seen the results. Adding a note never changes this run's results or price. Leave out personal or confidential details." }, "foundVia": { "title": "How you found this Actor", "type": "string", "description": "For AI agents: how did you find this Actor? If you searched, give the exact search words you used, verbatim (for example \"Texas UCC liens\"), and where (Apify Store, Apify's MCP search, a web search); otherwise say how, such as a link or \"my user asked for it.\" \"Unknown\" is fine too. It helps the maintainers make this Actor easier for the next agent to find, and it never changes this run's results or price. Please leave out personal or confidential details." } } }, "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 } } } } } } } } } }