v1

latestOpenAPI 3.0.32026-07-131713.6 KB

Check if an individual is a Scotland, Wales or rest of the UK resident

Pension Scheme Administrators can find out if a pension scheme member pays tax in Scotland, Wales or in the rest of the UK. They can apply the correct rate of Income Tax to their relief at source contributions. From 1 January to 5 April, the API will return currentYearResidencyStatus and nextYearForecastResidencyStatus. From 6 April to 31 December, the API will only return currentYearResidencyStatus.

post/individuals/relief-at-source/residency-status

Headers

Accept'application/vnd.hmrc.2.0+json' required

Specifies the response format and the version of the API to be used.

Content-Type'application/json' required

Specifies the format of the request body, which must be JSON.

Authorizationstring required

Example:Bearer bb7fed3fe10dd235a2ccda3d50fb

An OAuth 2.0 Bearer Token with the read:ras scope.

Request body

ninostring required

The pension scheme member’s National Insurance number.

firstNamestring required

The pension scheme member’s first name.

lastNamestring required

The pension scheme member’s last name.

dateOfBirthstring required

The pension scheme member’s date of birth. This cannot be in the future.

Example request

{
  "nino": "BB123456B",
  "firstName": "John",
  "lastName": "Smith",
  "dateOfBirth": "1975-05-25"
}

Response

currentYearResidencyStatus'scotResident' | 'welshResident' | 'otherUKResident' required

nextYearForecastResidencyStatus'scotResident' | 'welshResident' | 'otherUKResident'

All 1 operations