v1

latestOpenAPI 3.0.32026-07-1341895.4 KB
Check report results

Get report summary

After you submit a monthly report, HMRC processes the data and generates a results summary, which provides high-level information about the submission. You can access a results summary only after the reporting window closes. Use this endpoint to find out whether the results summary is available for a submitted report.

If the request is successful, the response includes:

  • a URL to retrieve the results summary
  • pagination details, including total records and total pages

If the results summary is not yet available or the report is not found, the API returns a 404 Not Found response.

get/monthly/{zReference}/{taxYear}/{month}/results/summary

Path parameters

zReferencestring required
Example:Z1234

A unique identifier assigned by HMRC to each approved ISA manager. Format: 'Zxxxx'.

taxYearstring string required
Example:2025-26

Tax year of the report.

month'JAN' | 'FEB' | 'MAR' | 'APR' | 'MAY' | 'JUN' | 'JUL' | 'AUG' | 'SEP' | 'OCT' | 'NOV' | 'DEC' required
Example:APR

Month of the report.

Headers

Accept'application/vnd.hmrc.1.0+json' required
Authorizationstring required

Bearer token for authentication.

Response

Results are now available for the specified monthly report.

returnResultsLocationstring uri

Use this URL to retrieve the results of the specified report.

totalRecordsinteger

Total number of records in the report results.

numberOfPagesinteger

Total number of pages in the result set.

Example response

{
  "returnResultsLocation": "https://test-api.service.hmrc.gov.uk/obligations/declaration/isa/return/monthly/Z1234/2025-26/APR/results?page=1",
  "totalRecords": 10000,
  "numberOfPages": 2
}