Relativity6Platform Docs

Environments

Beta

Use production and test API keys to keep live usage separate from integration testing.

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.

Two environments

Every organization has a production environment and a test environment. Both run on the same Relativity6 APIs. Test keys do not share quotas, credits, or stored results with production keys.

Use production keys for live underwriting traffic. Use test keys while you integrate, validate response shapes, or run automated suites.

Key format

Send the full key on every request in the x-api-key header.

EnvironmentPrefix
Productionr6- followed by the key id, a period, and the secret
Testr6-test- followed by the key id, a period, and the secret

Do not rewrite a production key by inserting test into the prefix. A key created for one environment is rejected if you change its prefix.

Create and rotate keys in organization settings. Production and test keys are listed separately.

What stays separate

Each environment has its own:

  • Request quota (Platform API v1 and Marvin2)
  • Credit balance (Risk API v2)
  • Usage history
  • Risk jobs, entities, and snapshots

A test-key job is not visible when you authenticate with a production key. Polling a production job with a test key returns 404.

Scheduled renewal runs always use the production environment.

Fixture responses

To exercise your client against a stable response without consuming quota or credits, send this header with a test key:

X-R6-Fixture: default

Supported today:

EndpointResult
POST /v1/business/riskImmediate canned assessment
POST /v2/riskAccepted job (202) that completes with a canned body — poll as usual
POST /marvin2Immediate canned classification

The header is beta. The only published scenario is default. Production keys that send the header receive 400 with code FIXTURE_TEST_KEY_REQUIRED. Unknown scenario names receive 400 with code UNKNOWN_FIXTURE.

Fixture calls still appear in usage history so you can confirm the request was received. They are not billed.

Fixture bodies are shape examples. They are not a real company assessment and must not be used for underwriting decisions.

Switching in the platform

In Relativity6, an environment switcher lets you work in production or test. Test mode is visually marked so it is obvious you are not looking at live results.

Workbench writes that would start a live research run are disabled while you are in test. Use a test API key (or the fixture header) for automated checks instead.