Skip to Content
Jobs APIOverview & Features

Overview & Features

Introduction

The Jobs API enables high-volume, asynchronous bulk sanctions screening. Rather than waiting for results synchronously, you submit a job and poll for its status — making it well-suited for large datasets that would exceed the limits of the Sanctions Screening API.

Submit up to 100,000 cases per job. The API accepts the job immediately and processes it in the background. When complete, results are made available via a secure, time-limited download link.

Technical Notes

The Jobs API is a JSON-based web service that accepts HTTPS requests. Each request must contain:

  1. Authentication in the form of an apiKey header or parameter.
  2. The list of cases to screen (people, entities, vessels, aircraft, etc.).
  3. Optionally: which Data Sources to screen against, a webhook URL, and a job name.

How It Works

The Jobs API follows an asynchronous submit-and-poll pattern:

  1. Submit — Send a POST /v4/jobs request with your cases. The API returns a 202 Accepted response immediately with a job id.
  2. Poll — Send GET /v4/jobs/{id} requests to check job status and progress.
  3. Download — Once status is COMPLETED, a reportUrl is included in the response. Download the results from this URL within 24 hours.

Alternatively, provide a webhookUrl when submitting and the API will notify you when the job completes — no polling required.

Webhooks

The Jobs API provides webhook functionality to enable job lifecycle alerts. Provide a destination endpoint via webhookUrl when submitting a job to receive an HTTPS notification when the job finishes — eliminating the need to poll. The Jobs API publishes a JOB_COMPLETED or JOB_FAILED event with the job ID and other information. Use the job ID to retrieve the full results via GET /v4/jobs/{id}.

The webhookUrl must use https://. Failed deliveries are retried automatically, and delivery status is tracked on the job object via the webhookStatus field (PENDING, DELIVERED, FAILED, or BLOCKED).

For full payload details and webhook status values, see the API Response page.

Data Sources

The Jobs API screens against the same global sanctions and compliance datasets as the Sanctions Screening API, including government sanction and embargo listings, political publications, eligibility databases, and more.

For a full listing of available data sources and their ID codes, see the Data Sources page.

Search Logic

The Jobs API uses the same fuzzy matching logic as the Sanctions Screening API. Matching logic was designed in coordination with the US Treasury Department, based on Treasury guidelines. More on Treasury guidelines here .

A match is returned when a case exceeds the minimum similarity score threshold. Only matches are included in the job report — cases with no hits are omitted from results.

Search Matching Customization Please contact us if you would like to know more about search logic and advanced settings.

Last updated on