check-eori-number-api

This microservice provides an API interface to the Check Eori Number microservice to provide users with a way to:

• check if an EORI number beginning with GB (issued by the UK) is valid.
• view the name and address of the business that the EORI number is registered to (if the business agreed to share this information).

Requirements

This service is written in Scala and Play, so needs at least a JRE to run.

Getting started with Check EORI number API

Step-by-step guide

1. Clone the git repos to the same location you keep your other services from:

   git clone git@github.com:hmrc/check-eori-number-api.git

   Note: Make sure that service-manager-config is up to date locally

2. Start the services:

   Run the services against the current versions in dev, stop the CHEN_FRONTEND service and  start manually
   
       sm2 --start CHEN_ALL 
       sm2 --stop CHEN_API
       cd check-eori-number-api
       sbt run
   

3. You can view the first page of the service in a browser using http://localhost:8350/check-eori-number/enter-number

4. Enter a EORI number to check if it is valid or not

5. In a stubbed environment each EORI will exhibit different behavior Please see here for details

Endpoints

Path	Method	Description
/check-multiple-eori	POST	Checks multiple EORI numbers with a maximum of 10 EORI numbers per request

Unit tests

Run sbt test it/test on the terminal to run the unit and integration tests.

Acronyms

In the context of this application we use the following acronyms and define their meanings. Provided you will also find a web link to discover more about the systems and technology.

• API: Application Programming Interface

• HoD: Head of Duty

• JRE: Java Runtime Environment

• EORI: Economic Operators Registration and Identification

License

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