Allows users to view tax profile and communication preferences

The following services are exposed from the micro-service.

Please note it is mandatory to supply an Accept HTTP header to all below services with the value application/vnd.hmrc.1.0+json.

• Run locally: sbt run which runs on port 8233 by default
• Run with test endpoints: sbt 'run -Dplay.http.router=testOnlyDoNotUseInAppConf.Routes'

The service can be run locally from Service Manager, using the following profiles:

• Run Unit Tests: sbt test
• Run Integration Tests: sbt it:test
• Run Unit and Integration Tests: sbt test it:test
• Run Unit and Integration Tests with coverage report: sbt clean compile coverage test it:test coverageReport dependencyUpdates

Validate the entered pin against the DOB pattern and previously used pin

• Local testing URL - http://localhost:8233/validate/pin/{enteredPin}?journeyId=&deviceId=

• QA URL - https://api.qa.tax.service.gov.uk/customer-profile/validate/pin/{enteredPin}?journeyId=&deviceId=

• Staging URL - https://api.staging.tax.service.gov.uk/customer-profile/validate/pin/{enteredPin}?journeyId=&deviceId=

• Headers - Accept -> application/vnd.hmrc.1.0+json

• Bearer token needs to be supplied

Example response body for success with 200 OK:

{
   "key" : "valid_pin",
   "message ":  "Pin is valid"
}

Example response body for DOB match with 200 OK:

{
    "key" : "create_pin_date_of_birth_error_message",
   "message ":  "PIN should not include your date of birth"
}

Example response body for previous pin match 200 OK:

{
    "key" : "change_pin_disallow_previous_pins_error_message",
   "message ":  "Do not re-use an old PIN"
}

• Local testing URL - http:/localhost:8233/upsert

• QA URL - https://api.qa.tax.service.gov.uk/customer-profile/upsert

• Staging URL - https://api.staging.tax.service.gov.uk/customer-profile/upsert

• Headers - Accept -> application/vnd.hmrc.1.0+json

• Bearer token needs to be supplied n

{
    "pin" : "123456",
   "deviceId ": "device-002"
}

All the above endpoints are accessible on sandbox with /sandbox prefix on each endpoint, e.g.

    GET /sandbox/profile/accounts

To trigger the sandbox endpoints locally, use the "X-MOBILE-USER-ID" header with one of the following values: 208606423740 or 167927702220

To test different scenarios, add a header "SANDBOX-CONTROL" to specify the appropriate status code and return payload. See each linked file for details:

save some pin data in DB

{
   "deviceId ": "device-002",
  "ninoHash" : "SZ123456B",
  "hashedPins" : ["123445","567890"]
}

delete all pin data from DB

delete all pin data from DB based on device id and nino

Version of API need to be provided in Accept request header

Accept: application/vnd.hmrc.v1.0+json

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