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 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.
| Key | Env var | Type | Required | Label |
|---|---|---|---|---|
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.
kosmo integrations:call companies-house.companies_house_search_all '{}' --json 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.
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 - Parameters
- none
kosmo integrations:call companies-house.companies_house_search_all '{}' --json kosmo integrations:companies-house companies_house_search_all '{}' --json companies-house.companies_house_search_companies
Search companies by name or number.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_search_companies '{}' --json kosmo integrations:companies-house companies_house_search_companies '{}' --json companies-house.companies_house_advanced_search_companies
Search companies using official advanced filters.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_advanced_search_companies '{}' --json kosmo integrations:companies-house companies_house_advanced_search_companies '{}' --json companies-house.companies_house_search_officers
Search company officers.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_search_officers '{}' --json kosmo integrations:companies-house companies_house_search_officers '{}' --json companies-house.companies_house_search_disqualified_officers
Search disqualified officers.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_search_disqualified_officers '{}' --json kosmo integrations:companies-house companies_house_search_disqualified_officers '{}' --json companies-house.companies_house_company_profile
Retrieve a company profile.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_company_profile '{}' --json kosmo integrations:companies-house companies_house_company_profile '{}' --json companies-house.companies_house_registered_office_address
Retrieve a registered office address.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_registered_office_address '{}' --json kosmo integrations:companies-house companies_house_registered_office_address '{}' --json companies-house.companies_house_officers
List company officers.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_officers '{}' --json kosmo integrations:companies-house companies_house_officers '{}' --json companies-house.companies_house_officer_appointment
Retrieve one company officer appointment.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_officer_appointment '{}' --json kosmo integrations:companies-house companies_house_officer_appointment '{}' --json companies-house.companies_house_officer_appointments
List appointments for an officer.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_officer_appointments '{}' --json kosmo integrations:companies-house companies_house_officer_appointments '{}' --json companies-house.companies_house_registers
Retrieve company registers.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_registers '{}' --json kosmo integrations:companies-house companies_house_registers '{}' --json companies-house.companies_house_filing_history
List company filing history.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_filing_history '{}' --json kosmo integrations:companies-house companies_house_filing_history '{}' --json companies-house.companies_house_filing_history_item
Retrieve one filing history item.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_filing_history_item '{}' --json kosmo integrations:companies-house companies_house_filing_history_item '{}' --json companies-house.companies_house_charges
List company charges.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_charges '{}' --json kosmo integrations:companies-house companies_house_charges '{}' --json companies-house.companies_house_charge
Retrieve one company charge.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_charge '{}' --json kosmo integrations:companies-house companies_house_charge '{}' --json companies-house.companies_house_insolvency
Retrieve insolvency information.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_insolvency '{}' --json kosmo integrations:companies-house companies_house_insolvency '{}' --json companies-house.companies_house_exemptions
Retrieve company disclosure exemptions.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_exemptions '{}' --json kosmo integrations:companies-house companies_house_exemptions '{}' --json companies-house.companies_house_uk_establishments
List UK establishments for an overseas company.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_uk_establishments '{}' --json kosmo integrations:companies-house companies_house_uk_establishments '{}' --json companies-house.companies_house_psc_list
List persons with significant control.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_psc_list '{}' --json kosmo integrations:companies-house companies_house_psc_list '{}' --json companies-house.companies_house_psc_statements
List PSC statements.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_psc_statements '{}' --json kosmo integrations:companies-house companies_house_psc_statements '{}' --json companies-house.companies_house_psc_individual
Retrieve an individual PSC.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_psc_individual '{}' --json kosmo integrations:companies-house companies_house_psc_individual '{}' --json companies-house.companies_house_psc_corporate_entity
Retrieve a corporate-entity PSC.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_psc_corporate_entity '{}' --json kosmo integrations:companies-house companies_house_psc_corporate_entity '{}' --json companies-house.companies_house_psc_legal_person
Retrieve a legal-person PSC.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_psc_legal_person '{}' --json kosmo integrations:companies-house companies_house_psc_legal_person '{}' --json companies-house.companies_house_psc_super_secure
Retrieve a super-secure PSC.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_psc_super_secure '{}' --json 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 - Parameters
- none
kosmo integrations:call companies-house.companies_house_psc_individual_beneficial_owner '{}' --json 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 - Parameters
- none
kosmo integrations:call companies-house.companies_house_psc_corporate_entity_beneficial_owner '{}' --json 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 - Parameters
- none
kosmo integrations:call companies-house.companies_house_psc_legal_person_beneficial_owner '{}' --json 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 - Parameters
- none
kosmo integrations:call companies-house.companies_house_psc_super_secure_beneficial_owner '{}' --json kosmo integrations:companies-house companies_house_psc_super_secure_beneficial_owner '{}' --json companies-house.companies_house_psc_statement
Retrieve one PSC statement.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_psc_statement '{}' --json kosmo integrations:companies-house companies_house_psc_statement '{}' --json companies-house.companies_house_disqualified_officer_natural
Retrieve a natural disqualified officer.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_disqualified_officer_natural '{}' --json kosmo integrations:companies-house companies_house_disqualified_officer_natural '{}' --json companies-house.companies_house_disqualified_officer_corporate
Retrieve a corporate disqualified officer.
read - Parameters
- none
kosmo integrations:call companies-house.companies_house_disqualified_officer_corporate '{}' --json 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
kosmo integrations:schema companies-house.companies_house_search_all --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_search_companies 0 parameters
kosmo integrations:schema companies-house.companies_house_search_companies --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_advanced_search_companies 0 parameters
kosmo integrations:schema companies-house.companies_house_advanced_search_companies --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_search_officers 0 parameters
kosmo integrations:schema companies-house.companies_house_search_officers --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_search_disqualified_officers 0 parameters
kosmo integrations:schema companies-house.companies_house_search_disqualified_officers --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_company_profile 0 parameters
kosmo integrations:schema companies-house.companies_house_company_profile --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_registered_office_address 0 parameters
kosmo integrations:schema companies-house.companies_house_registered_office_address --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_officers 0 parameters
kosmo integrations:schema companies-house.companies_house_officers --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_officer_appointment 0 parameters
kosmo integrations:schema companies-house.companies_house_officer_appointment --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_officer_appointments 0 parameters
kosmo integrations:schema companies-house.companies_house_officer_appointments --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_registers 0 parameters
kosmo integrations:schema companies-house.companies_house_registers --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_filing_history 0 parameters
kosmo integrations:schema companies-house.companies_house_filing_history --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_filing_history_item 0 parameters
kosmo integrations:schema companies-house.companies_house_filing_history_item --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_charges 0 parameters
kosmo integrations:schema companies-house.companies_house_charges --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_charge 0 parameters
kosmo integrations:schema companies-house.companies_house_charge --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_insolvency 0 parameters
kosmo integrations:schema companies-house.companies_house_insolvency --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_exemptions 0 parameters
kosmo integrations:schema companies-house.companies_house_exemptions --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_uk_establishments 0 parameters
kosmo integrations:schema companies-house.companies_house_uk_establishments --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_psc_list 0 parameters
kosmo integrations:schema companies-house.companies_house_psc_list --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_psc_statements 0 parameters
kosmo integrations:schema companies-house.companies_house_psc_statements --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_psc_individual 0 parameters
kosmo integrations:schema companies-house.companies_house_psc_individual --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_psc_corporate_entity 0 parameters
kosmo integrations:schema companies-house.companies_house_psc_corporate_entity --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_psc_legal_person 0 parameters
kosmo integrations:schema companies-house.companies_house_psc_legal_person --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_psc_super_secure 0 parameters
kosmo integrations:schema companies-house.companies_house_psc_super_secure --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_psc_individual_beneficial_owner 0 parameters
kosmo integrations:schema companies-house.companies_house_psc_individual_beneficial_owner --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_psc_corporate_entity_beneficial_owner 0 parameters
kosmo integrations:schema companies-house.companies_house_psc_corporate_entity_beneficial_owner --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_psc_legal_person_beneficial_owner 0 parameters
kosmo integrations:schema companies-house.companies_house_psc_legal_person_beneficial_owner --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_psc_super_secure_beneficial_owner 0 parameters
kosmo integrations:schema companies-house.companies_house_psc_super_secure_beneficial_owner --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_psc_statement 0 parameters
kosmo integrations:schema companies-house.companies_house_psc_statement --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_disqualified_officer_natural 0 parameters
kosmo integrations:schema companies-house.companies_house_disqualified_officer_natural --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
companies-house.companies_house_disqualified_officer_corporate 0 parameters
kosmo integrations:schema companies-house.companies_house_disqualified_officer_corporate --json | Parameter | Type | Required | Description |
|---|---|---|---|
| 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.