# i2 group API

# Summary
API for searching companies and people, retrieving full details, and exploring their network connections.

# Quota
Each API key is limited based on credits. If you run out of credits, you will receive a `429 Too Many Requests` response.

# Authentication
You must provide an API key in the `i2-api-key` header to access the API. If you do not provide a valid API key, you will receive a `401 Unauthorized` response.


Version: 2.0.0
License: Proprietary

## Servers

```
https://dev-api-gateway.mnai.tech/i2-group
```

```
https://prod-api-gateway.mnai.tech/i2-group
```

## Security

### ApiKeyAuth

Type: apiKey
In: header
Name: i2-api-key

## Download OpenAPI description

[i2 group API](https://i2-group-docs.mnai.tech/_bundle/openapi.yaml)

## Other

### Search companies

 - [GET /company/search](https://i2-group-docs.mnai.tech/openapi/paths/~1company~1search/get.md): The ability to search for a company by company name or company number.

Results can be filtered by status (Active, In distress, Closed, Restored, Dormant, Non-trading, Active proposal to strike off).

Results are ordered by matching relevance.

### Search people

 - [GET /person/search](https://i2-group-docs.mnai.tech/openapi/paths/~1person~1search/get.md): The ability to search for a person by name, company name or company number.

Results can be filtered by birthDate (format must be YYYY-MM).

Results are ordered by matching relevance.

### Company details

 - [GET /company/{idCompany}](https://i2-group-docs.mnai.tech/openapi/paths/~1company~1%7Bidcompany%7D/get.md): Retrieve full details of a company by idCompany.

### Person details

 - [GET /person/{idPerson}](https://i2-group-docs.mnai.tech/openapi/paths/~1person~1%7Bidperson%7D/get.md): Retrieve full details of a person by idPerson.

### Person roles

 - [GET /person/{idPerson}/roles](https://i2-group-docs.mnai.tech/openapi/paths/~1person~1%7Bidperson%7D~1roles/get.md): Retrieve role details of a person by idPerson.

Results are ordered by appointedDate DESC.

### Person shareholdings

 - [GET /person/{idPerson}/shareholdings](https://i2-group-docs.mnai.tech/openapi/paths/~1person~1%7Bidperson%7D~1shareholdings/get.md): Retrieve shareholdings of a person by idPerson.

Results are ordered by sharesSince DESC.

### Company network

 - [GET /company/{idCompany}/network](https://i2-group-docs.mnai.tech/openapi/paths/~1company~1%7Bidcompany%7D~1network/get.md): Retrieve any linked connections of a company by idCompany.

This can be used to explore or extend the network of a company.

### Person network

 - [GET /person/{idPerson}/network](https://i2-group-docs.mnai.tech/openapi/paths/~1person~1%7Bidperson%7D~1network/get.md): Retrieve any linked connections of a person by idPerson.

This can be used to explore or extend the network of a person.

### Company trading addresses

 - [GET /company/{idCompany}/trading-addresses](https://i2-group-docs.mnai.tech/openapi/paths/~1company~1%7Bidcompany%7D~1trading-addresses/get.md): Retrieve trading addresses of a company by idCompany.

Results are ordered by address line 1.

### Company officers

 - [GET /company/{idCompany}/officers](https://i2-group-docs.mnai.tech/openapi/paths/~1company~1%7Bidcompany%7D~1officers/get.md): Retrieve officers of a company by idCompany.

Results are ordered by appointedDate DESC.

### Company shareholders

 - [GET /company/{idCompany}/shareholders](https://i2-group-docs.mnai.tech/openapi/paths/~1company~1%7Bidcompany%7D~1shareholders/get.md): Retrieve shareholders of a company by idCompany.

Results are ordered by sharesSince DESC.

### Company shareholdings

 - [GET /company/{idCompany}/shareholdings](https://i2-group-docs.mnai.tech/openapi/paths/~1company~1%7Bidcompany%7D~1shareholdings/get.md): Retrieve shareholdings of a company by idCompany.

Results are ordered by incorporatedDate DESC.

### Company charges

 - [GET /company/{idCompany}/charges](https://i2-group-docs.mnai.tech/openapi/paths/~1company~1%7Bidcompany%7D~1charges/get.md): Retrieve charges of a company by idCompany.

Results are ordered by createdDate DESC.

### Company judgments

 - [GET /company/{idCompany}/judgments](https://i2-group-docs.mnai.tech/openapi/paths/~1company~1%7Bidcompany%7D~1judgments/get.md): Retrieve judgments of a company by idCompany.

Results are ordered by judgmentDate DESC.