{ "openapi": "3.0.1", "info": { "title": "UK Companies House KYB + GLEIF LEI & Ownership", "description": "UK company lookup & search on the official Companies House API (your free key): status, SIC, office, deadlines, filings, charges, insolvency. Plus keyless GLEIF LEI lookup & direct/ultimate parent chain for any country. No officer/PSC names. Not affiliated with Companies House/GLEIF.", "version": "0.1", "x-build-id": "CzUKkStAHQcrpLrwl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/itulo~uk-companies-house-kyb/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-itulo-uk-companies-house-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/itulo~uk-companies-house-kyb/runs": { "post": { "operationId": "runs-sync-itulo-uk-companies-house-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/itulo~uk-companies-house-kyb/run-sync": { "post": { "operationId": "run-sync-itulo-uk-companies-house-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": { "apiKey": { "title": "Companies House API key", "type": "string", "description": "Your own free REST API key from https://developer.company-information.service.gov.uk/ (Register an application > Create new key > REST, live). Needed for the Companies House modes; the GLEIF modes need no key. Without a key, lookup mode returns GLEIF LEI records for the company numbers instead. Stored encrypted as a secret input and never logged." }, "mode": { "title": "Mode", "enum": [ "lookup", "search", "advanced_search", "gleif_lookup", "gleif_ownership", "gleif_search" ], "type": "string", "description": "Companies House modes (need your free key): lookup, search, advanced_search. GLEIF modes (no key, any country, CC0): gleif_lookup, gleif_ownership (direct and ultimate parent from GLEIF Level 2 data), gleif_search.", "default": "lookup" }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Lookup mode: Companies House numbers, e.g. 00000006, SC123456, OC301540. Leading zeros optional. Max 5,000.", "items": { "type": "string" } }, "query": { "title": "Search text", "type": "string", "description": "Search mode: company name or number." }, "companyNameIncludes": { "title": "Name includes", "type": "string", "description": "Advanced search: words the company name must include." }, "companyNameExcludes": { "title": "Name excludes", "type": "string", "description": "Advanced search: words the company name must not include." }, "companyStatus": { "title": "Company status", "type": "array", "description": "Advanced search: active, dissolved, liquidation, receivership, administration, voluntary-arrangement, converted-closed, insolvency-proceedings, registered, removed, closed, open.", "items": { "type": "string" } }, "companyType": { "title": "Company type", "type": "array", "description": "Advanced search: e.g. ltd, plc, llp, limited-partnership, private-limited-guarant-nsc.", "items": { "type": "string" } }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Advanced search: SIC 2007 codes, e.g. 62020, 70229.", "items": { "type": "string" } }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "Advanced search: YYYY-MM-DD." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "Advanced search: YYYY-MM-DD." }, "dissolvedFrom": { "title": "Dissolved from", "type": "string", "description": "Advanced search: YYYY-MM-DD." }, "dissolvedTo": { "title": "Dissolved to", "type": "string", "description": "Advanced search: YYYY-MM-DD." }, "location": { "title": "Location", "type": "string", "description": "Advanced search: registered-office town/postcode text, e.g. Manchester." }, "leis": { "title": "LEI codes (GLEIF modes)", "type": "array", "description": "gleif_lookup / gleif_ownership: 20-character Legal Entity Identifiers, e.g. 7LTWFZYICNSX8D621K86 (Deutsche Bank). Max 5,000.", "items": { "type": "string" } }, "gleifName": { "title": "GLEIF: legal name", "type": "string", "description": "gleif_search: legal or other name to match." }, "gleifRegisteredAs": { "title": "GLEIF: national register number", "type": "string", "description": "gleif_search: the company's number in its national register (e.g. a UK company number, Finnish Y-tunnus, French SIREN)." }, "gleifCountry": { "title": "GLEIF: country (ISO 3166-1 alpha-2)", "type": "string", "description": "gleif_search: legal-address country filter, e.g. GB, DE, FI." }, "gleifStatus": { "title": "GLEIF: entity status", "enum": [ "ACTIVE", "INACTIVE" ], "type": "string", "description": "gleif_search: optional entity status filter." }, "fetchFullProfiles": { "title": "Fetch full company profiles", "type": "boolean", "description": "Search modes: fetch the full profile (accounts and confirmation-statement dates, previous names, charges/insolvency flags) for every hit. Uses one extra API request per company.", "default": true }, "filingHistoryItems": { "title": "Latest filings per company", "minimum": 0, "maximum": 100, "type": "integer", "description": "Attach the N latest filing-history items (type, date, category, document link). 0 = off. Officer names are removed from filing descriptions.", "default": 0 }, "includeCharges": { "title": "Include charges (mortgages)", "type": "boolean", "description": "Attach registered charges: status, classification, dates. Chargeholder names are not output (count only).", "default": false }, "includeInsolvency": { "title": "Include insolvency cases", "type": "boolean", "description": "Attach insolvency case types and dates (practitioner details are not output).", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Search modes: maximum companies to return.", "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 } } } } } } } } } }