Scrub a batch of phone numbers

POST

https://api.dnclatam.com

scrub

curl --request POST \
  --url https://api.dnclatam.com/v1/scrub \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "country": "mx",
  "phones": [
    "+52 55 1234 5678",
    "55 8765 4321",
    "abc"
  ]
}
'

import requests

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

payload = {
    "country": "mx",
    "phones": ["+52 55 1234 5678", "55 8765 4321", "abc"]
}
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: 'mx', phones: ['+52 55 1234 5678', '55 8765 4321', 'abc']})
};

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

{
  "prohibited_numbers_to_call": [
    "+52 55 1234 5678"
  ],
  "safe_numbers_to_call": [
    "55 8765 4321"
  ],
  "invalid_numbers": [
    {
      "input": "abc",
      "reason": "unparseable"
    }
  ],
  "summary": {
    "total_checked": 3,
    "prohibited_numbers": 1,
    "safe_numbers": 1,
    "invalid_numbers": 1
  }
}

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

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

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

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

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

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

{
  "error": "<string>",
  "message": "<string>",
  "retry_after": 450
}

{
  "error": "<string>",
  "message": "<string>",
  "retry_after": 123
}

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 random UUID and never include phone numbers or other PII. Exact retries are protected for at least 7 days; only a keyed, non-reversible fingerprint is retained.

Required string length: 1 - 255

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

Body

application/json

country

enum<string>

required

Registry country.

Available options:

mx,

ar

phones

string[]

required

Phone numbers in international or supported local formats.

Required array length: 1 - 500000 elements

Maximum string length: 64

Response

Scrub completed

prohibited_numbers_to_call

string[]

required

Original, structurally valid inputs found in the selected DNC registry. Do not call these numbers. Original formatting and relative order within this category are preserved; duplicates are returned once per occurrence.

safe_numbers_to_call

string[]

required

Original, structurally valid inputs not found in the selected DNC registry at the time of the check. Here, safe is limited to this DNC registry result; it does not confirm that a number is active or reachable, prove consent, or grant universal legal permission to call. Original formatting and relative order within this category are preserved; duplicates are returned once per occurrence.

invalid_numbers

object[]

required

Inputs that could not be normalized for the selected country, in their original relative order.

Hide child attributes

invalid_numbers.input

string

required

Original input exactly as submitted.

invalid_numbers.reason

enum<string>

required

empty: blank or separators only. unparseable: not recognizable as a phone number. wrong_country: explicit country code does not match the requested registry. too_short or too_long: normalized national number has the wrong number of digits.

Available options:

empty,

unparseable,

wrong_country,

too_short,

too_long

summary

object

required

Aggregate counts for this request. summary.total_checked equals summary.prohibited_numbers + summary.safe_numbers + summary.invalid_numbers.

Hide child attributes

summary.total_checked

integer

required

Total inputs submitted, including invalid inputs and duplicates.

Required range: x >= 0

summary.prohibited_numbers

integer

required

Number of entries returned in prohibited_numbers_to_call, including repeated inputs.

Required range: x >= 0

summary.safe_numbers

integer

required

Number of entries returned in safe_numbers_to_call, including repeated inputs.

Required range: x >= 0

summary.invalid_numbers

integer

required

Number of entries returned in invalid_numbers.

Required range: x >= 0

AI integration promptA copyable prompt that gives an AI the correct DNC LATAM API workflow and privacy constraints.

⌘I

Scrub a batch of phone numbers

curl --request POST \
  --url https://api.dnclatam.com/v1/scrub \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "country": "mx",
  "phones": [
    "+52 55 1234 5678",
    "55 8765 4321",
    "abc"
  ]
}
'

import requests

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

payload = {
    "country": "mx",
    "phones": ["+52 55 1234 5678", "55 8765 4321", "abc"]
}
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: 'mx', phones: ['+52 55 1234 5678', '55 8765 4321', 'abc']})
};

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

{
  "prohibited_numbers_to_call": [
    "+52 55 1234 5678"
  ],
  "safe_numbers_to_call": [
    "55 8765 4321"
  ],
  "invalid_numbers": [
    {
      "input": "abc",
      "reason": "unparseable"
    }
  ],
  "summary": {
    "total_checked": 3,
    "prohibited_numbers": 1,
    "safe_numbers": 1,
    "invalid_numbers": 1
  }
}

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

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

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

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

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

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

{
  "error": "<string>",
  "message": "<string>",
  "retry_after": 450
}

{
  "error": "<string>",
  "message": "<string>",
  "retry_after": 123
}

Getting started

Core concepts

Reliability and privacy

Use with AI

API reference

Scrub a batch of phone numbers

Authorizations

Headers

Body

Response