Individual Income API
Version and status | |
---|---|
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 |
Overview
This API is one of a number of APIs that provide information that HMRC knows about an individual's tax affairs.
This API in particular provides the following information about an individual's income for a given tax year:
- income from employment, as reported to HMRC by their employers through the PAYE process
- income from pensions (other than state pension) and retirement annuities
- income from other state benefits or grants, such as taxable Incapacity Benefit, contribution-based Employment and Support Allowance and the Self-Employment Income Support Scheme
The primary intended use for this information is to pre-populate an individual's Self Assessment tax return.
Errors
Testing
You can use the sandbox environment to test this API.
It supports stateful behaviour. You can set up test data using the Individual PAYE Test Support API.
Versioning
Endpoints
View API endpointsWhy do these endpoints look different?
The endpoints for this API now use the Open API Specification (OAS).
The API has not changed. You do not need to make any updates to your application if you already use this API.