v1

latestOpenAPI 3.0.32026-07-138463.8 KB
Checkpoint for Vendor Data

Restore to Checkpoint

This endpoint enables you to reset the stateful data back to the checkpoint created in the sandbox environment.

A valid checkpoint ID must be provided.

When you restore the checkpoint, the modified date of the data will be updated to the restored date.

Note: To prevent data loss or unexpected behaviour, the checkpoint restore should not be performed while any other stateful or checkpoint operations are in progress for the same National Insurance number.

post/individuals/self-assessment-test-support/vendor-state/checkpoints/{checkpointId}/restore

Path parameters

checkpointIdstring required
Example:a1e8057e-fbbc-47a8-a8b4-78d9f015c253

The unique identifier of the checkpoint returned by the 'Create a checkpoint' endpoint. Format: ^[A-Za-z0-9-]{36}$

Headers

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

Specifies the response format and the version of the API to be used.

Authorizationstring required
Example:Bearer bb7fed3fe10dd235a2ccda3d50fb

An OAuth 2.0 Bearer Token with the write:self-assessment scope.

Response

Success