{ "openapi": "3.0.1", "info": { "title": "UK Disqualified Directors", "description": "Searches the Companies House register of disqualified company directors by name, company or postcode and returns the start and end dates, the reason, the court, the case reference and the companies involved.", "version": "0.1", "x-build-id": "fhsRSgUxa4hIIqTfX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/spookyweb~uk-disqualified-directors/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-spookyweb-uk-disqualified-directors", "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/spookyweb~uk-disqualified-directors/runs": { "post": { "operationId": "runs-sync-spookyweb-uk-disqualified-directors", "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/spookyweb~uk-disqualified-directors/run-sync": { "post": { "operationId": "run-sync-spookyweb-uk-disqualified-directors", "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": [ "query" ], "properties": { "query": { "title": "Search term", "type": "string", "description": "Who to look for on the disqualified directors register. A surname such as smith, a full name such as john smith, a disqualified company name, or a postcode such as SW1A 1AA. The register is searched by name and by the address the disqualifying authority gave, so a town name on its own will not match." }, "officerType": { "title": "Officer type", "enum": [ "any", "natural", "corporate" ], "type": "string", "description": "Whether to keep disqualified people, disqualified corporate entities, or both. Corporate entries are mostly companies disqualified under sanctions legislation rather than individual directors.", "default": "any" }, "disqualificationType": { "title": "Disqualification type", "enum": [ "any", "Undertaking", "Court order", "Sanction" ], "type": "string", "description": "Keep only officers holding a disqualification of this kind. An undertaking is agreed with the Insolvency Service, a court order is imposed by a judge, and a sanction comes from the UK sanctions list. Read from the officer page, so it turns disqualification details on.", "default": "any" }, "activeOnly": { "title": "Only disqualifications still in force", "type": "boolean", "description": "Drop officers whose disqualification period has already ended. The register keeps entries after they expire, so this is the difference between people who cannot be a director today and people who once could not. Read from the officer page, so it turns disqualification details on.", "default": false }, "fetchDisqualificationDetails": { "title": "Fetch disqualification details", "type": "boolean", "description": "Open each officer page to collect the start and end dates, the reason, the court, the case reference, the nationality and the companies involved. Leave it on. Turning it off returns names and addresses only, and costs one request per officer less.", "default": true }, "maxResults": { "title": "Max officers", "minimum": 1, "maximum": 300, "type": "integer", "description": "Hard cap on how many officers a run returns. Each officer saved is one billable result. The ceiling is 300 because reading one officer page each is what fits inside the 300 second default run timeout, and a run that runs out of time stops cleanly and keeps everything it collected.", "default": 100 }, "maxRecordsScanned": { "title": "Maximum officers to read", "minimum": 20, "maximum": 2000, "type": "integer", "description": "Safety stop on how many officers the run reads before giving up on filling the result cap. It matters when officerType, disqualificationType or activeOnly are narrow, because those are applied after each officer page has been fetched, and a search that matches almost nobody would otherwise read the register until the run is killed.", "default": 400 } } }, "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 } } } } } } } } } }