Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer <key>. A key is nrk_live_ or nrk_test_, a 26-character key id, _ and a 43-character secret. Account, audit and usage data stay within the key's environment. Dedicated team scopes apply across the workspace.

assess creates and reads assessments, records outcomes and reports key usage. investigate reads accounts, assessment history and request diagnostics without export or enforcement access. The legacy history scope also permits account exports, submitted identifiers and enforcement reports. delete permits account and assessment deletion.

evidence or detailed adds detailed merged evidence and submitted identifiers where the operation permits them. Neither grants access to the underlying resource alone. exports permits exports with the underlying account or audit scope. audit reads audit events and usage reads usage. audit_manage manages audit streams and retention, and includes audit-read and export authority.

webhooks manages webhook endpoints. integrations manages hosted auth-provider integrations. management manages keys, settings, lists, reviews and policy evaluations in the key's environment. New keys cannot exceed the issuer's effective permissions.

settings reads configuration, previews policy and list changes, runs evaluations and changes retention. Publishing decision policy or changing lists requires settings and policy_publish together, or the legacy management scope.

groups creates and reads groups, adds people, starts and cancels screenings and records decisions on people, in the key's environment.

members reads the workspace directory. members_manage also administers non-owner members and invitations. These scopes require a live key issued by a current owner with access to both environments. They grant access across the workspace. management does not grant team access. API keys cannot change owners or accept invitations.

A missing, unknown, revoked or expired key answers 401. A valid key without a required scope answers 403.

Headers

Idempotency-Key
string
required

Opaque client key, 16 to 128 characters of [A-Za-z0-9._:-] (a UUID or ULID fits). Scoped to the workspace principal and bound to the canonical body for 24 hours.

Required string length: 16 - 128
Pattern: ^[A-Za-z0-9._:-]{16,128}$

Path Parameters

workspace_id
string
required

The workspace id. A workspace the acting user is not an active member of answers 404, as do another workspace than an API key's own, a malformed id and a test environment's id. The workspace id, which is also its live environment's workspace id; the test environment's is the same id with:test appended. A workspace created through the API is tnt_ and a 26-character ULID.

Pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,122}$
environment
enum<string>
required

The environment: live or test. Each has its own settings. Any other value answers 400. An API key reads and changes only its own environment's; the other answers 404. The environment the key belongs to. A live key assesses with live sources; a test key answers from the deterministic simulator.

Available options:
live,
test

Body

application/json
expected_policy_version
integer
required
Required range: 0 <= x <= 9007199254740991
from
string<date-time>
required
to
string<date-time>
required
candidates
object[]
required
Required array length: 1 - 200 elements
costs
object
required
limits
object
required
label_collection
string
required
Required string length: 20 - 2000
split_seed
string
required
Required string length: 16 - 128

Response

The bounded job is durably queued. Poll Location after Retry-After.

id
string
required
Pattern: ^pev_[0-7][0-9A-HJKMNP-TV-Z]{25}$
environment
enum<string>
required
Available options:
live,
test
status
enum<string>
required
Available options:
queued,
running,
completed,
failed,
cancelled
policy_version
integer
required
Required range: 0 <= x <= 9007199254740991
scoring_policy
string
required
Required string length: 1 - 128
created_at
string<date-time>
required
expires_at
string<date-time>
required
accounts
integer
required
Required range: 0 <= x <= 1000
requests
integer
required
Required range: 0 <= x <= 50000
evaluator_version
any
required
evaluator_sha256
string
required
Pattern: ^[0-9a-f]{64}$
captured_at
string<date-time>
finished_at
string<date-time>
build_version
string
Required string length: 1 - 128
result_status
enum<string>
Available options:
no_change,
proposal_requires_review
error_code
string
Required string length: 1 - 64
published_policy_version
integer
Required range: 0 <= x <= 9007199254740991
manifest_sha256
string
Pattern: ^[0-9a-f]{64}$
input_sha256
string
Pattern: ^[0-9a-f]{64}$
cohort_sha256
string
Pattern: ^[0-9a-f]{64}$
result_sha256
string
Pattern: ^[0-9a-f]{64}$