No description, website, or topics provided.
Scala
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
conf
project
test/uk/gov/hmrc
.gitignore
.travis.yml
LICENSE
README.md
repository.yaml
scalastyle-config.xml

README.md

business-matching

Build Status Download

This service privides the ability for agents, organistation or self-assessment individuals to search (and register) to ETMP. This is Register Once in ROSM pattern.

Business Lookup APIs

The request must be a valid json using one of the following uris

PATH Supported Methods Description
/sa/:sa/business-matching/business-lookup/:utr/:userType POST Self Assessment users should call this
/org/:org/business-matching/business-lookup/:utr/:userType POST Organisations should call this
/agent/:ac/business-matching/business-lookup/:utr/:userType POST Agents should call this

where,

Parameter Message
sa/org/ac unique auth id for clients/agents
utr he Unique Tax Reference being looked up
userType Whether this is "sa", "org" or "agent"

Usage

POST /agent/123456789/business-matching/business-lookup/1111111111/agent

POST /org/123477789/business-matching/business-lookup/1111111111/org

POST /sa/123890789/business-matching/business-lookup/1111111111/sa

Request body

{
  "acknowledgementReference": "12345678901234123456789098909090",
  "utr": "1234567890",
  "requiresNameMatch": true,
  "isAnAgent": true,
  "individual": {
    "firstName": "Stephen",
    "lastName": "Wood",
    "dateOfBirth": "1990-04-03"
  }
}

Response

Status Message
200 Ok
400 Bad Request
404 Not Found
500 Internal Server Error
503 Service Unavailable
{
 "sapNumber": "1234567890",
 "safeId": "XE0001234567890",
 "agentReferenceNumber": "AARN1234567",
 "isEditable": true,
 "isAnAgent": false,
 "isAnIndividual": true,
 "individual": {
   "firstName": "Stephen",
   "lastName": "Wood",
   "dateOfBirth": "1990-04-03"
 },
 "address": {
   "addressLine1": "100 SuttonStreet",
   "addressLine2": "Wokingham",
   "addressLine3": "Surrey",
   "addressLine4": "London",
   "postalCode": "DH14EJ",
   "countryCode": "GB"
 },
 "contactDetails": {
   "phoneNumber": "01332752856",
   "mobileNumber": "07782565326",
   "faxNumber": "01332754256",
   "emailAddress": "stephen@manncorpone.co.uk"
 }
}

License

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