Relativity6Platform Docs

Quickstart

Beta

Submit a company, poll for progress, and read a full risk assessment in a few minutes.

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.

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

Risk API v2 is billed in credits. A core job is the cheapest valid selection.

How it works

The Risk API v2 is asynchronous. A risk assessment runs research across many sources and can take a few minutes, so you never hold a long-lived connection.

  1. Submit a company to POST /v2/risk. You get back a job_id and a poll_url immediately (HTTP 202).
  2. Poll GET /v2/risk/{job_id} for progress events and, once finished, the full result.

Every submit must state what to run with plan, entitlements, or addons. There is no implicit “run everything.”

Prefer not to poll? Register a webhook and we'll notify you when a job finishes.

Why asynchronous?

Long-running synchronous requests are fragile — proxies and gateways time out well before deep research completes. The job model is reliable end to end and lets you show live progress to your users.

1. Submit a job

Send at least a company name and a plan. A website and state sharpen entity matching:

POST /v2/risk

The response acknowledges the job and tells you where to poll:

202 Accepted

Credits are charged when the job is accepted. Failed or cancelled jobs are refunded automatically.

2. Poll for the result

Call the poll_url until status is completed or failed. Pass after set to the last cursor you saw to fetch only new progress events:

GET /v2/risk/{job_id}

When the job completes, the poll payload includes the full risk result under response — with top-level metadata, entity, entitlements, summary, grouped categories, and a canonical sources bibliography (categories cite sources via source_ids):

Completed

A polite poll interval is every 2–3 seconds. See the async job model for cursors, statuses, cancel, and retry guidance.

What's next