{
  "openapi": "3.0.1",
  "info": {
    "title": "Company Registry Lookup API: KYB, LEI, VAT, Officers",
    "description": "Verify companies by name or ID in 10 official registries: UK Companies House, SEC EDGAR, GLEIF LEI, France, Norway, Finland, Czechia, Poland KRS, Latvia, Brazil CNPJ. Status, address, VAT, industry, LEI and officers as one JSON. Not-found rows are free.",
    "version": "0.1",
    "x-build-id": "Azgel9bPQkomxhNwc"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/chaptersoft~kyb-company-lookup/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-chaptersoft-kyb-company-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/chaptersoft~kyb-company-lookup/runs": {
      "post": {
        "operationId": "runs-sync-chaptersoft-kyb-company-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/chaptersoft~kyb-company-lookup/run-sync": {
      "post": {
        "operationId": "run-sync-chaptersoft-kyb-company-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",
        "required": [
          "queries"
        ],
        "properties": {
          "queries": {
            "title": "Companies (names or IDs)",
            "type": "array",
            "description": "One per line. Mix freely: company names (\"Tesco PLC\", \"Nokia Oyj\"), registration numbers with an optional country prefix (\"GB 00445790\", \"FR 552032534\", \"NO 923609016\", \"FI 0112038-9\", \"CZ 45274649\", \"KRS 0000019193\", \"LV 40003245752\", \"BR 33.000.167/0001-01\"), VAT numbers (\"FR27552032534\", \"CZ45274649\"), SIRET, LEI codes (\"LEI OW6OFBNCKXC4US5C7523\"), SEC CIK (\"CIK 320193\") or stock tickers (\"$AAPL\"). IDs are validated (checksums) before any request. Up to 5,000 per run.",
            "items": {
              "type": "string"
            }
          },
          "countries": {
            "title": "Registries to search",
            "type": "array",
            "description": "Limit name searches to these registries (IDs with a country prefix always go to their own registry). Empty = all 10.",
            "items": {
              "type": "string",
              "enum": [
                "GB",
                "US",
                "FR",
                "NO",
                "FI",
                "CZ",
                "PL",
                "LV",
                "BR",
                "GLEIF"
              ],
              "enumTitles": [
                "United Kingdom (Companies House)",
                "United States (SEC EDGAR filers)",
                "France (SIRENE / RNE)",
                "Norway (Brønnøysund)",
                "Finland (PRH / YTJ)",
                "Czechia (ARES)",
                "Poland (KRS, ID lookup only)",
                "Latvia (Register of Enterprises)",
                "Brazil (CNPJ, ID lookup only)",
                "Global LEI (GLEIF, 2.9M+ entities in 200+ countries)"
              ]
            }
          },
          "maxResultsPerQuery": {
            "title": "Max companies per name search",
            "minimum": 1,
            "maximum": 25,
            "type": "integer",
            "description": "For name searches: how many best matches to return (ranked by match quality, then by size signals such as listed/PLC/LEI). ID lookups always return the one company.",
            "default": 3
          },
          "minMatchScore": {
            "title": "Minimum name match score (0–100)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Name matches below this score are dropped. 100 = same name ignoring legal form (Ltd, Oyj, a.s.); 85+ = name contained in a longer name; 70 = loose.",
            "default": 70
          },
          "activeOnly": {
            "title": "Active companies only",
            "type": "boolean",
            "description": "Skip dissolved, struck-off, bankrupt and in-liquidation companies.",
            "default": false
          },
          "includeOfficers": {
            "title": "Include directors / officers",
            "type": "boolean",
            "description": "Current directors, board members, secretaries and authorised signatories where the registry publishes them (UK, FR, NO, CZ, PL, BR). No dates of birth or home addresses are stored. Free.",
            "default": true
          },
          "maxOfficersPerCompany": {
            "title": "Max officers per company",
            "minimum": 0,
            "maximum": 500,
            "type": "integer",
            "description": "Cap on officers per company (large groups can list hundreds). 0 = none.",
            "default": 50
          },
          "includeLei": {
            "title": "Add LEI (Legal Entity Identifier)",
            "type": "boolean",
            "description": "Look up each company's LEI in GLEIF and add it with its status. Free.",
            "default": true
          },
          "includeNotFound": {
            "title": "Output a row for not-found queries",
            "type": "boolean",
            "description": "Adds a free 'not-found' row (with the registries checked) for every query without a match, so you can reconcile your list. Invalid IDs and registry errors are always reported (free).",
            "default": true
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}