← Back to schema index

ValidationQueued

Asynchronous response from `POST /v1/validate?async=1` and `POST /v1/validate-ocr?async=1`. Contains the queued validation and the data needed to retrieve its result from `GET /v1/validations/{id}`.

Properties

FieldTypeDescription
dataobjectJSON:API wrapper for the queued resource.
typestringJSON:API resource type. Always `validation`.
idstring (uuid)Unique identifier of the created validation (UUID v4), 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`. Sending it as an ETag avoids unnecessary responses when the status has not changed.
enqueued_atstring (date-time)ISO 8601 timestamp in UTC with an explicit `Z` suffix; for example, `"2026-05-01T05:14:38Z"`. The `*_at`, `*_end`, `*_start`, and `*_date` fields follow this format. `meta.datetime` describes the same contract in the response.
expires_atstring (date-time)ISO 8601 timestamp in UTC with an explicit `Z` suffix; for example, `"2026-05-01T05:14:38Z"`. The `*_at`, `*_end`, `*_start`, and `*_date` fields follow this format. `meta.datetime` describes the same contract in the response.
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`.
enabledboolean`true` when the validation has retries configured, even if its cycle has already ended (`terminal_state`).
max_retriesinteger | nullConfigured maximum number of retries; `null` when `enabled` is `false`.
interval_secondsinteger | nullInterval between retries in seconds, from `300` to `86400`; `null` when `enabled` is `false`.
outcomesarray | nullOutcomes that trigger a retry: `not_found`, `cep_unavailable`, and `error`; `null` when `enabled` is `false`.
attempts_completedintegerNumber of retries completed so far.
next_attempt_atTimestampUTC | nullDate of the next retry; `null` when none is scheduled.
resolved_atTimestampUTC | nullDate when a retry produced `valid`; `null` until that occurs.
exhausted_atTimestampUTC | nullDate when attempts were exhausted; `null` until that occurs.
cancelled_atTimestampUTC | nullCycle cancellation date; `null` until that occurs.
terminal_statestring | nullCycle state: `pending`, `resolved`, `exhausted`, or `cancelled`. It is `null` when the validation has no retry cycle.
client_refstringReference of your own sent in the request (`client_ref`), returned as sent. It only appears when the request included it.
metaobjectControl metadata for the polling flow.
next_poll_after_secondsintegerRecommended seconds to wait before the first poll to `GET /v1/validations/{id}`. Polling before this interval can trigger the request limit.
playgroundboolean`true` when the validation belongs to the playground. Field reserved for compatibility: current asynchronous responses omit it, because the playground does not queue validations.