Get a complete Scrub Job result

GET

https://api.dnclatam.com

scrub

{job_id}

result

Get a complete Scrub Job result

curl --request GET \
  --url https://api.dnclatam.com/v2/scrub/{job_id}/result \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

{
  "prohibited_numbers_to_call": [
    "<string>"
  ],
  "safe_numbers_to_call": [
    "<string>"
  ],
  "invalid_numbers": [
    {
      "input": "<string>",
      "reason": "empty"
    }
  ],
  "summary": {
    "total_checked": 1,
    "prohibited_numbers": 1,
    "safe_numbers": 1,
    "invalid_numbers": 1
  },
  "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"
    }
  }
}

{
  "error": "invalid_key"
}

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

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

{
  "error": "job_result_not_ready",
  "message": "<string>",
  "status": "queued",
  "request_id": "<string>",
  "retry_after": 2
}

{
  "error": "job_result_expired",
  "message": "<string>",
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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": "platform_failure",
  "message": "<string>",
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

job_id

string<uuid>

required

Opaque lowercase UUID returned at admission. 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}$

Response

Scrub completed successfully

One complete result for the submitted Scrub Batch. No provider chunks or partial result are exposed.

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. safe is limited to this registry result; it does not confirm that a number is active or reachable, prove consent, or grant universal legal permission to call.

invalid_numbers

object[]

required

Inputs that failed structural validation or were explicitly rejected by the selected registry, 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. provider_rejected: the selected registry did not return an acceptable determination for this otherwise structurally valid input; it is not classified as safe.

Available options:

empty,

unparseable,

wrong_country,

too_short,

too_long,

provider_rejected

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

scrub_record

object

Phone-free Screening record for this successful Scrub. Delivered with the Scrub Result; v1 does not persist it.

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

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

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

Get a complete Scrub Job result

curl --request GET \
  --url https://api.dnclatam.com/v2/scrub/{job_id}/result \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

{
  "prohibited_numbers_to_call": [
    "<string>"
  ],
  "safe_numbers_to_call": [
    "<string>"
  ],
  "invalid_numbers": [
    {
      "input": "<string>",
      "reason": "empty"
    }
  ],
  "summary": {
    "total_checked": 1,
    "prohibited_numbers": 1,
    "safe_numbers": 1,
    "invalid_numbers": 1
  },
  "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"
    }
  }
}

{
  "error": "invalid_key"
}

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

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

{
  "error": "job_result_not_ready",
  "message": "<string>",
  "status": "queued",
  "request_id": "<string>",
  "retry_after": 2
}

{
  "error": "job_result_expired",
  "message": "<string>",
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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": "platform_failure",
  "message": "<string>",
  "request_id": "<string>"
}

Getting started

Core concepts

Reliability and privacy

Use with AI

API reference

Get a complete Scrub Job result

Authorizations

Path Parameters

Response