{ "openapi": "3.0.1", "info": { "title": "Company Registry Lookup (KYB) - Companies House, Sirene, Brreg", "description": "Company registry lookup (KYB) in official business registers - UK Companies House, France Sirene, Norway Brreg, Finland PRH: search by name or registration number for status, legal form, industry codes, address, VAT and officers in one company record. $3.00 per 1,000 company records.", "version": "0.1", "x-build-id": "8WQGr2U3puQwKy3S5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/offgrid-labs~company-registry-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-offgrid-labs-company-registry-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/offgrid-labs~company-registry-lookup/runs": { "post": { "operationId": "runs-sync-offgrid-labs-company-registry-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/offgrid-labs~company-registry-lookup/run-sync": { "post": { "operationId": "run-sync-offgrid-labs-company-registry-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", "required": [ "queries" ], "properties": { "queries": { "title": "Company names or registration numbers", "type": "array", "description": "Required. One per line: a company name (Equinor, Danone, Nokia) or a registration number - Norwegian organisasjonsnummer (923609016), French SIREN/SIRET (552032534), Finnish Business ID / Y-tunnus (0112038-9), UK company number (02627406, SC123456). Numbers are looked up directly in the register that uses that format; names are searched in every selected register.", "items": { "type": "string" } }, "registries": { "title": "Registries", "type": "array", "description": "Official registers to search: no = Norway Brreg (Enhetsregisteret), fr = France Sirene/RNE (Recherche d'entreprises), fi = Finland PRH/YTJ, uk = UK Companies House (needs your free API key below). Default [\"no\", \"fr\", \"fi\"]. Each query is searched in every selected register.", "items": { "type": "string", "enum": [ "no", "fr", "fi", "uk" ], "enumTitles": [ "Norway - Brønnøysund (no key)", "France - Recherche d'entreprises / Sirene (no key)", "Finland - PRH / YTJ (no key)", "UK - Companies House (your free API key)" ] }, "default": [ "no", "fr", "fi" ] }, "maxResultsPerQuery": { "title": "Max results per query per registry", "minimum": 1, "maximum": 100, "type": "integer", "description": "Best name-search matches kept per query in each register (1-100). Default 5. Registration-number lookups return one company. One company = one dataset row = one charged result. Example: 1 for the single best match", "default": 5 }, "activeOnly": { "title": "Active companies only", "type": "boolean", "description": "If true, skip dissolved, deleted, bankrupt or ceased companies. Default false (return all statuses).", "default": false }, "includeOfficers": { "title": "Include officers / directors", "type": "boolean", "description": "If true, adds an officers list (name and role only; birth dates and home addresses are never included). Uses extra requests for Norway and the UK. Default false.", "default": false }, "companiesHouseApiKey": { "title": "Companies House API key", "type": "string", "description": "Required only for the uk registry. Your own free REST API key from developer.company-information.service.gov.uk (Register > Create application > REST key). Stored encrypted; sent only to Companies House." } } }, "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 } } } } } } } } } }