Test data generator

Service for generating and storing random test company data. This includes company profile, authentication code, filing history, officers and people of significant control.

As new filings are exposed to external software vendors more test data options should be added to this service and the relevant public specs/docs updated.

Requirements

In order to run the API locally you'll need the following installed on your machine:

• Java 21
• Maven
• Git
• MongoDB

Getting started

1. Run make
2. Run ./start.sh

Docker

There is a Docker service for this project called test-data-generator which can be used for development and test in the CHS Dev Env.

The docker compose file for this service is docker-chs-development/services/test-utils/test-data-generator.docker-compose.yaml for correct operation under CHS Dev Env pay attention to the following clauses:

environment:
  - TEST_DATA_GENERATOR_PORT=4022
  - MONGODB_URL=mongodb://mongo:27017
  - BARCODE_SERVICE_URL=http://barcode-generator:18101
  - HUMAN_LOG=1
  - API_URL=http://localhost:8080
expose:
  - 4022
ports:
  - "4022:4022"

Usage

In order to use the generator, there are different possible endpoints that can be used.

Creating test companies

• POST: Sending a POST request to {Base URL}/test-data/company will generate a new test company and accompanying Authcode. The request body can include an optional CompanySpec parameter to customise the generated company.

  • jurisdiction: The jurisdiction of the company (e.g., england_wales, scotland, northern_ireland, united-kingdom). Defaults to england_wales.

  • company_status: The status of the company (e.g., active, dissolved, administration). Defaults to active.

  • type: The type of the company (e.g., ltd, plc). Defaults to ltd.

  • has_uk_establishment: Boolean value to determine if the oversea company has a UK establishment. Defaults to false, true value will create an oversea company with a UK establishment. Used alongside oversea-company company type.

  • sub_type: The subtype of the company (e.g., community-interest-company, private-fund-limited-partnership). Defaults to no subtype.

  • has_super_secure_pscs: Boolean value to determine if the company has super secure PSCs. Defaults to false, true value will create a Psc entry of super-secure-person-with-significant-control or super-secure-beneficial-owner depending on CompanyType.

  • registers : The registers of the company (e.g., directors, persons-with-significant-control, ``). Defaults to no registers.

  • number_of_appointments: Used alongside officer_roles to determine the number of appointments to create. Defaults to 1. Has a maximum allowed value of 20.

  • officer_roles: This takes a list of officer roles (director, secretary). Defaults to director when no role is passed.

  • is_secure_officer: Boolean value to determine if the officer is a secure officer. Defaults to false, true value will create an officer with is_secure_officer set to true.

  • no_default_officers: Boolean value to determine if the company is created without default officers. Defaults to false, true value will create a company without default officers.

  • disqualified_officers: This takes a list to create a company with disqualified officers. Defaults a company without a disqualified officers list.

  • accounts_due_status: Set the accounts and confirmation statement due dates of the company by providing accounts_due_status (e.g., overdue, due-soon). Defaults to current date.

  • company_status_detail: The status detail of the company (e.g., active-proposal-to-strike-off, converted-to-plc). Defaults to no value, field not present in the database.

  • company_name: The name of the company. Defaults to a randomly generated name. Creates a company with the name provided and appended with company number.

  • is_company_number_padding: Boolean value to determine if the company number should be padded with zeros. Defaults to false, true value will create a company number with leading zeros.

  • filing_history: {

    • type: The type of the submission (e.g., GAZ1(A), DS01). Defaults to NEWINC.
    • category: The category of the filing (e.g., incorporation, dissolution, gazette, resolution). Defaults to incorporation.
    • subcategory: The sub category of the filing (e.g., appointments, resolution)
    • description: The description of the filing (e.g., incorporation-company, gazette-notice-voluntary). Defaults to incorporation-company.
    • original_description: The original description of the filing (e.g., First gazette notice for voluntary strike-off). Defaults to Certificate of incorporation general company details & statements of; officers, capital & shareholdings, guarantee, compliance memorandum of association.
    • number_of_pscs: The number of PSCs to create. Defaults to 0. Can be used to create multiple PSCs. Has a maximum allowed value of 20.
    • psc_type: Used alongside the number_of_pscs. The types of PSCs to create (e.g., individual, corporate, legal-person, individual-bo, corporate-bo).
    • resolutions: This is optional, mandatory only when type is RESOLUTIONS
      • barcode: Barcode value for resolutions type. By default, it's an empty string.
      • category: Resolutions category for resolutions type (e.g., incorporation, resolutions)
      • delta_at: Convert date for delta at format and stores as string.
      • description: Description for resolutions type (e.g., resolution-re-registraion, incorporation-company)
      • subcategory: Sub category for resolutions type (e.g., resolution, incorporation)
      • type: Type for the resolutions type (e.g., RES02, NEWINC)
    • document_metadata: Boolean value adds document meta data to links. By default, its false. }
    • psc_active: 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 fasle value here will set the first PSC to inactive. Defaults to true.

  • withdrawn_statements: Integer value to determine the number of withdrawn PSC statements to create. Defaults to 0. has a maximum allowed value of 20.

  • active_statements: Integer value to determine the number of active PSC statements to create. Defaults to 1 or the number_of_pscs passed in the request. Has a maximum allowed value of 20.

  • registered_office_is_in_dispute: Boolean value to determine if the registered office is in dispute. Defaults to false.

  • alphabetical_search: Boolean value to determine if the company is included in the alphabetical search. Defaults to false.

  • advanced_search: Boolean value to determine if the company is included in the advanced search. Defaults to false.

  • A usage example for creating registered-overseas-entity looks like this: {"registered-overseas-entity}, this will create an overseas entity with hardcoded values

  • A usage example for creating registered-overseas-entity with a user specified legal form looks like this: {"registered-overseas-entity", "foreign_company_legal_form": "legal-form-123"}, this will create an overseas entity with specified legal form or it will default to Plc when not provided.

  • A usage example for creating oversea-company looks like this: {"overseas-company}, this will create an overseas entity with hardcoded values

  • A usage example for creating oversea-company with has_uk_establishment looks like this: {"overseas-company", "has_uk_establishment": true}, this will create an oversea company with hardcoded values and a UK establishment

  • A usage example for creating with single filing history: {"jurisdiction":"scotland", "company_status":"administration", "type":"plc", "sub_type":"community-interest-company", "has_super_secure_pscs":true, "registers":["register_type": "directors", "register_moved_to": "public-register"], "accounts_due_status":"overdue", "company_status_detail":"active-proposal-to-strike-off", "filing_history": [{"type": "GAZ1(A)", "category": "gazette", "description": "gazette-notice-voluntary", "original_description": "First gazette notice for voluntary strike-off"}], "number_of_appointments": 2, "officer_roles": ["director"]}

  • A usage example for creating with multiple filing history: {"jurisdiction":"scotland", "company_status":"administration", "type":"plc", "sub_type":"community-interest-company", "has_super_secure_pscs":true, "accounts_due_status":"overdue", "company_status_detail":"active-proposal-to-strike-off", "filing_history": [{"type": "AP01", "category": "officers", "subcategory": "appointments", "description": "appoint-person-director-company-with-name-date", "original_description": "Appointment of Mr John Test as a director on 10 November 2020", "document_metadata": true }, {"type": "RESOLUTIONS", "category": "resolution", "subcategory": "resolution", "description": "resolution", "original_description": "RESOLUTIONS", "resolutions" : [{"barcode" : "", "category" : "incorporation", "delta_at" : "20180723091906627635", "description" : "resolution-re-registration", "subcategory" : "resolution", "type" : "RES02" } ]}], "number_of_appointments": 2, "officer_roles": ["director"]}

  • A usage example for creating a company with psc: { "number_of_pscs": 2, "psc_type": ["legal", "individual"] }

  • A usage example for creating a company with withdrawn psc statements: { "withdrawn_statements": 3 }

  • A usage example for creating a company with active psc statements: { "active_statements": 5 }

  • A usage example of creating a company with an inactive psc: { "number_of_pscs": 1, "psc_active": false }

  • A usage example for creating a company with registered office in dispute: { "registered_office_is_in_dispute": true }

  • A usage example for creating a company with undeliverable office address: { "undeliverable_registered_office_address": true}

  • A usage example for creating a company with padded company number: { "is_company_number_padding": true }

  • A usage example for creating a company with company name: { "company_name": "Test Company Ltd" }

  • A usage example for creating a company with alphabetical search: { "alphabetical_search": true }

  • A usage example for creating a company with advanced search: { "advanced_search": true }

  • A usage example for creating a company with disqualified officers: { "disqualified_officers": [ { "disqualification_type": "court-order", "is_corporate_officer": false }]}

• DELETE: Sending a DELETE request on the endpoint {Base URL}/test-data/company/{companyNumber} will delete the test company. There is a required parameter that is Authcode which needs to be included in the request body to be allowed to delete the test company. A usage example looks like this: {"auth_code":"222222"}

• Health Check: Sending a GET request on the endpoint {Base URL}/test-data/healthcheck will return a status code and an empty response body.

Getting authcode for a company without an authcode

• GET: Sending a GET request on the endpoint {Base URL}/test-data/internal/company/authcode?{companyNumber} will return the default authcode for a company if it does not have an existing authcode or will return a null if the company has a valid existing authcode.

Creating test users

• POST: Sending a POST request to create users with the associated roles {Base URL}/test-data/user will generate a new test user. The request body must include UserSpec parameter to customise the generated user.

  • email: The email id of the user. This is an optional field which defaults to randomly generated string + a test email domain.
  • password: The password of the user. This is mandatory.
  • roles: The entra group name of the user which contains all the associated roles for that user. Roles is optional.
  • is_company_auth_allow_list: This is optional. If we provide this, we need to provide the value as true or false.
  • identity_verification: This is optional. It takes a list of IdentiyVerificationSpec and creates an identity and uvid

  A usage example looks like this: { "password": "password", "roles": [ "GROUPNAME_1", "GROUPNAME_2"] ], "is_company_auth_allow_list": true, "identity_verification": [{"verification_source": "ONE_LOGIN"}] }

• DELETE: Sending a DELETE request on the endpoint {Base URL}/test-data/user/{userId} will delete the test user. userid is required to delete the user.

Creating admin permission

• POST: Sending a POST request to create admin permission for a user {Base URL}/test-data/admin-permission will generate a new admin permission for a user. The request body must include AdminPermissionSpec parameter to customise the generated admin permission.

  • entra_group_id: The user id of the user. This is mandatory.
  • group_name: The permission of the user. This is mandatory.
  • roles: The roles associated with the permission.

  A usage example looks like this: {"group_id": "8aa9fc1c-8d78-4ce3-8ba9-fee57adf3a84", "group_name": "chs admin csi support", "roles": [ "/admin/images" ] }

• DELETE: Sending a DELETE request on the endpoint {Base URL}/test-data/admin-permission/{id} will delete the test admin permission. id is required to delete the admin permission; This is generated as response when an admin permission is created.

Getting Identity_Id and Uvid for a user

• GET: Sending a GET request on the endpoint {Base URL}/test-data/identity/?email=email@email.com will return the identity_id, uvid, firstname and lastname for the user. userId is required to get the identity id and uvid.

  A usage example response looks like this: {"identity_id": "d4b5f5e2-5f4e-4c3a-9f3e-2b5f5e25f4e4", "uvid": "XX4YBV22223"}

Creating Acsp Members and Acsp Profiles

• POST: Sending a POST request to create Acsp Members and Acsp Profiles {Base URL}/test-data/acsp-members will generate a new Acsp Member and Acsp Profile. The request body must include mandatory userId and optional AcspMembersSpec and AcspProfile parameter to customise the generated Acsp Member and Acsp Profile.

  • user_id: The User ID of user from the user db. This is mandatory.
  • user_role: This is the role of the ACSP Member. This is optional
  • status: Status of the Acsp Member. This is optional
  • acsp_profile:
    • type: Company type of the AcspProfile. This is optional with a defaults to limited-company.
    • status: Status of the Acsp Profile. This is optional with a defaults toactive.
    • acsp_number: ACSP number of the ACSP Profile. This is optional.
    • business_sector: Business sector of the ACSP Profile. This is optional.
    • aml_details:
      • supervisory_body: Supervisory body of the Acsp Profile. This is optional.
      • membership_details: Membership details of the Acsp Profile. This is optional.
    • email: The email of the AcspProfile. This is optional.

  A usage example looks like this: {"user_id": "rsf3pdwywvse5yz55mfodfx8","user_role": "test","status": "test","acsp_profile": {"type": "test","status": "test", "acsp_number": "TestACSP", "aml_details": [ {"supervisory_body": "association-of-chartered-certified-accountants-acca","membership_details": "test"} ] } }

• DELETE: Sending a DELETE request on the endpoint {Base URL}/test-data/acsp-members/{acspMemberId} will delete the test Acsp Member and associated Acsp Profile. acspMemberId is required to delete the Acsp Member.

Getting acsp profile document

• GET: Sending a GET request on the endpoint {Base URL}/test-data/internal/acsp-profile/{id} will return the entire acsp profile document for the id.

Deleting Appeals

• DELETE: Sending a DELETE request on the endpoint {Base URL}/test-data/appeals will delete the appeals by providing

  • company_number: The company number of the company. This is mandatory.
  • penalty_reference: The penalty reference of the appeal. This is mandatory.

  A usage example looks like this: {"company_number": "123456", "penalty_reference": "A0000001"}

Adding Certificates and Basket

Creating Certificates

• POST: Sending a POST request to {Base URL}/test-data/certificates will order certificates for a company and add the basket details.

  • company_name: The name of the company.

  • company_number: The number of the company matching with company name.

  • description_identifier: The identifier description of the certificate.

  • item_options: [{

    • certificate_type: The certificates types for the item.
    • delivery_timescale: The delivery time scale (e.g. standard, express).
    • inclue_email_copy: The boolean value for sending email copy. Default value is false.
    • company_type: The type of the company (e.g., ltd, plc).
    • company_status: The status of the company (e.g., active, dissolved, administration).
    • delivery_method: The method delivery is requested (e.g., postal, collection)
    • director_details: { The below values are for director details only.
      • include_address: The boolean value for include address. This is optional
      • include_appointment_date: The boolean value for include appointment date. This is optional.
      • include_basic_information: The boolean value for include basic information. This is optional
      • include_country_of_residence: The boolean value for include country of resident. This is optional.
      • include_dob_type: The boolean value for include dob type. This is optional.
      • include_nationality: The boolean value for include nationality. This is optional.
      • include_occupation: The boolean value for include occupation. This is optional. }
    • forename: The forename of the item options. This is optional.
    • include_company_objects_information: The boolean value to include the company objects information. This is optional.
    • include_good_standing_information: The boolean value to include good standing information in certificates. This is optional.
    • registered_office_address_details: {
      • include_address_records_type: The include address records type of the registered office address details (e.g., all, current, current-and-previous, current-previous-and-prior). This is optional.
      • include_dates: The boolean value for include dates. This is optional. }
    • secretary_details: { The below values are for secretary details only.
      • include_address: The boolean value for include address. This is optional
      • include_appointment_date: The boolean value for include appointment date. This is optional.
      • include_basic_information: The boolean value for include basic information. This is optional
      • include_country_of_residence: The boolean value for include country of resident. This is optional.
      • include_dob_type: The boolean value for include dob type. This is optional.
      • include_nationality: The boolean value for include nationality. This is optional.
      • include_occupation: The boolean value for include occupation. This is optional. }
    • surname: The surname of the item options. This is optional. }]

  • basket: {

    • forename: The forename for basket delivery details.
    • surname: The surname for basket delivery details.
    • enrolled: To make the multi-item basket available to all users, this should be set to true. Default value is true. }

  • kind: The kind of the certificate.

  • quantity: The number of the certificate.

  • postal_delivery: The boolean value for certificate postal delivery. Default value is false.

  • user_id: The user id who logged in to order a certificate.

  • A usage example looks like this: {"company_name": "ACME Company", "company_number": "SC172618", "description_identifier": "certificate", "item_options": {"certificate_type": "incorporation-with-all-name-changes", "company_status": "active", "company_type": "ltd", "delivery_method": "postal", "delivery_timescale": "standard", "director_details": {"include_address": true, "include_appointment_date": true, "include_basic_information": true, "include_country_of_residence": true, "include_dob_type": "partial", "include_nationality": true, "include_occupation": true}, "forename": "John", "include_company_objects_information": true, "include_email_copy": false, "include_good_standing_information": true, "registered_office_address_details": {"include_address_records_type": "current", "include_dates": true}, "secretary_details": {"include_address": true, "include_appointment_date": true, "include_basic_information": true, "include_country_of_residence": true, "include_dob_type": "partial", "include_nationality": true, "include_occupation": true}, "surname": "Doe"}, "kind": "item#certificate", "quantity": 1, "postal_delivery": false, "user_id": "xiteAZJVGMjGFgPUnqsHSLhtkiss", "basket": {"forename": "John", "surname": "Doe", "enrolled": true}}

  • Adding multiple certificates example: {"company_name": "ACME Company", "company_number": "SC172618", "description_identifier": "certificate", "item_options": [{"certificate_type": "incorporation-with-all-name-changes", "company_status": "active", "company_type": "ltd", "delivery_method": "postal", "delivery_timescale": "standard", "director_details": {"include_address": true, "include_appointment_date": true, "include_basic_information": true, "include_country_of_residence": true, "include_dob_type": "partial", "include_nationality": true, "include_occupation": true}, "forename": "John", "include_company_objects_information": true, "include_email_copy": false, "include_good_standing_information": true, "registered_office_address_details": {"include_address_records_type": "current", "include_dates": true}, "secretary_details": {"include_address": true, "include_appointment_date": true, "include_basic_information": true, "include_country_of_residence": true, "include_dob_type": "partial", "include_nationality": true, "include_occupation": true}, "surname": "Doe"}, {"certificate_type": "incorporation-with-all-name-changes", "company_status": "active", "company_type": "ltd", "delivery_method": "postal", "delivery_timescale": "express", "forename": "John", "include_company_objects_information": false, "include_email_copy": true, "include_good_standing_information": false, "surname": "Doe"}], "kind": "item#certificate", "quantity": 1, "postal_delivery": false, "user_id": "xiteAZJVGMjGFgPUnqsHSLhtkiss", "basket": {"forename": "John", "surname": "Doe", "enrolled": true}}

• DELETE: Sending a DELETE request on the endpoint {Base URL}/test-data/certificates/{id} will delete the test certificate.

Creating Certified copies

• POST: Sending a POST request to {Base URL}/test-data/certified-copies will order certified copies for a company and add the basket details.

  • company_name: The name of the company.

  • company_number: The number of the company matching with company name.

  • customer_reference: The reference to the customer.

  • item_costs: {

    • discount_applied: The discount applied for the certified copies.
    • item_cost: The cost of the item.
    • calculated_cost: The total cost of certified copies.
    • product_type: The type of the product , default value is certifed-copy. }

  • item_options: [{

    • collection_location: The location of delivery address. This should be added only if the delivery method is collection.
    • contact_number: The contact number of the collection person. This should be added only if the delivery method is collection.
    • delivery_method: The delivery method of the certified document (e.g., collection, digital, postal).
    • delivery_timescale: The timescale for the delivery (e.g., digital, same-day, standard).
    • forename: The forename of the person for the delivery or collection.
    • surname: The surname of the person for the delivery or collection.
    • filing_history_documents: [{
      • filing_history_date: The date of the filing history in a string value.
      • filing_history_description: The description of the filing history (e.g., accounts-balance-sheet, capital-allotment-shares)
      • filing_history_description_values: {
        • date: The date when filing history description values set.
        • capital: [{
          • figure: The figure value for the filing history.
          • currency: The currency for the filling history. ]},
        • charge_number: The charge number for the filing history.
        • made_up_date: The made up date for the filing history.
        • officer_name: The office name for the filing history. }
      • filing_history_id: The id value of the filing history document.
      • filing_history_type: The filing history type value (e.g., SH01, NEWINC).
      • filing_history_cost: The cost of the filing history document. }] }]

  • basket: {

    • forename: The forename for basket delivery details.
    • surname: The surname for basket delivery details.
    • enrolled: To make the multi-item basket available to all users, this should be set to true. Default value is true. }

  • kind: The kind of the certified copies.

  • quantity: The number of the certified copies.

  • postal_delivery: The boolean value for certified copies postal delivery. Default value is false.

  • user_id: The user id who logged in to order a certified copies.

  • postage_cost: The cost for the postage.

  • total_item_Cost: The total cost of certified copies.

  • A usage example looks like this: {"company_name": "ACME Company", "company_number": "SC172618", "customer_reference": "test", "item_costs": [ { "discount_applied": "0", "item_cost": "15", "calculated_cost": "15", "product_type": "certified-copy" } ], "item_options": [ { "collection_location": "cardiff", "contact_number": "013473847444", "delivery_method": "collection", "delivery_timescale": "standard", "filing_history_documents": [ { "filing_history_date": "2016-05-26", "filing_history_description": "incorporation-company", "filing_history_id": "MzE0OTM3MTQxNmFkaXF6a2N4", "filing_history_type": "NEWINC", "filing_history_cost": "30" } ], "forename": "John", "surname": "Smith" } ], "kind": "item#certified-copy", "quantity": 1, "postal_delivery": false, "user_id": "Y2VkZWVlMzhlZWFjY2M4MzQ3MT", "basket": { "forename": "John", "surname": "Doe", "enrolled": true }, "postage_cost": "0", "total_item_cost": "30" }

  • Adding multiple certified copies example: { "company_name": "ACME Company", "company_number": "SC172618", "customer_reference": "test", "item_costs": [ { "discount_applied": "0", "item_cost": "15", "calculated_cost": "15", "product_type": "certified-copy" } ], "item_options": [ { "collection_location": "cardiff", "contact_number": "7252827444", "delivery_method": "postal", "delivery_timescale": "standard", "filing_history_documents": [ { "filing_history_date": "2019-11-23", "filing_history_description": "capital-allotment-shares", "filing_history_description_values": { "capital": [ { "figure": "34,253,377", "currency": "GBP" } ], "charge_number": "908484848", "date": "2019-11-10", "made_up_date": "2019-12-10", "officer_name": "Officer test" }, "filing_history_id": "OTAwMzQ1NjM2M2FkaXF6a6N4", "filing_history_type": "SH01", "filing_history_cost": "15" } ], "forename": "test", "surname": "sur test" }, { "collection_location": "cardiff", "contact_number": "013473847444", "delivery_method": "collection", "delivery_timescale": "standard", "filing_history_documents": [ { "filing_history_date": "2016-05-26", "filing_history_description": "incorporation-company", "filing_history_id": "MzE0OTM3MTQxNmFkaXF6a2N4", "filing_history_type": "NEWINC", "filing_history_cost": "30" } ], "forename": "John", "surname": "Smith" } ], "kind": "item#certified-copy", "quantity": 1, "postal_delivery": false, "user_id": "Y2VkZWVlMzhlZWFjY2M4MzQ3MT", "basket": { "forename": "John", "surname": "Doe", "enrolled": true }, "postage_cost": "0", "total_item_cost": "30" }

• DELETE: Sending a DELETE request on the endpoint {Base URL}/test-data/certified-copies/{id} will delete the test certified copies.

Creating Missing Image Deliveries

• POST: Sending a POST request to {Base URL}/test-data/missing-image-deliveries will order missing image deliveries for a company and add the basket details.

  • company_name: The name of the company.

  • company_number: The number of the company matching with company name.

  • customer_reference: The reference to the customer.

  • item_costs: {

    • discount_applied: The discount applied for the missing image deliveries.
    • item_cost: The cost of the item.
    • calculated_cost: The total cost of missing image deliveries.
    • product_type: The type of the product , default value is missing-image-delivery-accounts. }

  • item_options: [{

    • filing_history_documents: {
      • filing_history_date: The date of the filing history in a string value.
      • filing_history_description: The description of the filing history (e.g., accounts-with-accounts-type-small, capital-allotment-shares)
      • filing_history_description_values: {
        • date: The date when filing history description values set.
        • capital: [{
          • figure: The figure value for the filing history.
          • currency: The currency for the filling history. ]},
        • charge_number: The charge number for the filing history.
        • made_up_date: The made up date for the filing history.
        • officer_name: The office name for the filing history. }
      • filing_history_id: The id value of the filing history document.
      • filing_history_type: The filing history type value (e.g., SH01, AA).
      • filing_history_barcode: The barcode of the filing history document.
      • filing_history_category: The category of the filing history document (e.g., accounts, capital). }] }]

  • basket: {

    • forename: The forename for basket delivery details.
    • surname: The surname for basket delivery details.
    • enrolled: To make the multi-item basket available to all users, this should be set to true. Default value is true. }

  • kind: The kind of the missing image deliveries.

  • quantity: The number of the missing image deliveries.

  • postal_delivery: The boolean value for missing image deliveries postal delivery. Default value is false.

  • user_id: The user id who logged in to order the missing image deliveries.

  • postage_cost: The cost for the postage.

  • total_item_Cost: The total cost of missing image deliveries.

  • A usage example looks like this: {"company_name": "ACME Company", "company_number": "SC172618", "customer_reference": "test", "item_costs": [ { "discount_applied": "0", "item_cost": "15", "calculated_cost": "15", "product_type": "certified-copy" } ], "item_options": [ { "filing_history_date": "2018-04-23", "filing_history_description": "mortgage-create-with-deed-with-charge-number", "filing_history_description_values": { "charge_number": "029231400009" }, "filing_history_id": "MzIwMzkwNTUxNmFkaXF6a2N0", "filing_history_type": "MR01", "filing_history_category": "mortgage", "filing_history_barcode": "J74HTP8H" } ], "kind": "item#missing-image-delivery", "quantity": 1, "postal_delivery": false, "user_id": "Y2VkZWVlMzhlZWFjY2M4MzQ3MT", "basket": { "forename": "John", "surname": "Doe", "enrolled": true }, "postage_cost": "0", "total_item_cost": "30" }

  • Adding multiple missing image deliveries example: {"company_name": "ACME Company", "company_number": "SC172618", "customer_reference": "test", "item_costs": [ { "discount_applied": "0", "item_cost": "15", "calculated_cost": "15", "product_type": "certified-copy" } ], "item_options": [ { "filing_history_date": "2018-04-06", "filing_history_description": "accounts-with-accounts-type-small", "filing_history_description_values": { "capital": [ { "figure": "34,253,377", "currency": "GBP" } ], "charge_number": "908484848", "date": "2019-11-10", "made_up_date": "2019-12-10", "officer_name": "Officer test" }, "filing_history_id": "MzIwMTkzODk1NGFkaXF6a2N6", "filing_history_type": "AA", "filing_history_category": "accounts", "filing_history_barcode": "L72QXI0Y" }, { "filing_history_date": "2018-04-23", "filing_history_description": "mortgage-create-with-deed-with-charge-number", "filing_history_description_values": { "charge_number": "029231400009" }, "filing_history_id": "MzIwMzkwNTUxNmFkaXF6a2N0", "filing_history_type": "MR01", "filing_history_category": "mortgage", "filing_history_barcode": "J74HTP8H" } ], "kind": "item#missing-image-delivery", "quantity": 1, "postal_delivery": false, "user_id": "Y2VkZWVlMzhlZWFjY2M4MzQ3MT", "basket": { "forename": "John", "surname": "Doe", "enrolled": true }, "postage_cost": "0", "total_item_cost": "30" }

• DELETE: Sending a DELETE request on the endpoint {Base URL}/test-data/missing-image-deliveries/{id} will delete the test missing image deliveries.

Creating, Retrieving, Updating and Deleting Account Penalties

• POST: Sending a POST request to create Account Penalties {Base URL}/test-data/penalties will create an Account Penalties entry in the account_penalties db collection. The request body must include all mandatory fields of companyCode, customer_code and amount then optional fields of createdAt, closedAt, isPaid, amount, number_of_penalties, type_description, ledger_code, dunning_status, account_status, outstandingAMount, transaction_type and transaction_sub_type parameters.

  • company_code: The Company Code of the Account Penalties entry in the account_penalties db collection. Mandatory field.

  • customer_code: The Customer Code of the Account Penalties entry in the account_penalties db collection. Mandatory field.

  • amount: The Amount of the Penalty being created in the Account Penalties data in the account_penalties db collection.

  • number_of_penalties: The number of penalties to be created in the Account Penalties data in the account_penalties db collection. Mandatory field.

  • created_at: The Created At date of the Penalty being created in the Account Penalties data in the account_penalties db collection.

  • closed_at: The Closed At date of the Penalty being created in the Account Penalties data in the account_penalties db collection.

  • part_payment: The Part Payment amount of the Penalty being created. Boolean, when set to true, the outstanding amount will be less than the total amount and the is_paid flag will be false.

  • is_paid: The Is Paid flag of the Penalty being created in the Account Penalties data in the account_penalties db collection.

  • type_description: The type description of the Penalty being created in the Account Penalties data in the account_penalties db collection.

  • ledger_code: The ledger code of the Penalty being created in the Account Penalties data in the account_penalties db collection.

  • dunning_status: The dunning status of the Penalty being created. Defaults to PEN1.

  • account_status: The account status of the Penalty being created in the Account Penalties data in the account_penalties db collection.

  • transaction_type: The transaction type of the Penalty being created in the Account Penalties data in the account_penalties db collection.

  • transaction_sub_type: The transaction sub-type of the Penalty being created in the Account Penalties data in the account_penalties db collection.

  • duplicate: The duplicate will create multiple penalties with same transaction reference. This is boolean by default is false which will not create duplicate penalties

  • An usage example looks like this: { "company_code": "LP", "customer_code": "NI095887", "number_of_penalties": 2, "amount": 150 }

  • An usage example for duplicate penalties looks like this: { "company_code": "LP", "customer_code": "NI095887", "number_of_penalties": 2, "amount": 150, "duplicate": true }

• GET: Sending a GET request to retrieve the Account Penalties by id {Base URL}/test-data/penalties/{id}.

  • id: The ID of the Account Penalties entry in the account_penalties db collection. This is mandatory and passed as a path variable.

  • penalty_ref: The Transaction Reference of the Account Penalties entry in the account_penalties db collection. This is optional and passed as a query parameter to return a single penalty from a list.

  • A usage example looks like this: GET {Base URL}/test-data/penalties/687932936d534811231973b6?transactionReference=A1234567

• GET: Sending a GET request to retrieve the Account Penalties by customer code and company code {Base URL}/test-data/penalties/query?customerCode=<customerCode>&companyCode=<companyCode>.

  • customerCode: The customer code of the Account Penalties in the account_penalties db collection. This is mandatory and passed as a query parameter.

  • companyCode: The Company code of the Account Penalties entry in the account_penalties db collection. This is mandatory and passed as a query parameter.

  • A usage example looks like this: GET {Base URL}/test-data/penalties/query?customerCode=12345678&companyCode=LP

• PUT: Sending a PUT request to update Account Penalties for a specific Penalty {Base URL}/test-data/penalties/{penaltyRef} will update an Account Penalties entry. The request body must include mandatory companyCode and customer_code, and optional createdAt, closedAt, isPaid, amount and outstandingAMount parameters.

  • company_code: The Company Code of the Account Penalties entry in the account_penalties db collection. This is mandatory.

  • customer_code: The Customer Code of the Account Penalties entry in the account_penalties db collection. This is mandatory.

  • created_at: The Created At date of the Penalty being updated in the Account Penalties data in the account_penalties db collection. This cannot be set to null. This is optional.

  • closed_at: The Closed At date of the Penalty being updated in the Account Penalties data in the account_penalties db collection. This is optional.

  • is_paid: The Is Paid flag of the Penalty being updated in the Account Penalties data in the account_penalties db collection. This is optional.

  • amount: The Amount of the Penalty being updated in the Account Penalties data in the account_penalties db collection. This is optional.

  • outstanding_amount: The Amount of the Penalty being updated in the Account Penalties data in the account_penalties db collection. This is optional.

  • A usage example looks like this: {"company_code": "LP", "customer_code": "12345678", "created_at": "2026-06-07T14:04:23.512Z", "closed_at": "2026-06-07T14:04:23.512Z", "is_paid": true, "amount": 50, "outstanding_amount": 0}

• DELETE: Sending a DELETE request on the endpoint {Base URL}/test-data/penalties/{id} will delete the Account Penalties. id is required.

  • id: The ID of the Account Penalties entry in the account_penalties db collection. This is mandatory.

  • penalty_ref: The Transaction Reference of the Account Penalties entry in the account_penalties db collection. This is optional and used to delete a single penalty from a list of penalties.

  • A usage example looks like this: { "penalty_ref": "A123456" }

Retrieving Postcode

• GET: Sending a GET request to retrieve the Postcode {Base URL}/test-data/postcode/{countrycode}.

  • countrycode: The country code to retrieve the postcode for. This will return a random postcode for the specified country code.
  • list of country codes:
    • GB-ENG: England
    • GB-SCT: Scotland
    • GB-WLS: Wales
    • GB-NIR: Northern Ireland
    • GB: United Kingdom

  A usage example looks like this: {"countrycode": "GB-ENG"}

Creating transactions and ACSP applications

• POST: Sending a POST request to {Base URL}/test-data/transactions will create a transaction and associated acsp application reference : Type of transaction being created userId : CHS User Id of the user associated with the transaction

  A usage example looks like this: {"reference": "ACSP Registration" , "userId": "test12552"}

  • DELETE: Sending a DELETE request on the endpoint {Base URL}/test-data/transactions/{transaction_id} will delete the Transaction and ACSP application.

Creating User Company Associations

• POST: Sending a POST request to create User Company Association {Base URL}/test-data/associations. A company_number is mandatory and either a user_id or a user_email is required.

  • company_number: The company number of the company.
  • user_id: The user ID of the user. This is mandatory if there is no user_email provided.
  • user_email: The user email of the user. This is mandatory if there is no user_id provided.
  • status: Status of the association. This is optional. Can only be confirmed, removed, migrated, awaiting-approval or unauthorised. Default is confirmed.
  • approval_route: The route through which the association was created. This is optional. Can only be auth_code, invitation or migration. Default is auth_code.
  • approval_expiry_at: The date and time the invitation expires. Default is 7 days from now. This is optional. It is only set if invitation data is passed.
  • invitations:
    • invited_by: User id of the user who invited them to the company.
    • invited_at: When the user was invited to the company.
  • previous_states:
    • status: The status of the association before it was changed.
    • changed_by: The user id of the user who made the change.
    • changed_at: When the association was changed.

  A usage example looks like this: { "company_number": "12345678", "user_id": "userA", "status": "awaiting-approval", "approval_route": "invitation", "invitations": [ { "invited_by": "userB", "invited_at": "2025-07-14T10:10:26.945+00:00" }, { "invited_by": "UserC", "invited_at": "2025-07-06T08:49:25.354+00:00" } ], "approval_expiry_at": "2025-07-14T12:40:40.702+00:00", "previous_states": [ { "status": "removed", "changed_by": "UserC", "changed_at": "2025-07-05T08:49:25.354+00:00" }, { "status": "migrated", "changed_by": "UserD", "changed_at": "2025-07-04T08:49:25.354+00:00" } ] }

• DELETE: Sending a DELETE request on the endpoint {Base URL}/test-data/associations/{associationId} will delete the association. associationId is required to delete the association.

Create Sic Code

• POST: Sending a POST request to create Sic Code {Base URL}/test-data/combined-sic-activities will generate a new Sic code.

  • activity_description: The User ID of user from the user db. This is mandatory.
  • sic_description: This is the Sic description for the Sic code.
  • is_ch_activity: Status of the ch activity. This is boolean , default value is false
  • activity_description_search_field: The activity description search field for the Sic code.

  A usage example looks like this: { "activity_description" : "Braunkohle waschen", "sic_description" : "Abbau von Braunkohle", "is_ch_activity" : false, "activity_description_search_field" : "braunkohle waschen" }

• DELETE: Sending a DELETE request on the endpoint {Base URL}/test-data/combined-sic-activities/{id} will delete the Sic Code and Keyword.

Environment Variables

The supported environmental variables have been categorised by use case and are as follows.

Code Analysis Variables

Name	Description	Mandatory	Default	Example
CODE_ANALYSIS_HOST_URL	The host URL of the code analysis server. See here	✓		http://HOST:PORT
CODE_ANALYSIS_LOGIN	The analysis server account to use when analysing or publishing. See here	✓		login
CODE_ANALYSIS_PASSWORD	The analysis server account password. See here	✓		password

Deployment Variables

Name	Description	Mandatory	Default	Example
TEST_DATA_GENERATOR_PORT	Configured port application runs on.	✓		4022
MONGODB_URL	Mongo database URL.	✓		mongodb://localhost:27017
BARCODE_SERVICE_URL	URL of barcode service	✓		http://localhost:9000
API_URL	URL of (company) API service	✓