Relativity6Platform Docs
POST/v1/business/risk

Business risk

Returns a business risk assessment for a company, including firmographics, filings, digital presence, adverse media, risk flags, and an executive summary. Which sections appear depends on your account configuration and any categories you request.

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

FieldTypeRequiredDescription
company_namestringRequiredLegal or trade name of the business.
domainstringOptionalPrimary website domain (for example, acmecorp.com).
addressstringOptionalStreet address.
citystringOptionalCity.
statestringOptionalState or region code.
zipstringOptionalPostal or ZIP code.
countrystringOptionalCountry code (for example, US).
categoriesstring[]OptionalResponse sections to run, intersected with your account configuration. Use reviews for public review and rating data. You may also request onlinePresence or publicReviews directly when those sections are enabled for your organization.firmographic · publicFilings · digitalAssetHealth · corporateStability · riskAssessment · summary · propertyInsights · adverseMedia · reviews
category_filterstring[]OptionalLimit which flag groups from your risk profile are evaluated. Applies only to the riskAssessment section.
flag_filterstring[]OptionalLimit which named flags from your risk profile are evaluated. Applies only to the riskAssessment section.
chain_fulfillmentbooleanOptionalRequest a deeper multi-pass assessment when true.Default: false
max_roundsnumberOptionalMaximum assessment passes when chain_fulfillment is true.
timeout_secondsnumberOptionalRequested processing time limit in seconds. A platform maximum still applies.
confidence_thresholdnumberOptionalMinimum confidence score (0–1) for a field to be included in the response.
showMetadatabooleanOptionalInclude additional diagnostic fields when enabled for your account.
bypass_cachebooleanOptionalReturn a fresh assessment instead of a previously cached result.

Response

FieldTypeRequiredDescription
requestobjectRequiredEcho of the submitted company identifiers and processing time.
company_namestringRequiredCompany name from the request.
timestampstring (ISO 8601)RequiredWhen the assessment was processed.
categoryAccessobjectRequiredWhich response sections were requested, allowed for your account, and actually returned.
requestedstring[]RequiredSections named in the request, if any.
entitledstring[]RequiredSections enabled for your organization.
effectivestring[]RequiredSections included in this response.
companyobjectRequiredBusiness risk data organized by section. Scalar fields use DataPoint with verificationStatus: not_searched when the section did not run on this request; no_evidence when the section ran but this field had no source value.
firmographicobjectOptionalLegal identity, location, scale estimates, and industry classification when enabled.Industry classification (NAICS, SIC, MCC, workers comp, and general liability) is contract-gated. Codes appear under industryClassification only when your agreement includes them.
legal_nameDataPoint<string>OptionalRegistered or commonly used legal name, with confidence and sources.
industryClassificationobjectOptionalIndustry codes when included in your contract: NAICS (2-, 4-, and 6-digit tiers), SIC, MCC, workers comp, and general liability.
naicsobjectOptionalPrimary and optional secondary NAICS predictions at 2-, 4-, and 6-digit levels.
sicDataPointOptionalStandard Industrial Classification code when enabled.
mccDataPointOptionalMerchant category code when enabled.
workersCompDataPointOptionalWorkers compensation classification when enabled.
glDataPointOptionalGeneral liability classification when enabled.
employee_countDataPoint<range>OptionalEstimated employee count range, with confidence and sources.
annual_revenueDataPoint<range>OptionalEstimated annual revenue range, with confidence and sources.
onlinePresenceobjectOptionalWebsite, social presence, and broader digital footprint.
publicReviewsobjectOptionalStructured public review and rating data.
publicFilingsobjectOptionalGovernment and corporate registry filings.
adverseMediaobjectOptionalAdverse media findings and supporting references.
digitalAssetHealthobjectOptionalWebsite security, technology, and digital risk signals.
corporateStabilityobjectOptionalCorporate history, longevity, and stability indicators.
riskAssessmentobjectOptionalRisk flags and profile evaluation for the business.
summaryobjectOptionalExecutive summary of the assessment.
businessDescriptionstringOptionalPlain-language description of what the business does.
riskVerdictstringOptionalOverall risk verdict for underwriting review.
propertyInsightsobjectOptionalProperty and co-tenant insights when propertyInsights is on your org access list and included in the request categories filter (if any). Default org access excludes propertyInsights unless explicitly entitled. Each child field is a DataPoint with verificationStatus.
geocodeobjectOptionalLat/lng for the submitted address. no_evidence when the lookup ran but coordinates were not returned.
structureobjectOptionalBuilding footprint polygon when available; no_evidence when searched with no polygon.
tenantsarrayOptionalCo-located businesses at the address; no_evidence when the tenant list is empty after search.
countyNamestringOptionalCounty name when returned by the registry.
verificationsobjectRequiredHow your submitted inputs matched the resolved business record.
executionobjectRequiredHow long the assessment took and how it was run.
mode'fast' | 'chained'Requiredfast for a single pass; chained for a deeper multi-pass run.
roundsnumberRequiredNumber of assessment passes completed.
providersExecutedarrayRequiredData sources that contributed to this response, with source references.
totalLatencynumberRequiredTotal processing time in milliseconds.
postProcessingobjectOptionalStatus of summary generation when the summary section was requested.
qualityobjectRequiredCoverage and verification metrics for the returned data.
completenessScorenumberRequiredShare of expected fields populated, from 0 to 1.
verifiedFieldsnumberRequiredCount of fields that passed verification.
totalFieldsnumberRequiredTotal fields evaluated for completeness.

Errors

StatusDescription
400Invalid request body or unknown section name in categories.
401Missing or invalid API key.
403API key not authorized for this endpoint or section.
429Organization quota exceeded.
500Server error.

Example request

Example response