← Volver al índice de esquemas

ValidationQueued

Respuesta 202 del flujo de validación asíncrona (`POST /v1/validate?async=1` y `POST /v1/validate-ocr?async=1`). Indica que la validación fue encolada; consultar `GET /v1/validations/{id}` periódicamente para el resultado final.

Propiedades

CampoTipoDescripción
dataobjectEnvoltorio JSON:API del recurso encolado.
typestringTipo del recurso JSON:API (siempre `validation`).
idstring (uuid)UUID de la validación creada, usable en `GET /v1/validations/{id}`.
attributesobjectCampos del recurso encolado.
validation_idstring (uuid)UUID de la validación (idéntico a `data.id`).
statusstringEstado inmediato tras el encolamiento (siempre `queued`).
etag_versionintegerVersión inicial del recurso para polling condicional con `If-None-Match`. Devolver este valor como ETag evita respuestas innecesarias cuando el estado no ha cambiado.
enqueued_atstring (date-time)Timestamp ISO 8601 en UTC con sufijo `Z` explícito. Ejemplo: `"2026-05-01T05:14:38Z"`. Cada campo `*_at`, `*_end`, `*_start`, `*_date` de la API usa esta forma. El descriptor compañero en `meta.datetime` permite afirmar el contrato en tiempo de ejecución sin volver a leer este spec. El `new Date(value)` nativo del navegador, el `datetime.fromisoformat` (≥3.11) de Python y el `time.Parse(time.RFC3339)` de Go parsean este formato directamente.
expires_atstring (date-time)Timestamp ISO 8601 en UTC con sufijo `Z` explícito. Ejemplo: `"2026-05-01T05:14:38Z"`. Cada campo `*_at`, `*_end`, `*_start`, `*_date` de la API usa esta forma. El descriptor compañero en `meta.datetime` permite afirmar el contrato en tiempo de ejecución sin volver a leer este spec. El `new Date(value)` nativo del navegador, el `datetime.fromisoformat` (≥3.11) de Python y el `time.Parse(time.RFC3339)` de Go parsean este formato directamente.
retry_stateobjectEstado del ciclo de reintentos automáticos al momento del encolamiento. Siempre presente; si no se configuró `retry_policy` en el body ni en la política del usuario, `enabled=false` y los campos de política son `null`.
enabledbooleanIndica si el ciclo de reintentos está activo para esta validación.
max_retriesinteger | nullNúmero máximo de reintentos configurado. El tope superior depende del plan (`retry_max_retries`) o del default global `max_retries_cap` (típicamente 5–10). `null` si `enabled=false`.
interval_secondsinteger | nullIntervalo entre reintentos en segundos (300–86400). `null` si `enabled=false`.
outcomesarray | nullResultados de validación que habilitan un reintento (`not_found`, `cep_unavailable`, `error`). `null` si `enabled=false`.
attempts_completedintegerNúmero de reintentos completados hasta el momento.
next_attempt_atTimestampUTC | nullTimestamp del próximo reintento programado. `null` si el ciclo está en estado terminal o si no hay reintentos activos.
resolved_atTimestampUTC | nullTimestamp cuando un reintento resolvió la validación a `valid`. `null` si el ciclo no ha terminado por resolución.
exhausted_atTimestampUTC | nullTimestamp cuando se agotaron los reintentos sin resolución. `null` si el ciclo no ha terminado por agotamiento.
cancelled_atTimestampUTC | nullTimestamp cuando el ciclo fue cancelado explícitamente. `null` si no fue cancelado.
terminal_statestring | nullEstado terminal del ciclo: `pending` — activo, sin resultado final aún; `resolved` — un reintento obtuvo `valid`; `exhausted` — se agotaron los intentos; `cancelled` — cancelado por el usuario. `null` si la validación no tiene ciclo de reintentos.
metaobjectMetadatos de control del flujo de polling.
next_poll_after_secondsintegerSegundos recomendados de espera antes del primer poll a `GET /v1/validations/{id}`. El cliente debe respetar este valor para evitar rate-limit en el endpoint de polling.
playgroundbooleanIndica si la validación fue encolada en modo playground. La ejecución consulta Banxico igual que las validaciones normales pero no consume cuota, no emite webhooks ni notificaciones.