{ "openapi": "3.0.1", "info": { "title": "UK PSC Tracker — Beneficial Ownership & Control", "description": "Pull UK Companies House Persons with Significant Control (PSC) — beneficial owners, parent entities, trusts. Returns name, kind, nationality, country, partial DOB, ownership % range, nature_of_control[], appointed_on, ceased_on. AML/KYC/UBO — BvD/Refinitiv/Sayari alt.", "version": "0.0", "x-build-id": "XptJYQbgZIibYTDZB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgendata~uk-psc-beneficial-ownership/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgendata-uk-psc-beneficial-ownership", "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/nexgendata~uk-psc-beneficial-ownership/runs": { "post": { "operationId": "runs-sync-nexgendata-uk-psc-beneficial-ownership", "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/nexgendata~uk-psc-beneficial-ownership/run-sync": { "post": { "operationId": "run-sync-nexgendata-uk-psc-beneficial-ownership", "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": { "companyNumber": { "title": "Company number (exact 8-char Companies House identifier)", "type": "string", "description": "Direct PSC lookup by Companies House company number. UK companies use the 8-character canonical format: 8 digits for England/Wales (e.g. '00445790' for Tesco PLC), 'SC' + 6 digits for Scotland (e.g. 'SC090312' for NatWest Group plc), 'NI' + 6 digits for Northern Ireland. Takes precedence over companyName when both are provided." }, "companyName": { "title": "Company name (partial match, used when companyNumber is blank)", "type": "string", "description": "Partial-match company name search. The actor calls /search/companies and pulls PSC data for the top match. For deterministic results, prefer companyNumber. Examples: 'Tesco', 'BP', 'Wise', 'Brewdog'." }, "includeCeased": { "title": "Include ceased / historical PSCs", "type": "boolean", "description": "When true, also returns PSCs whose control has ceased (e.g. founder who exited at IPO, parent entity sold to a buyer, trust wound up). Useful for AML EDD (was a sanctioned party ever a UBO?), M&A diligence (who held control before the LBO?), and journalism (full beneficial-ownership timeline). Defaults to false for current-only view.", "default": false }, "maxResults": { "title": "Max PSC rows returned", "minimum": 1, "maximum": 200, "type": "integer", "description": "Hard cap on total PSC rows pushed to the dataset (1-200). Each PSC is one row. Pricing is per-row so set this tight on large group sweeps. Typical company: 1-10 PSCs. Some private-equity holdcos return 20+ when ceased PSCs are included.", "default": 50 }, "companyHouseApiKey": { "title": "Companies House API key (REQUIRED)", "type": "string", "description": "REQUIRED. Free Companies House REST API key — register at https://developer.company-information.service.gov.uk (no payment, no enterprise contract, takes ~2 minutes). The free tier enforces a 600 request / 5-minute rolling rate limit per key; this actor handles HTTP 429 with exponential backoff automatically. The key is sent via HTTP Basic auth (username = your API key, password = blank). If this field is left blank, the actor logs an ERROR and exits without pushing any rows and without charging the per-result event — you are NOT billed for a missing-key run." } } }, "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 } } } } } } } } } }