Core & Core+
BetaEvery job runs Core. Add Core+ modules with enabled_categories when you need them.
Beta
Overview
A v2 risk assessment is organized into categories — self-contained sections such as firmographics, business history, or OSHA.
There are two tiers:
- Core — always runs. You do not send it as an option.
- 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:
| Status | Meaning |
|---|---|
executed | This section ran and produced a result. |
cached | Served from a prior matching run. |
degraded | The section was attempted but could not fully resolve. |
not_requested / skipped_not_requested | Present 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_filingsis corporate registration and related filings. Core+form_5500andirs_990are separate filing programs — they do not replace Core. - Core
property_overviewis address verification. Core+property_financialsadds assessed value, tax, mortgage, and sale detail. - Core
owners_operatorsis the people section. Firmographics may still include a thin operator rollup. - Core
online_presenceis domain, listings, and reviews. Core+digital_riskis cyber / exposure posture.
Core
Omit enabled_categories (or pass []) to run Core only. The Core assessment is charged on every POST /v2/risk job.
| Category | Id | What it covers | Config |
|---|---|---|---|
| Summary | summary | Synthesized verdict, key findings, and confidence. | — |
| Property verification | property_overview | Physical address verification for the requested location. | — |
| Industry classification | industry_classification | NAICS and related industry codes for the resolved business. | Options |
| Firmographics | company_firmographics | Legal identity, location, headcount, and revenue ranges. | — |
| Company growth | company_growth | Trajectory and growth signals. | — |
| Owners & operators | owners_operators | Key people associated with the business. | — |
| Business history | business_history | Founding, milestones, and a cross-source operating timeline. | — |
| Online presence | online_presence | Primary domain, directory listings, and public reviews. | — |
| Government filings | government_filings | Corporate 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:
| Item | Credits | Config |
|---|---|---|
Core assessmentCharged on every POST /v2/risk job. | 12 | Options |
| Digital riskdigital_risk | 4 | — |
| Adverse newsadverse_news | 3 | — |
| Property financialsproperty_financials | 5 | — |
| Form 5500form_5500 | 2 | — |
| IRS Form 990irs_990 | 2 | — |
| Business risk flagsbusiness_risk_flags | 4 | Options |
| FMCSA / SAFERfmcsa_safer | 2 | — |
| OSHAosha | 2 | Options |
| Producer reportproducer_report | 2 | — |
Full catalog of wire ids (including coming soon):
| Category | Id | Tier | What it covers | Config |
|---|---|---|---|---|
| Industry classification | industry_classification | Core | NAICS and related industry codes for the resolved business. | Options |
| Firmographics | company_firmographics | Core | Legal identity, location, headcount, and revenue ranges. | — |
| Owners & operators | owners_operators | Core | Key people associated with the business. | — |
| Business history | business_history | Core | Founding, milestones, and a cross-source operating timeline. | — |
| Company growth | company_growth | Core | Trajectory and growth signals. | — |
| Online presence | online_presence | Core | Primary domain, directory listings, and public reviews. | — |
| Government filings | government_filings | Core | Corporate registration and related public filings. | — |
| OSHA | osha | Core+ | Workplace safety inspections and citations. | Options |
| Form 5500 | form_5500 | Core+ | Employee benefit plan filings. | — |
| IRS Form 990 | irs_990 | Core+ | Tax-exempt organization profile and filings. | — |
| FMCSA / SAFER | fmcsa_safer | Core+ | Motor carrier safety records. | — |
| Adverse news | adverse_news | Core+ | Negative press and reputational signals. | — |
| Business risk flags | business_risk_flags | Core+ | Compliance concerns and regulatory risk indicators. | Options |
| Digital risk | digital_risk | Core+ | Cyber posture and digital exposure signals. | — |
| Producer report | producer_report | Core+ | Likely coverage stack, opportunities, and open questions for producers. | — |
| Property verification | property_overview | Core | Physical address verification for the requested location. | — |
| Property financials | property_financials | Core+ | Assessed value, tax, mortgage, and sale details. | — |
| Restricted listsComing soon | ofac_restricted_lists | Core+ | Screening against sanctions and restricted lists. | — |
| Liquor licensesComing soon | liquor_licenses | Core+ | Liquor license records where a public registry is available. | — |
| Trade licensesComing soon | trade_licenses | Core+ | Trade and contractor license records. | — |
| Summary | summary | Core | Synthesized 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.
| Field | Values | Default |
|---|---|---|
classify.families | naics, sic, mcc, gl, workers_comp | ["naics"] when omitted or empty |
classify.naics_year or top-level naics_year | 2017, 2022 | 2017 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.
| Layer | What you get |
|---|---|
1 | Inspection list (default) |
2 | Inspection detail |
3 | Violation detail |
POST /v2/risk with OSHA layer 2
Business risk flags
Applies when business_risk_flags is in enabled_categories.
| Field | Meaning |
|---|---|
profile_source | org (default when omitted) uses the organization's active risk-flag profile. default uses the Relativity6 Business Risk Flags package. |
profile_id | Optional UUID override. Takes precedence over profile_source. Returns 400 if that profile is not available to the organization. |
category_filter / flag_filter | Optional 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.
| Module | Id | What it covers |
|---|---|---|
| Restricted lists | ofac_restricted_lists | Screening against sanctions and restricted lists. |
| Liquor licenses | liquor_licenses | Liquor license records where a public registry is available. |
| Trade licenses | trade_licenses | Trade and contractor license records. |
| Secretary of State | secretary_of_state | State entity registrations and standing. Not a requestable category id yet. |
| UCC filings | ucc_filings | Uniform 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.