Skip to content

Docs: say which application and key type to create #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vdmeu wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Docs: say which application and key type to create #232

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ Register an application on the
[Companies House developer hub](https://developer.company-information.service.gov.uk/)
to get an API key for the public data API.

Choose a **live** application (test applications are for the sandbox) and create a key of type
**API key**, not stream key. A [step-by-step walkthrough](https://registrum.co.uk/guides/how-to-get-a-companies-house-api-key)
covers each screen, and [this checklist](https://registrum.co.uk/guides/companies-house-api-key-not-working)
covers the usual causes of a 401.

## Getting started

### Constructing the client directly
Expand Down