From f1b8bc194e838b0d8a73e71f69b7c8c3fdc4e2ac Mon Sep 17 00:00:00 2001 From: vdmeu Date: Thu, 22 Oct 2026 09:53:01 +0100 Subject: [PATCH] Docs: say which application and key type to create Co-Authored-By: Claude --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 58aaf69..037a7c7 100644 --- a/README.md +++ b/README.md @@ -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