https://api.veriko.mx/v1/validations/{id}/purge/preparePreparar el borrado definitivo de una validación
Guía de uso →Describe lo que borraría el borrado definitivo de una validación propia y emite el token con el que POST /v1/validations/{id}/purge/execute lo confirma. No cambia nada: la validación y sus archivos quedan como estaban.
DELETE /v1/validations/{id} solo retira la validación del historial; el registro, el CEP, los datos extraídos y el archivo del comprobante siguen existiendo. El borrado definitivo, en dos pasos, los elimina.
La respuesta incluye:
confirmation_token: Token de un solo uso, atado a la cuenta y a esta validación, que caduca enexpires_insegundos.will_delete: Lo que se borrará: el archivo, el CEP, los campos con contenido y la cantidad de registros derivados.will_keep: Los campos que conserva la lápida en que queda la validación.cancels_pending_retries:truecuando hay un ciclo de reintentos abierto, que el borrado cancela.same_image_validation_ids: Otras validaciones de la cuenta con el mismo comprobante, que no se tocan.irreversible:truesiempre.
Solo se admite una validación propia en un estado terminal. Una validación en curso responde un estado HTTP 409 (con purge_validation_in_progress en el cuerpo), y una ya purgada, un estado HTTP 410 (con validation_purged en el cuerpo).
La lápida, lo que se borra y las limitaciones están en la retención de comprobantes y datos.
| Parámetro | Ubicación | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
id* | path | string (uuid) | obligatorio | Identificador (UUID) de la validación |
curl -X POST 'https://api.veriko.mx/v1/validations/{id}/purge/prepare' \
-H 'Authorization: Bearer veriko_••••' \
-H 'Content-Type: application/json'Ejemplo en Python — próximamente.
Ejemplo en JavaScript — próximamente.
Ejemplo en PHP — próximamente.
| Campo | Tipo | Descripción |
|---|---|---|
data* | object | Recurso JSON:API de la preparación. Su |
type* | string | Tipo del recurso, fijo para esta operación. Forma parte de su identidad en la envoltura JSON:API. Siempre validation_purge |
id* | string (uuid) | Identificador de la validación que se borraría. p. ej.3fa85f64-5717-4562-b3fc-2c963f66afa6 |
attributes* | object | Resumen del borrado y token de confirmación. |
confirmation_token* | string | Token de un solo uso, atado a la cuenta y a esta validación, que eyJhZG1pbl9pZCI6Ii4uLiJ9.q1w2e3r4t5y6u7i8o9p0 |
expires_in* | integer | Segundos de vigencia del token. p. ej.120 |
irreversible* | boolean |
true |
will_delete* | object | Lo que borraría el borrado definitivo. |
image* | boolean |
true |
cep* | boolean |
true |
stored_data* | array | Campos de la validación con contenido que se vaciarían. De ["request_data","ocr_result","normalized_data","banxico_result"] |
retry_attempts* | integer | Cantidad de intentos de reintento que se borrarían. p. ej.2 |
probe_attempts* | integer | Cantidad de sondeos de cuenta candidata que se borrarían. p. ej.0 |
webhook_deliveries* | integer | Cantidad de entregas de webhook de esta validación a las que se les quitaría el cuerpo enviado y la respuesta del receptor. El registro de cada entrega se conserva. p. ej.1 |
notifications* | integer | Cantidad de entregas de notificación de esta validación cuyo contenido se vaciaría. Las notificaciones de la bandeja de la cuenta se borrarían. p. ej.1 |
idempotency_responses* | integer | Cantidad de respuestas guardadas de 1 |
audit_traces* | boolean |
true |
will_keep* | array | Campos que conserva la lápida en que queda la validación: bastan para que la cuota, las estadísticas, finanzas y el historial sigan cuadrando. p. ej.["id","validation_type","status","banxico_status","amount","created_at","purged_at"] |
cancels_pending_retries* | boolean |
false |
refunds_quota* | boolean |
false |
same_image_validation_ids* | array | Identificadores de otras validaciones de la misma cuenta con el mismo comprobante (hasta 20). No se tocan: cada una guarda su propia copia de lo extraído y se borra por separado. p. ej.[] |
| Código | Clase | Descripción | Cuerpo |
|---|---|---|---|
| 200 | 2xx | Resumen de lo que se borraría y token de confirmación. La validación no cambió. | ValidationPurgePrepareResponse |
| 401 | 4xx | Se requiere autenticación o las credenciales son inválidas | ErrorResponse |
| 403 | 4xx | Permisos insuficientes | ErrorResponse |
| 404 | 4xx | Validación no encontrada, o ajena a la cuenta de usuario (not_found). | ErrorResponse |
| 409 | 4xx | La validación sigue en curso (queued o processing) y todavía no se puede purgar (purge_validation_in_progress, con el estado en meta.status). | ErrorResponse |
| 410 | 4xx | La validación se purgó y este recurso ya no existe (validation_purged). | ErrorResponse |
| 422 | 4xx | UUID inválido en la ruta (invalid_uuid). | ErrorResponse |
| 429 | 4xx | Límite de tasa excedido | ErrorResponse |
| Código | Clave | Ejemplo |
|---|---|---|
| 401 | unauthorized | Credenciales de autenticación ausentes o inválidas. Envelope
|
| 403 | permission_denied | No tienes permiso para acceder a este recurso. Envelope
|
| 410 | validation_purged | La validación se purgó y este recurso ya no existe. Envelope
|
| 429 | rate_limit_exceeded | Límite de peticiones excedido. Inténtalo de nuevo en 45 segundos. Envelope
Cabeceras de respuesta
|