Relief At Source API
| REST | |
| Version 2.0 - stable | |
| 01 May 2026 | |
| Sandbox base URL | https://test-api.service.hmrc.gov.uk |
| Production base URL | https://api.service.hmrc.gov.uk |
Overview
Check a pension scheme member residency for tax purposes. Pension scheme administrators need this for relief at source claims.
Before you start
You will need the pension scheme member’s:
- full name
- date of birth
- National Insurance number
Errors
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.
Testing
You can use the sandbox environment to test this API.
It does not currently support stateful behaviour, but you can use the payloads described in Resources to test specific scenarios.
You must set up a test user which is an organisation for this API using the Create Test User API.
Versioning
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.
Endpoints
| Version | Environments | Endpoints |
|---|---|---|
|
Version 2.0 - stable
(opens in new tab) |
Sandbox and Production | 2.0 endpoints |