Relativity6Platform Docs

Snapshot extend

Beta

Add one module to a completed snapshot without starting a new research job.

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

After a job completes, the result is stored as a snapshot. POST /v2/snapshots/{snapshot_id}/extend adds exactly one module to that snapshot and returns the updated body.

Extend is synchronous. It does not create a new job_id and you do not poll. Use the snapshot_id from a completed job.

Use extend when the first run was Core-only (or omitted a Core+ module) and you later need OSHA, Form 5500, adverse news, or another priced module.

Modules

These live module ids are accepted. Coming-soon ids such as liquor_licenses and ofac_restricted_lists should not be sent. trade_licenses is not an extend id and returns 400.

OSHA accepts modules[].options.layer (1, 2, or 3) — see OSHA options. Business risk flags accept the same profile fields as submit — see risk flag options.

ModuleCreditsConfig
Adverse newsadverse_news3
Business risk flagsbusiness_risk_flags4Options
Digital riskdigital_risk4
OSHAosha2Options
Property financialsproperty_financials5
Form 5500form_55002
FMCSA / SAFERfmcsa_safer2
IRS Form 990irs_9902
Producer reportproducer_report2

Add a module

Send exactly one module. Optional refresh_summary regenerates the executive summary after the module is added.

POST /v2/snapshots/{snapshot_id}/extend

Already present

If that module is already on the snapshot, the API returns 409. Use idempotency_key so a retried extend reuses the same amendment instead of charging again.

Billing

Extend charges only that module at the credit weight in the table above. A degraded or failed extend refunds those credits. See Credits.