Marriage Allowance API
|Available in Sandbox||Yes|
|Sandbox base URL||https://test-api.service.hmrc.gov.uk|
|Available in Production||Yes|
|Production base URL||https://api.service.hmrc.gov.uk|
This API provides resources related to Marriage Allowance.
Marriage Allowance lets the lower earner of a couple transfer some of their Personal Allowance to their husband, wife or civil partner. If they are eligible this will then lower their tax bill.
In particular, this API can
- Retrieve an individual’s Marriage Allowance status
- Check their partner’s eligibility to be a recipient of Marriage Allowance (useful if the individual is considering applying for Marriage Allowance)
Switch to version 2.0
On 28 February 2020 version 1.0 will be switched off.
If you are deploying after 28 February 2020, you should build based on version 2.0.
If you are deploying before 28 February 2020, you can continue building based on version 1.0 until that date. You must switch to version 2.0 on 28 February 2020.
Version 2.0 will be available from 23 October 2019 within the Sandbox and Production environment.
The endpoint in this API is user-restricted. Your users must grant authority for your software to access it by signing in to their HMRC online account.
The API supports individual and agent users. Note that:
- Individual users can only access their own information.
- Agent users can only access their own clients’ data.
The following options are supported for agents:
Option 1: Agent services account
Option 2: HMRC online services for agents account
If the agent uses an HMRC online services for agents account which is enrolled for Self Assessment for Agents, they will be able to access their existing 64-8 clients (restricted to 2 years’ history).
When an API changes in a way that is backwards-incompatible, we increase the version number of the API. See our reference guide for more on versioning.
We use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:
- 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action
- 400 to 499 if it failed because of a client error by your application
- 500 to 599 if it failed because of an error on our server
Errors specific to each API are shown in the Endpoints section, under Response. See our reference guide for more on errors.