Relativity6Platform Docs

Categories & access

Beta

Control which sections a risk assessment produces, within your account's access.

Beta

Risk API v2 is in beta. You can use it in production, but request fields, response shapes, category coverage, and credit weights may change without a version pin. Build against the documented contract and expect updates.

Overview

A v2 risk assessment is organized into categories — self-contained sections such as firmographics, business history, or adverse news. In a completed result, categories appear under response.categories, keyed by category id. Each category includes overview (summary, risk_level, confidence), structured data, and source_ids pointing into the top-level response.sources bibliography.

Which categories run is determined by two things, in order:

  1. Your request — a required plan, entitlements, or addons selection.
  2. Your account access — categories not on your agreement are skipped even if requested.

There is no implicit default. A request that omits plan, entitlements, and addons returns 400.

Every assessment includes the resolution backbone and an executive summary, regardless of plan.

Plans

The simplest way to pick categories is a named plan. Pass it as plan on the request. Use addons to layer additional bundles on top.

PlanIncludes
coreCore. Summary, Industry classification, Firmographics, Owners & operators, Business history, Company growth, Online presence.
core_plus_governmentGovernment records. Summary, Government filings, OSHA, Form 5500, IRS Form 990, FMCSA / SAFER.
core_plus_riskRisk & reputation. Summary, Adverse news, Business risk flags, Digital risk, Producer report.
core_plus_propertyProperty. Summary, Property verification, Property financials.
core_plus_compliance_listsCompliance lists. Summary, Restricted lists, Liquor licenses, Trade licenses.

Categories

The categories that can appear in a result. Industry codes inside firmographics and classification may be omitted when they are not on your contract.

CategoryIdWhat it covers
Industry classificationindustry_classificationNAICS and related industry codes for the resolved business.
Firmographicscompany_firmographicsLegal identity, location, headcount, and revenue ranges.
Owners & operatorsowners_operatorsKey people associated with the business.
Business historybusiness_historyFounding, milestones, and a cross-source operating timeline.
Company growthcompany_growthTrajectory and growth signals.
Online presenceonline_presencePrimary domain, directory listings, and public reviews.
Government filingsgovernment_filingsCorporate registration and related public filings.
OSHAoshaWorkplace safety inspections and citations.
Form 5500form_5500Employee benefit plan filings.
IRS Form 990irs_990Tax-exempt organization profile and filings.
FMCSA / SAFERfmcsa_saferMotor carrier safety records.
Adverse newsadverse_newsNegative press and reputational signals.
Business risk flagsbusiness_risk_flagsCompliance concerns and regulatory risk indicators.
Digital riskdigital_riskCyber posture and digital exposure signals.
Producer reportproducer_reportLikely coverage stack, opportunities, and open questions for producers.
Property verificationproperty_overviewPhysical address verification for the requested location.
Property financialsproperty_financialsAssessed value, tax, mortgage, and sale details.
Restricted listsLimited availabilityofac_restricted_listsScreening against sanctions and restricted lists.
Liquor licensesLimited availabilityliquor_licensesLiquor license records where a public registry is available.
Trade licensesNot returned yettrade_licensesTrade and contractor license records.
SummarysummarySynthesized verdict, key findings, and confidence.

Trade licenses

trade_licenses is a valid request id and appears in the compliance-lists plan, but the assessment does not currently return that category. Do not depend on it in production clients.

Selecting what runs

For most integrations, set a plan:

POST /v2/risk with a plan

For fine-grained control, pass entitlements with specific capability ids, or use the deprecated enabled_categories list (prefer plan / entitlements / addons for new integrations).

Partial results

Categories run independently. If one category can't be completed, the rest still return — check each category's overview.confidence and data rather than assuming all-or-nothing. Skipped categories report a status such as skipped_not_entitled with a client-safe reason in data.

Access & contract

Category access follows your commercial agreement. Some categories — and the industry codes within classification — are contract-gated and only appear when included in your plan.

After the first snapshot, you can add one priced module at a time with snapshot extend instead of starting a new job.

See data you like? Contact us to get access.
Your Relativity6 team can add response sections, risk profiles, and usage capacity to match how you want to underwrite. Tell us which capabilities you want to enable and we will align your account with your agreement.