Response categories

A single POST /v1/business/risk call can return firmographics, filings, reviews, risk flags, a summary, and more. Each block of data is a response section, selected through the categories array on your request.

Which sections you can receive depends on what is enabled for your organization. Which sections you do receive depends on your request and that configuration together. See Your access for how contracts and entitlements work.

Access to response categories is set by your agreed contract with Relativity6, not by the API alone. Your organization’s enabled sections appear in categoryAccess.entitled on every business risk response. You can request any section name in categories, but only entitled sections are evaluated and returned.

Typical contract decisions include which data sections are in scope, whether property insights or specialized review configurations apply, and how your custom risk profile is maintained. If you need a section that is not enabled today, your account team can update your configuration after your agreement is amended.

Use these values in the categories array:

If a section is not enabled for your account, it will not appear in categoryAccess.effective even if you request it. Sections you are not contracted for remain unavailable until Relativity6 updates your organization configuration.

Run everything you are entitled to — omit categories. The API runs all sections enabled for your organization.

Run a subset — send a categories array with the section names you need:

Only sections that are both requested and entitled are included. Unknown section names return HTTP 400.

Request nothing — send categories": []. The API runs no sections and returns an empty company object (aside from metadata). Use this only when you intentionally want a no-op assessment.

Send reviews in categories whenever you need review and rating data. You do not need to request onlinePresence or publicReviews separately.

The API maps reviews to the review section enabled for your organization. The response appears under company.onlinePresence or company.publicReviews, never both.

"categories": ["firmographic", "reviews", "summary"]

If review data is not enabled for your organization, reviews is omitted from the response.

Every response includes categoryAccess so you can see what happened:

{
  "requested": ["firmographic", "riskAssessment"],
  "entitled": ["firmographic", "riskAssessment", "summary", "publicFilings"],
  "effective": ["firmographic", "riskAssessment"]
}

• requested — what you asked for (empty if you omitted categories)
• entitled — sections enabled under your Relativity6 agreement
• effective — section ids included in this response, such as onlinePresence or publicReviews when review data ran

Use effective to drive UI layout and downstream parsing so you only read sections that are present.

Each card below describes one response section: how to request it, what underwriters typically use it for, important fields, and a trimmed JSON example.

Most scalar and structured fields use a DataPoint object:

Examples are abbreviated. Your responses may include additional fields depending on which sections are enabled for your organization and what data is available for the business.