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.

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
review_id
string
required
Pattern: ^rev_[0-7][0-9A-HJKMNP-TV-Z]{25}$

Body

application/json
expected_version
integer
required
Required range: 1 <= x <= 9007199254740991
expected_risk_version
integer
required
Required range: 1 <= x <= 9007199254740991
conclusion
enum<string>
required
Available options:
benign,
abuse,
inconclusive
note
string
required
Required string length: 1 - 2000

Response

Resolve a review against an exact account risk version.

id
string
required
Pattern: ^rev_[0-7][0-9A-HJKMNP-TV-Z]{25}$
account_id
string
required

The provider's own opaque identifier for the account being checked, scoped to the calling workspace. It must be provider-opaque and must not contain a direct identifier (email, phone, name, national id): that is a provider obligation the schema can only partly check. '|' is accepted so an Auth0 user id such as 'auth0|64abc' passes unchanged; '@', '+', '$' and whitespace are refused by the pattern, as is an exact-shape JWT; a hex digest such as a SHA-256 is allowed, because hashing an internal id is a common pseudonymous scheme. A value such as '07700900123' or 'jane.doe.gmail.com' cannot be told apart from an opaque id. It travels in bodies, and in a URL only as the path segment of GET /v1/accounts/{account_id}, its /assessments and its /links. An assessment requested by a provider hook at pre_registration, which has no account yet, carries the server-issued account_id pre: followed by its assessment_id.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:|-]{0,127}$
status
enum<string>
required
Available options:
open,
in_progress,
resolved
priority
enum<string>
required
Available options:
low,
normal,
high,
urgent
version
integer
required
Required range: 1 <= x <= 9007199254740991
opened_risk_version
integer
required
Required range: 1 <= x <= 9007199254740991
current_risk_version
integer
required
Required range: 1 <= x <= 9007199254740991
created_by
string
required
Required string length: 1 - 256
Pattern: ^[!-~]+$
updated_by
string
required
Required string length: 1 - 256
Pattern: ^[!-~]+$
created_at
string<date-time>
required
updated_at
string<date-time>
required
expires_at
string<date-time>
required
assignee
string
Required string length: 1 - 256
Pattern: ^[!-~]+$
resolution
object
assignee_principal_id
string

Immutable workspace member ID. assignee is the historical display identity captured at assignment.

Pattern: ^mem_[0-7][0-9A-HJKMNP-TV-Z]{25}$