{
  "openapi": "3.0.1",
  "info": {
    "title": "Companies House UK Company Data - Directors, PSC & Financials",
    "description": "UK Companies House scraper & due-diligence pack: company profile, directors/officers, PSC beneficial owners, charges, filing deadlines, risk flags and parsed iXBRL financials (turnover, profit, net assets). Bulk lookup by company number or name. For KYB, AML, supplier checks, lead enrichment.",
    "version": "0.1",
    "x-build-id": "LjThpZaMTh8KOOpQs"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/rejoicing_shanty~uk-company-due-diligence/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-rejoicing_shanty-uk-company-due-diligence",
        "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/rejoicing_shanty~uk-company-due-diligence/runs": {
      "post": {
        "operationId": "runs-sync-rejoicing_shanty-uk-company-due-diligence",
        "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/rejoicing_shanty~uk-company-due-diligence/run-sync": {
      "post": {
        "operationId": "run-sync-rejoicing_shanty-uk-company-due-diligence",
        "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": "Company numbers",
            "type": "array",
            "description": "UK Companies House company numbers to look up, e.g. 00445790 (England & Wales), SC123456 (Scotland), NI012345, OC300001 (LLP). Leading zeros are added automatically if missing (445790 -> 00445790). Invalid formats return an error record instead of failing the run.",
            "items": {
              "type": "string"
            }
          },
          "companyNames": {
            "title": "Company names",
            "type": "array",
            "description": "Optional company names to resolve via the Companies House search. The first ACTIVE match is used (falls back to the top match). Prefer company numbers when you have them - names can be ambiguous.",
            "items": {
              "type": "string"
            }
          },
          "includeFinancials": {
            "title": "Include financials",
            "type": "boolean",
            "description": "Parse key figures (turnover, profit, net assets, cash, employees etc.) from machine-readable iXBRL accounts in the Companies House Accounts Data Product. Companies that file PDF/paper accounts (common for large groups) return filing links but no figures.",
            "default": true
          },
          "accountsFilings": {
            "title": "Accounts filings to check",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "How many of the most recent annual accounts filings to look at per company (each filing usually also contains the prior-year comparatives).",
            "default": 2
          },
          "maxPeriods": {
            "title": "Max financial periods",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Maximum number of fiscal year-ends to return in financials.periods (newest first).",
            "default": 4
          },
          "includeOfficers": {
            "title": "Include officers",
            "type": "boolean",
            "description": "Return directors and secretaries (name, role, appointed/resigned dates, nationality, occupation, country of residence).",
            "default": true
          },
          "activeOfficersOnly": {
            "title": "Active officers only",
            "type": "boolean",
            "description": "If true, only currently serving officers are returned; if false, resigned officers are included too.",
            "default": true
          },
          "maxOfficers": {
            "title": "Max officers",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Maximum officers returned per company.",
            "default": 50
          },
          "includePsc": {
            "title": "Include persons with significant control",
            "type": "boolean",
            "description": "Return persons with significant control (beneficial owners) and any PSC statements/exemptions.",
            "default": true
          },
          "includeCharges": {
            "title": "Include charges",
            "type": "boolean",
            "description": "Return registered charges (mortgages/secured debt) with outstanding/satisfied status and lender names.",
            "default": true
          },
          "maxCharges": {
            "title": "Max charges",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Maximum charges returned per company.",
            "default": 25
          },
          "maxCompanies": {
            "title": "Max companies",
            "minimum": 1,
            "type": "integer",
            "description": "Hard cap on the number of companies processed in this run (after de-duplication).",
            "default": 1000
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Companies processed in parallel (1-10). Requests to Companies House are rate limited regardless.",
            "default": 3
          },
          "requestsPerSecond": {
            "title": "Requests per second",
            "minimum": 0.2,
            "maximum": 2,
            "type": "number",
            "description": "Polite request rate to the Companies House register (capped at 2.0).",
            "default": 1.6
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}