GEThttps://api.veriko.mx/v1/users/me/retry-policy

Get default retry policy

Audience
public
Auth
API key
Permission
users:read_self
How-to guide →

Returns the retry policy configured for the authenticated user. This policy is applied to all validations that do not specify a retry_policy in the body of POST /v1/validate(-ocr).

Request
curl -X GET 'https://api.veriko.mx/v1/users/me/retry-policy' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response 200RetryPolicy — User's default retry policy.
FieldTypeDescription
enabledboolean

Enables or disables the retry cycle for this validation. If false, the other fields are ignored.

e.g. true
max_retriesinteger

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).

e.g. 3
interval_secondsinteger

Seconds to wait between each retry (300–86400, i.e., 5 minutes to 24 hours).

e.g. 600
outcomesarray (items: 1–?, unique items)

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"].

e.g. ["not_found","cep_unavailable","error"]
Response status codesGET /v1/users/me/retry-policy
StatusClassDescriptionBody
2002xxUser's default retry policy.No body
4014xxAuthentication is required or the provided credentials are invalid.ErrorResponse
Errors from GET /v1/users/me/retry-policy
StatusCodeExample
401unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b9