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

Obtener la política de reintentos de una cuenta de usuario

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

Devuelve la política de reintentos configurada en la cuenta del usuario autenticado.

Esta política se aplicará a toda validación que no contenga su propia retry_policy en el cuerpo, tanto en POST /v1/validate como en POST /v1/validate-ocr.

Una cuenta que nunca ha configurado la política de reintentos, recibe la forma desactivada: enabled=false, los contadores en 0 y outcomes vacío.

meta.caps contiene los límites efectivos del plan activo, con los valores globales para los campos sin sobreescritura. max_retries_cap=0 impide activar reintentos.

Petición
curl -X GET 'https://api.veriko.mx/v1/users/me/retry-policy' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200UserRetryPolicyResponse — Política de reintentos por defecto de la cuenta autenticada.
CampoTipoDescripción
dataobject

Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con type, id, attributes).

typestring

attributesobject

Política de reintentos guardada de la cuenta: activación, límite, intervalo y resultados elegibles. Desactivada o sin configurar, trae enabled=false, max_retries=0, interval_seconds=0 y outcomes vacío.

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: 0–?, 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"]
metaobject

Metadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC.

versionstring

Versión de la API que procesó la petición.

p. ej. 1.47.0
api_versionstring

Versión del prefijo de ruta de la API (ej. v1).

p. ej. v1
request_idstring

Identificador único de la petición (hex).

p. ej. a1b2c3d4e5f66f5e4d3c2b1a
datetimeobject

Descriptor compañero presente en el bloque meta de cada respuesta (y en el meta del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec.

p. ej. {"timezone":"UTC","format":"ISO 8601"}
timezone*string

Siempre UTC: La zona canónica para cada campo datetime del cuerpo.

p. ej. UTC
format*string

Siempre ISO 8601: Sufijo Z explícito en cada datetime.

p. ej. ISO 8601
linksobject

Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Códigos de respuestaGET /v1/users/me/retry-policy
CódigoClaseDescripciónCuerpo
2002xxPolítica de reintentos por defecto de la cuenta autenticada.UserRetryPolicyResponse
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
Errores de GET /v1/users/me/retry-policy
CódigoClaveEjemplo
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c