This version is in beta - expect some breaking changes.

Interest Restriction Return (IRR) API

Dates and amounts
Date Amount
Version and status
Available in Sandbox Yes
Sandbox base URL
Available in Production Yes
Production base URL


The API in its current state supports the following functions:

  • Revoke an existing Reporting Company from submitting Interest Restriction Returns
  • Appoint a new Reporting Company for submitting Interest Restriction Returns
  • Submit an Interest Restriction Return (full)
  • Submit an Interest Restriction Return (abbreviated)

This API uses User Restricted Endpoints. Please find further details on the Authorisation page.

For more information about how to develop your own client applications, including example clients for this API, see Tutorials.


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.




The way we show Interest Restriction Return (IRR) API v1.0 endpoints has changed, which might look different to other Developer Hub APIs.

The API has not changed. You do not need to make any updates to your application if you already use this API.