---
title: "Produce a HMRC Self Assessment Assist Report"
method: POST
path: "/individuals/self-assessment/assist/reports/{nino}/{taxYear}/{calculationId}"
tags: ["Generate Report"]
---

# Produce a HMRC Self Assessment Assist Report

`POST /individuals/self-assessment/assist/reports/{nino}/{taxYear}/{calculationId}`

## Request

- Base URL: `https://test-api.service.hmrc.gov.uk`
- URL: `https://test-api.service.hmrc.gov.uk/individuals/self-assessment/assist/reports/{nino}/{taxYear}/{calculationId}`
- Auth: OAuth 2
  - Authorization code: `https://api.service.hmrc.gov.uk/oauth/authorize`
  - Token URL: `https://api.service.hmrc.gov.uk/oauth/token` scopes: `read:self-assessment-assist`

This endpoint allows a developer to request a HMRC Assist report to be generated for a customer or their agent.

<strong> A 200 OK response is returned when applicable messages are available, and a 204 No Content response is returned when there are no messages to report.</strong></p>

### Test data
In the sandbox environment, responses are simulated based on specific Calculation IDs included in the request. Each Calculation ID corresponds to a predefined test scenario that defines the response outcome.

| Calculation ID                                                                                                                                                                                                                                                                                                                   | Scenario                                                                                                      |
|------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
| Any valid Calculation ID except the two listed below | Simulates a scenario where a 200 OK success response is returned with a report containing assist messages.    |
| 620490b4-06e3-4fef-a555-6fd0877dc7ca                 | Simulates a scenario where there are no messages to report and a 204 No Content success response is returned. |
| 640490b4-06e3-4fef-a555-6fd0877dc7ca               | Simulates a scenario where the specified Calculation ID is not found.                                       |

## Path parameters

- `nino` string, required
- `taxYear` string, required
- `calculationId` string, required

## Headers

- `Accept` 'application/vnd.hmrc.1.0+json', required
- `Authorization` string, required

## Response `200`

Success - messages returned

- object: Produce a HMRC Self Assessment Assist Report
  - `reportId` string, required: The unique identifier for the report. Must conform to the regular expression: `^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$`
  - `messages` object[]: A list of HMRC Assist 'messages' for the customer.
    - `title` string, required: Title of message
    - `body` string, required: The body contains the message for the customer.
    - `action` string: The recommend action the customer should take.
    - `links` object[]: A list of help or support 'links' associated with the message body.
      - `title` string: The title text that appears before the links.
      - `url` string: The URL of support or help link.
    - `path` string, required: The HTTP path to guidance provided by HMRC.
  - `nino` string, required: National Insurance number, in the format `AA999999A`.
  - `taxYear` string, required: The tax year the data applies to, for example, 2025-26. The start year and end year must not span two tax years. No gaps are allowed, for example, 2025-27 is not valid.
  - `calculationId` string, required: The unique identifier for the calculation. Must conform to the regular expression: `^[0-9]{8}|[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
  - `correlationId` string, required: The correlation ID of the report.

## Other responses

- `204`: Success (No Content) - no messages returned
- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/hmrc/apis/self-assessment-assist.md) - [All operations](https://skmtc.dev/hmrc/apis/self-assessment-assist/llms.txt) - [OpenAPI document](https://skmtc.dev/hmrc/apis/self-assessment-assist/revisions/2fa70fa90454?raw)