POST/v2/riskBeta
Submit a risk job
Starts an asynchronous risk assessment for a company and returns immediately with a job you can poll. Research runs in the background and can take a few minutes; you never hold a long-lived connection. Use the returned poll_url to check progress and retrieve the final result, or register a webhook to be notified on completion.
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 |
|---|
| company_name | string | Required | Legal or trade name of the business (2–200 characters). |
| website | string | Optional | Primary website domain (for example, acmerobotics.com). Improves match accuracy. |
| address | string | Optional | Street address. |
| city | string | Optional | City. |
| state | string | Recommended | State or region code. Strongly recommended to disambiguate the entity. |
| zip | string | Optional | Postal or ZIP code. |
| country | string | Optional | Two-letter country code (for example, US). |
| policy_id | string | Optional | Your own reference id, echoed back and stored with the result for reconciliation. |
| enabled_categories | string[] | Optional | Optional Core+ category ids to run in addition to Core. Omit or pass [] for a Core-only job. Core ids in this list are ignored. Do not send coming-soon ids (liquor_licenses, ofac_restricted_lists, trade_licenses). Sending plan, addons, or entitlements returns 400. See Core & Core+. |
| naics_year | string | Optional | NAICS vintage for industry classification. Default is 2017 unless 2022 is sent.2017 · 2022 |
| classify | object | Optional | Industry classification options for Core industry_classification. See Core & Core+. |
| families | string[] | Optional | Code families to return. Omit or pass [] for naics only.naics · sic · mcc · gl · workers_comp | | naics_year | string | Optional | NAICS vintage. Default is 2017 unless 2022 is sent.2017 · 2022 |
|
| business_risk_flags | object | Optional | Filters and profile selection for Core+ business_risk_flags. See Core & Core+. |
| category_filter | string[] | Optional | Limit evaluation to specific flag categories. | | flag_filter | string[] | Optional | Limit evaluation to specific flag names. | | profile_source | string | Optional | Which risk profile drives flag evaluation when profile_id is omitted. org (the default when omitted) uses the organization's active default; default uses the Business Risk Flags package.default · org | | profile_id | string | Optional | Optional portfolio override. UUID of an org-owned profile or a global package the organization has installed. Takes precedence over profile_source. Returns 400 if the profile is not available to the organization. |
|
| osha | object | Optional | Options for Core+ OSHA. See Core & Core+. |
| layer | number | Optional | Inspection depth: 1 = inspection list (default), 2 = inspection detail, 3 = violation detail.1 · 2 · 3 |
|
| cache | object | Optional | Request cache control. |
| mode | string | Optional | default uses the cache; ignore bypasses it for this request.default · ignore |
|
Response
| Field | Type | Required | Description |
|---|
| job_id | string | Required | Unique id for this job. Use it to poll status and to match webhook deliveries. |
| status | string | Required | Lifecycle state. Always queued on the initial response.queued · running · completed · failed |
| company_name | string | Optional | Company name echoed from the request. |
| poll_url | string | Required | Relative path to poll for status and the final result (GET /v2/risk/{job_id}). |
| created_at | string (ISO 8601) | Optional | When the job was accepted. |
