← Volver al índice de esquemas

ValidationQueued

Respuesta asíncrona de `POST /v1/validate?async=1` y `POST /v1/validate-ocr?async=1`. Contiene la validación encolada y los datos necesarios para consultar su resultado en `GET /v1/validations/{id}`.

Propiedades

CampoTipoDescripción
dataobjectEnvoltorio JSON:API del recurso encolado.
typestringTipo de recurso JSON:API. Siempre `validation`.
idstring (uuid)Identificador único de la validación creada (UUID v4), utilizable en `GET /v1/validations/{id}`.
attributesobjectDatos de la validación encolada.
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`. Enviarla 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; por ejemplo, `"2026-05-01T05:14:38Z"`. Los campos `*_at`, `*_end`, `*_start` y `*_date` adoptan esta forma. `meta.datetime` describe el mismo contrato en la respuesta.
expires_atstring (date-time)Timestamp ISO 8601 en UTC con sufijo `Z` explícito; por ejemplo, `"2026-05-01T05:14:38Z"`. Los campos `*_at`, `*_end`, `*_start` y `*_date` adoptan esta forma. `meta.datetime` describe el mismo contrato en la respuesta.
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`.
enabledboolean`true` cuando la validación tiene reintentos configurados, aunque su ciclo ya haya terminado (`terminal_state`).
max_retriesinteger | nullNúmero máximo de reintentos configurado; `null` cuando `enabled` es `false`.
interval_secondsinteger | nullIntervalo en segundos entre reintentos, de `300` a `86400`; `null` cuando `enabled` es `false`.
outcomesarray | nullResultados que originan un reintento: `not_found`, `cep_unavailable` y `error`; `null` cuando `enabled` es `false`.
attempts_completedintegerCantidad de reintentos completados hasta el momento.
next_attempt_atTimestampUTC | nullFecha del próximo reintento; `null` cuando no hay uno programado.
resolved_atTimestampUTC | nullFecha en que un reintento obtuvo `valid`; `null` mientras no ocurra.
exhausted_atTimestampUTC | nullFecha en que se agotaron los intentos; `null` mientras no ocurra.
cancelled_atTimestampUTC | nullFecha de cancelación del ciclo; `null` mientras no ocurra.
terminal_statestring | nullSituación del ciclo: `pending`, `resolved`, `exhausted` o `cancelled`. Es `null` cuando la validación no tiene un ciclo de reintentos.
client_refstringReferencia propia enviada en la petición (`client_ref`), devuelta tal cual. Solo aparece cuando la petición la incluyó.
metaobjectMetadatos de control del flujo de polling.
next_poll_after_secondsintegerSegundos recomendados de espera antes del primer poll a `GET /v1/validations/{id}`. Sondear antes de este intervalo puede activar el límite de solicitudes.
playgroundboolean`true` cuando la validación pertenece al banco de pruebas (Playground). Campo reservado para compatibilidad: las respuestas asíncronas actuales lo omiten, porque el banco de pruebas no encola validaciones.