{ "openapi": "3.0.1", "info": { "title": "UK Company Risk Report (Companies House + Gazette)", "description": "Returns a plain-English risk report for any UK company from the official Companies House API and The Gazette: status, overdue filings, strike-off, director track record, PSCs, charges, insolvency, as red/amber/green flags and a verdict. Inputs: company numbers or names. Agent-ready, pay per report.", "version": "0.1", "x-build-id": "6W1QbOkWXmDFU6GwJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nerolabs~uk-company-risk-report/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nerolabs-uk-company-risk-report", "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/nerolabs~uk-company-risk-report/runs": { "post": { "operationId": "runs-sync-nerolabs-uk-company-risk-report", "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/nerolabs~uk-company-risk-report/run-sync": { "post": { "operationId": "run-sync-nerolabs-uk-company-risk-report", "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": "Companies (numbers or names)", "type": "array", "description": "One entry per company to report on. An 8-character Companies House number (e.g. 00445790) is matched exactly. A name (e.g. \"Carillion plc\") is searched on the register: a unique exact match proceeds to a full report; anything ambiguous returns the candidate list instead, so nothing is reported on the wrong company.", "items": { "type": "string" } }, "includeGazette": { "title": "Check The Gazette for insolvency notices", "type": "boolean", "description": "Searches The Gazette's corporate insolvency notices (winding-up petitions, administrations, liquidations) by the company's exact current and previous names. A winding-up petition appears here before anything changes on Companies House. The Gazette rate-limits callers; if a search is refused the report says so rather than silently reporting no notices.", "default": true }, "checkDirectorHistory": { "title": "Check each active director's other appointments", "type": "boolean", "description": "For each active director (up to the limit below), counts their other current appointments and how many of their past companies are dissolved or insolvent, from the Companies House officer appointments endpoint. A director with a long trail of dissolved companies is flagged amber.", "default": true }, "checkDisqualifications": { "title": "Check the disqualified directors register", "type": "boolean", "description": "Searches the Companies House disqualified officers register by each active director's name. A name match is reported as a possible match needing a manual check (amber), never asserted as a confirmed disqualification, because the register is searched by name only.", "default": true }, "maxOfficerChecks": { "title": "Max directors to cross-check per company", "minimum": 0, "maximum": 25, "type": "integer", "description": "Caps the per-director appointment and disqualification lookups to keep large companies fast and within the Companies House rate limit (600 calls per 5 minutes). Directors beyond the cap are listed but not cross-checked, and the report says so.", "default": 8 }, "includeMarkdown": { "title": "Include a Markdown version of each report", "type": "boolean", "description": "Adds a reportMarkdown field with the whole report as readable Markdown, handy for pasting into a CRM note, an email, or an AI agent's context.", "default": true } } }, "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 } } } } } } } } } }