Skip to main content
Every POST /v1/scrub and POST /v2/scrub request requires an Idempotency-Key header.
An idempotency key identifies one logical request for the authenticated API key.

​
Rules

  • Generate a random UUID or another opaque high-entropy value.
  • Use a new key for every new logical request.
  • Reuse the key only when retrying the exact same country and phones array.
  • Preserve the original array order and values on a retry.
  • Never derive the key from phone numbers, customer IDs, email addresses, or other PII.
  • Keep the value between 1 and 255 visible ASCII characters with no spaces.
Exact v1 retries are protected for at least seven days. DNC LATAM retains only a keyed, non-reversible fingerprint—not the raw idempotency key, request body, phone numbers, or response. For v2, an exact retry returns the already accepted job identity while its job metadata exists; it does not create a second job or reserve Customer Quota again.

​
Completed retry

When a v1 request completed successfully, an exact retry is recalculated in memory and returns:
The replay does not consume quota or write a second usage event. A v2 replay returns the original job_id and may include Idempotency-Replayed: true. The status is 202 while the job is still active and 200 after it has terminalized.

​
Concurrent retry

If the original v1 request is still running, the API returns HTTP 409:
Respect the Retry-After header and retry the same payload with the same idempotency key. For v2, polling the job status is the normal way to observe a running job; resubmitting the same key is safe but unnecessary.

​
Reused key with a different payload

If the same key is used with a different country or phone array, either API returns HTTP 409:
Do not retry this response. Generate a new idempotency key for the new logical request. Store the idempotency key beside your own internal job identifier and a non-sensitive status. Do not store the phone-number payload merely to support API retries if your own retention policy does not otherwise require it.