individuals-disclosures-api

The Individuals Disclosures API allows a developer to create and amend, retrieve, and delete data relating to disclosures.

Requirements

• Scala 2.13.x
• Java 11
• sbt 1.10.x
• Service Manager 2

Development Setup

Run the microservice from the console using: sbt run (starts on port 7799 by default)

Start the service manager profile: sm2 --start MTDFB_INDIVIDUALS_DISCLOSURES

Run Tests

Run unit tests: sbt test

Run integration tests: sbt it/test

Viewing OAS

To view documentation locally, ensure the Individuals Disclosures API is running, and run api-documentation-frontend:

./run_local_with_dependencies.sh

Then go to http://localhost:9680/api-documentation/docs/openapi/preview and use the appropriate port and version:

http://localhost:7799/api/conf/2.0/application.yaml

Changelog

You can see our changelog here

Support and Reporting Issues

You can create a GitHub issue here

API Reference / Documentation

Available on the HMRC Developer Hub

License

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