Sandbox Test Data Generator API: createTestCompanyRequestBody

Methods

post - Create a test company

Resource

{
    "accounts_due_status": "string",
    "active_statements": "integer",
    "advanced_search": "boolean",
    "alphabetical_search": "boolean",
    "company_name": "string",
    "company_status": "string",
    "company_status_detail": "string",
    "company_type": "string",
    "filing_history": [
        {
            "category": "string",
            "description": "string",
            "document_metadata": "boolean",
            "original_description": "string",
            "resolutions": [
                {
                    "barcode": "string",
                    "category": "string",
                    "delta_at": "string",
                    "description": "string",
                    "subcategory": "string",
                    "type": "string"
                }
            ],
            "sub_category": "string",
            "type": "string"
        }
    ],
    "has_super_secure_pscs": "boolean",
    "has_uk_establishment": "boolean",
    "is_company_number_padding": "boolean",
    "jurisdiction": "string",
    "number_of_appointments": "integer",
    "number_of_pscs": "integer",
    "officer_roles": [
        "string"
    ],
    "psc_active": "boolean",
    "psc_type": "string",
    "registered_office_is_in_dispute": "boolean",
    "registers": [
        {
            "register_moved_to": "string",
            "register_type": "string"
        }
    ],
    "sub_type": "string",
    "withdrawn_statements": "integer"
}

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
active_statements	integer	Integer value to determine the number of active PSC statements to create. Defaults to 1 or `the number_of_psc` passed in the request. Has a maximum allowed value of 20.	Optional
advanced_search	boolean	Boolean value to determine if the company is included in the advanced search. Defaults to false.	Optional
alphabetical_search	boolean	Boolean value to determine if the company is included in the alphabetical search. Defaults to false.	Optional
company_name	string	The name of the company. Creates a company with the name provided and appended with company number. Defaults to a randomly generated name.	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[].document_metadata	boolean	Adds document metadata to link self, default value is false	Optional
filing_history[].original_description	string	The original description of the filing history	Optional
filing_history[].resolutions[]	array	The resolutions associated with the filing history	Optional
filing_history[].resolutions[].barcode	string	Barcode value for resolutions type. Defaults to an empty string	Optional
filing_history[].resolutions[].category	string	Resolutions category for resolutions type (e.g., `incorporation`, `resolutions`)	Optional
filing_history[].resolutions[].delta_at	string	Convert date for delta at format and stores as string	Optional
filing_history[].resolutions[].description	string	Description for resolutions type (e.g., `resolution-re-registration`, `incorporation-company`)	Optional
filing_history[].resolutions[].subcategory	string	Sub category for resolutions type (e.g., `resolution`, `incorporation`)	Optional
filing_history[].resolutions[].type	string	Type for the resolutions type (e.g., `RES02`, `NEWINC`)	Optional
filing_history[].sub_category	string	The sub category 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
has_uk_establishment	boolean	Boolean value to determine if the oversea company has a UK establishment. Defaults to false. A `true` value will create an oversea company with a UK establishment. Used alongside `oversea-company` company type.	Optional
is_company_number_padding	boolean	Boolean value to determine if the company number padding is enabled. Defaults to false. If true, the company number will be padded with leading three zeros to a length of eight characters.	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
number_of_pscs	integer	The number of PSCs to create. Defaults to 0. Can be used to create multiple PSCs. Has a maximum allowed value of 20	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
psc_active	boolean	Boolean value to determine if the PSCs are active or ceased. To be used alongside PSC requests. Where a request is creating multiple PSCs, a false value here will set the first PSC to inactive. Defaults to true.	Optional
psc_type	string	The type of PSC to create. Defaults to `individual` Possible values are: `individual` `corporate` `legal-person` `individual-bo` `corporate-bo`	Optional
registered_office_is_in_dispute	boolean	Boolean value to determine if the registered office is in dispute. Defaults to false.	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
withdrawn_statements	integer	Integer value to determine the number of withdrawn PSC statements to create. Defaults to 0. Has a maximum allowed value of 20.	Optional

createTestCompanyRequestBody resource

Methods

Resource

Properties