Quickstart
Run a business risk assessment with the Platform API in a few minutes.
Before you start
You need an organization API key in the format r6-<keyId>.<secret>. Send it on every request:
x-api-key: r6-yourKeyId.yourSecret
Base URL: https://api.relativity6.com
The Platform API endpoint for business risk is POST /v1/business/risk. For every field, see the business risk API reference.
Your first request
Send at least a company name. Adding domain, city, and state (or a full address) usually improves match quality.
Example request
A successful response returns HTTP 200 with a JSON body. Assessments can take from a few seconds to longer for deeper runs — plan your client timeout accordingly.
Read the response
Business data lives under company, grouped by section (for example company.firmographic, company.summary).
Many fields use a consistent shape:
value— the answerconfidence— how reliable that answer is (0–1)sources— references supporting the value, when available
The categoryAccess object shows which sections you asked for, which your account allows, and which were actually returned:
| Field | Meaning |
|---|---|
requested | Section names from your categories array, if you sent one |
entitled | Sections enabled for your organization |
effective | Sections included in this response |
execution describes how the run completed (for example single-pass fast vs multi-pass chained). quality summarizes coverage for the returned data.
Example response (abbreviated)
Optional controls
| Request field | Purpose |
|---|---|
categories | Limit which response sections to run — see Response categories |
category_filter / flag_filter | Limit which risk flags are evaluated — see Risk profiles |
chain_fulfillment | Request a deeper multi-pass assessment when true |
bypass_cache | Request a fresh assessment instead of a cached result |
confidence_threshold | Omit fields below a confidence score (0–1) |
What's next
- Response categories — every section and how to request them
- Risk profiles — risk flags vs evidence review, and flag filtering
- Business risk API reference — complete request and response specification