API reference

Admit a durable Scrub Job

Accepts a phone-number array up to a hard 500,000-entry ceiling and returns within a 5-second admission budget with a durable job resource. The raw HTTP body, canonical durable input, and conservative complete-result estimate each have a 25 MiB guard; the first reached limit controls admission. The admission budget covers authentication, validation, entitlement, quota reservation, and enqueueing; it does not include job execution. The job is processed internally in bounded units and succeeds or fails as one complete batch. Admission still requires Country Purchase, availability/activation, quota, and operational availability. CSV is not accepted by the corporate API.

POST

https://api.dnclatam.com

scrub

curl --request POST \
  --url https://api.dnclatam.com/v2/scrub \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "country": "sg",
  "phones": [
    "+65 6123 4567",
    "+65 6123 4568"
  ]
}
'

import requests

url = "https://api.dnclatam.com/v2/scrub"

payload = {
    "country": "sg",
    "phones": ["+65 6123 4567", "+65 6123 4568"]
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({country: 'sg', phones: ['+65 6123 4567', '+65 6123 4568']})
};

fetch('https://api.dnclatam.com/v2/scrub', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "queued",
  "country": "mx",
  "submitted_count": 2,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "status_url": "<string>",
  "result_url": "<string>",
  "error": {
    "error": "country_service_maintenance",
    "message": "<string>",
    "country": "mx",
    "retry_after": 2,
    "request_id": "<string>"
  },
  "scrub_record": {
    "record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "record_version": "1",
    "surface": "api_v1",
    "organization": {
      "name": "<string>"
    },
    "country": "mx",
    "registry": {
      "authority": "<string>",
      "mode": "snapshot",
      "source_observed_at": "2023-11-07T05:31:56Z",
      "consulted_at": "2023-11-07T05:31:56Z"
    },
    "status": "succeeded",
    "counts": {
      "submitted": 2,
      "prohibited": 1,
      "safe": 1,
      "invalid": 1
    },
    "submitted_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "record_issued_at": "2023-11-07T05:31:56Z",
    "request_id": "<string>",
    "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "client_scrub_reference": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "failure": {
      "error": "<string>",
      "country": "mx"
    }
  }
}

{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "queued",
  "country": "mx",
  "submitted_count": 2,
  "created_at": "2023-11-07T05:31:56Z",
  "status_url": "<string>",
  "result_url": "<string>",
  "cancel_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}

{
  "error": "missing_idempotency_key",
  "message": "<string>",
  "max": 2,
  "max_chars": 2
}

{
  "error": "invalid_key"
}

{
  "error": "subscription_inactive",
  "message": "<string>",
  "request_id": "<string>"
}

{
  "error": "account_suspended",
  "message": "<string>",
  "request_id": "<string>"
}

{
  "error": "method_not_allowed",
  "message": "<string>"
}

{
  "error": "idempotency_request_in_progress",
  "message": "<string>",
  "request_id": "<string>"
}

{
  "error": "payload_too_large",
  "max_bytes": 26214400,
  "message": "<string>",
  "request_id": "<string>"
}

{
  "error": "rate_limit_exceeded",
  "message": "<string>",
  "limit": 30000,
  "window_seconds": 60,
  "retry_after": 2,
  "request_id": "<string>"
}

{
  "error": "internal",
  "request_id": "<string>",
  "message": "<string>"
}

{
  "error": "country_service_maintenance",
  "message": "<string>",
  "country": "mx",
  "request_id": "<string>",
  "retry_after": 2
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

required

Opaque key for one logical request, scoped to the authenticated API key. Use a high-entropy value and never include phone numbers or other PII. Exact retries are protected for at least 7 days for v1; v2 keeps the accepted job identity for the job metadata lifetime.

Required string length: 1 - 255

Pattern: ^[\x21-\x7e]+$

Body

application/json

The public API accepts arrays only. Admission has a hard 500,000-entry ceiling and three independent 25 MiB byte guards: raw HTTP body, canonical durable input, and conservative complete-result estimate. The first reached limit controls admission. CSV uploads are available only through the authenticated panel and are not accepted here.

country

enum<string>

required

Technical country code. The current sellable catalog is mx/ar/co. es/au/sg are planned product coverage, end of September 2026, and are not sellable at checkout until their catalog and runtime are released together. Every real request requires a matching Country Purchase and country availability/activation. Colombia is sellable and operational, and a successful initial payment activates its complete API access immediately without manual approval; entitlement and operational availability are still evaluated at admission.

Available options:

mx,

ar,

co,

es,

au,

sg

phones

string[]

required

Phone numbers in international or supported local formats. Durable jobs accept up to 500,000 entries, but admission may reject earlier when the raw HTTP body, canonical durable input, or conservative complete-result estimate exceeds 25 MiB. Invalid and duplicate entries count toward Customer Quota.

Required array length: 1 - 500000 elements

Maximum string length: 64

Response

Terminal idempotent replay of an already succeeded, failed, cancelled, or expired job

Public job state. Provider names, retries, chunks, cost, balance, credentials, and raw provider errors are never included.

job_id

string<uuid>

required

Opaque lowercase UUIDv4 generated by DNC LATAM. It carries no country, tenant, provider, or execution meaning; tenant identity remains internal and is never returned.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

status

enum<string>

required

Available options:

queued,

running,

succeeded,

failed,

cancelled,

expired

country

enum<string>

required

Available options:

mx,

ar,

co,

es,

au,

sg

submitted_count

integer

required

Required range: x >= 1

created_at

string<date-time>

required

updated_at

string<date-time>

required

expires_at

string<date-time>

required

State-dependent expiration: queued/running = admission plus the 24-hour active job/input hard cap; succeeded = successful terminalization plus the seven-day result TTL; failed/cancelled/expired = terminalization plus the 30-day metadata TTL. Attached input is eligible for purge at terminalization; an unconfirmed or unknown upload is revalidated at the 24-hour hard cap. This field does not signal input availability.

status_url

string<uri>

required

result_url

string<uri>

Available as a link when a result can still be retrieved.

error

object

Required when status is failed (or expired) and contains the closed public JobError mapping. Cancelled jobs never include this field: cancellation is not an error.

Hide child attributes

error.error

enum<string>

required

Available options:

country_service_maintenance,

country_service_temporarily_unavailable,

platform_failure,

job_expired

error.message

string

required

error.country

enum<string>

Available options:

mx,

ar,

co,

es,

au,

sg

error.retry_after

integer

Required range: x >= 1

error.request_id

string

scrub_record

object

Phone-free Screening record once the job is terminal and within the metadata TTL. Cancelled records omit failure. Owning organization only.

Hide child attributes

scrub_record.record_id

string<uuid>

required

Opaque lowercase UUIDv4 generated by DNC LATAM. It carries no country, tenant, provider, or execution meaning; tenant identity remains internal and is never returned.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

scrub_record.record_version

string

required

Allowed value: "1"

scrub_record.surface

enum<string>

required

Available options:

api_v1,

api_v2,

panel_csv

scrub_record.organization

object

required

Hide child attributes

scrub_record.organization.name

string

required

Required string length: 1 - 200

scrub_record.country

enum<string>

required

Available options:

mx,

ar,

co,

es,

au,

sg

scrub_record.registry

object

required

Hide child attributes

scrub_record.registry.authority

string

required

scrub_record.registry.mode

enum<string>

required

Available options:

snapshot,

live_consult

scrub_record.registry.source_observed_at

string<date-time>

scrub_record.registry.consulted_at

string<date-time>

scrub_record.status

enum<string>

required

Available options:

succeeded,

failed,

cancelled,

expired

scrub_record.counts

object

required

Hide child attributes

scrub_record.counts.submitted

integer

required

Required range: x >= 1

scrub_record.counts.prohibited

integer

required

Required range: x >= 0

scrub_record.counts.safe

integer

required

Required range: x >= 0

scrub_record.counts.invalid

integer

required

Required range: x >= 0

scrub_record.submitted_at

string<date-time>

required

scrub_record.completed_at

string<date-time>

required

scrub_record.record_issued_at

string<date-time>

required

scrub_record.request_id

string

Present only for api_v1.

scrub_record.job_id

string<uuid>

Present only for api_v2.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

scrub_record.client_scrub_reference

string<uuid>

Optional UUIDv4 Client Scrub Reference on the record when supplied. Not an idempotency key. Request-body acceptance is not published in this contract version.

scrub_record.failure

object

Hide child attributes

scrub_record.failure.error

string

required

scrub_record.failure.country

enum<string>

required

Available options:

mx,

ar,

co,

es,

au,

sg

Admit a durable Scrub Job

curl --request POST \
  --url https://api.dnclatam.com/v2/scrub \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "country": "sg",
  "phones": [
    "+65 6123 4567",
    "+65 6123 4568"
  ]
}
'

import requests

url = "https://api.dnclatam.com/v2/scrub"

payload = {
    "country": "sg",
    "phones": ["+65 6123 4567", "+65 6123 4568"]
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({country: 'sg', phones: ['+65 6123 4567', '+65 6123 4568']})
};

fetch('https://api.dnclatam.com/v2/scrub', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "queued",
  "country": "mx",
  "submitted_count": 2,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "status_url": "<string>",
  "result_url": "<string>",
  "error": {
    "error": "country_service_maintenance",
    "message": "<string>",
    "country": "mx",
    "retry_after": 2,
    "request_id": "<string>"
  },
  "scrub_record": {
    "record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "record_version": "1",
    "surface": "api_v1",
    "organization": {
      "name": "<string>"
    },
    "country": "mx",
    "registry": {
      "authority": "<string>",
      "mode": "snapshot",
      "source_observed_at": "2023-11-07T05:31:56Z",
      "consulted_at": "2023-11-07T05:31:56Z"
    },
    "status": "succeeded",
    "counts": {
      "submitted": 2,
      "prohibited": 1,
      "safe": 1,
      "invalid": 1
    },
    "submitted_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "record_issued_at": "2023-11-07T05:31:56Z",
    "request_id": "<string>",
    "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "client_scrub_reference": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "failure": {
      "error": "<string>",
      "country": "mx"
    }
  }
}

{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "queued",
  "country": "mx",
  "submitted_count": 2,
  "created_at": "2023-11-07T05:31:56Z",
  "status_url": "<string>",
  "result_url": "<string>",
  "cancel_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}

{
  "error": "missing_idempotency_key",
  "message": "<string>",
  "max": 2,
  "max_chars": 2
}

{
  "error": "invalid_key"
}

{
  "error": "subscription_inactive",
  "message": "<string>",
  "request_id": "<string>"
}

{
  "error": "account_suspended",
  "message": "<string>",
  "request_id": "<string>"
}

{
  "error": "method_not_allowed",
  "message": "<string>"
}

{
  "error": "idempotency_request_in_progress",
  "message": "<string>",
  "request_id": "<string>"
}

{
  "error": "payload_too_large",
  "max_bytes": 26214400,
  "message": "<string>",
  "request_id": "<string>"
}

{
  "error": "rate_limit_exceeded",
  "message": "<string>",
  "limit": 30000,
  "window_seconds": 60,
  "retry_after": 2,
  "request_id": "<string>"
}

{
  "error": "internal",
  "request_id": "<string>",
  "message": "<string>"
}

{
  "error": "country_service_maintenance",
  "message": "<string>",
  "country": "mx",
  "request_id": "<string>",
  "retry_after": 2
}

Getting started

Core concepts

Reliability and privacy

Use with AI

API reference

Admit a durable Scrub Job

Authorizations

Headers

Body

Response