{ "openapi": "3.0.1", "info": { "title": "UK Companies House Officers Search — Director Lookup", "description": "Search UK Companies House officers — directors, secretaries, LLP members — by name / company / number. Returns role, partial DOB, nationality, occupation, country, appointment + resignation, service address. KYC / AML / M&A — Veriff / Onfido / BvD alt.", "version": "0.0", "x-build-id": "L5aBo7uQtVhaz8JJ9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgendata~uk-companies-house-officers/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgendata-uk-companies-house-officers", "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/nexgendata~uk-companies-house-officers/runs": { "post": { "operationId": "runs-sync-nexgendata-uk-companies-house-officers", "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/nexgendata~uk-companies-house-officers/run-sync": { "post": { "operationId": "run-sync-nexgendata-uk-companies-house-officers", "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": { "searchQuery": { "title": "Search query — company name OR officer surname (partial match)", "type": "string", "description": "Partial-match search across UK Companies House. Searches by company name (e.g. 'Tesco', 'Wise', 'Brewdog') OR by officer surname (e.g. 'Steiner', 'Storonsky', 'Dyson'). When a Companies House API key is supplied, this hits the live `/search/companies` endpoint and pulls officers from the top 5 matching companies. With no API key, the actor falls back to a curated public-record universe of ~30 of the most-searched UK entities. Leave blank if using `companyNumber` for a direct lookup." }, "companyNumber": { "title": "Company number (exact, 8-char canonical CH identifier)", "type": "string", "description": "Direct lookup by Companies House company number. UK companies use the 8-character canonical format: 8 digits for England/Wales (e.g. '00445790' for Tesco PLC), 'SC' + 6 digits for Scotland (e.g. 'SC090312' for NatWest Group plc), 'NI' + 6 digits for Northern Ireland. Takes precedence over `searchQuery` when both are provided. Get from any UK company's letterhead, invoice, or website — statutorily required under section 82 of the Companies Act 2006." }, "includeFormerOfficers": { "title": "Include former / resigned officers", "type": "boolean", "description": "When true, returns directors and secretaries who have since resigned (e.g. ex-CEOs, former board members) in addition to currently appointed officers. Useful for M&A diligence (find the prior CEO at the target), journalism (track a director's full appointment history), and KYC red-flag screening (look for officers who resigned just before a striking-off event). Defaults to false to keep results focused on current board composition.", "default": false }, "maxResults": { "title": "Max officer rows returned", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap on total officer rows returned (1-500). Each officer is one dataset row. Pricing is per-row, so set this tight if you're sweeping many companies. Typical KYC lookup: 5-15 officers per target company. M&A diligence sweep across a 5-subsidiary group: 50-100 officers.", "default": 50 }, "companyHouseApiKey": { "title": "Companies House API key (optional — actor uses curated fallback if blank)", "type": "string", "description": "Optional Companies House REST API key for live, real-time access to the full UK register (5M+ active and dissolved entities). Register a free key at https://developer.company-information.service.gov.uk/ — no payment, no enterprise contract. The free tier enforces a 600 requests / 5-minute rolling rate limit per key; this actor handles backoff + retry automatically on HTTP 429. With no key supplied, the actor serves from a curated public-record universe covering ~30 of the most-searched UK entities (FTSE 100 incumbents + UK fintech + dissolved KYC examples)." } } }, "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 } } } } } } } } } }