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

Get default retry policy

Audience: public
Auth: API key
Permission: users:read_self

Returns the authenticated user's default retry policy.

It is the one applied to every validation that does not carry its own retry_policy in the body, at POST /v1/validate as well as at POST /v1/validate-ocr.

An account that has never configured it receives the disabled shape: enabled=false, the counters at 0 and an empty outcomes.

meta.caps contains the effective limits of the active plan, with global values for fields without overrides. max_retries_cap=0 prevents enabling retries.

Request

cURLPython•JavaScript•PHP•

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 200**`UserRetryPolicyResponse` — Default retry policy of the authenticated account.
Field	Type	Description
`data`	`object`	Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`).
`type`	`string`
`attributes`	`object`	The account's saved retry policy: activation, limit, interval, and eligible outcomes. Disabled or not configured, it carries `enabled=false`, `max_retries=0`, `interval_seconds=0` and empty `outcomes`.
`enabled`	`boolean`	`true` when the retry cycle is active. With `false`, the other fields are ignored. e.g. `true`
`max_retries`	`integer`	Maximum number of automatic retries. Once reached, the cycle enters the `exhausted` terminal state. The allowed limit depends on the plan. e.g. `3`
`interval_seconds`	`integer`	Seconds to wait between each retry (300–86400, i.e., 5 minutes to 24 hours). e.g. `600`
`outcomes`	`array` (items: 0–?, unique items)	Outcomes that trigger a retry. By default, they are `not_found`, `cep_unavailable`, and `error`; the combination `["not_found", "cep_unavailable"]` excludes `error`. e.g. `["not_found","cep_unavailable","error"]`
`meta`	`object`	Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.
`version`	`string`	API version that processed the request. e.g. `1.47.0`
`api_version`	`string`	API route prefix version (e.g. `v1`). e.g. `v1`
`request_id`	`string`	Unique request identifier (hex). e.g. `a1b2c3d4e5f66f5e4d3c2b1a`
`datetime`	`object`	Companion descriptor present in the `meta` block of every response (and in the `meta` of outgoing webhook bodies). Lets clients assert the timezone contract without re-reading the spec. e.g. `{"timezone":"UTC","format":"ISO 8601"}`
`timezone`*	`string`	Always `UTC`: The canonical timezone for every datetime field in the body. e.g. `UTC`
`format`*	`string`	Always `ISO 8601`: Explicit `Z` suffix on every datetime. e.g. `ISO 8601`
`links`	`object`	Pagination or related links, present only when the endpoint returns a paginated collection.

**Response status codes**`GET /v1/users/me/retry-policy`
Status	Class	Description	Body
200	`2xx`	Default retry policy of the authenticated account.	`UserRetryPolicyResponse`
401	`4xx`	Authentication is required or the provided credentials are invalid.	`ErrorResponse`

**Errors from `GET /v1/users/me/retry-policy`**
Status	Code	Example
401	`unauthorized`	Invalid or missing authentication credentials. Envelope meta.request_id `c4d5e6f7a8b99b8a7f6e5d4c`