Sandbox Test Data Generator API: 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:

{
    "accounts_due_status": "string",
    "company_status": "string",
    "company_status_detail": "string",
    "company_type": "string",
    "filing_history": [
        {
            "category": "string",
            "description": "string",
            "original_description": "string",
            "type": "string"
        }
    ],
    "has_super_secure_pscs": "boolean",
    "jurisdiction": "string",
    "number_of_appointments": "integer",
    "officer_roles": [
        "string"
    ],
    "registers": [
        {
            "register_moved_to": "string",
            "register_type": "string"
        }
    ],
    "sub_type": "string"
}

Properties

Name	Type	Description	Additional
accounts_due_status	string	The accounts due status of the test company to generate. Defaults to `overdue` Possible values are: `overdue` `due-soon`	Optional
company_status	string	The company_status of the test company to generate. Defaults to `active` Possible values are: `active` `administration` `closed` `converted-closed` `dissolved` `inactive` `insolvency-proceedings` `liquidation` `open` `receivership` `registered` `removed` `voluntary-arrangement`	Optional
company_status_detail	string	The company status detail of the test company to generate. Defaults to `active` Possible values are: `active` `active-proposal-to-strike-off` `converted-closed` `converted-to-plc` `converted-to-uk-societas` `converted-to-ukeig` `dissolved` `petition-to-restore-dissolved` `transferred-from-uk` `transformed-to-se`	Optional
company_type	string	The company type of the test company to generate. Defaults to `ltd` Possible values are: `assurance-company` `charitable-incorporated-organisation` `community-interest-company` `converted-or-closed` `eeig` `eeig-establishment` `european-public-limited-liability-company-se` `further-education-or-sixth-form-college-corporation` `icvc-securities` `icvc-umbrella` `icvc-warrant` `industrial-and-provident-society` `investment-company-with-variable-capital` `limited-partnership` `llp` `ltd` `northern-ireland` `northern-ireland-other` `old-public-company` `other` `oversea-company` `plc` `private-fund-limited-partnership` `private-limited-guarant-nsc` `private-limited-guarant-nsc-limited-exemption` `private-limited-shares-section-30-exemption` `private-unlimited` `private-unlimited-nsc` `protected-cell-company` `registered-overseas-entity` `registered-society-non-jurisdictional` `royal-charter` `scottish-charitable-incorporated-organisation` `scottish-partnership` `uk-establishment` `ukeig` `united-kingdom-societas` `unregistered-company`	Optional
filing_history[]	array	The filing history of the test company to generate. Defaults to `none`	Optional
filing_history[].category	string	The category of the filing history	Optional
filing_history[].description	string	The description of the filing history	Optional
filing_history[].original_description	string	The original description of the filing history	Optional
filing_history[].type	string	The type of the filing history	Optional
has_super_secure_pscs	boolean	Whether the test company has super secure PSCs. Defaults to not having super secure PSCs	Optional
jurisdiction	string	The jurisdiction of the test company to generate. Defaults to `england-wales` Possible values are: `england-wales` `scotland` `northern-ireland`	Optional
number_of_appointments	integer	The number of appointments for the test company to generate. Defaults to `1`	Optional
officer_roles[]	array of string	Possible values are: `cic-manager` `corporate-director` `corporate-llp-designated-member` `corporate-llp-member` `corporate-manager-of-an-eeig` `corporate-managing-officer` `corporate-member-of-a-management-organ` `corporate-member-of-a-supervisory-organ` `corporate-member-of-an-administrative-organ` `corporate-nominee-director` `corporate-nominee-secretary` `corporate-secretary` `director` `general-partner-in-a-limited-partnership` `judicial-factor` `limited-partner-in-a-limited-partnership` `llp-designated-member` `llp-member` `manager-of-an-eeig` `managing-officer` `member-of-a-management-organ` `member-of-a-supervisory-organ` `member-of-an-administrative-organ` `nominee-director` `nominee-secretary` `person-authorised-to-accept` `person-authorised-to-represent` `person-authorised-to-represent-and-accept` `receiver-and-manager` `secretary`	Optional
registers[]	array		Optional
registers[].register_moved_to	string	Where the register has been moved to	Optional
registers[].register_type	string	The type of the register	Optional
sub_type	string	The company sub type of the test company to generate. Defaults to `none` Possible values are: `community-interest-company` `private-fund-limited-partnership`	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