This is an application to allow Limited Companies to provide their information to HMRC.

1. Make sure any dependent services are running using the following service-manager command sm --start INCORPORATED_ENTITY_IDENTIFICATION_ALL

2. Stop the backend in service manager using sm --stop INCORPORATED_ENTITY_IDENTIFICATION

3. Run the backend locally using sbt 'run 9719 -Dapplication.router=testOnlyDoNotUseInAppConf.Routes'

Creates a new journeyId and stores it in the database

No body is required for this request

Status: Created(201)

Example Response body:

{“journeyId”: "<random UUID>"}

Retrieves all the journey data that is stored against a specific journeyID.

A valid journeyId must be sent in the URI

Example response body:

{
"companyProfile":
    {"companyName":"TestCompanyLtd”,
    “companyNumber":"01234567",
    "dateOfIncorporation":"2020-01-01"},
"ctutr":"1234567890",
"identifiersMatch":true,
"businessVerification":
    {"verificationStatus":"PASS"},
"registration":
    {"registrationStatus":"REGISTERED",
    "registeredBusinessPartnerId":"X00000123456789"}
}

Retrieves all the journey data that matches the dataKey for a specific journeyID.

Example Request URI

/journey/testJourneyId/ctutr

Response body for example URI:

{"1234567890"}

Stores the json body against the data key and journey id provided in the uri

Requires a valid journeyId and user must be authorised to make changes to the data

Example request URI:

/journey/testJourneyId/ctutr

Example request body:

{"1234567890"}

Checks if the user entered identifiers match what is held in the database. This endpoint is feature switched using the Use stub for Get CT Reference switch, which returns a specific CTUTR based on the CRN.

Example Body:

{
"companyNumber": 12345678,
"ctutr": 1234567890
}

Example response bodies:

{"matched":true}

or

{"matched":false}

Submits a registration request to the downstream Register API. This API is feature switched behind the Use stub for submissions to DES switch so it can be stubbed using the Register test endpoint described below.

Body:

{
"company": {
            "crn": 12345678,
            "ctutr": 1234567890
           }
}

Status: OK(200) Attempted registration and returns result of call

Example response bodies:

{
"registration":{
                "registrationStatus":"REGISTERED",
                "registeredBusinessPartnerId":"<randomm UUID>"
               }
}

or

{
"registration":{
                "registrationStatus":"REGISTRATION_FAILED",
               }
}

Stubs a call to retrieve a CTUTR from the database

URI must contain a company number

Company Numbers are mapped to specific CTUTRs

Example Response body:

"{CTUTR":"1234567890}"

Stub for downstream Register API

No body is required for this request as this always returns a successful response regardless of the data sent.

Status: OK(200)

Example Response body:

{
"identification":{
                  "idType":"SAFEID",
                  "idValue":"X00000123456789"
                 }
}

This code is open source software licensed under the Apache 2.0 License.