How to create an application
Creating an application
- Sign in to create an application.
- Provide a name and description for the application.
- Choose whether you want a test application for use against our sandbox environment or a live application for use in production.
- Provide optional links to the privacy policy URL and terms and conditions URL of your service.
- Select 'Create'.
- A new application will be created. You can then create API clients for your application.
API clients created for to your application can then be used to interact with the Companies House API and OAuth 2.0 service. There are 3 types of API client: API key, stream key and OAuth web client.
Creating an API client
- Sign in to see the application overview.
- Select the application you’d like to create a key for, or select 'Create an application' to create a new one.
- Select 'Create new key'.
- Provide a name for the key and choose the client type.
- Select 'Create'.
- Unique API client credentials will be generated.
API or stream keys can be sent with most GET
requests for a public resource served by the Companies House API. OAuth web client ID and secret combinations
can be used to interact with the Companies House OAuth 2.0 service.
API authentication details how to use each type of API client with the Companies House API and OAuth 2.0 services.