Skip to content

rszmacinski/customer-profile

 
 

Repository files navigation

CUSTOMER-PROFILE

Build Status Download

Allows users to view tax profile and communication preferences

Requirements

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.

API

Task Supported Methods Description
/profile/accounts GET Look up for the current user's tax account identifiers. More...
/profile/personal-details/:nino GET Returns a user's designatory details. More...
/profile/preferences GET Returns the user's preferences. More...
/profile/preferences/paperless-settings/opt-in POST Sets or updates the user's paperless opt-in preference settings. More...
/profile/preferences/paperless-settings/opt-out POST Opts the user out of paperless. More...
/profile/native-app/version-check POST Confirms that the user's native app installation is valid and should not be prompted to upgrade. More...

Sandbox

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

    GET /sandbox/profile/accounts

Version

Version of API need to be provided in Accept request header

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

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

Languages

  • Scala 96.7%
  • RAML 3.3%