This version is in beta - expect some breaking changes.

Individual Benefits API

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 information about an employee’s or director’s benefits for a given tax year, as reported to HMRC by their employer(s) through the PAYE process. For example company cars and fuel, interest-free and low interest loans, private medical and dental insurance.

For more information, see HMRC’s A-Z guide to expenses and benefits

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 endpoints
Why 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.