# OpenCorporates

> Look up companies from registers worldwide in OpenCorporates: search companies and officers, read filings and ownership, and watch companies for changes.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/opencorporates

## Actions

### Get account status

Get the API plan, when it expires, and how many calls are used and left today and this month.

**Inputs**: None.

**Outputs**

- `calls_remaining_this_month` (number): Calls left this month
- `calls_remaining_today` (number): Calls left today; resets at midnight UTC
- `calls_used_this_month` (number): Calls made this month
- `calls_used_today` (number): Calls made today
- `expiry_date` (text): When the plan or its paid period ends (YYYY-MM-DD)
- `plan` (text): The API plan
- `status` (text): The account's status, such as approved

**Example output**

```json
{
  "calls_remaining_this_month": 49997,
  "calls_remaining_today": 9998,
  "calls_used_this_month": 3,
  "calls_used_today": 2,
  "expiry_date": "2015-01-27",
  "plan": "open_data",
  "status": "approved"
}
```

### Get company

Get a company's record: status, type, dates, address, previous names, identifiers, owners, officers and recent filings.

**Inputs**

- Jurisdiction (`jurisdiction_code`, text, required): Where the company is registered. Pick one, or give its code, such as gb or us_de.
- Company number (`company_number`, text, required): The company's number in that register, such as 07444723. A pasted OpenCorporates company address works too, without a jurisdiction.
- Core details only (`core_only`, true/false): Leave out officers and filings, for a quicker answer.

**Outputs**

- `company` (object): The company
- `officers` (list): The officers on its record
- `recent_filings` (list): Its most recent filings

**Example output**

```json
{
  "company": {
    "agent_address": "",
    "agent_name": "",
    "alternate_registrations": [],
    "alternative_names": [],
    "branch": "",
    "branch_status": "",
    "company_number": "07444723",
    "company_type": "Private Limited Company",
    "controlling_entity": {
      "company_number": "",
      "jurisdiction_code": "",
      "name": "",
      "opencorporates_url": ""
    },
    "corporate_groupings": [
      {
        "name": "OpenCorporates",
        "opencorporates_url": "https://opencorporates.com/corporate_groupings/OpenCorporates"
      }
    ],
    "created_at": "2010-12-18T01:35:14+00:00",
    "current_status": "Active",
    "dissolution_date": "",
    "home_company": {
      "company_number": "",
      "jurisdiction_code": "",
      "name": "",
      "opencorporates_url": ""
    },
    "identifiers": [
      {
        "identifier_system_code": "gb_vat",
        "identifier_system_name": "GB VAT Number",
        "uid": "164331133"
      }
    ],
    "inactive": false,
    "incorporation_date": "2010-11-18",
    "industry_codes": [
      {
        "code": "70100",
        "code_scheme_id": "uk_sic_2007",
        "code_scheme_name": "UK SIC Classification 2007",
        "description": "Activities of head offices",
        "uid": "uk_sic_2007-70100"
      }
    ],
    "jurisdiction_code": "gb",
    "name": "OPENCORPORATES LTD",
    "opencorporates_url": "https://opencorporates.com/companies/gb/07444723",
    "previous_names": [
      {
        "company_name": "CHRINON LTD",
        "end_date": "2018-05-21",
        "start_date": "2010-11-18"
      }
    ],
    "previous_registrations": [],
    "registered_address": {
      "country": "United Kingdom",
      "locality": "London",
      "postal_code": "N3 1LF",
      "region": "",
      "street_address": "Aston House, Cornwall Avenue"
    },
    "registered_address_in_full": "Aston House, Cornwall Avenue, London, N3 1LF",
    "registry_url": "https://beta.companieshouse.gov.uk/company/07444723",
    "retrieved_at": "2023-03-18T10:58:55+00:00",
    "source": {
      "publisher": "UK Companies House",
      "retrieved_at": "2023-03-18T10:58:55+00:00",
      "terms": "UK Crown Copyright",
      "url": "http://xmlgw.companieshouse.gov.uk/"
    },
    "subsequent_registrations": [],
    "ultimate_beneficial_owners": [
      {
        "name": "Mr Christopher Taggart",
        "opencorporates_url": "https://opencorporates.com/placeholders/101560262"
      }
    ],
    "ultimate_controlling_company": {
      "company_number": "",
      "jurisdiction_code": "",
      "name": "",
      "opencorporates_url": ""
    },
    "updated_at": "2023-03-18T10:58:57+00:00"
  },
  "officers": [
    {
      "address": "ASTON HOUSE CORNWALL AVENUE, LONDON, N3 1LF, UNITED KINGDOM",
      "company": {
        "company_number": "07444723",
        "jurisdiction_code": "gb",
        "name": "OPENCORPORATES LTD",
        "opencorporates_url": "https://opencorporates.com/companies/gb/07444723"
      },
      "current_status": "",
      "date_of_birth": "",
      "end_date": "",
      "id": "206814999",
      "inactive": null,
      "jurisdiction_code": "gb",
      "name": "CHRISTOPHER TAGGART",
      "nationality": "BRITISH",
      "occupation": "DEVELOPER",
      "opencorporates_url": "https://opencorporates.com/officers/206814999",
      "position": "director",
      "retrieved_at": "",
      "start_date": "2010-11-18",
      "uid": ""
    }
  ],
  "recent_filings": [
    {
      "company": {
        "company_number": "07444723",
        "jurisdiction_code": "gb",
        "name": "OPENCORPORATES LTD",
        "opencorporates_url": "https://opencorporates.com/companies/gb/07444723"
      },
      "date": "2023-03-17",
      "description": "Termination of appointment of Tannah Matus as a secretary on 2023-02-22",
      "filing_type_code": "TM02",
      "filing_type_name": "Termination of appointment of secretary",
      "id": "1471815138",
      "opencorporates_url": "https://opencorporates.com/statements/1471815138",
      "title": "Termination of appointment of secretary",
      "uid": "MzM3MzEwNjE2OWFkaXF6a2N4",
      "url": ""
    }
  ]
}
```

### Get filing

Get one statutory filing, with a link to the document where the register has one.

**Inputs**

- Filing (`filing_id`, text, required): Its OpenCorporates id or address, from 'List company filings' or 'Get company'.

**Outputs**

- `filing` (object): The filing

**Example output**

```json
{
  "filing": {
    "company": {
      "company_number": "00102498",
      "jurisdiction_code": "gb",
      "name": "BP P.L.C.",
      "opencorporates_url": "https://opencorporates.com/companies/gb/00102498"
    },
    "date": "2014-02-13",
    "description": "RETURN OF PURCHASE OF OWN SHARES",
    "filing_type_code": "SH03",
    "filing_type_name": "Return of purchase of own shares",
    "id": "199825350",
    "opencorporates_url": "https://opencorporates.com/filings/199825350",
    "title": "Return of purchase of own shares",
    "uid": "284acfeJxjZRd2YnXi4ohPyU9OSS1OBnHYQJzMFCdxfgMDA0djQy9",
    "url": ""
  }
}
```

### Get industry code

Get what an industry code means, and the codes it matches in other schemes.

**Inputs**

- Code scheme (`code_scheme_id`, text, required): The code's scheme. Pick one, or give its id, such as be_nace_2008.
- Code (`code`, text, required): The industry code, such as 66191.

**Outputs**

- `equivalent_codes` (list): The same industry in other code schemes
- `industry_code` (object): An industry code

**Example output**

```json
{
  "equivalent_codes": [
    {
      "code": "6619",
      "code_scheme_id": "eu_nace_2",
      "code_scheme_name": "European Community NACE Rev 2",
      "description": "Other activities auxiliary to financial services, except insurance and pension funding",
      "uid": "eu_nace_2-6619"
    }
  ],
  "industry_code": {
    "code": "66191",
    "code_scheme_id": "be_nace_2008",
    "code_scheme_name": "NACE-BEL 2008",
    "description": "Agenten en makelaars in bankdiensten",
    "uid": "be_nace_2008-66191"
  }
}
```

### Get industry code scheme

Get an industry code scheme and every code in it.

**Inputs**

- Code scheme (`code_scheme_id`, text, required): The industry code scheme. Pick one, or give its id, such as eu_nace_2.

**Outputs**

- `code_scheme` (object): The industry code scheme
- `count` (number): How many codes there are
- `industry_codes` (list): The codes in the scheme

**Example output**

```json
{
  "code_scheme": {
    "id": "uk_sic_2007",
    "name": "UK SIC Classification 2007",
    "url": ""
  },
  "count": 1,
  "industry_codes": [
    {
      "code": "70100",
      "code_scheme_id": "uk_sic_2007",
      "code_scheme_name": "UK SIC Classification 2007",
      "description": "Activities of head offices",
      "uid": "uk_sic_2007-70100"
    }
  ]
}
```

### Get officer

Get one officer appointment: position, dates, occupation, nationality, address and company.

**Inputs**

- Officer (`officer_id`, text, required): Its OpenCorporates id or address, from 'Search officers' or a company's officers.

**Outputs**

- `officer` (object): The officer
- `source` (object): Where OpenCorporates got the data

**Example output**

```json
{
  "officer": {
    "address": "ASTON HOUSE CORNWALL AVENUE, LONDON, N3 1LF, UNITED KINGDOM",
    "company": {
      "company_number": "07444723",
      "jurisdiction_code": "gb",
      "name": "OPENCORPORATES LTD",
      "opencorporates_url": "https://opencorporates.com/companies/gb/07444723"
    },
    "current_status": "",
    "date_of_birth": "",
    "end_date": "",
    "id": "206814999",
    "inactive": null,
    "jurisdiction_code": "gb",
    "name": "CHRISTOPHER TAGGART",
    "nationality": "BRITISH",
    "occupation": "DEVELOPER",
    "opencorporates_url": "https://opencorporates.com/officers/206814999",
    "position": "director",
    "retrieved_at": "",
    "start_date": "2010-11-18",
    "uid": ""
  },
  "source": {
    "publisher": "UK Companies House",
    "retrieved_at": "2015-12-20T02:37:10+00:00",
    "terms": "UK Crown Copyright",
    "url": "http://xmlgw.companieshouse.gov.uk/"
  }
}
```

### Get placeholder

Get an owner or parent named in ownership data, and the company it has been matched to, if any.

**Inputs**

- Placeholder (`placeholder_id`, text, required): Its OpenCorporates id or address, from a company's ultimate beneficial owners or a control statement.

**Outputs**

- `placeholder` (object): The placeholder

**Example output**

```json
{
  "placeholder": {
    "company": {
      "company_number": "",
      "jurisdiction_code": "",
      "name": "",
      "opencorporates_url": ""
    },
    "id": "101560262",
    "identifier": "",
    "jurisdiction_code": "",
    "jurisdiction_string": "",
    "name": "Mr Christopher Taggart",
    "opencorporates_url": "https://opencorporates.com/placeholders/101560262",
    "source": {
      "publisher": "UK Companies House",
      "retrieved_at": "2023-03-18T10:58:55+00:00",
      "terms": "",
      "url": "http://download.companieshouse.gov.uk/en_pscdata.html"
    }
  }
}
```

### Get statement

Get one statement: a subsidiary, shareholding, licence or other record about a company.

**Inputs**

- Statement (`statement_id`, text, required): Its OpenCorporates id or address, from 'List company statements' or a search.

**Outputs**

- `statement` (object): The statement

**Example output**

```json
{
  "statement": {
    "data_type": "subsidiary",
    "date": "",
    "description": "",
    "details": {
      "data_type": "subsidiary",
      "id": 11499887,
      "opencorporates_url": "https://opencorporates.com/statements/11499887",
      "properties": {
        "percentage_controlled": "100"
      },
      "provenances": [
        {
          "confidence": 80,
          "created_at": "2014-01-08T10:00:00+00:00",
          "source_type": "external",
          "source_url": "https://www.sec.gov/"
        }
      ],
      "title": "Subsidiary relationship"
    },
    "id": "11499887",
    "opencorporates_url": "https://opencorporates.com/statements/11499887",
    "title": "Subsidiary relationship"
  }
}
```

### List company filings

List the statutory filings a company has made, newest first.

**Inputs**

- Jurisdiction (`jurisdiction_code`, text, required): Where the company is registered. Pick one, or give its code, such as gb or us_de.
- Company number (`company_number`, text, required): The company's number in that register, such as 07444723. A pasted OpenCorporates company address works too, without a jurisdiction.
- Page (`page`, number): Which page of results to return, 1 to 100. Defaults to 1. From 1 to 100.
- Results per page (`per_page`, number): How many results to return, 1 to 100. Defaults to 30. From 1 to 100.

**Outputs**

- `filings` (list): The filings
- `page` (number): This page's number
- `per_page` (number): Results per page
- `summary` (text): What came back, in words
- `total_count` (number): How many results there are in all
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "filings": [
    {
      "company": {
        "company_number": "07444723",
        "jurisdiction_code": "gb",
        "name": "OPENCORPORATES LTD",
        "opencorporates_url": "https://opencorporates.com/companies/gb/07444723"
      },
      "date": "2023-03-17",
      "description": "Termination of appointment of Tannah Matus as a secretary on 2023-02-22",
      "filing_type_code": "TM02",
      "filing_type_name": "Termination of appointment of secretary",
      "id": "1471815138",
      "opencorporates_url": "https://opencorporates.com/statements/1471815138",
      "title": "Termination of appointment of secretary",
      "uid": "MzM3MzEwNjE2OWFkaXF6a2N4",
      "url": ""
    }
  ],
  "page": 1,
  "per_page": 30,
  "summary": "Showing 1 of 1 filings (page 1 of 1).",
  "total_count": 1,
  "total_pages": 1
}
```

### List company officers

List a company's directors, secretaries and other officers, current, former or both.

**Inputs**

- Jurisdiction (`jurisdiction_code`, text, required): Where the company is registered. Pick one, or give its code, such as gb or us_de.
- Company number (`company_number`, text, required): The company's number in that register, such as 07444723. A pasted OpenCorporates company address works too, without a jurisdiction.
- Which officers (`which`, text): Current officers have no end date. One of: `all` (All officers (default)), `current` (Current officers), `former` (Former officers). Default: `all`.

**Outputs**

- `company` (object): The company
- `count` (number): How many officers came back
- `officers` (list): The officers

**Example output**

```json
{
  "company": {
    "company_number": "07444723",
    "jurisdiction_code": "gb",
    "name": "OPENCORPORATES LTD",
    "opencorporates_url": "https://opencorporates.com/companies/gb/07444723"
  },
  "count": 1,
  "officers": [
    {
      "address": "ASTON HOUSE CORNWALL AVENUE, LONDON, N3 1LF, UNITED KINGDOM",
      "company": {
        "company_number": "07444723",
        "jurisdiction_code": "gb",
        "name": "OPENCORPORATES LTD",
        "opencorporates_url": "https://opencorporates.com/companies/gb/07444723"
      },
      "current_status": "",
      "date_of_birth": "",
      "end_date": "",
      "id": "206814999",
      "inactive": null,
      "jurisdiction_code": "gb",
      "name": "CHRISTOPHER TAGGART",
      "nationality": "BRITISH",
      "occupation": "DEVELOPER",
      "opencorporates_url": "https://opencorporates.com/officers/206814999",
      "position": "director",
      "retrieved_at": "",
      "start_date": "2010-11-18",
      "uid": ""
    }
  ]
}
```

### List company statements

List what public records say about a company: subsidiaries, shareholdings, licences, notices and more.

**Inputs**

- Jurisdiction (`jurisdiction_code`, text, required): Where the company is registered. Pick one, or give its code, such as gb or us_de.
- Company number (`company_number`, text, required): The company's number in that register, such as 07444723. A pasted OpenCorporates company address works too, without a jurisdiction.
- Page (`page`, number): Which page of results to return, 1 to 100. Defaults to 1. From 1 to 100.
- Results per page (`per_page`, number): How many results to return, 1 to 100. Defaults to 30. From 1 to 100.

**Outputs**

- `page` (number): This page's number
- `per_page` (number): Results per page
- `statements` (list): The statements
- `summary` (text): What came back, in words
- `total_count` (number): How many results there are in all
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "page": 1,
  "per_page": 30,
  "statements": [
    {
      "data_type": "subsidiary",
      "date": "",
      "description": "",
      "details": {
        "data_type": "subsidiary",
        "id": 11499887,
        "opencorporates_url": "https://opencorporates.com/statements/11499887",
        "properties": {
          "percentage_controlled": "100"
        },
        "provenances": [
          {
            "confidence": 80,
            "created_at": "2014-01-08T10:00:00+00:00",
            "source_type": "external",
            "source_url": "https://www.sec.gov/"
          }
        ],
        "title": "Subsidiary relationship"
      },
      "id": "11499887",
      "opencorporates_url": "https://opencorporates.com/statements/11499887",
      "title": "Subsidiary relationship"
    }
  ],
  "summary": "Showing 1 of 1 statements (page 1 of 1).",
  "total_count": 1,
  "total_pages": 1
}
```

### List industry code schemes

List the industry code schemes OpenCorporates uses, such as NAICS and NACE.

**Inputs**: None.

**Outputs**

- `code_schemes` (list): The code schemes
- `count` (number): How many code schemes there are

**Example output**

```json
{
  "code_schemes": [
    {
      "id": "uk_sic_2007",
      "name": "UK SIC Classification 2007",
      "url": ""
    },
    {
      "id": "eu_nace_2",
      "name": "European Community NACE Rev 2",
      "url": ""
    }
  ],
  "count": 2
}
```

### List jurisdictions

List every jurisdiction OpenCorporates knows, with the code other steps take.

**Inputs**: None.

**Outputs**

- `count` (number): How many jurisdictions there are
- `jurisdictions` (list): The jurisdictions

**Example output**

```json
{
  "count": 2,
  "jurisdictions": [
    {
      "code": "gb",
      "country": "United Kingdom",
      "country_code": "gb",
      "full_name": "United Kingdom",
      "name": "United Kingdom"
    },
    {
      "code": "us_de",
      "country": "United States",
      "country_code": "us",
      "full_name": "Delaware (US)",
      "name": "Delaware"
    }
  ]
}
```

### List placeholder statements

List the statements that name a placeholder, such as the companies it controls.

**Inputs**

- Placeholder (`placeholder_id`, text, required): Its OpenCorporates id or address, from a company's ultimate beneficial owners or 'Get placeholder'.
- Page (`page`, number): Which page of results to return, 1 to 100. Defaults to 1. From 1 to 100.
- Results per page (`per_page`, number): How many results to return, 1 to 100. Defaults to 30. From 1 to 100.

**Outputs**

- `page` (number): This page's number
- `per_page` (number): Results per page
- `statements` (list): The statements
- `summary` (text): What came back, in words
- `total_count` (number): How many results there are in all
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "page": 1,
  "per_page": 30,
  "statements": [
    {
      "data_type": "subsidiary",
      "date": "",
      "description": "",
      "details": {
        "data_type": "subsidiary",
        "id": 11499887,
        "opencorporates_url": "https://opencorporates.com/statements/11499887",
        "properties": {
          "percentage_controlled": "100"
        },
        "provenances": [
          {
            "confidence": 80,
            "created_at": "2014-01-08T10:00:00+00:00",
            "source_type": "external",
            "source_url": "https://www.sec.gov/"
          }
        ],
        "title": "Subsidiary relationship"
      },
      "id": "11499887",
      "opencorporates_url": "https://opencorporates.com/statements/11499887",
      "title": "Subsidiary relationship"
    }
  ],
  "summary": "Showing 1 of 1 statements (page 1 of 1).",
  "total_count": 1,
  "total_pages": 1
}
```

### Match jurisdiction

Find the jurisdiction code for a place written any way, such as 'Delaware, USA' or 'Great Britain'.

**Inputs**

- Place (`place`, text, required): The country, state or province, written however it comes.
- Related jurisdiction (`related_jurisdiction`, text): A jurisdiction that tells similar names apart, such as us for Georgia the state rather than the country.

**Outputs**

- `code` (text): The jurisdiction code; empty when nothing matched
- `jurisdiction` (object): The jurisdiction
- `matched` (true/false): Whether a jurisdiction matched

**Example output**

```json
{
  "code": "gb",
  "jurisdiction": {
    "code": "gb",
    "country": "United Kingdom",
    "country_code": "gb",
    "full_name": "United Kingdom",
    "name": "United Kingdom"
  },
  "matched": true
}
```

### Search beneficial owners

Find who owns or controls companies (beneficial owners and parent companies), by company or controller name.

**Inputs**

- Controlled company (`controlled_company_name`, text): The name of the company that is owned or controlled.
- Owner or controller (`controller_name`, text): The name of the person or company that owns or controls.
- How control is held (`mechanism_types`, list): Only these kinds of control. Leave empty for every kind. One or more of: `share_ownership` (Share ownership), `voting_rights` (Voting rights), `right_to_appoint_and_remove_directors` (Right to appoint or remove directors), `right_to_appoint_and_remove_members` (Right to appoint or remove members), `right_to_appoint_and_remove_person` (Right to appoint or remove a person), `right_to_share_surplus_assets` (Right to share surplus assets), `significant_influence_or_control` (Significant influence or control).
- Controller types (`controller_types`, list): Only controllers of these types. Leave empty for every type. One or more of: `person`, `company`, `organisation` (Other organisation), `unknown`.
- Ultimate beneficial owners (`ultimate_owner`, text): Whether the controllers are the company's ultimate beneficial owners. One of: `any` (Either (default)), `yes`, `no`. Default: `any`.
- Names a controller (`has_controllers`, text): Whether the statement names anyone with control. One of: `any` (Either (default)), `yes`, `no`. Default: `any`.
- Added from (`added_from`, date): Only statements added to OpenCorporates on or after this date.
- Added to (`added_to`, date): Only statements added to OpenCorporates on or before this date.
- Sort by (`order`, text): The order to return statements in. One of: `newest` (Newest first (default)), `score` (Best match first). Default: `newest`.
- Page (`page`, number): Which page of results to return, 1 to 100. Defaults to 1. From 1 to 100.
- Results per page (`per_page`, number): How many results to return, 1 to 100. Defaults to 30. From 1 to 100.

**Outputs**

- `page` (number): This page's number
- `per_page` (number): Results per page
- `statements` (list): The control statements found
- `summary` (text): What came back, in words
- `total_count` (number): How many results there are in all
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "page": 1,
  "per_page": 30,
  "statements": [
    {
      "control_mechanisms": [
        {
          "description": "ownership-of-shares-75-to-100-percent",
          "mechanism_type": "share_ownership"
        }
      ],
      "controlled_entity": {
        "company_number": "07444723",
        "jurisdiction_code": "gb",
        "name": "OPENCORPORATES LTD",
        "opencorporates_url": "https://opencorporates.com/companies/gb/07444723"
      },
      "controlling_entities": [
        {
          "address": "",
          "company_number": "11268479",
          "country_of_residence": "",
          "date_of_birth": "",
          "entity_type": "company",
          "jurisdiction_code": "gb",
          "name": "OPENCORPORATES HOLDING LTD",
          "nationality": "",
          "opencorporates_url": "https://opencorporates.com/companies/gb/11268479"
        }
      ],
      "details": {
        "control_mechanisms": [
          {
            "mechanism_type": "share_ownership",
            "source_description": "ownership-of-shares-75-to-100-percent"
          }
        ],
        "controlled_entity": {
          "company": {
            "company_number": "07444723",
            "jurisdiction_code": "gb",
            "name": "OPENCORPORATES LTD",
            "opencorporates_url": "https://opencorporates.com/companies/gb/07444723"
          }
        },
        "controlling_entities": [
          {
            "company": {
              "company_number": "11268479",
              "jurisdiction_code": "gb",
              "name": "OPENCORPORATES HOLDING LTD",
              "opencorporates_url": "https://opencorporates.com/companies/gb/11268479"
            }
          }
        ],
        "id": 566996420,
        "opencorporates_url": "https://opencorporates.com/statements/566996420",
        "other_attributes": {
          "notified_on": "2018-04-06"
        }
      },
      "end_date": "",
      "id": "566996420",
      "is_ultimate_beneficial_owner": null,
      "opencorporates_url": "https://opencorporates.com/statements/566996420",
      "start_date": "2018-04-06"
    }
  ],
  "summary": "Showing 1 of 1 control statements (page 1 of 1).",
  "total_count": 1,
  "total_pages": 1
}
```

### Search companies

Find companies by name, number or filters such as jurisdiction, status, type, industry and incorporation date.

**Inputs**

- Company name (`query`, text): Words in the company's name (current or previous). Leave empty to search by filters alone.
- Match (`name_match`, text): How the name must match. One of: `words` (Has all the words, in any order (default)), `starts_with` (Starts with these words). Default: `words`.
- Search in (`search_in`, list): Which fields to look for the words in. Defaults to names and previous names. One or more of: `name`, `normalised_name` (Normalised name), `previous_names` (Previous names), `company_number` (Company number), `heavily_normalised_number` (Company number without leading zeros), `native_company_number` (Former company number), `postal_codes` (Postal code), `trademark_registration_mark_texts` (Trademark text).
- Normalise the name (`normalise_name`, true/false): Treat Ltd as Limited, Corp as Corporation and so on before searching.
- Jurisdictions (`jurisdiction_codes`, list): Only these jurisdictions. Leave empty for all of them.
- Countries (`country_codes`, list): Only these countries, every state or province included (all of the US, say). Leave empty for all.
- Company types (`company_type`, list): Only these types, in the register's words, such as Private Limited Company.
- Statuses (`current_status`, list): Only these statuses, in the register's words, such as Active.
- Active or inactive (`activity`, text): Inactive means dissolved, struck off, liquidated and the like. One of: `any` (Active or inactive (default)), `active` (Active only), `inactive` (Inactive only). Default: `any`.
- Branches (`branch`, text): Whether to include branches of companies registered elsewhere. One of: `any` (Branches included (default)), `exclude` (No branches), `only` (Branches only). Default: `any`.
- Nonprofits (`nonprofit`, text): Whether to include companies of a nonprofit type. One of: `any` (Nonprofits included (default)), `exclude` (No nonprofits), `only` (Nonprofits only). Default: `any`.
- Incorporated from (`incorporated_from`, date): Only companies incorporated on or after this date.
- Incorporated to (`incorporated_to`, date): Only companies incorporated on or before this date.
- Dissolved from (`dissolved_from`, date): Only companies dissolved on or after this date.
- Dissolved to (`dissolved_to`, date): Only companies dissolved on or before this date.
- Added from (`added_from`, date): Only companies added to OpenCorporates on or after this date.
- Added to (`added_to`, date): Only companies added to OpenCorporates on or before this date.
- Updated from (`updated_from`, date): Only companies whose record changed on or after this date.
- Updated to (`updated_to`, date): Only companies whose record changed on or before this date.
- Registered address (`registered_address`, text): Words in the registered address, such as a street or postal code.
- Industry codes (`industry_codes`, list): Only companies in any of these industries, each as scheme and code joined by a hyphen, such as eu_nace_2-6201.
- Other identifier (`identifier`, text): Only the company with this identifier, such as a tax or charity number.
- Sort by (`order`, text): The order to return companies in. One of: `alphabetical` (Name, A to Z (default)), `score` (Best match first), `incorporation_date` (Newest incorporated first), `dissolution_date` (Newest dissolved first), `created_at` (Newest added to OpenCorporates first), `updated_at` (Most recently updated first). Default: `alphabetical`.
- Page (`page`, number): Which page of results to return, 1 to 100. Defaults to 1. From 1 to 100.
- Results per page (`per_page`, number): How many results to return, 1 to 100. Defaults to 30. From 1 to 100.

**Outputs**

- `companies` (list): The companies found
- `page` (number): This page's number
- `per_page` (number): Results per page
- `summary` (text): What came back, in words
- `total_count` (number): How many results there are in all
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "companies": [
    {
      "agent_address": "",
      "agent_name": "",
      "alternate_registrations": [],
      "alternative_names": [],
      "branch": "",
      "branch_status": "",
      "company_number": "07444723",
      "company_type": "Private Limited Company",
      "controlling_entity": {
        "company_number": "",
        "jurisdiction_code": "",
        "name": "",
        "opencorporates_url": ""
      },
      "corporate_groupings": [
        {
          "name": "OpenCorporates",
          "opencorporates_url": "https://opencorporates.com/corporate_groupings/OpenCorporates"
        }
      ],
      "created_at": "2010-12-18T01:35:14+00:00",
      "current_status": "Active",
      "dissolution_date": "",
      "home_company": {
        "company_number": "",
        "jurisdiction_code": "",
        "name": "",
        "opencorporates_url": ""
      },
      "identifiers": [
        {
          "identifier_system_code": "gb_vat",
          "identifier_system_name": "GB VAT Number",
          "uid": "164331133"
        }
      ],
      "inactive": false,
      "incorporation_date": "2010-11-18",
      "industry_codes": [
        {
          "code": "70100",
          "code_scheme_id": "uk_sic_2007",
          "code_scheme_name": "UK SIC Classification 2007",
          "description": "Activities of head offices",
          "uid": "uk_sic_2007-70100"
        }
      ],
      "jurisdiction_code": "gb",
      "name": "OPENCORPORATES LTD",
      "opencorporates_url": "https://opencorporates.com/companies/gb/07444723",
      "previous_names": [
        {
          "company_name": "CHRINON LTD",
          "end_date": "2018-05-21",
          "start_date": "2010-11-18"
        }
      ],
      "previous_registrations": [],
      "registered_address": {
        "country": "United Kingdom",
        "locality": "London",
        "postal_code": "N3 1LF",
        "region": "",
        "street_address": "Aston House, Cornwall Avenue"
      },
      "registered_address_in_full": "Aston House, Cornwall Avenue, London, N3 1LF",
      "registry_url": "https://beta.companieshouse.gov.uk/company/07444723",
      "retrieved_at": "2023-03-18T10:58:55+00:00",
      "source": {
        "publisher": "UK Companies House",
        "retrieved_at": "2023-03-18T10:58:55+00:00",
        "terms": "UK Crown Copyright",
        "url": "http://xmlgw.companieshouse.gov.uk/"
      },
      "subsequent_registrations": [],
      "ultimate_beneficial_owners": [
        {
          "name": "Mr Christopher Taggart",
          "opencorporates_url": "https://opencorporates.com/placeholders/101560262"
        }
      ],
      "ultimate_controlling_company": {
        "company_number": "",
        "jurisdiction_code": "",
        "name": "",
        "opencorporates_url": ""
      },
      "updated_at": "2023-03-18T10:58:57+00:00"
    }
  ],
  "page": 1,
  "per_page": 30,
  "summary": "Showing 1 of 1 companies (page 1 of 1).",
  "total_count": 1,
  "total_pages": 1
}
```

### Search gazette notices

Find notices in official gazettes, such as insolvencies and strike-offs, newest first.

**Inputs**

- Words (`query`, text): Words in the notice, such as a company name. Leave empty to list a jurisdiction's notices.
- Jurisdictions (`jurisdiction_codes`, list): Only these jurisdictions. Leave empty for all of them.
- Gazettes (`publication`, list): Only notices in these gazettes, by title.
- Notice types (`notice_type`, list): Only notices of these types, such as Insolvency.
- Sort by (`order`, text): The order to return notices in. One of: `newest` (Newest first (default)), `score` (Best match first). Default: `newest`.
- Page (`page`, number): Which page of results to return, 1 to 100. Defaults to 1. From 1 to 100.
- Results per page (`per_page`, number): How many results to return, 1 to 100. Defaults to 30. From 1 to 100.

**Outputs**

- `notices` (list): The notices found
- `page` (number): This page's number
- `per_page` (number): Results per page
- `summary` (text): What came back, in words
- `total_count` (number): How many results there are in all
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "notices": [
    {
      "date_published": "2026-10-01",
      "details": {
        "date_published": "2026-10-01",
        "id": 1023456789,
        "jurisdiction_code": "gb",
        "opencorporates_url": "https://opencorporates.com/statements/1023456789",
        "summary": "Appointment of Liquidators",
        "url": "https://www.thegazette.co.uk/notice/1023456"
      },
      "id": "1023456789",
      "jurisdiction_code": "gb",
      "opencorporates_url": "https://opencorporates.com/statements/1023456789",
      "summary": "Appointment of Liquidators",
      "url": "https://www.thegazette.co.uk/notice/1023456"
    }
  ],
  "page": 1,
  "per_page": 30,
  "summary": "Showing 1 of 1 gazette notices (page 1 of 1).",
  "total_count": 1,
  "total_pages": 1
}
```

### Search officers

Find company directors, secretaries and agents by name, with the company each appointment is at.

**Inputs**

- Officer name (`query`, text, required): Words in the officer's name, in any order.
- Jurisdictions (`jurisdiction_codes`, list): Only these jurisdictions. Leave empty for all of them.
- Positions (`position`, list): Only these positions, such as director, secretary or agent.
- Address (`address`, text): Words in the officer's address.
- Born from (`born_from`, date): Only officers born on or after this date. Dates of birth are mostly known for UK directors.
- Born to (`born_to`, date): Only officers born on or before this date.
- Current or former (`status`, text): Former means the appointment ended or the company is inactive. One of: `any` (Current or former (default)), `current` (Current only), `former` (Former only). Default: `any`.
- Sort by (`order`, text): The order to return officers in. One of: `alphabetical` (Name, A to Z (default)), `score` (Best match first). Default: `alphabetical`.
- Page (`page`, number): Which page of results to return, 1 to 100. Defaults to 1. From 1 to 100.
- Results per page (`per_page`, number): How many results to return, 1 to 100. Defaults to 30. From 1 to 100.

**Outputs**

- `officers` (list): The officers found
- `page` (number): This page's number
- `per_page` (number): Results per page
- `summary` (text): What came back, in words
- `total_count` (number): How many results there are in all
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "officers": [
    {
      "address": "ASTON HOUSE CORNWALL AVENUE, LONDON, N3 1LF, UNITED KINGDOM",
      "company": {
        "company_number": "07444723",
        "jurisdiction_code": "gb",
        "name": "OPENCORPORATES LTD",
        "opencorporates_url": "https://opencorporates.com/companies/gb/07444723"
      },
      "current_status": "",
      "date_of_birth": "",
      "end_date": "",
      "id": "206814999",
      "inactive": null,
      "jurisdiction_code": "gb",
      "name": "CHRISTOPHER TAGGART",
      "nationality": "BRITISH",
      "occupation": "DEVELOPER",
      "opencorporates_url": "https://opencorporates.com/officers/206814999",
      "position": "director",
      "retrieved_at": "",
      "start_date": "2010-11-18",
      "uid": ""
    }
  ],
  "page": 1,
  "per_page": 30,
  "summary": "Showing 1 of 1 officers (page 1 of 1).",
  "total_count": 1,
  "total_pages": 1
}
```

### Search trademark registrations

Find trademark registrations by the trademark's text, with their holders and dates.

**Inputs**

- Trademark text (`query`, text, required): Words in the trademark.
- Sort by (`order`, text): The order to return registrations in. One of: `created_at` (Date added to OpenCorporates (default)), `mark_text` (Trademark text), `registration_date` (Registration date), `expiry_date` (Expiry date), `score` (Best match first). Default: `created_at`.
- Page (`page`, number): Which page of results to return, 1 to 100. Defaults to 1. From 1 to 100.
- Results per page (`per_page`, number): How many results to return, 1 to 100. Defaults to 30. From 1 to 100.

**Outputs**

- `page` (number): This page's number
- `per_page` (number): Results per page
- `summary` (text): What came back, in words
- `total_count` (number): How many results there are in all
- `total_pages` (number): How many pages there are
- `trademarks` (list): The registrations found

**Example output**

```json
{
  "page": 1,
  "per_page": 30,
  "summary": "Showing 1 of 1 trademark registrations (page 1 of 1).",
  "total_count": 1,
  "total_pages": 1,
  "trademarks": [
    {
      "details": {
        "expiry_date": "2025-02-27",
        "holders": [
          {
            "name": "OPENCORPORATES LTD"
          }
        ],
        "id": 987654321,
        "mark_details": {
          "mark_text": "OPENCORPORATES"
        },
        "opencorporates_url": "https://opencorporates.com/statements/987654321",
        "register": "UKIPO",
        "registration_date": "2015-06-12",
        "status": "Registered"
      },
      "expiry_date": "2025-02-27",
      "holders": [
        "OPENCORPORATES LTD"
      ],
      "id": "987654321",
      "mark_text": "OPENCORPORATES",
      "opencorporates_url": "https://opencorporates.com/statements/987654321",
      "register": "UKIPO",
      "registration_date": "2015-06-12",
      "status": "Registered",
      "url": ""
    }
  ]
}
```
