Risk profiles
Your organization’s risk profile defines which flags are evaluated and how results are returned in the riskAssessment section.
Overview
Custom risk flags appear under company.riskAssessment. They come from your organization’s active risk profile — the flag list Relativity6 configures for your account (industry rules, property hazards, operational concerns, and so on).
To run risk flags at all, include riskAssessment in categories (or omit categories and ensure that section is entitled). Profile filters below only apply to that section.
Risk flags vs evidence review
Each organization uses one active profile type. The type changes how flags are researched and what appears in the response — not the overall response shape.
| Profile style | Best for | Flag behavior |
|---|---|---|
| Risk flags (default) | General underwriting — industry, operations, premises, financial, and location concerns | Flags include reasoning and a risk level (high, medium, low) |
| Evidence review | Hazard- and property-oriented programs that need a source link when a flag fires | Same fields, plus evidenceLink with a supporting URL when a flag is raised |
If no custom profile is assigned, the API uses the risk flags style with a standard Relativity6 flag set.
Your account team can tell you which profile type is active and share the exact group names and flag names available for filtering.
What each flag includes
Each flag in company.riskAssessment.customFlags typically includes:
| Field | Meaning |
|---|---|
flag | Flag name (for example Cannabis/CBD, Schools) |
category | Group within your profile (for example Industry & Product Risks) |
reasoning | Short explanation of why the flag applies |
riskLevel | high, medium, or low |
evidenceLink | Supporting URL when your profile uses evidence review; otherwise null |
The parent customFlags field also carries confidence and sources like other assessment data.
category_filter
category_filter limits evaluation to specific groups from your risk profile — the names in the category field on each flag.
Use it when you only care about one part of the profile (for example property-related groups) and want a faster, smaller response.
"categories": ["riskAssessment"],
"category_filter": ["Industry & Product Risks"]
Names must match your profile exactly. If you are unsure of the strings, ask your Relativity6 contact for your profile export or documentation.
flag_filter
flag_filter limits evaluation to specific flag names from your profile — the strings in the flag field.
Use it when you only need answers for a handful of known flags (for example cannabis or liquor-related rules):
"categories": ["riskAssessment"],
"flag_filter": ["Cannabis/CBD", "Alcohol Service"]
Again, names must match your profile exactly.
Combining filters
You can send both filters together. Only flags that match both lists are evaluated and returned.
Scoped risk assessment
Not the same as categories
The top-level categories array chooses response sections (firmographic, summary, and so on). category_filter only narrows flag groups inside riskAssessment. Do not put profile group names in categories.