{ "openapi": "3.0.1", "info": { "title": "UK Company KYB: Companies House, Officers, PSC & Insolvency", "description": "UK company data for KYB and KYC. Enrich a company number (CRN) or name from Companies House: status, registered office, SIC, directors, PSC beneficial owners, charges, overdue accounts and insolvency, plus The Gazette.", "version": "1.0", "x-build-id": "kP7k3cPG5fg7f0RV6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datacraft-studio~uk-company-enrichment/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datacraft-studio-uk-company-enrichment", "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/datacraft-studio~uk-company-enrichment/runs": { "post": { "operationId": "runs-sync-datacraft-studio-uk-company-enrichment", "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/datacraft-studio~uk-company-enrichment/run-sync": { "post": { "operationId": "run-sync-datacraft-studio-uk-company-enrichment", "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": [ "companies" ], "properties": { "companies": { "title": "Company numbers or names", "type": "array", "description": "UK company numbers (CRN) or registered names, one per item. Numbers are normalised to 8 characters. Examples: 00445790, SC123456, NI012345, OC123456, LP123456.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "enrich", "monitor" ], "type": "string", "description": "enrich returns a row per company. monitor stores a snapshot in the named key-value store and returns a row only when something material changed. The first monitor run is a free baseline.", "default": "enrich" }, "includeOfficers": { "title": "Include officers", "type": "boolean", "description": "Directors, LLP members, and secretaries. Adds the officers-psc charge in enrich mode when the register responds. Required to detect appointments and resignations in monitor mode.", "default": true }, "includePsc": { "title": "Include PSCs (beneficial owners)", "type": "boolean", "description": "Persons with significant control. Protected (super-secure) PSCs are flagged without personal details. Shares the officers-psc charge with officers.", "default": true }, "includeCharges": { "title": "Include charges", "type": "boolean", "description": "Mortgage charge register. Also fetched when the profile has has_charges or links.charges, even if this is off. Included in the company-enriched price.", "default": false }, "includeFilings": { "title": "Include recent filings", "type": "boolean", "description": "Latest filing-history page (25 items). Accounts and confirmation-statement dates and overdue flags come from the profile either way.", "default": false }, "includeInsolvency": { "title": "Always include insolvency cases", "type": "boolean", "description": "When off, the insolvency endpoint is still called if the profile shows has_insolvency_history, has_been_liquidated, links.insolvency, or an insolvency status.", "default": false }, "gazetteNotices": { "title": "Gazette insolvency notices", "enum": [ "auto", "always", "off" ], "type": "string", "description": "The Gazette public notice feed needs no API key. auto searches only when Companies House already shows insolvency, liquidation, or a strike-off proposal. always searches every company. off skips The Gazette. Fair use is 5 requests per 10 seconds.", "default": "auto" }, "companiesHouseApiKey": { "title": "Companies House API key", "type": "string", "description": "Optional. Overrides the COMPANIES_HOUSE_API_KEY secret for this run. Sent as the HTTP Basic username. Leave blank to use the Actor secret." }, "snapshotStoreName": { "title": "Monitor snapshot store", "type": "string", "description": "Named key-value store for monitor snapshots. Persists across runs on the Apify account that executes the Actor.", "default": "uk-company-monitor" }, "maxCompanies": { "title": "Maximum companies", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Caps how many input items are processed in one run.", "default": 1000 }, "activeOfficersOnly": { "title": "Active officers only", "type": "boolean", "description": "Hide resigned officers from the output list. Monitor diffs still use the full fetched page.", "default": false } } }, "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 } } } } } } } } } }