POST/v1/flags

Flags

Analyzes a business for insurance hazard flags using evidence-backed research. Returns hazard categories and flags with confidence scores, explanations, and supporting source links. Run a comprehensive scan with no filters, or narrow the search with category_filter and flag_filter.

Base URLhttps://api.relativity6.com

Authentication

Send your API key in the x-api-key header. Send your API key in this header on every request. Modern keys use the format r6-<keyId>.<secret>.

Request body

Field	Type	Required	Description
business_name	string	Required	Legal or trade name of the business.
business_address	string	Required	Full street address for the business location being evaluated.
category_filter	string[]	Optional	Limit analysis to specific hazard categories. Names must match the supported taxonomy exactly (case and spacing are normalized on comparison).Guard · Alarm · Janitorial · Gov't Contractors · Fire Suppression · Pest Control · Temp Staffing · Hab - Prop · Hab - GL
flag_filter	string[]	Optional	Limit analysis to specific hazard flags (for example, Bankruptcy or OSHA Violation). When combined with category_filter, each flag must belong to one of the specified categories.

Response

Field

Type

Required

Description

requestId

string (UUID)

Required

Unique identifier for this flags request.

business_name

string

Required

Business name from the request.

business_address

string

Required

Business address from the request.

hazard_results

array

Required

Evidence-backed hazard findings, sorted by confidence score descending. Only flags with supporting evidence are returned.

hazard_flag	string	Required	The hazard flag that matched (for example, Bankruptcy).
hazard_category	string	Required	Hazard category the flag belongs to (for example, Guard).
explanation	string	Required	Plain-language summary of why this flag applies to the business.
confidence_score	number	Required	Confidence that the flag applies, from 0 to 1.
evidence_link	string	Optional	URL to supporting evidence when available.

hazard_flag_counts

object

Required

Number of hazard_results entries for each hazard_flag name.

Errors

Status	Description
400	Invalid request body, unknown category_filter or flag_filter values, or flag/category mismatch when both filters are provided.
401	Missing or invalid API key.
403	API key not authorized for this endpoint.
429	Organization quota exceeded.
502	Upstream research service unavailable.
500	Server error.

Flags

Authentication

Request body

Response

Errors

Example request

Example response