Sign in

v1

latestOpenAPI 3.0.32026-07-1341895.4 KB
Check report results

Get report reconciliation results

After the results summary is available, use this endpoint to retrieve the reconciliation results for the monthly report. The API returns reconciliation results in paginated batches. These show which records were accepted and which were rejected, including error messages where applicable.

Optionally, include a page query parameter to request a specific page of results.

If the request is successful, the response includes:

  • pagination information, including page number, total pages, and total records
  • the reconciliation results for the current page, including record-level identifiers and any reconciliation errors

If the reconciliation results are not yet available, or if the specified page or report is not found, the API returns a 404 Not Found response.

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

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.

Query parameters

pagenumber
Example:3

Page of records in the report to return. Defaults to 0.

Headers

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

Bearer token for authentication.

Response

Reconciliation results for the specified page of the monthly report.

currentPageinteger

The page number of the results.

recordsInPageinteger

The number of records in the current page.

totalRecordsinteger

Total number of records in the report results.

totalNumberOfPagesinteger

Total number of pages to return all results.

Example response

{
  "currentPage": 1,
  "recordsInPage": 8000,
  "totalRecords": 10000,
  "totalNumberOfPages": 2,
  "returnResults": [
    {
      "accountNumber": "12345678",
      "nino": "AB123456C",
      "issueIdentified": {
        "code": "OVER_SUBSCRIBED",
        "overSubscribedAmount": 1000
      }
    }
  ]
}