API REFERENCE · SCHEMA

Investigation 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.

screeningIdRequired

string

Format: uuid.

counterpartyIdRequired

string or null

May be null.

counterpartyId fields and rules

Allowed alternatives

string
Format: uuid.
null
May be null.

decisionRequired

string

Values: "open", "confirmed", "dismissed".

revisionRequired

integer

Minimum: 0.

assigneeIdRequired

string or null

May be null.

assigneeId fields and rules

Allowed alternatives

string
null
May be null.

priorityRequired

string

Values: "low", "normal", "high", "urgent".

dueAtRequired

string or null

May be null.

dueAt fields and rules

Allowed alternatives

string
Format: date-time.
null
May be null.

escalatedAtRequired

string or null

May be null.

escalatedAt fields and rules

Allowed alternatives

string
Format: date-time.
null
May be null.

requiresSecondReviewRequired

boolean

reviewStateRequired

string

Values: "open", "pending_approval", "approved", "superseded".

businessDispositionRequired

string

Values: "pending", "allow", "restrict", "escalate".

reviewStartedAtRequired

string

Format: date-time.

supersededByScreeningIdRequired

string or null

May be null.

supersededByScreeningId fields and rules

Allowed alternatives

string
Format: uuid.
null
May be null.

supersededByCaseIdRequired

string or null

May be null.

supersededByCaseId fields and rules

Allowed alternatives

string
Format: uuid.
null
May be null.

approvalRequiredByPolicyRequired

boolean

approvalRequiredForActionsRequired

string[]

approvalRequiredForActions item fields

Each array item: string.

approverRolesRequired

string[]

approverRoles item fields

Each array item: string.

reviewConcernRequired

string or null

May be null.

reviewConcern fields and rules

Allowed alternatives

string
null
May be null.

policyContextRequired

object or null

May be null.

policyContext fields and rules

Allowed alternatives

Provide policyContext.id and policyContext.version and policyContext.name and policyContext.purpose and policyContext.exclusions.
policyContext.idRequired
string
Format: uuid.
policyContext.versionRequired
integer
Minimum: 0.
policyContext.nameRequired
string
policyContext.purposeRequired
string
policyContext.exclusionsRequired
string[]
policyContext.exclusions item fields
Each array item: string.
null
May be null.

decisionHistoryRequired

object[]

decisionHistory item fields

Each array item: object.

decisionHistory[].idRequired: string
Format: uuid.
decisionHistory[].screeningIdRequired: string or null
May be null.; decisionHistory[].screeningId fields and rules
Allowed alternatives
string
Format: uuid.
null
May be null.
decisionHistory[].decisionRequired: string
Values: "open", "confirmed", "dismissed".
decisionHistory[].businessDispositionRequired: string or null
May be null.; decisionHistory[].businessDisposition fields and rules
Allowed alternatives
string
Values: "pending", "allow", "restrict", "escalate".
null
May be null.
decisionHistory[].rationaleRequired: string or null
May be null.; decisionHistory[].rationale fields and rules
Allowed alternatives
string
null
May be null.
decisionHistory[].actorIdRequired: string
decisionHistory[].actorLabelRequired: string or null
May be null.; decisionHistory[].actorLabel fields and rules
Allowed alternatives
string
null
May be null.
decisionHistory[].createdAtRequired: string
Format: date-time.
decisionHistory[].appliedControlsRequired: AppliedDecisionControls or null
May be null.; decisionHistory[].appliedControls fields and rules
Allowed alternatives
AppliedDecisionControls
See all AppliedDecisionControls fields for the complete structure, required properties and constraints.
null
May be null.

decisionHistoryTruncatedRequired

boolean

checksRequired

object[]

checks item fields

Each array item: object.

checks[].labelRequired: string
checks[].instructionsOptional: string
checks[].evidenceExampleOptional: string
checks[].reviewConcernOptional: string
checks[].statusRequired: string
Values: "outstanding", "completed_externally", "not_applicable".
checks[].evidenceReferenceRequired: string
checks[].rationaleRequired: string
checks[].actorIdRequired: string or null
May be null.; checks[].actorId fields and rules
Allowed alternatives
string
null
May be null.
checks[].updatedAtRequired: string or null
May be null.; checks[].updatedAt fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.

checkHistoryRequired

object[]

checkHistory item fields

Each array item: object.

checkHistory[].idRequired: string
Format: uuid.
checkHistory[].screeningIdRequired: string
Format: uuid.
checkHistory[].labelRequired: string
checkHistory[].statusRequired: string
Values: "outstanding", "completed_externally", "not_applicable".
checkHistory[].evidenceReferenceRequired: string
checkHistory[].rationaleRequired: string
checkHistory[].actorIdRequired: string
checkHistory[].updatedAtRequired: string
Format: date-time.
checkHistory[].expiresAtRequired: string or null
May be null.; checkHistory[].expiresAt fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.

reuseChallengesRequired

object[]

reuseChallenges item fields

Each array item: object.

reuseChallenges[].ruleIdRequired: string
reuseChallenges[].originCaseIdRequired: string
reuseChallenges[].challengedByCaseIdRequired: string
reuseChallenges[].actorIdRequired: string
reuseChallenges[].revokedAtRequired: string
Format: date-time.
reuseChallenges[].affectedCaseIdsRequired: string[]; reuseChallenges[].affectedCaseIds item fields
Each array item: string.

submittedByRequired

string or null

May be null.

submittedBy fields and rules

Allowed alternatives

string
null
May be null.

approvedByRequired

string or null

May be null.

approvedBy fields and rules

Allowed alternatives

string
null
May be null.

matchesRequired

object[]

matches item fields

Each array item: object.

matches[].idRequired

string

Format: uuid.

matches[].screeningIdRequired

string

Format: uuid.

matches[].sourceIdRequired

string

matches[].recordIdRequired

string

matches[].identityDecisionRequired

string

Values: "unresolved", "same", "different".

matches[].businessDecisionRequired

string

Values: "pending", "allow", "restrict", "escalate".

matches[].rationaleRequired

string

matches[].reusableUntilRequired

string or null

May be null.

matches[].reusableUntil fields and rules

Allowed alternatives

string
Format: date-time.
null
May be null.

matches[].reusedRuleIdRequired

string or null

May be null.

matches[].reusedRuleId fields and rules

Allowed alternatives

string
Format: uuid.
null
May be null.

matches[].actorIdRequired

string

matches[].updatedAtRequired

string

Format: date-time.

matches[].reuseOptional

object

matches[].reuse fields and rules

matches[].reuse.caseIdRequired: string
Format: uuid.
matches[].reuse.screeningIdRequired: string
Format: uuid.
matches[].reuse.approvedByRequired: string
matches[].reuse.expiresAtRequired: string
Format: date-time.
matches[].reuse.revokedAtRequired: string or null
May be null.; matches[].reuse.revokedAt fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.

subjectRequired

Subject or null

May be null.

subject fields and rules

Allowed alternatives

Subject
subject.nameRequired
string
Name to compare with publisher records. Leading and trailing whitespace is removed; provide the fullest reliable name available.
Minimum length: 2. Maximum length: 300.
subject.entityTypeOptional
string
Type of subject. Defaults to person when omitted. Every selected source must support this type.
Values: "person", "organization", "vessel", "aircraft", "other". Default: "person".
subject.identifiersOptional
object[]
Typed identifiers used for exact matching, such as passport, national_id, registration, lei, imo or mmsi. Defaults to an empty array. Use the publisher’s identifier scheme; custom scheme names are accepted.
Maximum items: 20. Default: [].
subject.identifiers item fields
Each array item: object.
subject.identifiers[].typeRequired
string
Identifier scheme, such as passport, national_id, registration, lei, imo or mmsi. Matching normalizes supported scheme aliases.
Minimum length: 1. Maximum length: 80.
subject.identifiers[].valueRequired
string
Identifier value. Send the original value; scheme-specific normalization is applied during matching.
Minimum length: 1. Maximum length: 160.
subject.identifiers[].issuerOptional
string
Optional issuing authority or country. Omit when unknown; do not send null.
Minimum length: 1. Maximum length: 100.
Additional fields are not accepted.
subject.birthDateOptional
string
Known date or partial date: YYYY, YYYY-MM or YYYY-MM-DD. Preserve known precision; do not invent a month or day. Year 0000 and invalid dates are rejected.
subject.birthDate fields and rules
Allowed alternatives
string
Pattern: ^(?!0000)\d{4}$.
string
Pattern: ^(?!0000)\d{4}-(0[1-9]|1[0-2])$.
string
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$.
Pattern: ^(?!0000).
subject.countryOptional
string
Known country name or code used as supporting identity evidence. It is not a source-selection or geographic coverage filter.
Minimum length: 2. Maximum length: 100.
Additional fields are not accepted.
null
May be null.

counterpartySubjectRequired

Subject or null

May be null.

counterpartySubject fields and rules

Allowed alternatives

Subject
counterpartySubject.nameRequired
string
Name to compare with publisher records. Leading and trailing whitespace is removed; provide the fullest reliable name available.
Minimum length: 2. Maximum length: 300.
counterpartySubject.entityTypeOptional
string
Type of subject. Defaults to person when omitted. Every selected source must support this type.
Values: "person", "organization", "vessel", "aircraft", "other". Default: "person".
counterpartySubject.identifiersOptional
object[]
Typed identifiers used for exact matching, such as passport, national_id, registration, lei, imo or mmsi. Defaults to an empty array. Use the publisher’s identifier scheme; custom scheme names are accepted.
Maximum items: 20. Default: [].
counterpartySubject.identifiers item fields
Each array item: object.
counterpartySubject.identifiers[].typeRequired
string
Identifier scheme, such as passport, national_id, registration, lei, imo or mmsi. Matching normalizes supported scheme aliases.
Minimum length: 1. Maximum length: 80.
counterpartySubject.identifiers[].valueRequired
string
Identifier value. Send the original value; scheme-specific normalization is applied during matching.
Minimum length: 1. Maximum length: 160.
counterpartySubject.identifiers[].issuerOptional
string
Optional issuing authority or country. Omit when unknown; do not send null.
Minimum length: 1. Maximum length: 100.
Additional fields are not accepted.
counterpartySubject.birthDateOptional
string
Known date or partial date: YYYY, YYYY-MM or YYYY-MM-DD. Preserve known precision; do not invent a month or day. Year 0000 and invalid dates are rejected.
counterpartySubject.birthDate fields and rules
Allowed alternatives
string
Pattern: ^(?!0000)\d{4}$.
string
Pattern: ^(?!0000)\d{4}-(0[1-9]|1[0-2])$.
string
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$.
Pattern: ^(?!0000).
counterpartySubject.countryOptional
string
Known country name or code used as supporting identity evidence. It is not a source-selection or geographic coverage filter.
Minimum length: 2. Maximum length: 100.
Additional fields are not accepted.
null
May be null.

counterpartyRevisionRequired

integer or null

May be null.

counterpartyRevision fields and rules

Allowed alternatives

integer
Minimum: 0.
null
May be null.

originCorrectionRequired

object or null

May be null.

originCorrection fields and rules

Allowed alternatives

Provide originCorrection.caseId and originCorrection.screeningId.
originCorrection.caseIdRequired
string
Format: uuid.
originCorrection.screeningIdRequired
string
Format: uuid.
null
May be null.

evidenceRequired

object[]

evidence item fields

Each array item: object.

evidence[].idRequired: string
Format: uuid.
evidence[].screeningIdRequired: string
Format: uuid.
evidence[].sourceIdRequired: string
evidence[].recordIdRequired: string
evidence[].fieldRequired: string
evidence[].valueRequired: string
evidence[].sourceReferenceRequired: string
evidence[].verificationRequired: string
Values: "unverified", "verified".
evidence[].comparisonRequired: string
Values: "agrees", "conflicts", "unknown".
evidence[].notesRequired: string
evidence[].contentRequired: string
evidence[].actorIdRequired: string
evidence[].createdAtRequired: string
Format: date-time.
evidence[].expiresAtRequired: string or null
May be null.; evidence[].expiresAt fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.

correctionsRequired

object[]

corrections item fields

Each array item: object.

corrections[].idRequired: string
Format: uuid.
corrections[].screeningIdRequired: string
Format: uuid.
corrections[].resultScreeningIdRequired: string
Format: uuid.
corrections[].resultCaseIdRequired: string or null
May be null.; corrections[].resultCaseId fields and rules
Allowed alternatives
string
Format: uuid.
null
May be null.
corrections[].beforeRequired: objectView Subject schema; corrections[].before fields and rules
See all Subject fields for the complete structure, required properties and constraints.
corrections[].afterRequired: objectView Subject schema; corrections[].after fields and rules
See all Subject fields for the complete structure, required properties and constraints.
corrections[].reasonRequired: string
corrections[].actorIdRequired: string
corrections[].createdAtRequired: string
Format: date-time.
corrections[].expiresAtRequired: string or null
May be null.; corrections[].expiresAt fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.

reviewHistoryRequired

object[]

reviewHistory item fields

Each array item: object.

reviewHistory[].idRequired

string

Format: uuid.

reviewHistory[].screeningIdRequired

string

Format: uuid.

reviewHistory[].sourceIdRequired

string

reviewHistory[].recordIdRequired

string

reviewHistory[].reviewRequired

object

reviewHistory[].review fields and rules

reviewHistory[].review.idRequired: string
Format: uuid.
reviewHistory[].review.screeningIdRequired: string
Format: uuid.
reviewHistory[].review.sourceIdRequired: string
reviewHistory[].review.recordIdRequired: string
reviewHistory[].review.identityDecisionRequired: string
reviewHistory[].review.businessDecisionRequired: string
reviewHistory[].review.rationaleRequired: string
reviewHistory[].review.reusableUntilRequired: string or null
May be null.; reviewHistory[].review.reusableUntil fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.
reviewHistory[].review.reusedRuleIdRequired: string or null
May be null.; reviewHistory[].review.reusedRuleId fields and rules
Allowed alternatives
string
Format: uuid.
null
May be null.
reviewHistory[].review.actorIdRequired: string
reviewHistory[].review.updatedAtRequired: string
Format: date-time.

reviewHistory[].replacedByRequired

string

reviewHistory[].reasonRequired

string

Values: "decision_updated", "evidence_added", "subject_corrected", "rule_challenged".

reviewHistory[].createdAtRequired

string

Format: date-time.

reviewHistory[].expiresAtRequired

string or null

May be null.

reviewHistory[].expiresAt fields and rules

Allowed alternatives

string
Format: date-time.
null
May be null.

commentsRequired

object[]

comments item fields

Each array item: object.

comments[].idRequired: string
Format: uuid.
comments[].bodyRequired: string
comments[].actorIdRequired: string
comments[].createdAtRequired: string
Format: date-time.

attachmentsRequired

object[]

attachments item fields

Each array item: object.

attachments[].idRequired: string
Format: uuid.
attachments[].titleRequired: string
attachments[].sha256Required: string
attachments[].sizeRequired: integer
Minimum: 0.
attachments[].actorIdRequired: string
attachments[].createdAtRequired: string
Format: date-time.
attachments[].expiresAtRequired: string or null
May be null.; attachments[].expiresAt fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.

assigneesRequired

object[]

assignees item fields

Each array item: object.

assignees[].idRequired: string
assignees[].emailRequired: string
assignees[].roleRequired: string