Skip to main content
PUT
Record a decision on a screening hit
Pro+ tier Records the team’s decision on a hit: truePositive, falsePositive, escalated or noMatch, or pending to undo it. Requires the pep scope on the API key. The decision follows the person or company into later screenings until the list updates the entry. See Reviewing hits.

Authorizations

x-api-key
string
header
required

Path Parameters

screeningId
string<uuid>
required

The screening's id

hitId
integer<int32>
required

The hit's id

Body

resolution
enum<string>
Available options:
pending,
truePositive,
falsePositive,
escalated,
noMatch
comment
null | string

Response

The hit with its decision

hitId
integer<int32>
category
enum<string>
Available options:
other,
pep,
sanction,
adverseMedia,
regulatoryWarning
name
null | string
birthDate
null | string
isEntity
boolean
sourceName
null | string
listType
null | string
externalId
null | string
hitRating
integer<int32>
nameMatchScore
null | number<double>
tier
null | integer<int32>
matchedVia
enum<string>
Available options:
primary,
otherIdentityNumber,
otherFamilyName,
previousName,
givenNameVariant,
alternativeBirthDate,
otherCompanyName,
supplied
isNew
boolean
resolution
enum<string>
Available options:
pending,
truePositive,
falsePositive,
escalated,
noMatch
resolvedAtUtc
null | string<date-time>
resolutionComment
null | string
listEntryUpdatedAtUtc
null | string<date-time>