user guide
UK Companies House Lookup Premium
Help & Documentation
This guide walks you through setting up your API key, adding the PCF control, and verifying it's working — with screenshots and a live demo.
UK Companies House Lookup Premium – Configuration & API Key Setup
Welcome to UK Companies House Lookup Premium!
To start using real-time Companies House validation and data enrichment, you’ll need to generate your own API Key from the GOV.UK Register and configure it inside the PCF control.
Follow the steps below.
1. How to Obtain and Configure Your UK Companies House API Key
Sign in, or register for a free Companies House account.
Once signed in, open Manage Applications.
In the left menu, select Manage Applications → Create an application.
Fill in the required fields:
Application Name: e.g., UK Companies House API Key
Description: e.g., API key for Dynamics 365 integration
Under Choose an environment, select Live, then click Create.
After creating the application, go back to Manage Applications → View all applications.
Locate your new application under Live Applications, then open it.
Scroll to Keys for this application and click Create new key.
Complete the form:
Title: Enter a key name (e.g., Dynamics 365 Integration Key)
Description: Short description
Key Type: Select REST
After selecting REST, two boxes appear. In the JavaScript domains box, add your CRM environment URL. Examples:
https://<yourorg>.crm11.dynamics.com(UK region)https://<yourorg>.crm6.dynamics.com(Australia/New Zealand)https://<yourorg>.crm4.dynamics.com(Europe)
Click Create Key.
Your API Key will be generated immediately.
Copy this API Key — you’ll need to paste it into the PCF control (see below).
2. Add the PCF Control to Your Solution
Note: You do not need to re-use our sample solution. Simply drop the UK Companies House Lookup Premium PCF into your own solution.
Steps:
-
Go to make.powerapps.com
-
Open the solution where you want to use the CompaniesHouseLookup Premium tool
-
Navigate to: Data → Tables, then select the table (e.g., Account, Contact, or a custom table)
-
Under Columns, click your Companies House field
-
Open the Controls tab
-
Click + Add Control → select CompaniesHouseLookup
-
Click Save
3. Enter Your Companies House API Key
Once the control is added, configure it inside your solution:
On any form using the control, click it → Edit Properties.
In the Custom Properties pane, locate API Key (API_Key).
Paste the Companies House API Key you generated in Step 1.
Map the necessary fields (e.g., Company Number, Company Name, Director Name, Director Role) as required.
Click Save, then Publish All Customizations.
📌 Notes:
You only need to enter the API key once per environment.
Ensure the UK Companies House field uses Single Line of Text format.
The control supports both UK Companies House number and Company Name search.
