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. Production keys start with r6-. Test keys start with r6-test-. Send the full key on every request:

x-api-key: r6-yourKeyId.yourSecret

See Environments for test keys and fixture responses.

Base URL: https://api.relativity6.com

Risk API v2 is billed in credits. Omitting enabled_categories runs Core only — the cheapest job.

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 v2 organization can run every module. Omit enabled_categories for Core only. Pass Core+ category ids to add priced modules. There is no implicit “run every Core+ module.”

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. 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 assessment under response. Walk the shape in Core & Core+ — metadata, entity, top-level summary, grouped categories, and sources. Production payloads are large; the example below is abbreviated.

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

  • Async job model — statuses, progress events, cancel, and the after cursor
  • Credits — how jobs and snapshot extends are billed
  • Core & Core+ — what always runs, and how to add priced modules
  • Snapshot extend — add one module to an existing result
  • Webhooks — get notified on completion instead of polling
  • API reference — full request and response specifications