GET/v2/risk/{job_id}Beta
Get 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.
Base URLhttps://api.relativity6.com
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. |
| metadata | object | Required | Run metadata for this assessment. | | request_id | string | Required | Stable id for this run (matches the job id). | | version | string | Required | Always "v2".v2 | | generated_at | string (ISO 8601) | Required | When the result was finalized. | | duration_ms | number | Required | Wall-clock processing time in milliseconds. | | endpoint | string | Required | Always "/v2/risk"./v2/risk | | served_from_cache | boolean | Optional | True when this body was served from the request cache. | | cache_captured_at | string (ISO 8601) | Optional | When the cached body was originally captured. |
| | entity | object | Required | Resolved business identity for this assessment. | | entity_id | string | Required | Stable id for the assessed business. | | snapshot_id | string | Optional | Snapshot id for the stored result, when persisted. | | primary_name | string | Required | Primary display name for the business. | | is_new | boolean | Required | True when this run created a new entity record for your organization. |
| | entitlements | object | Required | What was requested versus what your account is entitled to run. | | requested | string[] | Required | Categories or capabilities requested for this job. | | enabled | string[] | Required | Categories that ran under your access. | | not_entitled | string[] | Required | Requested categories skipped because they are not on your account. |
| | summary | object | Optional | Executive summary synthesized across categories (top-level, not inside categories). | | status | string | Required | Execution status for the summary section.executed · cached · skipped_not_entitled · skipped_not_requested · degraded · not_requested | | overview | object | Required | Narrative summary for underwriting review. | | summary | string | Required | Plain-language synthesis. | | risk_level | string | Required | Overall severity for this section.low · medium · high | | confidence | number | Required | Epistemic certainty for these conclusions (0–1). |
| | data | object | Required | Structured underwriting signals. | | top_findings | Signal[] | Optional | Material facts driving the rating. | | reasons_to_underwrite | Signal[] | Optional | Evidence-backed reasons to bind. | | reasons_not_to_underwrite | Signal[] | Optional | Evidence-backed reasons to decline or restrict. | | open_questions | OpenQuestion[] | Optional | Unresolved gaps to verify before bind. |
| | source_ids | string[] | Optional | References into the top-level sources bibliography. |
| | categories | object | Required | Per-category results keyed by category id (for example, company_firmographics). Absent keys were not requested or not entitled. | | <category_id> | CategoryResult | Optional | One assessed section. Each includes status, overview, data, and source_ids. | | status | string | Required | Whether and how this category executed.executed · cached · skipped_not_entitled · skipped_not_requested · degraded · not_requested | | overview | object | Required | Category-level summary, risk_level, and confidence. | | data | object | Required | Category-specific structured fields. | | source_ids | string[] | Optional | References into response.sources for this category. |
|
| | sources | Source[] | Required | Canonical bibliography for the assessment. Categories cite rows via source_ids — there is no per-category embedded source list. | | id | string | Required | Stable source row id referenced by source_ids. | | url | string | Optional | Public URL when available. | | title | string | Optional | Human-readable label. | | source_type | string | Required | Source bucket — no vendor names on the wire.web = open web research; marvin2 = Relativity6 Data Source; records = public records.web · marvin2 · records | | display_name | string | Optional | Optional display label. | | pulled_at | string (ISO 8601) | Optional | When this source was retrieved. |
| | _admin | object | Optional | Internal diagnostics for Relativity6 staff only. Present only when the authenticated organization is the Relativity6 system-admin org and the request sets admin.debug to true.Never available to customer organizations. Omit in production client integrations. |
|
| 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. |
