GOV.UK
API documentation
These are the RESTful APIs we offer on the Developer Hub.
Separately we also offer XML APIs.
Example API
-
Hello WorldVersion: 1.0 (Stable)
A 'hello world' example of an API on the HMRC API Developer Hub.
APIs
-
Bulk Data File ListVersion: 1.0 (Beta)
An API informing about files available for download from Secure Data Exchange Services.
-
Customs DeclarationsVersion: 1.0 (Beta)
Single WCO-compliant Customs Declarations API
-
Customs Inventory Linking ExportsVersion: 1.0 (Beta)
Customs Inventory Linking Exports
-
Estate Registration ServiceVersion: 1.0 (Beta)
An API for registering estates.
-
Individual BenefitsVersion: 1.1 (Beta)
Benefit–based services, such as retrieval of benefits information.
-
Individual EmploymentVersion: 1.1 (Beta)
Employment–based services, such as employment history.
-
Individual IncomeVersion: 1.1 (Beta)
Income–based services, such as historic personal income and employment-based income.
-
Individual TaxVersion: 1.1 (Beta)
Tax–based services, such as retrieval of annual personal and employment-related tax liabilities and refunds.
-
Lifetime ISAVersion: 1.0 (Beta)
The Lifetime ISA (LISA) API allows financial organisations to report information to HM Revenue and Customs (HMRC) and get information about payments made by HMRC.
-
Marriage AllowanceVersion: 1.0 (Stable)
The Marriage Allowance API provides information about whether someone is claiming Marriage Allowance and checks eligibility to claim Marriage Allowance.
-
National InsuranceVersion: 1.1 (Beta)
National Insurance services, such as retrieval of annual summary of Class 1 and Class 2 National Insurance contributions.
-
Pull NotificationsVersion: 1.0 (Beta)
Allows for retrieval of notifications
-
Relief At SourceVersion: 1.0 (Stable)
For pension scheme administrators to identify the residency status for their scheme members.
-
Self Assessment (MTD)Version: 1.0 (Beta)
An API for providing self assessment data and obtaining tax calculations
-
Trust Registration ServiceVersion: 1.0 (Beta)
An API for registering trusts.
-
VAT (MTD)Version: 1.0 (Beta)
An API for providing VAT data
Test Support APIs
These APIs are available solely for testing purposes, for example setting up test data.
-
Create Test UserVersion: 1.0 (Beta)
The Create Test User API is responsible for creating test users on the external test environment.
-
Individual PAYE Test SupportVersion: 1.0 (Beta)
Lets you set up test data for the Individual PAYE APIs: Individual Benefits, Individual Employment, Individual Income and Individual Tax.
-
Marriage Allowance Test SupportVersion: 1.0 (Beta)
Lets you set up test data for the Marriage Allowance API.
-
National Insurance Test SupportVersion: 1.0 (Beta)
Lets you set up data for the National Insurance API.