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.

people reads people, groups and investigations with full evidence by default. people_write changes submitted people, groups and memberships. investigations starts or cancels jobs and screenings. decisions records reviews. exports with people-read access exports rosters. delete deletes people, groups and memberships. Existing groups keys retain non-destructive people access. Explicit evidence.read restrictions withhold collected records, posts, media, discovered identifiers and notes.

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

investigation_id
string
required
Pattern: ^inv_[0-7][0-9A-HJKMNP-TV-Z]{25}$

Body

application/json

Records a decision on a person.

decision
enum<string>
required

cleared, watch or escalated.

Available options:
cleared,
watch,
escalated
note
string

Why, for the venue team and later reviewers.

Maximum string length: 2000

Response

Record an investigation decision.

highest_band
enum<string> | null
required

The most severe finding's band, or null when nothing was flagged.

Available options:
critical,
high,
moderate,
low,
info
coverage
object
required

What the latest screening read: accounts found, accessible, items read, the period covered and each platform's status. Zero, with no platforms, until a screening reaches the person.

spend
object
required

What the latest screening of the person cost.

decision
enum<string> | null
required

The latest reviewer decision, or null before any.

Available options:
cleared,
watch,
escalated
id
string
required
Pattern: ^inv_[0-7][0-9A-HJKMNP-TV-Z]{25}$
person_id
string
required
Pattern: ^per_[0-7][0-9A-HJKMNP-TV-Z]{25}$
group_id
string | null
required
Pattern: ^grp_[0-7][0-9A-HJKMNP-TV-Z]{25}$
status
enum<string>
required
Available options:
queued,
running,
completed,
partial,
failed,
cancelled,
unknown
depth
enum<string>
required

standard reads the bio and the last 100 posts of each profile.

Available options:
standard
platforms
string[]
required
Required array length: 1 - 11 elements

A platform a screening can cover, such as instagram, x, bluesky, youtube, tiktok or github. A new platform adds an id without changing this contract, so read a platform you do not know in a response as one you have not seen before, not as an error. synthetic is the deterministic connector's own platform, for exercising the product end to end with no network.

Pattern: ^[a-z][a-z0-9_]{0,63}$
match_state
enum<string> | null
required

How sure the latest screening is that it found the person's accounts. unscreened until a screening reaches the person, and after one that had no profile to check (no_profile_to_check).

Available options:
unscreened,
confirmed,
probable,
possible,
none_found,
inaccessible
created_at
string<date-time>
required
expires_at
string<date-time>
required
deadline_at
string<date-time>
required
decision_note
string
Required string length: 1 - 2000
decided_by
string
Required string length: 1 - 256
decided_at
string<date-time>
error_code
string
started_at
string<date-time>
finished_at
string<date-time>