← Back to schema index

ValidationQueued

202 response for the asynchronous validation flow (`POST /v1/validate?async=1` and `POST /v1/validate-ocr?async=1`). Indicates the validation was queued; poll `GET /v1/validations/{id}` for the final result.

Properties

FieldTypeDescription
dataobjectJSON:API wrapper for the queued resource.
typestringJSON:API resource type (always `validation`).
idstring (uuid)UUID of the created validation, usable in `GET /v1/validations/{id}`.
attributesobjectFields of the queued resource.
validation_idstring (uuid)UUID of the validation (identical to `data.id`).
statusstringImmediate status after queuing (always `queued`).
etag_versionintegerInitial resource version for conditional polling with `If-None-Match`. Passing this as an ETag avoids unnecessary responses when the status has not changed.
enqueued_atstring (date-time)ISO 8601 timestamp in UTC with explicit `Z` suffix. Example: `"2026-05-01T05:14:38Z"`. Every datetime field uses this shape. The descriptor at `meta.datetime` makes the contract runtime-assertable.
expires_atstring (date-time)ISO 8601 timestamp in UTC with explicit `Z` suffix. Example: `"2026-05-01T05:14:38Z"`. Every datetime field uses this shape. The descriptor at `meta.datetime` makes the contract runtime-assertable.
retry_stateobjectAutomatic retry cycle state at queue time. Always present; if neither a body `retry_policy` nor a user default policy was provided, `enabled=false` and policy fields are `null`.
enabledbooleanWhether the retry cycle is active for this validation.
max_retriesinteger | nullConfigured maximum number of retries. The upper bound depends on the plan (`retry_max_retries`) or the global default `max_retries_cap` (typically 5–10). `null` if `enabled=false`.
interval_secondsinteger | nullInterval between retries in seconds (300–86400). `null` if `enabled=false`.
outcomesarray | nullValidation outcomes that trigger a retry (`not_found`, `cep_unavailable`, `error`). `null` if `enabled=false`.
attempts_completedintegerNumber of retries completed so far.
next_attempt_atTimestampUTC | nullTimestamp of the next scheduled retry. `null` if the cycle is in a terminal state or if no retries are active.
resolved_atTimestampUTC | nullTimestamp when a retry resolved the validation to `valid`. `null` if the cycle has not ended by resolution.
exhausted_atTimestampUTC | nullTimestamp when retries were exhausted without resolution. `null` if the cycle has not ended by exhaustion.
cancelled_atTimestampUTC | nullTimestamp when the cycle was explicitly cancelled. `null` if not cancelled.
terminal_statestring | nullTerminal state of the cycle: `pending` — active, no final result yet; `resolved` — a retry obtained `valid`; `exhausted` — all attempts used; `cancelled` — cancelled by the user. `null` if the validation has no retry cycle.
metaobjectControl metadata for the polling flow.
next_poll_after_secondsintegerRecommended seconds to wait before the first poll to `GET /v1/validations/{id}`. Clients should respect this value to avoid rate-limiting on the polling endpoint.
playgroundbooleanWhether the validation was queued in playground mode. The execution still queries Banxico like normal validations but does not consume quota, emit webhooks, or fire notifications.