Britixo CRMBritixo CRM Enterprise Help Centre
Companies House & Fresh UK leads · How-to guide

Save and validate the Companies House API key

Store the module-specific Public Data API key only after the module validates it.

Audience: Administrators and authorised lead-generation staffPermission: Administrator accessModule v1.0.0
Feature pathFresh UK Leads → API Connection
Before you beginThis guide documents the supplied module workflow. Public data and internet research can become outdated and must be checked before operational use.

What this feature does

Store the module-specific Public Data API key only after the module validates it. The supplied Companies House Leads module keeps the saved Companies House result, public-people refresh, internet evidence, internal lead intelligence, native lead import and Letter Manager history as connected but distinct stages. A result should not be treated as verified or imported unless its displayed status confirms that stage.

How the workflow fits together

The supplied Companies House Leads module keeps the saved Companies House result, public-people refresh, internet evidence, internal lead intelligence, native lead import and Letter Manager history as connected but distinct stages. A result should not be treated as verified or imported unless its displayed status confirms that stage. Use the screen’s current status, warnings and related-record links to decide the next permitted action. Where the module creates a downstream document, queue item, native lead or audit event, verify that record separately.

Step-by-step workflow

  1. Open Fresh UK Leads → API Connection.
  2. Review the existing configuration, status and related records before changing a control.
  3. Select only the implemented options required for the intended workflow.
  4. Apply the least-privilege, minimum-data and evidence-based setting.
  5. Save the configuration and reopen the record to verify persistence.
  6. Test the affected workflow with a controlled record before relying on it operationally.

Important fields and decisions

API keyEnter the Companies House Public Data API key in the password field; the module validates it before saving.
Connection stateThe page shows whether a valid key was found and only displays the final characters when ready.
Key sourceThe module records that the key came from its manual module setting.
Failure messageA rejected or empty key is not saved over the current valid configuration.

Record lifecycle and audit

The module retains operational state separately from the message shown after submission. Reopen the relevant register and confirm the identifier, status, linked employee or company, dates, owner, decision note and any generated document or downstream record. Review the audit, activity, access, export, scheduler or letter history available for this area.

What happens after completion

After the action completes, the updated record remains available through Fresh UK Leads → API Connection or its related register. Confirm the expected status and check any connected workflow—such as a payroll draft, protected document, portal request, export job, notification queue, native lead or Letter Manager entry—rather than assuming every downstream step completed automatically.

Controls, checks and common mistakes

  • Use the exact employee, record, period, search or lead reference shown by the module; similar names are not sufficient confirmation.
  • Do not bypass a missing permission, disabled control, validation warning or restricted status by changing an unrelated setting.
  • Confirm the final saved record, register entry and audit/activity history instead of relying only on a success alert.
  • Use the least destructive correction. Preserve history when the operational event genuinely occurred.
  • Treat Companies House, directory and website data as research evidence that may require a current manual check before outreach.
  • Do not import, contact or send a letter to a suppressed or review-required company until the displayed evidence has been assessed.
Data and workflow safetyThis guide documents the supplied module workflow. Public data and internet research can become outdated and must be checked before operational use. Confirm the exact record, authorised audience and final module status before exporting, publishing, importing, contacting or deleting anything.
Browse connected topics:companies housefresh uk leads
Companies House Leads module overview →Open Fresh UK Leads →Search companies by SIC code →Filter companies by incorporation date →