Companies House | Operate As Docs

Connect your client's Companies House with a key they paste, and call its API through Operate As.

Website: gov.uk
Connects by: Pasting a API key
Category: Analytics and SEO
Services: 1
Tools: Pass-through only

Service	Key	Base URL
Companies House	`companies-house`	`https://api.company-information.service.gov.uk`

Connecting

Your client makes a API key in their Companies House settings and pastes it on their link. Operate As tries it with Companies House before saving it, and stores it encrypted. See Services connected with an API key.

Check they're connected

curl https://api.operate.as/v1/me/clients \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl https://api.operate.as/v1/me/clients \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

[
  {
    "id": "6f1c2a7e-...",
    "name": "Miller Dental",
    "services": [
      "companies-house"
    ]
  }
]

[  {    "id": "6f1c2a7e-...",    "name": "Miller Dental",    "services": [      "companies-house"    ]  }]

Permissions

What the client reads	Permission it asks for
Use the Companies House key you paste, with only the access you gave that key	Chosen on the provider's screen

Pass-through

Companies House has no ready-made tools yet. Call any endpoint of its API through Operate As instead, with the client's access attached.

Add the client

In Clients, add your client and select Companies House. Then send them their link.

Your client connects

They paste a API key from their Companies House settings.

Find the endpoint

Pick the call from Companies House's own API docs. Your path is everything after https://api.company-information.service.gov.uk.

Send it through Operate As

Use the client's ID, the service key companies-house and that path. Your Operate As key goes in Authorization; the client's access is added for you.

See Pass-through requests for the full request and response format.

Call any endpoint

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../companies-house/company/00000006" \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../companies-house/company/00000006" \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

When access ends

A key works until your client deletes it in Companies House. They can paste a new one on the same link at any time, and your workflows carry on without changes.

See Keeping access alive and Removing access.

Calls answer, once the key is deleted

{
  "status": 401,
  "data": {
    "…": "the service's own error"
  },
  "encoding": "json"
}

{  "status": 401,  "data": {    "…": "the service's own error"  },  "encoding": "json"}