{ "swagger": "2.0", "info": { "version": "1.0.0", "title": "Sandbox Test Data Generator API", "description": "Sandbox API suite to generate test data on demand" }, "host": "test-data-sandbox.company-information.service.gov.uk", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [{ "name": "companyTestData", "description": "Company Test Data" } ], "securityDefinitions": { "api_key": { "type": "apiKey", "name": "api_key", "in": "header" } }, "security": [{ "api_key": [] } ], "paths": { "/test-data/company": { "post": { "summary": "Create a test company", "description": "Create a test company", "tags": [ "companyTestData" ], "x-operationName": "create", "parameters": [{ "name": "request", "in": "body", "description": "The options available for creating a test company", "required": false, "schema": { "$ref": "http://127.0.0.1:10000/api.ch.gov.uk-specifications/swagger-2.0/spec/test-data-generator-public.json#/definitions/createTestCompanyRequestBody" } }], "responses": { "201": { "description": "Test company created", "schema": { "$ref": "http://127.0.0.1:10000/api.ch.gov.uk-specifications/swagger-2.0/spec/test-data-generator-public.json#/definitions/createTestCompanyResponse" } }, "401": { "description": "Not authorised to create a test company" } } } }, "/test-data/company/{companyNumber}": { "delete": { "summary": "Delete a test company", "description": "Delete a test company", "tags": [ "companyTestData" ], "x-operationName": "delete", "parameters": [{ "name": "request", "in": "body", "description": "The information required to delete a test company", "required": true, "schema": { "$ref": "http://127.0.0.1:10000/api.ch.gov.uk-specifications/swagger-2.0/spec/test-data-generator-public.json#/definitions/deleteTestCompanyRequestBody" } }], "responses": { "204": { "description": "Test company deleted" }, "401": { "description": "Not authorised to delete a test company" } } } } }, "definitions": { "createTestCompanyRequestBody": { "title": "createTestCompanyRequestBody", "properties": { "jurisdiction": { "description": "The jurisdiction of the test company to generate. Defaults to `england-wales`", "type": "string", "enum": [ "england-wales", "scotland", "northern-ireland" ] }, "company_status": { "description": "The company_status of the test company to generate. Defaults to `active`", "type": "string", "enum": [ "active", "administration", "closed", "converted-closed", "dissolved", "inactive", "insolvency-proceedings", "liquidation", "open", "receivership", "registered", "removed", "voluntary-arrangement" ] }, "company_type": { "description": "The company type of the test company to generate. Defaults to `ltd`", "type": "string", "enum": [ "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" ] }, "sub_type": { "description": "The company sub type of the test company to generate. Defaults to `none`", "type": "string", "enum": [ "community-interest-company", "private-fund-limited-partnership" ] }, "company_status_detail": { "description": "The company status detail of the test company to generate. Defaults to `active`", "type": "string", "enum": [ "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" ] }, "filing_history": { "description": "The filing history of the test company to generate. Defaults to `none`. Maximum of 20 items can be specified.", "type": "array", "items": { "properties": { "type": { "type": "string", "description": "The type of the filing history", "enum": [ "1(Scot)", "1.1", "1.1(NI)", "1.1(Scot)", "1.11", "1.11(NI)", "1.11(Scot)", "1.12", "1.12(NI)", "1.12(Scot)", "1.14", "1.14(NI)", "1.14(Scot)", "1.16", "1.16(NI)", "1.18(NI)", "1.2", "1.2(NI)", "1.3", "1.3(NI)", "1.3(Scot)", "1.4", "1.4(NI)", "1.4(Scot)", "107(NI)", "11(NI)", "117", "12.1", "122", "123", "127(NI)", "128(1)", "128(3)", "128(4)", "128(U)", "129(1)", "129(3)", "132(NI)", "133(NI)", "138-1(NI)", "138-3(NI)", "138-4(NI)", "139", "147", "155(6)a", "155(6)b", "157", "1656A(NI)", "1656B(NI)", "169", "169(1B)", "169A(2)", "17(NI)", "173", "179(NI)", "183(NI)", "190", "190a", "199(NI)", "1F(NI)", "2(Scot)", "2.07(NI)", "2.08(NI)", "2.1(NI)", "2.1(Scot)", "2.11(Scot)", "2.11B(Scot)", "2.12(Scot)", "2.12B", "2.12B(NI)", "2.15", "2.15(NI)", "2.15B(Scot)", "2.16(NI)", "2.16B", "2.16B(NI)", "2.16B(Scot)", "2.16BZ(Scot)", "2.17B", "2.17B(NI)", "2.17B(Scot)", "2.18", "2.18B", "2.18B(Scot)", "2.18BA(NI)", "2.19", "2.19(NI)", "2.19B(Scot)", "2.2(NI)", "2.2(Scot)", "2.20", "2.20(NI)", "2.20B(Scot)", "2.21", "2.21(NI)", "2.21B(Scot)", "2.22(NI)", "2.22B", "2.22B(NI)", "2.22B(Scot)", "2.23", "2.23B", "2.23B(NI)", "2.23B(Scot)", "2.24(NI)", "2.24B", "2.24B(NI)", "2.24B(Scot)", "2.25B(Scot)", "2.26B", "2.26B(Scot)", "2.27B", "2.27B(Scot)", "2.28B", "2.29B(Scot)", "2.2B(Scot)", "2.3(Scot)", "2.30B", "2.30B(NI)", "2.30B(Scot)", "2.31B", "2.31B(NI)", "2.31B(Scot)", "2.32B", "2.32B(NI)", "2.32B(Scot)", "2.33B", "2.33B(NI)", "2.34B", "2.34B(NI)", "2.35B", "2.35B(NI)", "2.36B", "2.36B(NI)", "2.38B", "2.38B(NI)", "2.39B", "2.39B(NI)", "2.4(Scot)", "2.40B", "2.40B(NI)", "2.6", "2.7", "2.7(Scot)", "2.8(Scot)", "2.9(Scot)", "224", "225", "225(1)", "225(2)", "23(NI)", "232(NI)", "233(NI)", "233-1(NI)", "233-2(NI)", "242", "244", "250(NI)", "252(NI)", "252-5(NI)", "26(NI)", "266(1)", "266(3)", "28(NI)", "287", "288", "288(U)", "288a", "288b", "288c", "295(NI)", "296(NI)", "3(Scot)", "3.05(NI)", "3.06(NI)", "3.07(NI)", "3.08(NI)", "3.09(NI)", "3.10", "3.10(NI)", "3.12(NI)", "3.2(Scot)", "3.3", "3.3(Scot)", "3.4", "3.5", "3.5(Scot)", "3.6", "3.7", "3.8", "30(NI)", "318", "32(NI)", "325", "325a", "326(NI)", "333(NI)", "35(NI)", "353", "353a", "361(NI)", "361A(NI)", "362", "362a", "363", "363(190)", "363(287)", "363(288)", "363(353)", "363(C)", "363a", "363b", "363s", "363x", "37(NI)", "370(NI)", "371A(NI)", "371AR(NI)", "371S(NI)", "371SR(NI)", "386", "391", "394(NI)", "395", "397", "397a", "398", "39B(NI)", "39C(NI)", "39D(NI)", "3F(NI)", "4.11(NI)", "4.11(Scot)", "4.13", "4.15A", "4.16(Scot)", "4.17(Scot)", "4.18(Scot)", "4.19(NI)", "4.19(Scot)", "4.2(NI)", "4.2(Scot)", "4.20", "4.20(NI)", "4.21(NI)", "4.22(Scot)", "4.24(Scot)", "4.25(Scot)", "4.26(NI)", "4.26(Scot)", "4.27(Scot)", "4.31", "4.32(NI)", "4.33", "4.34(NI)", "4.35", "4.36(NI)", "4.38", "4.39(NI)", "4.40", "4.41(NI)", "4.43", "4.43(NI)", "4.44", "4.44(NI)", "4.45(NI)", "4.46", "4.47(NI)", "4.48", "4.48(NI)", "4.49(NI)", "4.5(NI)", "4.50(NI)", "4.51", "4.52(NI)", "4.6(Scot)", "4.68", "4.69", "4.69(NI)", "4.70", "4.70(NI)", "4.71", "4.71(NI)", "4.72", "4.72(NI)", "4.73(NI)", "4.9(Scot)", "40-5A(NI)", "40-5B(NI)", "40-5C(NI)", "400", "402(NI)", "402DF(NI)", "402PP(NI)", "402R(NI)", "403a", "403b", "404(NI)", "404A(NI)", "405(1)", "405(2)", "405(NI)", "407(NI)", "408(NI)", "410(Scot)", "411A(NI)", "411B(NI)", "413(Scot)", "413-1(NI)", "413a(Scot)", "416(Scot)", "419a(Scot)", "419b(Scot)", "42(NI)", "43(3)", "43(3)e", "43(NI)", "44A(NI)", "45(NI)", "4612A(NI)", "4612B(NI)", "463(NI)", "466(Scot)", "47", "47b", "49(1)", "49(8)(a)", "49(8)(b)", "49A(NI)", "51", "52", "52(NI)", "53", "53(3)(NI)", "53-3(NI)", "53-3E(NI)", "54", "55(NI)", "558(NI)", "558A(NI)", "558B(NI)", "558C(NI)", "59(NI)", "59-8A(NI)", "59-8B(NI)", "5F(NI)", "6", "60(NI)", "600", "603A(NI)", "603AR(NI)", "603C(NI)", "61(NI)", "63(NI)", "64(NI)", "641(NI)", "642-2(NI)", "6421A(NI)", "6421B(NI)", "6421C(NI)", "644A(NI)", "650-2(NI)", "6506A(NI)", "6506B(NI)", "650A(NI)", "650B(NI)", "650C(NI)", "652C", "652a", "691", "691-REREG", "692(1)(a)", "692(1)(b)", "692(1)(c)", "692(2)", "694(4)(a)", "694(4)(b)", "694(a)", "694(b)", "695A(3)", "701a", "701b", "701c", "703P(1)", "703P(3)", "703P(5)", "703Q(1)", "7F(NI)", "88(2)", "88(2)C", "88(2)O", "88(2)P", "88(2)R", "88(3)", "97", "98(2)(NI)", "98(3)(NI)", "98-2(NI)", "98-3(NI)", "A2(NI)", "A3(NI)", "A3A(NI)", "A5(NI)", "A7F(NI)", "AA", "AA01", "AA03", "AAMD", "AC(NI)", "AC05", "AC07", "AC09", "AC20", "AC21", "AC41", "AC42", "AC92", "AC93", "AC94", "ACX(NI)", "ACXR(NI)", "AD01", "AD02", "AD03", "AD04", "AD05", "ADDR(C)", "AFF(NI)", "AGREE(NI)", "AGREEMENT1", "AGREEMENT2", "ALLOT(NI)", "ALLOTCORR", "AM01", "AM01(Scot)", "AM02", "AM02(Scot)", "AM03", "AM03(Scot)", "AM04", "AM04(Scot)", "AM05", "AM05(Scot)", "AM06", "AM06(Scot)", "AM07", "AM07(Scot)", "AM08", "AM08(Scot)", "AM09", "AM09(Scot)", "AM10", "AM10(Scot)", "AM11", "AM11(Scot)", "AM12", "AM12(Scot)", "AM13", "AM13(Scot)", "AM14", "AM14(Scot)", "AM15", "AM15(Scot)", "AM16", "AM16(Scot)", "AM17", "AM17(Scot)", "AM18", "AM18(Scot)", "AM19", "AM19(Scot)", "AM20", "AM20(Scot)", "AM21", "AM21(Scot)", "AM22", "AM22(Scot)", "AM23", "AM23(Scot)", "AM24", "AM24(Scot)", "AM25", "AM25(Scot)", "ANNOTATION", "AP01", "AP02", "AP03", "AP04", "AP05", "AR(NI)", "AR01", "ARTS(NI)", "AUD", "AUDR", "AUDS", "AURES(NI)", "BONA", "BR1", "BR1(NI)", "BR1-BCH", "BR1-PAR", "BR2", "BR2(NI)", "BR3", "BR3(NI)", "BR4", "BR4(NI)", "BR5", "BR5(NI)", "BR6", "BR6(NI)", "BS", "BUSADD", "BUSADDCH", "C-MIN(NI)", "C-ORD(NI)", "C-RES(NI)", "C.48", "C402(NI)", "CAP-MDSC", "CAP-SS", "CC01", "CC02", "CC03", "CC04", "CC05", "CC06", "CENT8", "CERT(INC)(NI)", "CERT(U)", "CERT1", "CERT10", "CERT11", "CERT12", "CERT13", "CERT15", "CERT16", "CERT17", "CERT18", "CERT19", "CERT2", "CERT20", "CERT21", "CERT22", "CERT23", "CERT3", "CERT4", "CERT5", "CERT6", "CERT7", "CERT8", "CERT8A", "CERT9", "CERTC(NI)", "CERTFI", "CERTINC", "CERTIPS", "CERTNM", "CH01", "CH02", "CH03", "CH04", "CHARTER", "CICCON", "CICINC", "CLOMERGE", "CLOSE", "CLOSE-LP", "CLTNI(NI)", "CNMNI(NI)", "CNR-D(NI)", "CNRES(NI)", "CO MORT MISC", "CO-ADD", "CO4.2(Scot)", "COADMIN", "COAPP", "COCOMP", "CODIS", "COLIQ", "COLIQ86", "COM1", "COM1(Scot)", "COM2", "COM2(Scot)", "COM3", "COM4", "CON(NI)", "CONDIR", "CONNOT", "COPAR(NI)", "CORECTIFY", "CS01", "CVA1", "CVA1(Scot)", "CVA2", "CVA2(Scot)", "CVA3", "CVA3(Scot)", "CVA4", "CVA4(Scot)", "DECL(NI)", "DETERMINAT", "DETERMINAT(NI)", "DIRS(NI)", "DISS16(SOAS)", "DISS40", "DISS6", "DRSCH(NI)", "DS01", "DS02", "DTOM", "EC REGS D", "EC REGS F", "EEAP01", "EEAP02", "EECH01", "EEFM01", "EEFM02", "EEIG-ADD", "EEIG1", "EH01", "EH02", "EH03", "EH04", "EH05", "EH06", "EJO(NI)", "EW01", "EW01RSS", "EW02", "EW03", "EW03RSS", "EW04", "EW04RSS", "EW05", "EW05RSS", "EXLIQ", "EXMLA(NI)", "F10.2", "F14", "F2.18", "F4.39", "F4.41", "F4.47", "F8(NI)", "F9.4", "FA(NI)", "FCART(NI)", "FCMEM(NI)", "FE01", "FOA-RR", "FPA", "G1(NI)", "G21(NI)", "G23(NI)", "G4A(NI)", "G629A(NI)", "G8(NI)", "G98-2(NI)", "GAZ(U)", "GAZ1", "GAZ1(A)", "GAZ2", "GAZ2(A)", "GEN117", "GF14(NI)", "GR4(NI)", "GR8(NI)", "GUARANTEE1", "GUARANTEE2", "HC 3(3)(C)", "HC01", "HC02", "IC01", "IC02", "IC65(2)", "IC65(4a)", "IC65(4b)", "IC65(4c)", "IC65(4d)", "IC7", "ICVCCON", "IE04", "IE04(NI)", "IE04(Scot)", "IE05", "IE05(NI)", "IE05(Scot)", "IPV(NI)", "L-A(NI)", "L100(NI)", "L104(NI)", "L106(NI)", "L107(NI)", "L131(NI)", "L21(NI)", "L22(NI)", "L64.01", "L64.04", "L64.06", "L64.07", "L80(NI)", "L82A(NI)", "L83(NI)", "L85(NI)", "L86(NI)", "L87(NI)", "L88(NI)", "L89(NI)", "L92(NI)", "LET-CESS", "LGLO", "LIQ", "LIQ JUDG F", "LIQ MISC", "LIQ MISC OC", "LIQ MISC OC(NI)", "LIQ MISC RES", "LIQ(NI)", "LIQ01", "LIQ02", "LIQ03", "LIQ04", "LIQ04(Scot)", "LIQ05", "LIQ06", "LIQ07", "LIQ08", "LIQ09", "LIQ10", "LIQ11", "LIQ12", "LIQ13", "LIQ13(Scot)", "LIQ14", "LIQ14(Scot)", "LIQ15(Scot)", "LLAA01", "LLAA02", "LLAD01", "LLAD02", "LLAD03", "LLAD04", "LLAD05", "LLAD05 ", "LLAP01", "LLAP02", "LLAR01", "LLCH01", "LLCH02", "LLCS01", "LLDE01", "LLDS01", "LLDS02", "LLEH01", "LLEH02", "LLEH04", "LLEW01", "LLEW01RSS", "LLEW02", "LLEW04", "LLEW04RSS", "LLIN01", "LLMG01", "LLMG01s", "LLMG02", "LLMG02s", "LLMG03s", "LLMG04", "LLMG04s", "LLMG05s", "LLMG06", "LLMG07", "LLMG08", "LLMR01", "LLMR02", "LLMR03", "LLMR04", "LLMR05", "LLMR06", "LLMR07", "LLMR08", "LLMR09", "LLMR10", "LLNM01", "LLP190", "LLP2", "LLP2(NI)", "LLP225", "LLP233(NI)", "LLP287", "LLP288a", "LLP288b", "LLP288c", "LLP295(NI)", "LLP296(NI)", "LLP296A(NI)", "LLP296B(NI)", "LLP296C(NI)", "LLP3", "LLP3(NI)", "LLP363", "LLP371(NI)", "LLP371S(NI)", "LLP391", "LLP395", "LLP400", "LLP402(NI)", "LLP403a", "LLP403b", "LLP405(NI)", "LLP410(Scot)", "LLP411A(NI)", "LLP419a(Scot)", "LLP466(Scot)", "LLP603A(NI)", "LLP603C(NI)", "LLP652a", "LLP652c", "LLP8", "LLP8(NI)", "LLPACCS(NI)", "LLPAUD", "LLPBONA", "LLPCERTM(NI)", "LLPCERTN(NI)", "LLPMISC", "LLPSC01", "LLPSC02", "LLPSC03", "LLPSC04", "LLPSC05", "LLPSC06", "LLPSC07", "LLPSC08", "LLPSC09", "LLRM01", "LLRM02", "LLTM01", "LP(C)", "LP5", "LP5(S)", "LP5D", "LP6", "LP7", "LP7(S)", "LP7D", "LP8", "LPAP01", "LPAP02", "LPAP03", "LPAP04", "LQ01", "LQ02", "M+A(NI)", "MA", "MAR", "MEM(NI)", "MEM/ARTS", "MF12(NI)", "MF8(NI)", "MG01", "MG01s", "MG02", "MG02s", "MG03s", "MG04", "MG04s", "MG05s", "MG06", "MG06s", "MG07", "MG08", "MISC", "MODEL ARTICLES", "MOREG(NI)", "MORT MISC", "MR01", "MR02", "MR03", "MR04", "MR05", "MR06", "MR07", "MR08", "MR09", "MR10", "MT01", "MT02", "MT03", "MT04", "MT05", "MT06", "MT07", "MT08", "MT09", "NAC", "NDISC", "NE01", "NEWINC", "NFOR", "NM01", "NM03", "NM04", "NM06", "NOCP", "NOCP(Scot)", "NOMIN(NI)", "O/C EARLY DISS", "O/C LTD DISCL", "O/C PROV RECALL", "O/C STAY", "O/C UNSTAY", "OC", "OC-DEF", "OC-DV", "OC-R", "OC138", "OC425", "OC427", "OCLI", "OCPRI", "OCREREG", "OCRESCIND", "OE01", "OE02", "OE03", "OLD10", "OS-PAR", "OSAA02", "OSAD01", "OSAD02", "OSAP01", "OSAP02", "OSAP03", "OSAP04", "OSAP05", "OSAP06", "OSAP07", "OSCC01", "OSCH01", "OSCH02", "OSCH03", "OSCH05", "OSCH06", "OSCH07", "OSCH09", "OSDS01", "OSDS02", "OSIN01", "OSLQ01", "OSLQ02", "OSLQ03", "OSLQ04", "OSNM01", "OSTM01", "OSTM02", "OSTM03", "OSTM04", "OSTN01", "OSTN01-CHNG", "OSTN01-PAR", "OTHER(NI)", "PA", "PARENT_ACC", "POD(NI)", "PRE14", "PRE87", "PRE87A", "PRE87M", "PRE95", "PRE95M", "PROS(NI)", "PROSP", "PSC01", "PSC02", "PSC03", "PSC04", "PSC05", "PSC06", "PSC07", "PSC08", "PSC09", "PUC 2", "PUC 3", "PUC 4", "PUC 5", "PUC 6", "PUC 7", "PUC(U)", "PUC1(NI)", "PUC2(NI)", "PUC3(NI)", "PUC3O", "PUC3P", "PUC4(NI)", "PUC5(NI)", "R-ORD(NI)", "R1(NI)", "R2(NI)", "R4(NI)", "R7(NI)", "RC", "REC1", "REC1(Scot)", "REC2", "REC3", "REC3(Scot)", "REC4", "REC5", "REC5(Scot)", "RELREC", "RENUN(NI)", "REREG(U)", "RES01", "RESOLUTIONS", "REST(NI)", "REST-COCOMP", "REST-CVL", "REST-MVL", "RESTADD-S", "RFWUM(NI)", "RM01", "RM01(Scot)", "RM02", "RM02(Scot)", "RP01AP01", "RP01CS01", "RP01PSC01", "RP01SH01", "RP04", "RP04AP01", "RP04AP02", "RP04AP03", "RP04AP04", "RP04AR01", "RP04CH01", "RP04CH02", "RP04CH03", "RP04CH04", "RP04CS01", "RP04LLAP01", "RP04LLAP02", "RP04LLAR01", "RP04LLCH01", "RP04LLCH02", "RP04LLCS01", "RP04LLPSC01", "RP04LLPSC02", "RP04LLPSC03", "RP04LLPSC04", "RP04LLPSC05", "RP04LLPSC06", "RP04LLPSC07", "RP04LLPSC08", "RP04LLPSC09", "RP04LLTM01", "RP04PSC01", "RP04PSC02", "RP04PSC03", "RP04PSC04", "RP04PSC05", "RP04PSC06", "RP04PSC07", "RP04PSC08", "RP04PSC09", "RP04SH01", "RP04SH02", "RP04SLPPSC01", "RP04SLPPSC02", "RP04SLPPSC03", "RP04SLPPSC04", "RP04SLPPSC05", "RP04SLPPSC06", "RP04SLPPSC07", "RP04SLPPSC08", "RP04SLPPSC09", "RP04SQPPSC01", "RP04SQPPSC02", "RP04SQPPSC03", "RP04SQPPSC04", "RP04SQPPSC05", "RP04SQPPSC06", "RP04SQPPSC07", "RP04SQPPSC08", "RP04SQPPSC09", "RP04TM01", "RP04TM02", "RP05", "RP09", "RP10", "RPCH01", "RPLLCH01", "RR01", "RR02", "RR05", "RR06", "RR07", "RR08", "RR09", "RROC138", "RROC649", "RT01", "SA", "SC70", "SC71", "SD(NI)", "SE SS01", "SE TR03", "SE10", "SE11", "SE5", "SE68(1)(a)", "SE68(2)(a)", "SE68(3)(a)", "SE7", "SE72(6)", "SE79B", "SE79C", "SE8", "SE82(1)(a)", "SEAP01", "SEAP02", "SEAS01", "SECH01", "SECH02", "SECV01", "SEDT02", "SEDT03", "SEFM01", "SEFM03", "SEFM04", "SEFM05", "SESS01", "SETM01", "SETR01", "SETR02", "SETR03", "SEWU01", "SH01", "SH02", "SH03", "SH04", "SH05", "SH06", "SH07", "SH08", "SH09", "SH10", "SH11", "SH12", "SH13", "SH14", "SH15", "SH16", "SH17", "SH18", "SH19", "SH20", "SH30", "SH50", "SLPCS01", "SLPPSC01", "SLPPSC02", "SLPPSC03", "SLPPSC04", "SLPPSC05", "SLPPSC06", "SLPPSC07", "SLPPSC08", "SLPPSC09", "SOAD(A)", "SOAS(A)", "SPEC PEN", "SQP1", "SQP2", "SQP3", "SQPCS01", "SQPPSC01", "SQPPSC02", "SQPPSC03", "SQPPSC04", "SQPPSC05", "SQPPSC06", "SQPPSC07", "SQPPSC08", "SQPPSC09", "SRES13", "SRO(NI)", "STREP(NI)", "TM01", "TM02", "TM03", "TRANSFORMATION", "UDART(NI)", "UDM+A(NI)", "UDMEM(NI)", "UNKN(NI)", "VAL", "VAM1", "VAM1(Scot)", "VAM2", "VAM2(Scot)", "VAM3", "VAM3(Scot)", "VAM4", "VAM4(Scot)", "VAM5", "VAM5(Scot)", "VAM6", "VAM6(Scot)", "VAM7", "VAM7(Scot)", "VAM8(Scot)", "VAMC", "VAMC(Scot)", "VL1", "WU01", "WU01(Scot)", "WU02", "WU02(Scot)", "WU03", "WU03(Scot)", "WU04", "WU05", "WU06", "WU07", "WU08", "WU09", "WU10", "WU11", "WU12", "WU13", "WU14", "WU15", "WU15(Scot)", "WU16(Scot)", "WU17(Scot)", "WU18(Scot)" ] }, "category": { "type": "string", "description": "The category of the filing history", "enum": [ "accounts", "address", "annotation", "annual-return", "auditors", "capital", "certificate", "change-of-constitution", "change-of-name", "confirmation-statement", "court-order", "dissolution", "document-replacement", "gazette", "historical", "incorporation", "insolvency", "liquidation", "miscellaneous", "mortgage", "officer", "officers", "other", "persons-with-significant-control", "reregistration", "resolution", "restoration", "return", "social-landlord" ] }, "description":{ "description": "The description of the filing history", "type": "string", "enum": [ "accounts-balance-sheet", "accounts-with-accounts-type-full", "accounts-with-accounts-type-group", "accounts-with-accounts-type-micro-entity", "accounts-with-accounts-type-small", "accounts-with-accounts-type-total-exemption-full", "accounts-with-accounts-type-unaudited-abridged", "annual-return-company-with-made-up-date-full-list-shareholders", "annual-update", "annual-update-with-made-up-date", "appoint-corporate-director-company-with-name-date", "appoint-corporate-member-limited-liability-partnership-with-appointment-date", "appoint-judicial-factor-with-name", "appoint-person-director-company-with-name", "appoint-person-director-company-with-name-date", "capital-allotment-shares", "capital-statement-capital-company-with-date-currency-figure", "certificate-change-of-name-company", "cessation-of-a-person-with-significant-control", "cessation-of-a-person-with-significant-control-limited-liability-partnership", "change-account-reference-date-company-current-extended", "change-constitutional-documents-overseas-company-with-date", "change-person-director-company-with-change-date", "change-registered-office-address-company-with-date-old-address-new-address", "change-registered-office-address-limited-liability-partnership-with-date-old-address-new-address", "change-sail-address-limited-liability-partnership-with-old-address-new-address", "change-to-a-person-with-significant-control", "confirmation-statement", "confirmation-statement-with-no-updates", "confirmation-statement-with-updates", "default-companies-house-registered-office-address-applied", "default-companies-house-service-address-applied-member", "default-companies-house-service-address-applied-officer", "default-companies-house-service-address-applied-psc", "dissolution-application-strike-off-company", "elect-to-keep-the-directors-register-information-on-the-public-register", "elect-to-keep-the-limited-liability-partnership-members-residential-address-register-information-on-the-public-register", "gazette-dissolved-liquidation", "gazette-notice-voluntary", "incorporation-company", "legacy", "liquidation-appointment-of-liquidator", "liquidation-cease-to-act-as-liquidator-northern-ireland", "liquidation-in-administration-appointment-of-administrator", "liquidation-in-administration-notice-administrators-proposals-scotland", "liquidation-in-administration-progress-report", "liquidation-in-administration-revision-administrators-proposals", "liquidation-moratorium-commencement-of-moratorium", "liquidation-moratorium-end-of-moratorium-by-monitor", "liquidation-moratorium-end-of-moratorium-following-disposal-of-application-for-extension-by-court-or-following-cva-proposal-taking-effect-or-being-withdrawn", "liquidation-moratorium-extension-of-moratorium", "liquidation-receiver-appointment-of-receiver", "liquidation-voluntary-appointment-of-liquidator", "liquidation-voluntary-creditors-paid-in-full", "liquidation-voluntary-creditors-return-of-final-meeting", "liquidation-voluntary-members-return-of-final-meeting", "liquidation-voluntary-statement-of-affairs", "liquidation-voluntary-statement-of-receipts-and-payments-with-brought-down-date", "memorandum-articles", "mortgage-create-with-deed-with-charge-number", "mortgage-create-with-deed-with-charge-number-charge-creation-date", "move-registers-to-sail-limited-liability-partnership-with-new-address", "notification-of-a-person-with-significant-control", "notification-of-a-person-with-significant-control-limited-liability-partnership", "notification-of-a-person-with-significant-control-statement", "notification-of-a-person-with-significant-control-statement-scottish-limited-partnership", "notification-of-a-person-with-significant-control-without-name-date", "registration-of-a-limited-partnership", "registration-overseas-entity", "removal-overseas-entity", "resolution", "selection-of-documents-registered-before-April-2014", "termination-director-company-with-name", "termination-director-company-with-name-termination-date", "termination-member-limited-liability-partnership-with-name-termination-date", "termination-secretary-company-with-name-termination-date", "withdrawal-of-a-person-with-significant-control-statement-scottish-limited-partnership" ] }, "sub_category": { "type": "string", "description": "The sub category of the filing history", "enum": [ "annual-return", "confirmation-statement", "full", "partial", "short", "acquire", "administration", "alter", "appointments", "certificate", "change", "compulsory", "court-order", "create", "debenture", "document-replacement", "investment-company", "mortgage", "notifications", "officers", "other", "receiver", "register", "release-cease", "resolution", "satisfy", "social-landlord", "statements", "termination", "transfer", "trustee", "voluntary", "voluntary-arrangement", "voluntary-arrangement-moratoria" ] }, "resolutions": { "type": "array", "description": "The resolutions associated with the filing history. Maximum of 20 resolutions can be specified", "items": { "type": "object", "properties": { "category": { "type": "string", "description": "Resolutions category for resolutions type (e.g., `incorporation`, `resolutions`)", "enum": [ "auditors", "capital", "change-of-name", "incorporation", "insolvency", "liquidation", "miscellaneous", "other", "resolution" ] }, "description": { "type": "string", "description": "Description for resolutions type (e.g., `resolution-re-registration`, `incorporation-company`)", "enum": [ "elective-resolution", "extraordinary-resolution", "extraordinary-resolution-acquisition", "extraordinary-resolution-adopt-memorandum", "extraordinary-resolution-alteration-memorandum", "extraordinary-resolution-capitalisation", "extraordinary-resolution-exemption", "extraordinary-resolution-increase-capital", "extraordinary-resolution-memorandum", "extraordinary-resolution-purchase-number-shares", "extraordinary-resolution-purchase-shares", "extraordinary-resolution-reduction-capital", "extraordinary-resolution-removal-pre-emption", "extraordinary-resolution-securities", "extraordinary-resolution-varying-share-rights", "liquidation-special-resolution-to-wind-up-northern-ireland", "liquidation-voluntary-extraordinary-resolution-to-wind-up", "liquidation-voluntary-extraordinary-resolution-to-wind-up-with-case-start-date", "liquidation-voluntary-extraordinary-to-wind-up-with-case-start-date", "liquidation-voluntary-special-resolution-to-wind-up", "liquidation-voluntary-special-resolution-to-wind-up-case-start-date", "ordinary-resolution", "ordinary-resolution-acquisition", "ordinary-resolution-adopt-memorandum", "ordinary-resolution-alteration-memorandum", "ordinary-resolution-capitalisation", "ordinary-resolution-decrease-capital", "ordinary-resolution-exemption", "ordinary-resolution-increase-capital", "ordinary-resolution-memorandum", "ordinary-resolution-purchase-number-shares", "ordinary-resolution-purchase-shares", "ordinary-resolution-redeem-shares", "ordinary-resolution-reduction-capital", "ordinary-resolution-removal-pre-emption", "ordinary-resolution-securities", "ordindary-resolution-varying-share-rights", "resolution", "resolution-acquisition", "resolution-adopt-articles", "resolution-adopt-memorandum-and-articles", "resolution-alteration-articles", "resolution-alteration-memorandum", "resolution-alteration-memorandum-and-articles", "resolution-capitalisation", "resolution-change-of-name", "resolution-decrease-capital", "resolution-exemption", "resolution-increase-capital", "resolution-memorandum-and-articles", "resolution-purchase-number-shares", "resolution-purchase-shares", "resolution-re-registration", "resolution-redeem-shares", "resolution-reduction-capital", "resolution-removal-pre-emption", "resolution-securities", "resolution-varying-share-rights", "special-resolution", "special-resolution-acquisition", "special-resolution-adopt-memorandum", "special-resolution-alteration-memorandum", "special-resolution-capitalisation", "special-resolution-decrease-capital", "special-resolution-exemption", "special-resolution-increase-capital", "special-resolution-memorandum", "special-resolution-purchase-number-shares", "special-resolution-purchase-shares", "special-resolution-re-registration", "special-resolution-redeem-shares", "special-resolution-reduction-capital", "special-resolution-removal-pre-emption", "special-resolution-securities", "special-resolution-varying-share-rights", "written-resolution", "written-resolution-acquisition", "written-resolution-adopt-memorandum", "written-resolution-alteration-memorandum", "written-resolution-capitalisation", "written-resolution-decrease-capital", "written-resolution-exemption", "written-resolution-increase-capital", "written-resolution-memorandum", "written-resolution-purchase-number-shares", "written-resolution-purchase-shares", "written-resolution-re-registration", "written-resolution-reduction-capital", "written-resolution-removal-pre-emption", "written-resolution-securities", "written-resolution-varying-share-rights" ] }, "subcategory": { "type": "string", "description": "Sub category for resolutions type (e.g., `resolution`, `incorporation`)", "enum": [ "resolution", "voluntary" ] }, "type": { "type": "string", "description": "Type for the resolutions type (e.g., `RES02`, `RES04`)", "enum": [ "(W)ELRES", "ELRES", "ERES01", "ERES03", "ERES04", "ERES06", "ERES07", "ERES08", "ERES09", "ERES10", "ERES11", "ERES12", "ERES13", "ERES14", "LRES(NI)", "LRESC(NI)", "LRESEX", "LRESM(NI)", "LRESSP", "ORES01", "ORES03", "ORES04", "ORES05", "ORES06", "ORES07", "ORES08", "ORES09", "ORES10", "ORES11", "ORES12", "ORES13", "ORES14", "ORES16", "RES(ECS)", "RES(NI)", "RES01", "RES02", "RES03", "RES04", "RES05", "RES06", "RES07", "RES08", "RES09", "RES10", "RES11", "RES12", "RES13", "RES14", "RES15", "RES16", "RESMISC", "SRES01", "SRES02", "SRES03", "SRES04", "SRES05", "SRES06", "SRES07", "SRES08", "SRES09", "SRES10", "SRES11", "SRES12", "SRES13", "SRES14", "SRES16", "WRES01", "WRES02", "WRES03", "WRES04", "WRES05", "WRES06", "WRES07", "WRES08", "WRES09", "WRES10", "WRES11", "WRES12", "WRES13", "WRES14" ] } } } } } } }, "accounts_due_status": { "description": "The accounts due status of the test company to generate. Defaults to `overdue`", "type": "string", "enum": [ "overdue", "due-soon" ] }, "registers": { "type": "array", "description": "The registers for the test company to generate. Maximum of 20 registers can be specified", "items": { "type": "object", "properties": { "register_type": { "type": "string", "description": "The type of the register", "enum": [ "members", "directors", "secretaries", "psc", "charges", "allotments", "debentures", "persons-with-significant-control", "usual-residential-address", "llp-members", "llp-usual-residential-address" ] }, "register_moved_to": { "type": "string", "description": "Where the register has been moved to", "enum": [ "public-register", "registered-office", "single-alternative-inspection-location", "unspecified-location" ] } } } }, "has_super_secure_pscs": { "description": "Whether the test company has super secure PSCs. Defaults to not having super secure PSCs", "type": "boolean" }, "number_of_appointments": { "description": "Total number of officers to create. Defaults to 1 (a director). If greater than 1, officers are created in this order: director, then secretary, then additional directors (unless officer_roles is specified). Maximum number of appointments are 20.", "type": "integer" }, "officer_roles": { "type": "array", "items": { "type": "string", "description": "List of strings. Specifies roles for the officers created. If the list is shorter than number_of_appointments, remaining officers default to directors. If ONLY this field is specified, only ONE officer is created (using the first role in the list).", "enum": [ "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" ] } }, "number_of_pscs": { "description": "Integer (Max: 20). The number of PSCs. This value is used as the default for active_statements if active_statements is not provided. Defaults to 0.", "type": "integer" }, "psc_type": { "description": "The type of PSC to create. Defaults to `individual`", "type": "string", "enum": [ "individual", "corporate", "legal-person", "individual-bo", "corporate-bo" ] }, "psc_active": { "description": "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.", "type": "boolean" }, "withdrawn_statements": { "description": "Integer (Max: 20). Number of withdrawn PSC statements. Defaults to 0.", "type": "integer" }, "active_statements": { "description": "Integer (Max: 20). Number of active PSC statements. Defaults to number_of_psc or 0. This value is ignored and forced to 1 if has_super_secure_pscs is true.", "type": "integer" }, "has_uk_establishment": { "description": "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.", "type": "boolean" }, "registered_office_is_in_dispute": { "description": "Boolean value to determine if the registered office is in dispute. Defaults to false.", "type": "boolean" }, "undeliverable_registered_office_address": { "description": "Boolean value to indicate if a company's registered office address has been reported as undeliverable by the Royal Mail. Defaults to false.", "type": "boolean" }, "is_secure_officer": { "description": "Boolean value. If set to `true`, all company officers created by this request will have their `is_secure_officer` field set to `true`. Defaults to `false`.", "type": "boolean" }, "foreign_company_legal_form": { "description": "Boolean value to determine if a foreign company legal form is to be added. Defaults to false. If it is true, an auto generated text form will be added to the foreign company details.", "type": "boolean" } } }, "createTestCompanyResponse": { "title": "createTestCompanyResponse", "required": [ "company_number", "company_uri", "auth_code" ], "properties": { "company_number": { "description": "The company number generated", "type": "string" }, "company_uri": { "description": "The URI to retrieve the generated company profile data", "type": "string" }, "auth_code": { "description": "The company authorisation code generated", "type": "string" } } }, "deleteTestCompanyRequestBody": { "title": "deleteTestCompanyRequestBody", "required": [ "auth_code" ], "properties": { "auth_code": { "description": "The company auth code returned when the test company was generated", "type": "string" } } } } }