{
  "openapi": "3.0.1",
  "info": {
    "title": "Company Registry Lookup: LEI, Norway, Czechia, Finland",
    "description": "Weekly lists of newly registered companies (UK Companies House with your API key, Norway, Finland, GLEIF). France has name and SIREN search and is not in the new-company list. Czechia and Poland lookup too. Company data only. Not affiliated with any registry.",
    "version": "1.1",
    "x-build-id": "avdu5AQflSVbQVrZA"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/mmdincer~company-registry-lookup/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-mmdincer-company-registry-lookup",
        "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/mmdincer~company-registry-lookup/runs": {
      "post": {
        "operationId": "runs-sync-mmdincer-company-registry-lookup",
        "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/mmdincer~company-registry-lookup/run-sync": {
      "post": {
        "operationId": "run-sync-mmdincer-company-registry-lookup",
        "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": [
              "search",
              "lookup",
              "new"
            ],
            "type": "string",
            "description": "<b>New companies</b> lists companies registered in the last days (GLEIF, Norway, Finland, and the UK when your Companies House API key is set). France is not in that list. <b>Search by name</b> looks the names up in GLEIF, Norway, Czechia, Finland, France and, with a key, the UK. <b>Look up by registration number</b> reads the companies you name by LEI, UK company number, French SIREN, Norwegian organisation number, Czech IČO, Finnish business ID or Polish KRS number. France has name and SIREN search and is not in the new-company list.",
            "default": "search"
          },
          "queries": {
            "title": "Company names",
            "maxItems": 100,
            "type": "array",
            "description": "Used in <b>Search by name</b>. One company name per line, for example <code>Equinor</code>. Each name is searched in every selected register that supports name search. Up to 100 per run.",
            "items": {
              "type": "string"
            }
          },
          "identifiers": {
            "title": "Registration numbers",
            "maxItems": 500,
            "type": "array",
            "description": "Used in <b>Look up by registration number</b>. One per line: a LEI (20 characters), <code>GB:00445790</code> or <code>SC123456</code>, <code>FR:552032534</code>, <code>NO:923609016</code>, <code>CZ:00177041</code>, <code>FI:0112038-9</code> or <code>PL:0000019193</code>. An 8-digit number without a prefix is a Czech IČO, and a 9-digit number without a prefix is Norwegian, so UK and French numbers need <code>GB:</code> or <code>FR:</code>. A UK number also needs your Companies House API key. Up to 500 per run.",
            "items": {
              "type": "string"
            }
          },
          "registries": {
            "title": "Registers",
            "type": "array",
            "description": "Which registers to use. Leave empty to use every register that supports the chosen mode. The UK is included only when UK Companies House API key is set. Name search: GLEIF, Norway, Czechia, Finland, France and the UK. New companies: GLEIF, Norway, Finland and the UK. France has name and SIREN search and is not in the new-company list. Poland (KRS) has no name search.",
            "items": {
              "type": "string",
              "enum": [
                "gleif",
                "brreg",
                "ares",
                "prh",
                "krs",
                "france",
                "companies-house"
              ],
              "enumTitles": [
                "GLEIF (LEI, worldwide)",
                "Norway (Bronnoysund)",
                "Czechia (ARES)",
                "Finland (PRH)",
                "Poland (KRS)",
                "France (Annuaire des Entreprises)",
                "UK (Companies House, your API key)"
              ]
            }
          },
          "companiesHouseApiKey": {
            "title": "UK Companies House API key",
            "type": "string",
            "description": "Your own free API key from <a href=\"https://developer.company-information.service.gov.uk/\">Companies House</a>. Required only for the UK register. The Actor sends it to Companies House as HTTP Basic authentication and nowhere else. It is not written to the dataset or the log. Company profiles only: officers, people with significant control and filings are never requested. Leave empty to skip the UK."
          },
          "maxResultsPerQuery": {
            "title": "Companies per name and register",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "In <b>Search by name</b> and <b>New companies</b>: the most companies delivered for each company name and register (for New companies, for each register). You pay per delivered company, and a spending limit also stops the run. Czechia answers at most 1,000 matches per search.",
            "default": 25
          },
          "onlyActive": {
            "title": "Active companies only",
            "type": "boolean",
            "description": "Skip companies the register shows as dissolved, ceased, in liquidation or bankrupt. Applies to name search and new companies; a registration-number lookup always returns the company with its status.",
            "default": false
          },
          "includeFunds": {
            "title": "Include funds (GLEIF)",
            "type": "boolean",
            "description": "GLEIF also lists investment funds. Off by default so a name search returns operating companies, branches, government entities and international organisations.",
            "default": false
          },
          "gleifCountries": {
            "title": "GLEIF countries",
            "maxItems": 50,
            "type": "array",
            "description": "Limit GLEIF results to the legal address country, as two-letter codes (<code>DE</code>, <code>NO</code>). Empty means worldwide. The national registers are always limited to their own country.",
            "items": {
              "type": "string"
            }
          },
          "linkLei": {
            "title": "Add the LEI",
            "type": "boolean",
            "description": "For records from the UK, French, Norwegian, Czech, Finnish and Polish registers, look the company up in GLEIF by its national registration number and add its LEI where one exists. Charged per LEI actually added.",
            "default": false
          },
          "sinceDays": {
            "title": "New companies: days back",
            "minimum": 1,
            "maximum": 90,
            "type": "integer",
            "description": "In <b>New companies</b>: companies registered in the last this-many days, 1 to 90. Schedule this with Skip companies seen before for a weekly lead list (Norway, Finland, and the UK when a key is set).",
            "default": 7
          },
          "onlyNew": {
            "title": "Skip companies seen before",
            "type": "boolean",
            "description": "Skip companies that an earlier run with the same saved-state name already delivered, so a scheduled run returns only what is new to you. The first run returns everything and records it.",
            "default": false
          },
          "stateName": {
            "title": "Saved-state name",
            "type": "string",
            "description": "Name of the key-value store that remembers delivered companies for Skip companies seen before. Use a different name for each monitor you schedule. Letters, digits and hyphens.",
            "default": "company-registry-lookup-state"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}