https://api.veriko.mx/v1/validations/{id}/cancel-retriesCancelar reintentos pendientes
Guía de uso →Cancela el ciclo activo de reintentos automáticos de una validación y devuelve terminal_state="cancelled".
Si el ciclo ya no está activo, responde con un estado HTTP 422 (con retry_not_active en el cuerpo).
La cabecera opcional Idempotency-Key permite repetir la misma petición sin duplicar la cancelación.
| Parámetro | Ubicación | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
id* | path | string (uuid) | obligatorio | Identificador (UUID) de la validación |
Idempotency-Key | header | string | opcional | Llave opcional que garantiza que la petición se procese exactamente una vez dentro de un TTL de 24 horas. Los reintentos con la misma llave y el mismo cuerpo devuelven la respuesta cacheada con la cabecera 11111111-2222-3333-4444-555555555555 |
curl -X POST 'https://api.veriko.mx/v1/validations/{id}/cancel-retries' \
-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 |
|---|---|---|
retry_state | object | Estado completo del ciclo de reintentos, con configuración, avance y situación actual. |
enabled | boolean |
true |
max_retries | integer | nullanulable | Número máximo de reintentos configurado; 3 |
interval_seconds | integer | nullanulable | Intervalo en segundos entre reintentos, de 600 |
outcomes | array | nullanulable | Resultados que originan un reintento: ["not_found","cep_unavailable","error"] |
attempts_completed | integer | Cantidad de reintentos completados hasta el momento. p. ej.1 |
next_attempt_at | TimestampUTC | null | Fecha del próximo reintento; |
resolved_at | TimestampUTC | null | Fecha en que un reintento obtuvo |
exhausted_at | TimestampUTC | null | Fecha en que se agotaron los intentos; |
cancelled_at | TimestampUTC | null | Fecha de cancelación del ciclo; |
terminal_state | string | nullanulable | Situación del ciclo: pending |
| Código | Clase | Descripción | Cuerpo |
|---|---|---|---|
| 200 | 2xx | Ciclo de reintentos cancelado. retry_state.terminal_state queda cancelled. | CancelValidationRetriesAttributes |
| 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 |
| 410 | 4xx | La validación se purgó y este recurso ya no existe (validation_purged). | ErrorResponse |
| 422 | 4xx | No hay ciclo de reintentos activo que cancelar (código retry_not_active). UUID inválido (invalid_uuid). | ErrorResponse |
| Cabecera | Tipo | Descripción |
|---|---|---|
Idempotent-Replayed | string | Solo está presente cuando la petición incluyó Idempotency-Key. true indica que la respuesta se reutilizó desde el caché de idempotencia, cuya vigencia es de 24 horas por cuenta, endpoint y clave. |
| 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
|