{ "openapi": "3.0.1", "info": { "title": "UK Company Distress Check: Status, Filings, Insolvency", "description": "Check if a UK company is insolvent or in distress. One row per company number: Companies House status, overdue accounts, charges, insolvency cases and Gazette insolvency notices, with a distress level. No API key needed. Unknown numbers are never charged.", "version": "1.0", "x-build-id": "U2SbWNjBSXB7pGeu7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/accountable_eel~uk-company-distress-check/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-accountable_eel-uk-company-distress-check", "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/accountable_eel~uk-company-distress-check/runs": { "post": { "operationId": "runs-sync-accountable_eel-uk-company-distress-check", "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/accountable_eel~uk-company-distress-check/run-sync": { "post": { "operationId": "run-sync-accountable_eel-uk-company-distress-check", "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": "Which UK companies do you want checked?", "type": "array", "description": "One Companies House company number per line, e.g. 00445790 or SC012345. Leading zeros may be left off, and a Companies House company page URL works too. Each company gets one row: status, overdue filings, charges, insolvency cases and any Gazette insolvency notice, with a distress level. No key needed. Accepted formats: 00445790, SC012345, 445790, https://find-and-update.company-information.service.gov.uk/company/00445790. You're only charged for the ones we actually find — a miss costs nothing.", "items": { "type": "string" } }, "testRun": { "title": "Try it first — only process the first 5", "type": "boolean", "description": "Turn this on to test your input on a small sample before running the full list. Turn it off to process everything.", "default": false }, "onlyFound": { "title": "Hide rows with no result", "type": "boolean", "description": "Only keep rows where something was actually found. Misses are always free, whether or not you show them here.", "default": false }, "includeKeywords": { "title": "Only keep rows containing", "type": "array", "description": "Optional. Only keep results that mention at least one of these words (e.g. a job title, a city, a product name). Leave empty to keep everything.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Skip rows containing", "type": "array", "description": "Optional. Drop any result that mentions one of these words. Leave empty to skip nothing.", "items": { "type": "string" } }, "maxResults": { "title": "Stop after this many results", "minimum": 1, "type": "integer", "description": "Optional. Stop the run once this many results have been found — useful for a quick, cheap sample. Leave blank for no limit." }, "columns": { "title": "Which columns do you want?", "type": "array", "description": "Choose which pieces of information to include in each result row. All are included by default.", "items": { "type": "string", "enum": [ "companyNumber", "companyName", "distressLevel", "distressFlags", "companyStatus", "companyStatusText", "companyType", "dateOfCreation", "dateOfCessation", "accountsNextDueDate", "accountsOverdue", "lastAccountsMadeUpTo", "confirmationStatementNextDueDate", "confirmationStatementOverdue", "strikeOffProposed", "hasInsolvencyHistory", "insolvencyCaseCount", "latestInsolvencyCaseType", "insolvencyCases", "chargesTotal", "chargesOutstanding", "chargesSatisfied", "chargesPartSatisfied", "latestChargeCreatedOn", "gazetteNoticeCount", "latestGazetteNoticeDate", "latestGazetteNoticeType", "gazetteNotices", "previousCompanyNames", "checksRun", "checkNotes", "source", "sourceUrl", "gazetteSearchUrl" ], "enumTitles": [ "Company number", "Company name", "Distress level", "Distress flags", "Status", "Status as printed", "Company type", "Incorporated on", "Dissolved on", "Accounts due by", "Accounts overdue", "Last accounts made up to", "Confirmation statement due by", "Confirmation statement overdue", "Strike-off proposed", "Insolvency history", "Insolvency cases", "Latest insolvency case", "Insolvency cases (list)", "Charges registered", "Charges outstanding", "Charges satisfied", "Charges part satisfied", "Latest charge created", "Gazette insolvency notices", "Latest Gazette notice", "Latest Gazette notice type", "Gazette notices (list)", "Previous names", "Checks run", "Notes", "Companies House route", "Companies House page", "Gazette search" ] }, "default": [ "companyNumber", "companyName", "distressLevel", "distressFlags", "companyStatus", "companyStatusText", "companyType", "dateOfCreation", "dateOfCessation", "accountsNextDueDate", "accountsOverdue", "lastAccountsMadeUpTo", "confirmationStatementNextDueDate", "confirmationStatementOverdue", "strikeOffProposed", "hasInsolvencyHistory", "insolvencyCaseCount", "latestInsolvencyCaseType", "insolvencyCases", "chargesTotal", "chargesOutstanding", "chargesSatisfied", "chargesPartSatisfied", "latestChargeCreatedOn", "gazetteNoticeCount", "latestGazetteNoticeDate", "latestGazetteNoticeType", "gazetteNotices", "previousCompanyNames", "checksRun", "checkNotes", "source", "sourceUrl", "gazetteSearchUrl" ] }, "apiKey": { "title": "Your free Companies House API key (optional)", "type": "string", "description": "Leave empty: the actor reads the public Companies House register and needs no key. With your own key the same record is read from the Companies House API instead (600 requests per 5 minutes, your own quota). A free key is issued at once at developer.company-information.service.gov.uk when you register a REST application. The key is used for this run only and never appears in a row." }, "includeGazette": { "title": "Check The Gazette for insolvency notices", "type": "boolean", "description": "On by default. The Gazette asks for 10 seconds between requests, so each company adds 10 seconds to the run. Turn it off for a long list when Companies House status, filings, charges and insolvency cases are enough.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Parallel requests. Keep conservative — this target has no browser fallback, so getting blocked costs more than slow-and-steady.", "default": 3 } } }, "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 } } } } } } } } } }