Relativity6Platform Docs

Credits

Beta

Risk API v2 bills in credits. Your contract sets the dollar rate; this page documents the credit units the API charges.

Beta

Risk API v2 is in beta. You can use it in production, but request fields, response shapes, category coverage, and credit weights may change without a version pin. Build against the documented contract and expect updates.

Overview

Every POST /v2/risk job charges a core amount plus any priced modules included in the request. Snapshot extend charges only the one module you add.

Credits are organization-wide. All API keys for an organization share the same balance.

We do not publish dollar rates here. Your Relativity6 agreement sets the price per credit.

What a job costs

A job always includes the core assessment. Selected modules add their weights. Duplicate module ids are charged once.

ItemCredits
Core assessmentCharged on every POST /v2/risk job.12
Digital riskdigital_risk4
Adverse newsadverse_news3
Property financialsproperty_financials5
Form 5500form_55002
IRS Form 990irs_9902
Business risk flagsbusiness_risk_flags4
FMCSA / SAFERfmcsa_safer2
OSHAosha2
Producer reportproducer_report2

Restricted-list screening and liquor licenses are currently 0 credits (limited availability). Trade licenses are not returned and are not billed.

Example

A plan: "core" job costs 12 credits. Adding OSHA (osha) and Form 5500 (form_5500) on the same submit adds those module weights to the core charge.

When credits are charged

ActionWhen chargedIf it fails
POST /v2/riskWhen the job is accepted (202)Refunded if the job fails or you cancel it before a result is stored
POST /v2/snapshots/{id}/extendWhen the extend startsRefunded if the extend fails or returns degraded
Retry with Idempotency-KeyNot charged againReuses the original job

Successful completions keep the charge. Polling, listing webhooks, and reading a completed job do not consume credits.

Insufficient credits

If the organization does not have enough credits, POST /v2/risk and snapshot extend return HTTP 402 with:

FieldMeaning
codeAlways INSUFFICIENT_CREDITS
credits_neededCredits this request would have charged
remaining_creditsCurrent remaining balance

No job is created when submit returns 402.

Overages

If your organization is configured to allow overages, a request can complete even when the remaining balance is below the charge. The used balance may then exceed the contracted total. Organizations without overages receive 402 instead.

See data you like? Contact us to get access.
Your Relativity6 team can add response sections, risk profiles, and usage capacity to match how you want to underwrite. Tell us which capabilities you want to enable and we will align your account with your agreement.