{ "openapi": "3.0.1", "info": { "title": "UK Companies House Search: New Companies & Status Checks", "description": "Verify UK companies by number or list new incorporations by SIC code, location and date from the official Companies House API: status, overdue accounts, insolvency flags. Fast, no browser. No director names or street addresses.", "version": "0.1", "x-build-id": "pqMPytGTzuMWdIYl8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jp-data-lab~uk-companies-house/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jp-data-lab-uk-companies-house", "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/jp-data-lab~uk-companies-house/runs": { "post": { "operationId": "runs-sync-jp-data-lab-uk-companies-house", "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/jp-data-lab~uk-companies-house/run-sync": { "post": { "operationId": "run-sync-jp-data-lab-uk-companies-house", "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 to verify", "type": "array", "description": "Optional, up to 1,000. For example 00000006 or SC123456. When set, the filters below are ignored and every status is included. Numbers with no match are listed in RUN_SUMMARY and are not charged.", "default": [], "items": { "type": "string" } }, "nameContains": { "title": "Name contains", "type": "string", "description": "Keep companies whose registered name contains this text." }, "nameExcludes": { "title": "Name does not contain", "type": "string", "description": "Leave out companies whose registered name contains this text." }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Five-digit SIC 2007 codes, for example 62012 for business and domestic software development.", "default": [], "items": { "type": "string" } }, "industryKeywords": { "title": "Industry keywords", "type": "array", "description": "Words to look up in the official SIC descriptions, for example software or restaurants. Each word adds every SIC code whose description contains it. Up to 60 codes in total.", "default": [], "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Town, city or postcode area of the registered office. For example Manchester or M1. It matches anywhere in the address, so Manchester also finds Altrincham addresses that mention Manchester." }, "statuses": { "title": "Company status", "type": "array", "description": "Leave empty for active companies only.", "items": { "type": "string", "enum": [ "active", "dissolved", "liquidation", "receivership", "administration", "voluntary-arrangement", "converted-closed", "insolvency-proceedings", "removed", "closed", "open" ], "enumTitles": [ "Active", "Dissolved", "Liquidation", "Receivership", "Administration", "Voluntary arrangement", "Converted or closed", "Insolvency proceedings", "Removed", "Closed", "Open" ] }, "default": [ "active" ] }, "companyTypes": { "title": "Company types", "type": "array", "description": "Leave empty for all types.", "items": { "type": "string", "enum": [ "ltd", "plc", "llp", "private-limited-guarant-nsc", "private-limited-guarant-nsc-limited-exemption", "private-unlimited", "limited-partnership", "charitable-incorporated-organisation", "scottish-charitable-incorporated-organisation", "registered-society-non-jurisdictional", "oversea-company", "uk-establishment", "registered-overseas-entity" ], "enumTitles": [ "Private limited company", "Public limited company", "Limited liability partnership", "Limited by guarantee", "Limited by guarantee, 'Limited' exemption", "Private unlimited company", "Limited partnership", "Charitable incorporated organisation", "Scottish charitable incorporated organisation", "Registered society", "Overseas company", "UK establishment", "Overseas entity" ] }, "default": [] }, "incorporatedWithinDays": { "title": "Incorporated within (days)", "minimum": 0, "maximum": 36500, "type": "integer", "description": "Only companies incorporated in the last N days, including today. 0 = no date limit, which reads at most 10,000 companies in the register's own order. Ignored if the dates below are set.", "default": 7 }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Start date, as YYYY-MM-DD." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "End date, as YYYY-MM-DD." }, "includeDetails": { "title": "Include accounts and risk flags", "type": "boolean", "description": "Adds accounts and confirmation statement dates, overdue flags, charges, insolvency history and previous names. Each company takes half a second, so a run is limited to 2,000 companies. Always on when verifying numbers.", "default": false }, "onlyNew": { "title": "Only companies not seen before", "type": "boolean", "description": "For scheduled runs. Skips companies this account already received with the same filters. The first run returns everything that matches.", "default": false }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Total for the run, newest first when a date filter is set. You are charged per result. Not used when verifying numbers.", "default": 100 } } }, "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 } } } } } } } } } }