KosmoKrator

data

Companies House CLI for AI Agents

Use the Companies House CLI from KosmoKrator to call Companies House tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

Companies House CLI Setup

Companies House can be configured headlessly with `kosmokrator integrations:configure companies-house`.

Install, configure, and verify
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure companies-house --set api_key="$COMPANIES_HOUSE_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor companies-house --json
kosmokrator integrations:status --json

Credentials

Authentication type: API key api_key. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

KeyEnv varTypeRequiredLabel
api_key COMPANIES_HOUSE_API_KEY Secret secret yes API Key

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call
kosmo integrations:call companies-house.companies_house_search_all '{}' --json
Provider shortcut
kosmo integrations:companies-house companies_house_search_all '{}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands
kosmo integrations:docs companies-house --json
kosmo integrations:docs companies-house.companies_house_search_all --json
kosmo integrations:schema companies-house.companies_house_search_all --json
kosmo integrations:search "Companies House" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

companies-house.companies_house_search_all

Search companies, officers, and disqualified officers.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_search_all '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_search_all '{}' --json

companies-house.companies_house_search_companies

Search companies by name or number.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_search_companies '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_search_companies '{}' --json

companies-house.companies_house_advanced_search_companies

Search companies using official advanced filters.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_advanced_search_companies '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_advanced_search_companies '{}' --json

companies-house.companies_house_search_officers

Search company officers.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_search_officers '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_search_officers '{}' --json

companies-house.companies_house_search_disqualified_officers

Search disqualified officers.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_search_disqualified_officers '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_search_disqualified_officers '{}' --json

companies-house.companies_house_company_profile

Retrieve a company profile.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_company_profile '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_company_profile '{}' --json

companies-house.companies_house_registered_office_address

Retrieve a registered office address.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_registered_office_address '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_registered_office_address '{}' --json

companies-house.companies_house_officers

List company officers.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_officers '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_officers '{}' --json

companies-house.companies_house_officer_appointment

Retrieve one company officer appointment.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_officer_appointment '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_officer_appointment '{}' --json

companies-house.companies_house_officer_appointments

List appointments for an officer.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_officer_appointments '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_officer_appointments '{}' --json

companies-house.companies_house_registers

Retrieve company registers.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_registers '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_registers '{}' --json

companies-house.companies_house_filing_history

List company filing history.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_filing_history '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_filing_history '{}' --json

companies-house.companies_house_filing_history_item

Retrieve one filing history item.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_filing_history_item '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_filing_history_item '{}' --json

companies-house.companies_house_charges

List company charges.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_charges '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_charges '{}' --json

companies-house.companies_house_charge

Retrieve one company charge.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_charge '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_charge '{}' --json

companies-house.companies_house_insolvency

Retrieve insolvency information.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_insolvency '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_insolvency '{}' --json

companies-house.companies_house_exemptions

Retrieve company disclosure exemptions.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_exemptions '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_exemptions '{}' --json

companies-house.companies_house_uk_establishments

List UK establishments for an overseas company.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_uk_establishments '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_uk_establishments '{}' --json

companies-house.companies_house_psc_list

List persons with significant control.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_psc_list '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_psc_list '{}' --json

companies-house.companies_house_psc_statements

List PSC statements.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_psc_statements '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_psc_statements '{}' --json

companies-house.companies_house_psc_individual

Retrieve an individual PSC.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_psc_individual '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_psc_individual '{}' --json

companies-house.companies_house_psc_corporate_entity

Retrieve a corporate-entity PSC.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_psc_corporate_entity '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_psc_corporate_entity '{}' --json

companies-house.companies_house_psc_legal_person

Retrieve a legal-person PSC.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_psc_legal_person '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_psc_legal_person '{}' --json

companies-house.companies_house_psc_super_secure

Retrieve a super-secure PSC.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_psc_super_secure '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_psc_super_secure '{}' --json

companies-house.companies_house_psc_individual_beneficial_owner

Retrieve an individual beneficial owner PSC.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_psc_individual_beneficial_owner '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_psc_individual_beneficial_owner '{}' --json

companies-house.companies_house_psc_corporate_entity_beneficial_owner

Retrieve a corporate-entity beneficial owner PSC.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_psc_corporate_entity_beneficial_owner '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_psc_corporate_entity_beneficial_owner '{}' --json

companies-house.companies_house_psc_legal_person_beneficial_owner

Retrieve a legal-person beneficial owner PSC.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_psc_legal_person_beneficial_owner '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_psc_legal_person_beneficial_owner '{}' --json

companies-house.companies_house_psc_super_secure_beneficial_owner

Retrieve a super-secure beneficial owner PSC.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_psc_super_secure_beneficial_owner '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_psc_super_secure_beneficial_owner '{}' --json

companies-house.companies_house_psc_statement

Retrieve one PSC statement.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_psc_statement '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_psc_statement '{}' --json

companies-house.companies_house_disqualified_officer_natural

Retrieve a natural disqualified officer.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_disqualified_officer_natural '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_disqualified_officer_natural '{}' --json

companies-house.companies_house_disqualified_officer_corporate

Retrieve a corporate disqualified officer.

Read read
Parameters
none
Generic call
kosmo integrations:call companies-house.companies_house_disqualified_officer_corporate '{}' --json
Shortcut
kosmo integrations:companies-house companies_house_disqualified_officer_corporate '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

companies-house.companies_house_search_all 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_search_all --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_search_companies 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_search_companies --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_advanced_search_companies 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_advanced_search_companies --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_search_officers 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_search_officers --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_search_disqualified_officers 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_search_disqualified_officers --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_company_profile 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_company_profile --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_registered_office_address 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_registered_office_address --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_officers 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_officers --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_officer_appointment 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_officer_appointment --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_officer_appointments 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_officer_appointments --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_registers 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_registers --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_filing_history 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_filing_history --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_filing_history_item 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_filing_history_item --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_charges 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_charges --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_charge 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_charge --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_insolvency 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_insolvency --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_exemptions 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_exemptions --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_uk_establishments 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_uk_establishments --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_psc_list 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_psc_list --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_psc_statements 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_psc_statements --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_psc_individual 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_psc_individual --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_psc_corporate_entity 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_psc_corporate_entity --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_psc_super_secure 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_psc_super_secure --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_psc_individual_beneficial_owner 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_psc_individual_beneficial_owner --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_psc_corporate_entity_beneficial_owner 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_psc_corporate_entity_beneficial_owner --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_psc_super_secure_beneficial_owner 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_psc_super_secure_beneficial_owner --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_psc_statement 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_psc_statement --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_disqualified_officer_natural 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_disqualified_officer_natural --json
ParameterTypeRequiredDescription
No parameters.
companies-house.companies_house_disqualified_officer_corporate 0 parameters
Schema command
kosmo integrations:schema companies-house.companies_house_disqualified_officer_corporate --json
ParameterTypeRequiredDescription
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.