# Companies House API

Aims to be a complete and up-to-date wrapper for the [Companies House API](https://developer-specs.company-information.service.gov.uk/) for Rust users.

## Public Data API

Read only access to search and retrieve public company data. [Reference docs](https://developer-specs.company-information.service.gov.uk/companies-house-public-data-api/reference).

### Examples

See [`examples/simple.rs`](./examples/simple.rs) for an example of interacting with the client.

### Operations

Currently under implementation.

- Registered office address
  - [x] `GET /company/{companyNumber}/registered-office-address`: Registered Office Address
- Company profile
  - [x] `GET /company/{companyNumber}` Company profile
- Search
  - [ ] `GET /advanced-search/companies`: Advanced search for a company
  - [ ] `GET /search`: Search All
  - [x] `GET /search/companies`: Search companies
  - [x] `GET /search/officers`: Search company officers
  - [ ] `GET /search/disqualified-officers`: Search disqualified officers
  - [ ] `GET /alphabetical-search/companies`: Search for a company
  - [ ] `GET /dissolved-search/companies`: Search for a dissolved company
- Officers
  - [ ] `GET /company/{company_number}/officers`: Company Officers
  - [ ] `GET /company/{company_number}/appointments/{appointment_id}`: Get a company officer appointment
- Registers
  - [ ] `GET /company/{company_number}/registers`: Company registers
- Charges
  - [ ] `GET /company/{company_number}/charges/{charge_id}`:
  - [ ] `GET /company/{company_number}/charges`: Charges
- Filing history
  - [ ] `GET /company/{company_number}/filing-history/{transaction_id}`: filingHistoryItem resource
  - [ ] `GET /company/{company_number}/filing-history`: filingHistoryList resource
- Insolvency
  - [ ] `GET /company/{company_number}/insolvency`:
- Exemptions
  - [ ] `GET /company/{company_number}/exemptions`:
- Officer disqualifications
  - [ ] `GET /disqualified-officers/corporate/{officer_id}`: Get a corporate officers disqualifications
  - [ ] `GET /disqualified-officers/natural/{officer_id}`: Get natural officers disqualifications
- Officer appointments
  - [ ] `GET /officers/{officer_id}/appointments`: Officer Appointment List
- UK Establishments
  - [ ] `GET /company/{company_number}/uk-establishments`: Company UK Establishments
- Persons with significant control
  - [ ] `GET /company/{company_number}/persons-with-significant-control/corporate-entity-beneficial-owner/{psc_id}`: Get the corporate entity beneficial owner
  - [ ] `GET /company/{company_number}/persons-with-significant-control/corporate-entity/{psc_id}`: Get the corporate entity with significant control
  - [ ] `GET /company/{company_number}/persons-with-significant-control/individual-beneficial-owner/{psc_id}`: Get the individual beneficial owner
  - [ ] `GET /company/{company_number}/persons-with-significant-control/individual/{psc_id}`: Get the individual person with significant control
  - [ ] `GET /company/{company_number}/persons-with-significant-control/legal-person-beneficial-owner/{psc_id}`: Get the legal person beneficial owner
  - [ ] `GET /company/{company_number}/persons-with-significant-control/legal-person/{psc_id}`: Get the legal person with significant control
  - [ ] `GET /company/{company_number}/persons-with-significant-control-statements/{statement_id}`: Get the person with significant control statement
  - [ ] `GET /company/{company_number}/persons-with-significant-control/super-secure-beneficial-owner/{super_secure_id}`: Get the super secure beneficial owner
  - [ ] `GET /company/{company_number}/persons-with-significant-control/super-secure/{super_secure_id}`: Get the super secure person with significant control
  - [ ] `GET /company/{company_number}/persons-with-significant-control`: List the company persons with significant control
  - [ ] `GET /company/{company_number}/persons-with-significant-control-statements`: List the company persons with significant control statements