{ "openapi": "3.0.1", "info": { "title": "UK Company Filing & Compliance Tracker", "description": "Monitor UK company filing activity and compliance signals from public registry records. Track filing history, accounts due dates, confirmation statement due dates, company status, recent changes, and source URLs for accountants, lenders, compliance teams, and B2B service providers.", "version": "0.0", "x-build-id": "vUN4xU9cVi2OrEYoF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lead.gen.labs~uk-company-filing-compliance-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lead.gen.labs-uk-company-filing-compliance-tracker", "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/lead.gen.labs~uk-company-filing-compliance-tracker/runs": { "post": { "operationId": "runs-sync-lead.gen.labs-uk-company-filing-compliance-tracker", "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/lead.gen.labs~uk-company-filing-compliance-tracker/run-sync": { "post": { "operationId": "run-sync-lead.gen.labs-uk-company-filing-compliance-tracker", "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": [ "max_companies" ], "properties": { "company_numbers": { "title": "Company Numbers", "type": "array", "description": "Companies House company numbers to monitor. Leave empty to discover candidates from search terms or locations.", "items": { "type": "string" }, "default": [] }, "search_terms": { "title": "Search Terms", "type": "array", "description": "Company-name search terms used when company numbers are not supplied.", "items": { "type": "string" }, "default": [ "limited" ] }, "locations": { "title": "Locations", "type": "array", "description": "Optional registered office address filters for Companies House advanced-search discovery.", "items": { "type": "string" }, "default": [ "London" ] }, "company_statuses": { "title": "Company Statuses", "uniqueItems": true, "type": "array", "description": "Companies House status filters used for location-based discovery.", "items": { "type": "string", "enum": [ "active", "dissolved", "open", "closed", "converted-closed", "removed", "receivership", "liquidation", "administration", "insolvency-proceedings", "voluntary-arrangement" ], "enumTitles": [ "Active", "Dissolved", "Open", "Closed", "Converted closed", "Removed", "Receivership", "Liquidation", "Administration", "Insolvency proceedings", "Voluntary arrangement" ] }, "default": [ "active" ] }, "company_types": { "title": "Company Types", "uniqueItems": true, "type": "array", "description": "Optional entity type filters for location-based discovery.", "items": { "type": "string", "enum": [ "ltd", "llp", "plc", "private-limited-guarant-nsc", "private-unlimited", "limited-partnership", "oversea-company", "registered-overseas-entity", "uk-establishment" ], "enumTitles": [ "Private limited company", "Limited liability partnership", "Public limited company", "Private limited by guarantee", "Private unlimited company", "Limited partnership", "Overseas company", "Overseas entity", "UK establishment company" ] }, "default": [] }, "filing_categories": { "title": "Filing Categories", "uniqueItems": true, "type": "array", "description": "Filing categories to include in the monitor output.", "items": { "type": "string", "enum": [ "all", "accounts", "confirmation-statement", "officers", "psc", "address", "risk", "other" ], "enumTitles": [ "All filings", "Accounts", "Confirmation statements", "Officers", "PSC", "Registered office address", "Risk and strike-off", "Other" ] }, "default": [ "all" ] }, "lookback_days": { "title": "Filing Lookback Days", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Only include filings from this many days back. Use 0 to include all fetched filings.", "default": 90 }, "due_soon_days": { "title": "Due Soon Days", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Flag accounts or confirmation statements as due soon when the due date falls within this many days.", "default": 30 }, "max_companies": { "title": "Maximum Companies", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum company profiles to monitor and save.", "default": 100 }, "max_pages_per_location": { "title": "Maximum Discovery Pages per Location", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum advanced-search result pages to fetch per selected location when discovering companies.", "default": 2 }, "max_filing_pages_per_company": { "title": "Maximum Filing Pages per Company", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum filing-history pages to fetch for each company.", "default": 2 }, "include_officers": { "title": "Include Officers", "type": "boolean", "description": "Fetch director and secretary details from the People tab.", "default": true }, "include_psc": { "title": "Include PSC People", "type": "boolean", "description": "Fetch persons with significant control when available.", "default": true }, "extract_emails": { "title": "Extract Public Emails", "type": "boolean", "description": "Extract public email addresses if they appear on fetched Companies House pages.", "default": true }, "request_delay_millis": { "title": "Request Delay", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Delay between requests in milliseconds.", "default": 750 }, "browser_impersonation": { "title": "Browser Impersonation", "type": "string", "description": "curl_cffi browser impersonation profile.", "default": "chrome136" }, "custom_proxy_url": { "title": "Custom Proxy URL", "type": "string", "description": "Optional proxy URL.", "default": "" } } }, "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 } } } } } } } } } }