API REFERENCE · SCHEMA

ScreeningSummary schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

All endpoints and schemas

idRequired: string
Format: uuid.
statusRequired: string
Values: "potential_match", "no_match".
createdAtRequired: string
Format: date-time.
subjectNameRequired: string or null
May be null.; subjectName fields and rules
Allowed alternatives
string
null
May be null.
entityTypeRequired: string or null
May be null.; entityType fields and rules
Allowed alternatives
string
null
May be null.
retentionRequired: string
Values: "standard", "minimal".
expiresAtRequired: string or null
May be null.; expiresAt fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.
originRequired: string
caseIdRequired: string or null
May be null.; caseId fields and rules
Allowed alternatives
string
Format: uuid.
null
May be null.
reviewDecisionRequired: string or null
May be null.; reviewDecision fields and rules
Allowed alternatives
string
Values: "open", "confirmed", "dismissed".
null
May be null.
reviewBusinessDispositionRequired: string or null
May be null.; reviewBusinessDisposition fields and rules
Allowed alternatives
string
Values: "pending", "allow", "restrict", "escalate".
null
May be null.
matchCountRequired: integer
Minimum: 0.
batchIdRequired: string or null
May be null.; batchId fields and rules
Allowed alternatives
string
Format: uuid.
null
May be null.
monitorIdRequired: string or null
May be null.; monitorId fields and rules
Allowed alternatives
string
Format: uuid.
null
May be null.