Individual Tax 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 tax record for a given year:
- tax deducted from annual gross income for a given employment and tax year
- tax deducted from pensions (other than state pension) and/or retirement annuities
- tax deducted from Incapacity Benefit
- tax refunded, or set off, within this tax year. For example; a repayment of CIS deductions (if you work in the construction industry), PAYE tax or tax paid on savings income. It may also be an amount that HMRC has reallocated to an existing debt.
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 for this API 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.