{ "openapi": "3.0.1", "info": { "title": "UK Company KYB Check — Companies House Officers, PSC, Charges", "description": "Verify UK companies in bulk from official Companies House data: profile, officers, beneficial owners (PSC), charges, filing history, insolvency and risk flags with a KYB score. Pay per company.", "version": "0.1", "x-build-id": "vFKGkBgnXLPOKeZBP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/registrylens~uk-company-kyb/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-registrylens-uk-company-kyb", "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/registrylens~uk-company-kyb/runs": { "post": { "operationId": "runs-sync-registrylens-uk-company-kyb", "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/registrylens~uk-company-kyb/run-sync": { "post": { "operationId": "run-sync-registrylens-uk-company-kyb", "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": { "companyNumbers": { "title": "Company numbers", "maxItems": 1000, "type": "array", "description": "Companies House company numbers, one per line (8 characters, e.g. 00445790 or SC123456). Digits-only values are zero-padded automatically.", "default": [ "00445790", "00041424" ], "items": { "type": "string" } }, "companyNames": { "title": "Company names (resolved by search)", "maxItems": 500, "type": "array", "description": "Company names to resolve to company numbers via Companies House search. The best match above the minimum match score is checked; others are reported as unresolved and not charged.", "default": [], "items": { "type": "string" } }, "minMatchScore": { "title": "Minimum name match score", "minimum": 0, "maximum": 1, "type": "number", "description": "Similarity (0–1) a search hit must reach to count as the company you meant. Legal-form suffixes such as LTD or PLC are ignored when comparing.", "default": 0.8 }, "sections": { "title": "Sections to fetch", "type": "array", "description": "Company profile and registered office are always included. Select which additional sections to fetch for every company.", "items": { "type": "string", "enum": [ "officers", "psc", "charges", "filingHistory", "insolvency" ], "enumTitles": [ "Officers", "Persons with significant control (PSC)", "Charges (mortgages)", "Filing history", "Insolvency" ] }, "default": [ "officers", "psc", "charges", "filingHistory", "insolvency" ] }, "maxItemsPerSection": { "title": "Max items per section", "minimum": 1, "maximum": 500, "type": "integer", "description": "Cap for officers, PSCs, charges and filings returned per company. Higher values cost more API requests but not more credits.", "default": 50 }, "includeResignedOfficers": { "title": "Include resigned officers", "type": "boolean", "description": "Also return officers who have resigned (with their resignation date).", "default": false }, "maxUnresolved": { "title": "Max free failures per run", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stop the run once this many inputs came back not found or unresolved. Failures are free for you but cost Companies House requests; the cap stops a stale list from burning through the request budget.", "default": 50 }, "apiKey": { "title": "Your own Companies House API key", "type": "string", "description": "Free at https://developer.company-information.service.gov.uk/. Optional up to 500 companies per run; required above that. With your own key the run gets the full dedicated rate limit (600 requests per 5 minutes)." } } }, "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 } } } } } } } } } }