← Back to schema index

RetryPolicy

Automatic retry policy. Configures when and how many times the system retries a validation that returned an eligible outcome (`not_found`, `cep_unavailable` or `error` by default).

Properties

Field Type Description
enabled boolean Enables or disables the retry cycle for this validation. If `false`, the other fields are ignored.
max_retries integer Maximum number of automatic retries. Once reached, the cycle enters the `exhausted` terminal state. The upper bound depends on the plan (`retry_max_retries`) or the global default `max_retries_cap` (typically 5–10).
interval_seconds integer Seconds to wait between each retry (300–86400, i.e., 5 minutes to 24 hours).
outcomes array Validation outcomes that trigger a retry. By default the cycle activates on `not_found`, `cep_unavailable` and `error`; clients that do not want to retry Banxico HTTP 5xx errors can send `["not_found", "cep_unavailable"]`.

Used in operations

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

Referenced by schemas