Request cancellation of a Scrub Job

POST

https://api.dnclatam.com

scrub

{job_id}

cancel

Request cancellation of a Scrub Job

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

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

fetch('https://api.dnclatam.com/v2/scrub/{job_id}/cancel', 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",
  "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"
    }
  }
}

{
  "error": "invalid_key"
}

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

{
  "error": "method_not_allowed",
  "message": "<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

The job is already terminal or cancellation completed

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

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

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

Request cancellation of a Scrub Job

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

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

fetch('https://api.dnclatam.com/v2/scrub/{job_id}/cancel', 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",
  "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"
    }
  }
}

{
  "error": "invalid_key"
}

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

{
  "error": "method_not_allowed",
  "message": "<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

Request cancellation of a Scrub Job

Authorizations

Path Parameters

Response