PUThttps://api.veriko.mx/v1/users/me/retry-policy

Establecer la política de reintentos en una cuenta de usuario

Audiencia
public
Autenticación
API key
Permiso
users:update_self
Guía de uso →

Fija la política de reintentos que se aplicará a la cuenta del usuario autenticado.

Desde que la política se guarda, se aplica a toda validación futura que no contenga la suya propia en el cuerpo.

La comprobación es estricta: un valor por encima de un tope se rechaza, no se recorta en silencio, y cualquier desvío responde con un estado HTTP 422 (con retry_policy_invalid en el cuerpo).

Con enabled=false, los demás campos se ignoran y la política queda guardada como desactivada.

Acepta Idempotency-Keyopcional, que evita guardar dos veces lo mismo cuando la red obliga a reintentar.

Parámetros
ParámetroUbicaciónTipoObligatorioDescripción
Idempotency-Keyheaderstringopcional

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 Idempotent-Replayed: true (sin re-disparar webhooks) y sin crear una nueva validación.

p. ej. 11111111-2222-3333-4444-555555555555
Parámetros
ParámetroTipoObligatorioDescripción
retry_policyobjectobligatorio

Política de reintentos de una validación: activación, límite, intervalo y resultados elegibles.

enabledbooleanopcional

true cuando el ciclo de reintentos está activo. Si es false, los demás campos pueden ser ignorados.

p. ej. true
max_retriesinteger (≥ 1)opcional

Número máximo de reintentos automáticos. Una vez alcanzado, el ciclo pasa al estado terminal exhausted.

p. ej. 3
interval_secondsinteger (≥ 300, ≤ 86400)opcional

Segundos de espera entre cada reintento. Valores válidos: 300–86400 (5 min a 24h).

p. ej. 600
outcomesarray<string> (elementos: 1–?, elementos únicos)opcional

Resultados que originan un reintento. De forma predeterminada son not_found, cep_unavailable y error; la combinación ["not_found", "cep_unavailable"] excluye error.

p. ej. ["not_found","cep_unavailable","error"]
Petición
curl -X PUT 'https://api.veriko.mx/v1/users/me/retry-policy' \
  -H 'Authorization: Bearer veriko_••••' \
  -H 'Content-Type: application/json' \
  -d '{
    "retry_policy": {
      "enabled": false
    }
  }'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200RetryPolicy — Política de reintentos actualizada (eco del body normalizado).
CampoTipoDescripción
enabledboolean

true cuando el ciclo de reintentos está activo. Si es false, los demás campos pueden ser ignorados.

p. ej. true
max_retriesinteger

Número máximo de reintentos automáticos. Una vez alcanzado, el ciclo pasa al estado terminal exhausted.

p. ej. 3
interval_secondsinteger

Segundos de espera entre cada reintento. Valores válidos: 300–86400 (5 min a 24h).

p. ej. 600
outcomesarray (elementos: 1–?, elementos únicos)

Resultados que originan un reintento. De forma predeterminada son not_found, cep_unavailable y error; la combinación ["not_found", "cep_unavailable"] excluye error.

p. ej. ["not_found","cep_unavailable","error"]
Códigos de respuestaPUT /v1/users/me/retry-policy
CódigoClaseDescripciónCuerpo
2002xxPolítica de reintentos actualizada (eco del body normalizado).RetryPolicy
4004xxEl cuerpo de la petición está vacío o no es JSON válido.ErrorResponse
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4134xxEl cuerpo de la petición supera el tamaño máximo admitido (body_too_large).ErrorResponse
4224xxLa política de reintentos es inválida (retry_policy_invalid). Causas: campo enabled falta o no es booleano; max_retries fuera de [1, max_retries_cap]; interval_seconds fuera de [min_interval_seconds, max_interval_seconds]; outcomes vacío cuando enabled=true; outcome fuera del allowlist (eligible_outcomes de la configuración global de reintentos).ErrorResponse
Cabeceras de respuesta200
CabeceraTipoDescripción
Idempotent-ReplayedstringSolo presente cuando el cliente envió Idempotency-Key. true cuando la respuesta es replay del caché de idempotencia (TTL 24h por usuario+endpoint+key).
Errores de PUT /v1/users/me/retry-policy
CódigoClaveEjemplo
400body_empty

El cuerpo de la petición está vacío.

Envelope
meta.request_id
b0c1d2e3f4a5b0c1d2e3f4a5
400invalid_json

El cuerpo no es JSON válido.

Envelope
meta.request_id
c1d2e3f4a5b6c1d2e3f4a5b6
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c
413body_too_large

El cuerpo de la petición es demasiado grande.

Envelope
meta.request_id
1a2b3c4d5e6ff6e5d4c3b2a1

Política de reintentos

PUT /v1/users/me/retry-policy

Política de reintentos de una validación: activación, límite, intervalo y resultados elegibles.

Intentos
—
Intervalo
5 min – 1 h × 24
Resultados elegibles
not_found, cep_unavailable, error

Esta operación admite una política de reintentos opcional.