Skip to content

hmrc/business-details-api

Repository files navigation

Business Details API

The business details API allows a developer to:

  • list all businesses
  • retrieve additional information for a user's business details

Requirements

Running the micro-service

Run from the console using: sbt run (starts on port 7792 by default) Start the service manager profile: sm2 -start MTDFB_BUSINESS_DETAILS

Running tests

sbt test
sbt it:test

Viewing Open API Spec (OAS) docs

To view documentation locally ensure the Business Details 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 this port and version: http://localhost:7792/api/conf/1.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 at HMRC Developer Hub

License

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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 47

Languages