/v2/risk/{job_id}BetaGet job status
Returns the current state of a risk job, an incremental list of progress events, and — once the job is completed — the full risk result. Poll this endpoint until status is completed or failed. Pass the after query parameter set to the last cursor you received to fetch only new progress events.
Beta. This endpoint is available for production integrations, but fields, categories, and credit weights may change without a version pin.
https://api.relativity6.comAuthentication
Send your API key in the x-api-key header. Send the same API key you used to submit the job.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
| after | number (query) | Optional | Return only progress events with sequence greater than this value. Use the cursor from your previous poll (0 on the first request).Default: 0 |
Response
| Field | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| job_id | string | Required | The job id from the submit response. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status | string | Required | Lifecycle state. Stop polling once completed or failed.queued · running · completed · failed | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| company_name | string | Optional | Company name echoed from the submitted request. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| created_at | string (ISO 8601) | Optional | When the job was accepted. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| started_at | string (ISO 8601) | Optional | When background processing began. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| completed_at | string (ISO 8601) | Optional | When the job reached a terminal state. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cursor | number | Required | Sequence number of the most recent event in this response. Pass it as after on your next poll. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| events | ProgressEvent[] | Required | Ordered progress events newer than the after cursor. Each event includes a type (run_started, stage_started, stage_completed, stage_error, category_started, category_completed, run_completed, run_failed), a timestamp, and elapsed_ms. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| poll_url | string | Optional | Relative path to continue polling this job. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| response | object | Optional | The full risk result. Present only when status is completed.Treat response as null until status is completed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| entity_id | string | Optional | Resolved entity id for the assessed company, available on completion. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| snapshot_id | string | Optional | Snapshot id for the stored result, available on completion. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| error | string | Optional | Human-readable failure reason. Present only when status is failed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response headers
RateLimit-PolicyStructured policy descriptor reporting your sustained per-minute quota (q, w=60) and per-second burst capacity (w=1) for this endpoint group.
RateLimitRemaining requests (r) in the current sustained window and seconds until reset (t).
Retry-AfterReturned on HTTP 429 responses. Whole seconds to wait before retrying.
Errors
| Status | Description |
|---|---|
| 401 | Missing or invalid API key. |
| 403 | The job belongs to a different organization. |
| 404 | No job exists with this id. |
| 429 | Read/polling rate limit exceeded (code RATE_LIMIT_EXCEEDED). Wait Retry-After seconds before polling again. |
| 500 | Server error. |