← Back to schema index

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

FieldTypeDescription
data*objectJSON:API resource of the preparation. Its `id` is the validation's.
type*stringResource 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*objectSummary of the deletion and the confirmation token.
confirmation_token*stringSingle-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*integerSeconds 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*objectWhat 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*arrayValidation fields with content that would be emptied. Of `normalized_data`, only the amount is kept.
retry_attempts*integerNumber of retry attempts that would be deleted.
probe_attempts*integerNumber of candidate-account probes that would be deleted.
webhook_deliveries*integerNumber of webhook deliveries of this validation whose sent body and receiver response would be removed. The record of each delivery is kept.
notifications*integerNumber of notification deliveries of this validation whose content would be emptied. The notifications in the account inbox would be deleted.
idempotency_responses*integerNumber 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*arrayFields 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*arrayIdentifiers 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