← Back to schema index

RetryPolicy

Validation retry policy: activation, limit, interval, and eligible outcomes.

Properties

FieldTypeDescription
enabledboolean`true` when the retry cycle is active. With `false`, the other fields are ignored.
max_retriesintegerMaximum number of automatic retries. Once reached, the cycle enters the `exhausted` terminal state. The allowed limit depends on the plan.
interval_secondsintegerSeconds to wait between each retry (300–86400, i.e., 5 minutes to 24 hours).
outcomesarrayOutcomes that trigger a retry. By default, they are `not_found`, `cep_unavailable`, and `error`; the combination `["not_found", "cep_unavailable"]` excludes `error`.

Used in operations

  • POST /v1/validate
  • POST /v1/validate-ocr
  • PUT /v1/validations/{id}/retry-policy
  • PUT /v1/users/me/retry-policy

Referenced by schemas