confirmation-statement-api

Overview

API service for submitting Confirmation Statements to CHIPS

Requirements

In order to run the service locally you will need the following:

• Java 21
• Maven
• Git

Getting started

To checkout and build the service:

1. Clone Docker CHS Development and follow the steps in the README.
2. Run chs-dev modules enable confirmation-statement
3. Run chs-dev development enable confirmation-statement-api
4. Manually enable the following services:

• chs-dev services enable company-appointments-api-ch-gov-uk
• company-metrics-api
• psc-data-api
• psc-statement-data-api
• chs-delta-api
• resource-change-publisher
• stream-router
• company-appointments-consumer

7. Run docker using "chs-dev up" in the docker-chs-development directory.
8. Run "chs-dev status" to check all required services are running and healthy
9. Open your browser and go to page http://chs.local/confirmation-statement/

These instructions are for a local docker environment.

Endpoints

The full path for each public endpoints that requires a transaction id begins with the app url: ${API_URL}/transactions/{TRANSACTION_ID}/confirmation-statement

Method	Path	Description
GET	/{confirmation_statement_id}	Returns confirmation-statement based on confirmationStatementId
GET	/{confirmation_statement_id}/validation-status	Returns flags to indicate that all required tasks are complete
GET	/{confirmation_statement_id}/costs	Returns the payment amount required to submit
GET	/{confirmation_statement_id}/active-director-details"	Returns data to present to the user
GET	/{confirmation_statement_id}/persons-of-significant-control	Returns data to present to the user
GET	/{confirmation_statement_id}/register-locations	Returns data to present to the user
GET	/{confirmation_statement_id}/shareholders	Returns data to present to the user
GET	/{confirmation_statement_id}/statement-of-capital	Returns data to present to the user
POST	/	Creates the confirmation statement
POST	/{confirmation_statement_id}	Updates the confirmation statement

For filing: ${API_URL}/private/transactions/{transaction_id}/confirmation-statement

Method	Path	Description
GET	{confirmation_statement_id}/filings	Returns filing data required for the CHIPS filing backend

For company endpoints: ${API_URL}/confirmation-statement/company/{companyNumber}

Method	Path	Description
GET	/eligibility	Check company is eligible for filing
GET	/next-made-up-to-date	Get due date

Private company endpoint to retrieve registered email address: ${API_URL}/private/confirmation-statement/company/{company-number}

Method	Path	Description
GET	/registered-email-address	Returns company's registered email address

Terraform ECS

What does this code do?

The code present in this repository is used to define and deploy a dockerised container in AWS ECS. This is done by calling a module from terraform-modules. Application specific attributes are injected and the service is then deployed using Terraform via the CICD platform 'Concourse'.

Application specific attributes	Value	Description
ECS Cluster	filing-maintain	ECS cluster (stack) the service belongs to
Load balancer	{env}-chs-apichgovuk {env}-chs-apichgovuk-private	The load balancer that sits in front of the service
Concourse pipeline	Pipeline link Pipeline code	Concourse pipeline link in shared services

Contributing

• Please refer to the ECS Development and Infrastructure Documentation for detailed information on the infrastructure being deployed.

Testing

• Ensure the terraform runner local plan executes without issues. For information on terraform runners please see the Terraform Runner Quickstart guide.
• If you encounter any issues or have questions, reach out to the team on the #platform slack channel.

Vault Configuration Updates

• Any secrets required for this service will be stored in Vault. For any updates to the Vault configuration, please consult with the #platform team and submit a workflow request.

Local Dev Environment Troubleshooting

AWS CLI

If you are having issues with the AWS CLI authorisation, you can use the following commands to export your credentials:

l_aws # choose development-eu-west-2
eval "$(aws configure export-credentials --format env)"

Docker Error Code 17

If you encounter the following error, or similar error code 17, when running chs-dev up on your local machine:

failed to solve: failed to compute cache key: failed to calculate checksum of r ef w7ku8z8s91nt5gefsc7foffdv::56zof7fesw33xLj94s8lahepr: "/app": not found
Running chs-dev environment: docker-chs-development... !
Error: Docker compose failed with status code: 17

run a make command within your confirmation-statement-api directory to resolve the issue. Also ensure you are also using the correct jdk version when running make.

sdk use <latest jdk 21 release>
make

Image Configuration within pom.xml

Although now fixed, changing the image configuration within the pom.xml file may resolve some issues. Near the end of the pom.xml in the confirmation-statement-api directory, change the image configuration to the following:

<configuration>
    <from>
        <image>416670754337.dkr.ecr.eu-west-2.amazonaws.com/ci-corretto-build-21:latest</image>
    </from>
    <to>
        <image>mvn compile jib:dockerBuild -Dimage=416670754337.dkr.ecr.eu-west-2.amazonaws.com/charges-delta-consumer:latest</image>
    </to>
</configuration>

Enabling the Debug Port

If you are wanting to enable the debug port, you can do so by adding the following to the confirmation-statement-api.docker-compose.yaml file. The yaml is found within the docker-chs-development/services/modules/confirmation-statement/ directory.

# At the end of the `environment` section
  JAVA_TOOL_OPTIONS=-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:9095
expose:
  - 8080
  - 9095
ports:
  - "9095:9095"

Postman Authorisation

In order to use Postman to test the endpoints, you will need to set up the authorisation. This can be done by following the steps below:

1. Open Postman and select the confirmation-statement-api collection.
2. Click on the Authorization tab.
3. Select OAuth 2.0 from the Auth Type dropdown.
4. Click on the Get New Access Token button.
5. Sign in with appropriate credentials.

Useful Links

• ECS service config dev repository
• ECS service config production repository