Skip to main content
GET
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

group_id
string
required
Pattern: ^grp_[0-7][0-9A-HJKMNP-TV-Z]{25}$
person_id
string
required
Pattern: ^per_[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response

The person, their matched profiles, findings and every recorded decision.

Everything known about one person, and where else in the environment they appear.

person
object
required

A person and where their screening and review stand.

profiles
object[]
required

The accounts this result matched, with how each was matched.

Maximum array length: 100
findings
object[]
required

What this result flagged, most severe first, each citing its evidence.

Maximum array length: 500
posts
object[]
required

All posts retained for this result, including posts that no finding cites.

Maximum array length: 5000
media
object[]
required

All images and videos retained for this result, including media that no finding cites.

Maximum array length: 5000
reviews
object[]
required

Every recorded decision, oldest first.

Maximum array length: 1000
other_groups
object
required

The other groups of this environment that explicitly include this workspace person, newest group first. Each group keeps its own screening, band, match state and decision. Identifier similarities alone never create a membership.

lookup
object

The source records and lookup coverage retained for this result. Absent when this result contains no completed lookup.

searches
object[]

The searches people started on this person's values, newest first: each names the value, and the record and field it came from. Absent when nobody searched.

Maximum array length: 10000
evidence_restricted
boolean

True when evidence.read is explicitly denied. Submitted details, coverage, job status and decisions remain available. Collected records, profiles, findings, posts, media, discovered values and free-text decision notes are withheld.