Get Async Job
curl --request GET \
--url https://api.deepidv.com/v1/async-jobs/{jobId}import requests
url = "https://api.deepidv.com/v1/async-jobs/{jobId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.deepidv.com/v1/async-jobs/{jobId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.deepidv.com/v1/async-jobs/{jobId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.deepidv.com/v1/async-jobs/{jobId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.deepidv.com/v1/async-jobs/{jobId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.deepidv.com/v1/async-jobs/{jobId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "ready",
"createdAt": 1717593600000,
"updatedAt": "2026-06-05T12:00:00.000Z",
"result": {
"totalHits": 2,
"riskLevel": "MEDIUM",
"riskScore": 45,
"summary": "Two adverse-media findings corroborated by court records.",
"findings": [],
"exposuresByCategory": {}
}
}
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "processing",
"createdAt": 1717593600000,
"updatedAt": "2026-06-05T12:00:01.000Z"
}
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "failed",
"createdAt": 1717593600000,
"updatedAt": "2026-06-05T12:00:30.000Z",
"error": "Upstream provider timed out"
}
Async Jobs
Get Async Job
Poll the status and result of a long-running async job
GET
/
v1
/
async-jobs
/
{jobId}
Get Async Job
curl --request GET \
--url https://api.deepidv.com/v1/async-jobs/{jobId}import requests
url = "https://api.deepidv.com/v1/async-jobs/{jobId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.deepidv.com/v1/async-jobs/{jobId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.deepidv.com/v1/async-jobs/{jobId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.deepidv.com/v1/async-jobs/{jobId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.deepidv.com/v1/async-jobs/{jobId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.deepidv.com/v1/async-jobs/{jobId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "ready",
"createdAt": 1717593600000,
"updatedAt": "2026-06-05T12:00:00.000Z",
"result": {
"totalHits": 2,
"riskLevel": "MEDIUM",
"riskScore": 45,
"summary": "Two adverse-media findings corroborated by court records.",
"findings": [],
"exposuresByCategory": {}
}
}
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "processing",
"createdAt": 1717593600000,
"updatedAt": "2026-06-05T12:00:01.000Z"
}
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "failed",
"createdAt": 1717593600000,
"updatedAt": "2026-06-05T12:00:30.000Z",
"error": "Upstream provider timed out"
}
GET /v1/async-jobs/{jobId}
jobId immediately; poll this endpoint until the job reaches a terminal state (ready or failed). The result shape depends on which endpoint created the job.
Job lifecycle
A job moves through these states:status | Terminal | Payload | Meaning |
|---|---|---|---|
pending | No | β | Queued, not yet picked up |
processing | No | β | Actively running |
ready | Yes | result | Completed successfully β result is available |
failed | Yes | error | Failed β error describes what went wrong |
Poll on a backoff interval (e.g. every 2β5 seconds) until
status is ready
or failed. Jobs are retained temporarily and then expire via a TTL, after
which the job ID returns 404 β fetch the result promptly once itβs ready.Request
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
jobId | string | Yes | The job ID returned by the creating endpoint |
Headers
| Header | Required | Description |
|---|---|---|
x-api-key | Yes | Your API key |
Example request
curl https://api.deepidv.com/v1/async-jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
-H "x-api-key: YOUR_API_KEY"
const response = await fetch(
"https://api.deepidv.com/v1/async-jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
{
headers: { "x-api-key": "YOUR_API_KEY" },
},
);
const job = await response.json();
import requests
response = requests.get(
"https://api.deepidv.com/v1/async-jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
headers={"x-api-key": "YOUR_API_KEY"},
)
job = response.json()
Response
200 β Job state
The response is a discriminated union onstatus. All variants include jobId, createdAt, updatedAt, and status.
| Field | Type | Present when | Description |
|---|---|---|---|
jobId | string | always | The job identifier |
status | string | always | pending, processing, ready, or failed |
createdAt | number | always | Epoch timestamp the job was created |
updatedAt | string | always | ISO 8601 timestamp the job was last updated |
result | object | status is ready | The job result (shape depends on the originating job) |
error | string | status is failed | Description of the failure |
Error responses
| Status | Description |
|---|---|
400 Bad Request | Malformed job ID |
401 Unauthorized | API key is invalid |
403 Forbidden | API key is missing or the job belongs to another org |
404 Not Found | No job with that ID (unknown or expired) |
500 Server Error | Unexpected server error |
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "ready",
"createdAt": 1717593600000,
"updatedAt": "2026-06-05T12:00:00.000Z",
"result": {
"totalHits": 2,
"riskLevel": "MEDIUM",
"riskScore": 45,
"summary": "Two adverse-media findings corroborated by court records.",
"findings": [],
"exposuresByCategory": {}
}
}
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "processing",
"createdAt": 1717593600000,
"updatedAt": "2026-06-05T12:00:01.000Z"
}
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "failed",
"createdAt": 1717593600000,
"updatedAt": "2026-06-05T12:00:30.000Z",
"error": "Upstream provider timed out"
}
βI