Create a test company

Create a test company

Request

POST https://test-data-sandbox.company-information.service.gov.uk/test-data/company

Request body

The request body takes a complete createTestCompanyRequestBody resource, containing the following writable properties:

{
    "jurisdiction": "string",
    "registeredEmailAddressChange": "boolean"
}

Properties

Name Type Description Additional
jurisdiction string

The jurisdiction of the test company to generate. Defaults to england-wales

Possible values are:

  • england-wales
  • scotland
  • northern-ireland
 Optional
registeredEmailAddressChange boolean

Set to true if creating a company to test the registered email update using the registered email address API

 Optional

Authorisation

This request requires the use of one of following authorisation methods: API key .

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
201 Created

Test company created

 createTestCompanyResponse
401 Unauthorized

Not authorised to create a test company