POSThttps://api.veriko.mx/v1/validations/{id}/cancel-retries

Cancel pending retries

Audience: public
Auth: API key
Permission: validations:read

Cancels the active automatic retry cycle of a validation and returns terminal_state="cancelled".

If the cycle is no longer active, it responds with an HTTP status 422 (with retry_not_active in the body).

The optional Idempotency-Key header allows repeating the same request without duplicating the cancellation.

Parameters
Parameter	In	Type	Required	Description
`id`*	path	`string (uuid)`	required	Validation UUID.
`Idempotency-Key`	header	`string`	optional	Optional client-generated key (Stripe-style) that guarantees the request is processed exactly once within a 24-hour TTL. The scope is `(user_id, endpoint, key)`. Retries with the same key and the same body return the byte-for-byte cached response with the `Idempotent-Replayed: true` header, without consuming rate-limit quota, without re-firing webhooks, and without creating a new `validations` row. Same key with a different body → 422 `idempotency_key_reused`. Same key with an in-flight request → 409 `idempotency_key_in_progress`. 5xx responses are not cached (retries with the same key are processed for real). Format: 1–255 characters, alphanumeric + `_` + `-`. e.g. `11111111-2222-3333-4444-555555555555`

Request

cURLPython•JavaScript•PHP•

curl -X POST 'https://api.veriko.mx/v1/validations/{id}/cancel-retries' \
  -H 'Authorization: Bearer veriko_••••' \
  -H 'Content-Type: application/json'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

**Response 200**`CancelValidationRetriesAttributes` — Retry cycle cancelled. `retry_state.terminal_state` is now `cancelled`.
Field	Type	Description
`retry_state`	`object`	Full retry cycle state with configuration, progress, and current status.
`enabled`	`boolean`	`true` when the validation has retries configured, even if its cycle has already ended (`terminal_state`). e.g. `true`
`max_retries`	`integer \| null`nullable	Configured maximum number of retries; `null` when `enabled` is `false`. e.g. `3`
`interval_seconds`	`integer \| null`nullable	Interval between retries in seconds, from `300` to `86400`; `null` when `enabled` is `false`. e.g. `600`
`outcomes`	`array \| null`nullable	Outcomes that trigger a retry: `not_found`, `cep_unavailable`, and `error`; `null` when `enabled` is `false`. e.g. `["not_found","cep_unavailable","error"]`
`attempts_completed`	`integer`	Number of retries completed so far. e.g. `1`
`next_attempt_at`	`TimestampUTC \| null`	Date of the next retry; `null` when none is scheduled.
`resolved_at`	`TimestampUTC \| null`	Date when a retry produced `valid`; `null` until that occurs.
`exhausted_at`	`TimestampUTC \| null`	Date when attempts were exhausted; `null` until that occurs.
`cancelled_at`	`TimestampUTC \| null`	Cycle cancellation date; `null` until that occurs.
`terminal_state`	`string \| null`nullable	Cycle state: `pending`, `resolved`, `exhausted`, or `cancelled`. It is `null` when the validation has no retry cycle. e.g. `pending`

**Response status codes**`POST /v1/validations/{id}/cancel-retries`
Status	Class	Description	Body
200	`2xx`	Retry cycle cancelled. `retry_state.terminal_state` is now `cancelled`.	`CancelValidationRetriesAttributes`
401	`4xx`	Authentication is required or the provided credentials are invalid.	`ErrorResponse`
403	`4xx`	Insufficient permissions.	`ErrorResponse`
404	`4xx`	Validation not found or not owned by the account (`not_found`).	`ErrorResponse`
410	`4xx`	The validation was purged and this resource no longer exists (`validation_purged`).	`ErrorResponse`
422	`4xx`	No active retry cycle to cancel (code `retry_not_active`). Invalid UUID (`invalid_uuid`).	`ErrorResponse`

**Response headers**`200`
Header	Type	Description
`Idempotent-Replayed`	`string`	Only present when the request included `Idempotency-Key`. `true` marks a response reused from the idempotency cache, which remains valid for 24 hours per account, endpoint, and key.

**Errors from `POST /v1/validations/{id}/cancel-retries`**
Status	Code	Example
401	`unauthorized`	Invalid or missing authentication credentials. Envelope meta.request_id `c4d5e6f7a8b99b8a7f6e5d4c`
403	`permission_denied`	You do not have permission to access this resource. Envelope meta.request_id `d5e6f7a8b9c00c9b8a7f6e5d`
410	`validation_purged`	The validation was purged and this resource no longer exists. Envelope meta.request_id `1a2b3c4d5e6ff6e5d4c3b2a1`