API Reference
Introduction
The Relativity6 API platform exposes REST endpoints for business risk assessment and industry classification. All endpoints require an API key and return JSON.
Authentication
Include your API key in the x-api-key header on every request.
- Production:
r6-<keyId>.<secret> - Test:
r6-test-<keyId>.<secret>
Keys are scoped to your organization and environment. Test keys charge a separate quota and credit pool and store results separately from production. See Environments.
Platform API v1 uses request quotas per organization across all keys in that environment. Risk API v2 uses credits.
Errors
Errors use conventional HTTP status codes with a JSON body:
- 400 — Invalid request body or parameters
- 401 — Missing or invalid API key
- 403 — Not entitled to the endpoint or resource
- 402 — Insufficient credits (Risk API v2)
- 429 — Quota or rate limit exceeded (Platform API v1)
- 5xx — Server error
Products
Platform API
Health check
GET /health
Platform API
Business risk
POST /v1/business/risk
Platform API
Flags
POST /v1/flags
Marvin2 API
Health check
GET /health
Marvin2 API
Classification
POST /marvin2
Marvin2 API
Multi classification
POST /classification
Marvin2 API
Co-tenant
POST /co-tenant
Risk API v2 · Beta
Submit a risk job
POST /v2/risk
Risk API v2 · Beta
Get job status
GET /v2/risk/{job_id}
Risk API v2 · Beta
Cancel a job
POST /v2/risk/{job_id}/cancel
Risk API v2 · Beta
Create a webhook
POST /v2/webhooks
Risk API v2 · Beta
Extend a snapshot
POST /v2/snapshots/{snapshot_id}/extend