{
  "openapi": "3.0.1",
  "info": {
    "title": "UK Company Check: Companies House Risk Flags",
    "description": "Check UK companies on the official Companies House register: status, age, SIC codes, accounts and confirmation deadlines, insolvency, charges, officer and PSC counts, and risk flags that name the field they come from. Or get a daily feed of new companies by SIC code.",
    "version": "0.1",
    "x-build-id": "yqn6D38dyGO43eAwR"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/lone_rachis~uk-company-check/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-lone_rachis-uk-company-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/lone_rachis~uk-company-check/runs": {
      "post": {
        "operationId": "runs-sync-lone_rachis-uk-company-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/lone_rachis~uk-company-check/run-sync": {
      "post": {
        "operationId": "run-sync-lone_rachis-uk-company-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": {
          "mode": {
            "title": "What to do",
            "enum": [
              "check",
              "new-companies"
            ],
            "type": "string",
            "description": "check: one row per company you list below, by number or name. new-companies: one row per company incorporated in a date window, filtered by SIC code, location and company type; run it daily on a schedule for a feed of new UK companies.",
            "default": "check"
          },
          "companies": {
            "title": "Companies to check",
            "maxItems": 5000,
            "type": "array",
            "description": "Check mode. Company numbers (8 characters, such as 00445790, SC123456 or OC447623; shorter numbers are padded with zeros) or exact company names, one per line. A name is looked up in Companies House's name search and must match a registered name exactly, apart from case, punctuation and LIMITED or LTD. Each company costs 4 requests (3 with Skip charges), so with the built-in key a run checks at most 25.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "acceptClosestNameMatch": {
            "title": "Accept the closest name",
            "type": "boolean",
            "description": "Check mode. When a name has no exact match on the register, use the first result of the name search instead of returning a free not-found row. The row then says matchedBy closest-name. Off by default, because the first result can be a different company.",
            "default": false
          },
          "skipCharges": {
            "title": "Skip charges",
            "type": "boolean",
            "description": "Check mode. Leave out the charges lookup, saving 1 request per company. The charge fields are then empty, chargesChecked is false, and the outstanding_charges flag cannot be raised. Off by default: the profile's own has_charges field was false on every profile read on 13 Oct 2026, also for companies with outstanding charges, so the Actor reads the charges list itself.",
            "default": false
          },
          "includeFilingActivity": {
            "title": "Include filing activity",
            "type": "boolean",
            "description": "Check mode. Also count the filings of the last 12 months and report the date and form type of the latest one. Costs 1 more request per company, up to 3 for very busy companies (more than 100 filings a year; the count is then a minimum). Off by default.",
            "default": false
          },
          "incorporatedFrom": {
            "title": "Incorporated from",
            "type": "string",
            "description": "New-companies mode. First incorporation date of the window, YYYY-MM-DD. Leave both dates empty for the last full days set below, which is what a daily schedule wants. With only this date set, the window runs to yesterday."
          },
          "incorporatedTo": {
            "title": "Incorporated to",
            "type": "string",
            "description": "New-companies mode. Last incorporation date of the window, YYYY-MM-DD, at most today (London time). Today's companies are still being added during the day, so a window that ends yesterday is complete."
          },
          "incorporatedInLastDays": {
            "title": "Days to read when no dates are set",
            "minimum": 1,
            "maximum": 31,
            "type": "integer",
            "description": "New-companies mode. When both dates are empty, read the last this many full days before today, London time. 1 means yesterday; 7 means the last week.",
            "default": 1
          },
          "sicCodes": {
            "title": "SIC codes",
            "maxItems": 200,
            "type": "array",
            "description": "New-companies mode. Keep companies with at least one of these SIC 2007 codes, one per line. Use a 5-digit code from Companies House's condensed list, such as 62020 (information technology consultancy), or 2 to 4 digits for every code under them, such as 62 for computer programming and consultancy. Leave empty for every industry.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "location": {
            "title": "Location",
            "type": "string",
            "description": "New-companies mode. Keep companies whose registered office address matches this text, such as Manchester or London. Matched by Companies House's search, without regard to case. Leave empty for anywhere."
          },
          "companyTypes": {
            "title": "Company types",
            "uniqueItems": true,
            "type": "array",
            "description": "New-companies mode. Keep companies of these types. Leave empty for every type. About 97% of new companies are private limited companies (ltd).",
            "items": {
              "type": "string",
              "enum": [
                "ltd",
                "plc",
                "llp",
                "limited-partnership",
                "private-limited-guarant-nsc",
                "private-limited-guarant-nsc-limited-exemption",
                "private-unlimited",
                "private-unlimited-nsc",
                "uk-establishment",
                "oversea-company",
                "registered-overseas-entity",
                "scottish-partnership",
                "european-public-limited-liability-company-se",
                "eeig",
                "ukeig",
                "protected-cell-company",
                "further-education-or-sixth-form-college-corporation"
              ],
              "enumTitles": [
                "Private limited company (ltd)",
                "Public limited company (plc)",
                "Limited liability partnership (llp)",
                "Limited partnership",
                "Private company limited by guarantee, no share capital",
                "Private company limited by guarantee, \"Limited\" exemption",
                "Private unlimited company",
                "Private unlimited company, no share capital",
                "UK establishment of an overseas company",
                "Overseas company",
                "Registered overseas entity",
                "Scottish qualifying partnership",
                "European public limited liability company (SE)",
                "European Economic Interest Grouping",
                "United Kingdom Economic Interest Grouping",
                "Protected cell company",
                "Further education or sixth form college corporation"
              ]
            },
            "default": []
          },
          "maxResults": {
            "title": "Maximum rows per run",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "New-companies mode. Optional. Stop after delivering this many companies. Leave empty for the cap of your key: 500 rows with the built-in trial key, 10,000 with your own. Use Maximum cost per run to cap spending."
          },
          "apiKey": {
            "title": "Your Companies House API key",
            "type": "string",
            "description": "Optional, and recommended. A REST API key from your own free Companies House developer account (the README shows how to get one in three steps). With it the run uses your own share of the rate limit (600 requests per 5 minutes) and checks up to 5,000 companies or 10,000 rows. Without it the run uses the Actor's built-in key, shared by every user, capped at 25 companies or 500 rows per run. The key is stored encrypted and is never written to the output or the log."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}