Quickstart
Get an API response in a few minutes using your organization API key. Your organization is on Risk API v2 or Platform API (v1) — use the matching product below.
1. Get an API key
An API key will be provided by Relativity6 when your organization is onboarded. If you have access to the Relativity6 platform, you can create and manage keys in your organization settings.
Production keys use the format r6-<keyId>.<secret>. Test keys use the same shape with an r6-test- prefix. Store the secret securely — it is shown only once at creation. See Environments.
2. Authenticate
Send the full key on every request:
x-api-key: r6-yourKeyId.yourSecret
3. Base URLs
| API | Base URL |
|---|---|
| Platform API (v1 and v2) | https://api.relativity6.com |
| Marvin2 API | https://classification.relativity6.com |
4. Risk assessment (Risk API v2, beta)
V2 is asynchronous: submit a company, then poll until the job completes. Core always runs. Add Core+ modules with enabled_categories. Jobs are billed in credits.
See the Risk API v2 quickstart and submit a risk job. For category shape, Core vs Core+, and request options, see Core & Core+.
5. Business risk (Platform API v1)
Use this if your organization is on v1.
Example request
See the full business risk reference.
6. Classification (Marvin2 API)
Example request
Check the X-Marvin2-Cache response header for cache hits. See the classification reference.
What's next
- Risk API v2 quickstart — jobs, polling, credits, and webhooks
- Platform API quickstart — business risk sections, profiles, and filtering
- Marvin2 API quickstart — classification and co-tenant endpoints