Relativity6Platform Docs

Core & Core+

Beta

Every job runs Core. Add Core+ modules with enabled_categories when you need them.

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 OSHA.

There are two tiers:

  1. Core — always runs. You do not send it as an option.
  2. Core+ — optional priced modules. Pass their category ids in enabled_categories.

Every v2 organization can run every live module. There is no separate entitlement list on the request or the result. What you pay is the credit total for Core plus any Core+ modules on that job.

Reading a result

When a job completes, the poll payload puts the assessment under response. That object is large in production; this page documents shape, not full payloads.

response
├── metadata          request_id, version, generated_at, duration_ms, endpoint
├── entity            entity_id, snapshot_id, primary_name, is_new
├── summary           top-level executive summary (not inside categories)
├── categories        map of category id → result
│   └── <id>
│       ├── status
│       ├── overview    summary, risk_level, confidence
│       ├── data        category-specific fields
│       └── source_ids  pointers into response.sources
└── sources[]         bibliography (source_type: web | marvin2 | records)

summary is top-level. It is part of Core (summary is a Core id) but it is never nested under categories.summary.

Absent keys were not run. If categories.osha is missing, OSHA was not on this job. Do not treat a missing key as an empty company.

Status values you will see on live jobs:

StatusMeaning
executedThis section ran and produced a result.
cachedServed from a prior matching run.
degradedThe section was attempted but could not fully resolve.
not_requested / skipped_not_requestedPresent on some stored snapshots when a section was in the catalog but not selected. Treat like “not run.”

Read overview.confidence and data per category. Categories run independently — one degraded section does not void the rest.

sources and source_ids: each category cites bibliography rows by id. source_type is web (open web), marvin2 (Relativity6 Data Source), or records (public records). There is no per-category embedded source list.

Overlaps to watch:

  • Core government_filings is corporate registration and related filings. Core+ form_5500 and irs_990 are separate filing programs — they do not replace Core.
  • Core property_overview is address verification. Core+ property_financials adds assessed value, tax, mortgage, and sale detail.
  • Core owners_operators is the people section. Firmographics may still include a thin operator rollup.
  • Core online_presence is domain, listings, and reviews. Core+ digital_risk is cyber / exposure posture.

Core

Omit enabled_categories (or pass []) to run Core only. The Core assessment is charged on every POST /v2/risk job.

CategoryIdWhat it coversConfig
SummarysummarySynthesized verdict, key findings, and confidence.
Property verificationproperty_overviewPhysical address verification for the requested location.
Industry classificationindustry_classificationNAICS and related industry codes for the resolved business.Options
Firmographicscompany_firmographicsLegal identity, location, headcount, and revenue ranges.
Company growthcompany_growthTrajectory and growth signals.
Owners & operatorsowners_operatorsKey people associated with the business.
Business historybusiness_historyFounding, milestones, and a cross-source operating timeline.
Online presenceonline_presencePrimary domain, directory listings, and public reviews.
Government filingsgovernment_filingsCorporate registration and related public filings.

Industry classification is the Core category that currently has extra request options — see Configuration.

Core+

Core+ modules are optional. Add them on the first job with enabled_categories, or later with snapshot extend. Credit weights for live modules:

ItemCreditsConfig
Core assessmentCharged on every POST /v2/risk job.12Options
Digital riskdigital_risk4
Adverse newsadverse_news3
Property financialsproperty_financials5
Form 5500form_55002
IRS Form 990irs_9902
Business risk flagsbusiness_risk_flags4Options
FMCSA / SAFERfmcsa_safer2
OSHAosha2Options
Producer reportproducer_report2

Full catalog of wire ids (including coming soon):

CategoryIdTierWhat it coversConfig
Industry classificationindustry_classificationCoreNAICS and related industry codes for the resolved business.Options
Firmographicscompany_firmographicsCoreLegal identity, location, headcount, and revenue ranges.
Owners & operatorsowners_operatorsCoreKey people associated with the business.
Business historybusiness_historyCoreFounding, milestones, and a cross-source operating timeline.
Company growthcompany_growthCoreTrajectory and growth signals.
Online presenceonline_presenceCorePrimary domain, directory listings, and public reviews.
Government filingsgovernment_filingsCoreCorporate registration and related public filings.
OSHAoshaCore+Workplace safety inspections and citations.Options
Form 5500form_5500Core+Employee benefit plan filings.
IRS Form 990irs_990Core+Tax-exempt organization profile and filings.
FMCSA / SAFERfmcsa_saferCore+Motor carrier safety records.
Adverse newsadverse_newsCore+Negative press and reputational signals.
Business risk flagsbusiness_risk_flagsCore+Compliance concerns and regulatory risk indicators.Options
Digital riskdigital_riskCore+Cyber posture and digital exposure signals.
Producer reportproducer_reportCore+Likely coverage stack, opportunities, and open questions for producers.
Property verificationproperty_overviewCorePhysical address verification for the requested location.
Property financialsproperty_financialsCore+Assessed value, tax, mortgage, and sale details.
Restricted listsComing soonofac_restricted_listsCore+Screening against sanctions and restricted lists.
Liquor licensesComing soonliquor_licensesCore+Liquor license records where a public registry is available.
Trade licensesComing soontrade_licensesCore+Trade and contractor license records.
SummarysummaryCoreSynthesized verdict, key findings, and confidence.

Configuration

Core always runs, and Core has request options. Each Core+ module might have options of its own. Matching fields (state, website, address) are not category config, but they strongly affect which entity is assessed.

Matching the business

Send at least company_name. Add state (strongly recommended), website, and a street address when you have them.

POST /v2/risk (Core)

Industry classification

Applies to Core industry_classification.

FieldValuesDefault
classify.familiesnaics, sic, mcc, gl, workers_comp["naics"] when omitted or empty
classify.naics_year or top-level naics_year2017, 20222017 unless you send 2022

POST /v2/risk with classification options

Industry codes follow the families you request. Unrequested families are omitted from the result.

OSHA

Applies when osha is in enabled_categories, and on snapshot extend for that module. Use osha.layer on submit and modules[].options.layer on extend.

LayerWhat you get
1Inspection list (default)
2Inspection detail
3Violation detail

POST /v2/risk with OSHA layer 2

Business risk flags

Applies when business_risk_flags is in enabled_categories.

FieldMeaning
profile_sourceorg (default when omitted) uses the organization's active risk-flag profile. default uses the Relativity6 Business Risk Flags package.
profile_idOptional UUID override. Takes precedence over profile_source. Returns 400 if that profile is not available to the organization.
category_filter / flag_filterOptional lists that narrow which flags are evaluated.

POST /v2/risk with risk flags

Other live Core+ modules have no extra options today.

Coming soon

These records are not live. Do not send them in enabled_categories or snapshot extend.

ModuleIdWhat it covers
Restricted listsofac_restricted_listsScreening against sanctions and restricted lists.
Liquor licensesliquor_licensesLiquor license records where a public registry is available.
Trade licensestrade_licensesTrade and contractor license records.
Secretary of Statesecretary_of_stateState entity registrations and standing. Not a requestable category id yet.
UCC filingsucc_filingsUniform Commercial Code financing statements. Not a requestable category id yet.

Selecting Core+

To add OSHA and Form 5500 on the same submit:

POST /v2/risk with Core+

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.

Credits

Every v2 organization can request any live Core+ module. What you pay is the credit total for Core plus the modules on that job.

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.