v1

latestOpenAPI 3.0.32026-07-132546.7 KB
Endpoints

Acknowledge HMRC Assist for VAT feedback [test only]

Acknowledge an HMRC Assist for VAT report, and confirm that your software has presented the feedback messages verbatim to the user.

Test data

<p>Scenario simulations using Gov-Test-Scenario headers are only available in the sandbox environment.</p> <table> <thead> <tr> <th>Header Value (Gov-Test-Scenario)</th> <th>Scenario</th> </tr> </thead> <tbody> <tr> <td><p>Default (No header value)</p></td> <td><p>Acknowledgement received.</p></td> </tr> <tr> <td><p>INVALID_VRN</p></td> <td><p>Scenario where the VRN has not passed validation.</p></td> </tr> <tr> <td><p>INVALID_REPORTID</p></td> <td><p>Scenario where the reportId has not passed validation.</p></td> </tr> <tr> <td><p>INVALID_DATETIME</p></td> <td><p>Scenario where the presented DateTime has not passed validation.</p></td> </tr> <tr> <td><p>INVALID_CREDENTIALS</p></td> <td><p>Scenario where invalid authentication information is provided.</p></td> </tr> <tr> <td><p>NOT_AUTHORISED</p></td> <td><p>Scenario where the client or their agent is not authorised.</p></td> </tr> <tr> <td><p>CORRELATION_ID</p></td> <td><p>Scenario where the correlation ID does not match.</p></td> </tr> <tr> <td><p>NOT_FOUND</p></td> <td><p>Simulates the scenario where the report cannot be found.</p></td> </tr> </tbody> </table>
post/misc/transaction-risking/acknowledge/{vrn}/{reportId}/{correlationId}

Path parameters

vrnstring required
Example:123456789

VAT registration number. <br> A nine-digit number.

reportIdstring required
Example:f2fb30e5-4ab6-4a29-b3c1-c00000000001

The unique identifier for the report.

correlationIdstring required
Example:c75f40a6-a3df-4429-a697-471eeec46435

The correlation ID of the report.

Query parameters

presentedDateTimestring date-time required
Example:2026-06-09T10:30:00Z

The date and time that the feedback was presented verbatim to the user.

Headers

Gov-Test-Scenariostring
Example:-

Only in sandbox environment. See Test Data table for all header values.

Response

Acknowledgement recorded successfully. No content returned.