ValidationPurgePrepareResponse
Response of `POST /v1/validations/{id}/purge/prepare`: what the permanent deletion would delete, what it would keep, and the token that confirms it. Nothing has changed yet.
Properties
| Field | Type | Description |
|---|---|---|
data* | object | JSON:API resource of the preparation. Its `id` is the validation's. |
type* | string | Resource type, fixed for this operation. Part of its identity in the JSON:API envelope. Always `validation_purge`. |
id* | string (uuid) | Identifier of the validation that would be deleted. |
attributes* | object | Summary of the deletion and the confirmation token. |
confirmation_token* | string | Single-use token, bound to the account and to this validation, that `POST /v1/validations/{id}/purge/execute` requires in order to delete. It expires in `expires_in` seconds. |
expires_in* | integer | Seconds the token stays valid. |
irreversible* | boolean | `true` in every response: the deletion cannot be undone. An infrastructure backup does not reverse it for the client. |
will_delete* | object | What the permanent deletion would delete. |
image* | boolean | `true` when there is a receipt file (image or PDF) that would be deleted. |
cep* | boolean | `true` when there is a CEP (the XML or the PDF) that would be deleted. |
stored_data* | array | Validation fields with content that would be emptied. Of `normalized_data`, only the amount is kept. |
retry_attempts* | integer | Number of retry attempts that would be deleted. |
probe_attempts* | integer | Number of candidate-account probes that would be deleted. |
webhook_deliveries* | integer | Number of webhook deliveries of this validation whose sent body and receiver response would be removed. The record of each delivery is kept. |
notifications* | integer | Number of notification deliveries of this validation whose content would be emptied. The notifications in the account inbox would be deleted. |
idempotency_responses* | integer | Number of stored `Idempotency-Key` responses that would be deleted. |
audit_traces* | boolean | `true` in every response: the bodies of the audit rows that name the validation would be removed, and the free-form context of its security events would be reduced to ids and codes. |
will_keep* | array | Fields the tombstone the validation is left as keeps: enough for quota, statistics, finance, and history to keep adding up. |
cancels_pending_retries* | boolean | `true` when the validation has an open retry cycle, which the deletion cancels. |
refunds_quota* | boolean | `false` in every response: the deletion neither refunds quota nor changes what was charged. |
same_image_validation_ids* | array | Identifiers of other validations of the same account with the same receipt (up to 20). They are not touched: each keeps its own copy of what was extracted and is deleted separately. |
Used in operations
POST /v1/validations/{id}/purge/prepare