Skip to main content
GET
/
v1
/
async-jobs
/
{jobId}
Get Async Job
curl --request GET \
  --url https://api.deepidv.com/v1/async-jobs/{jobId}
{
  "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": {}
  }
}

GET /v1/async-jobs/{jobId}
Returns the current state of an async job. Endpoints that kick off long-running work — such as adverse media screening — return a 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:
statusTerminalPayloadMeaning
pendingNo—Queued, not yet picked up
processingNo—Actively running
readyYesresultCompleted successfully — result is available
failedYeserrorFailed — 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

ParameterTypeRequiredDescription
jobIdstringYesThe job ID returned by the creating endpoint

​
Headers

HeaderRequiredDescription
x-api-keyYesYour API key

​
Example request

curl https://api.deepidv.com/v1/async-jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "x-api-key: YOUR_API_KEY"

​
Response

​
200 — Job state

The response is a discriminated union on status. All variants include jobId, createdAt, updatedAt, and status.
FieldTypePresent whenDescription
jobIdstringalwaysThe job identifier
statusstringalwayspending, processing, ready, or failed
createdAtnumberalwaysEpoch timestamp the job was created
updatedAtstringalwaysISO 8601 timestamp the job was last updated
resultobjectstatus is readyThe job result (shape depends on the originating job)
errorstringstatus is failedDescription of the failure

​
Error responses

StatusDescription
400 Bad RequestMalformed job ID
401 UnauthorizedAPI key is invalid
403 ForbiddenAPI key is missing or the job belongs to another org
404 Not FoundNo job with that ID (unknown or expired)
500 Server ErrorUnexpected 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": {}
  }
}