v1

latestOpenAPI 3.0.32026-07-138463.8 KB

Checkpoint for Vendor Data

Delete a Checkpoint

This endpoint enables you to delete a checkpoint created in the sandbox, specified with a ‘checkpointId’.

Any checkpoint that is not deleted is automatically removed from the database 7 days after its creation.

Checkpoints can only be deleted with this endpoint. Deleting data with the Delete Stateful Test Data endpoint will not delete checkpoints.

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

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

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