API REFERENCE · SCHEMA
MonitorEvent 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 schemasidRequired- string
Format: uuid.
monitorIdRequired- string
Format: uuid.
monitorNameRequired- string
caseIdRequired- string or null
May be null.
caseId fields and rules
Allowed alternatives
- string
Format: uuid.
- null
May be null.
- string
screeningIdRequired- string or null
May be null.
screeningId fields and rules
Allowed alternatives
- string
Format: uuid.
- null
May be null.
- string
previousScreeningIdRequired- string or null
May be null.
previousScreeningId fields and rules
Allowed alternatives
- string
Format: uuid.
- null
May be null.
- string
kindRequired- string
Values: "initial_match", "match_added", "match_removed", "evidence_changed", "policy_changed", "baseline_unavailable", "screening_failed", "screening_overdue", "screening_recovered", "review_required".
statusRequired- string
Values: "unread", "acknowledged".
createdAtRequired- string
Format: date-time.
acknowledgedAtRequired- string or null
May be null.
acknowledgedAt fields and rules
Allowed alternatives
- string
Format: date-time.
- null
May be null.
- string
errorCodeRequired- string or null
Public screening failure code, or null when the event does not represent an error. Infrastructure details are not returned; temporarily_unavailable and screening_failed are generic fallbacks. Unknown future codes must remain a failed or incomplete check, never no_match.
May be null.
errorCode fields and rules
Allowed alternatives
- string
- null
May be null.
totalChangesRequired- integer
Total saved changes before preview limits.
Minimum: 0.
evidenceExpiredRequired- boolean
True if linked current or prior evidence is unavailable under retention; missing preview content is not proof of no change.
currentEvidenceAvailableRequired- boolean
previousEvidenceAvailableRequired- boolean
changesRequired- object[]
Bounded change previews: at most 10 per list item or 25 on detail. Use linked retained screening IDs for complete evidence.
changes item fields
Each array item: object.
changes[]Required.sourceId - string
changes[]Required.recordId - string
changes[]Required.kind - string
Values: "added", "removed", "changed".
changes[]Required.fields - string[]
changes[].fields item fields
Each array item: string.
changes[]Optional.before - object
Prior retained evidence preview; omitted when the record did not exist or prior evidence is unavailable.
View MonitorRecordPreview schema changes[].before fields and rules
See all MonitorRecordPreview fields for the complete structure, required properties and constraints.
changes[]Optional.after - object
Current retained evidence preview; omitted when the record no longer exists or current evidence is unavailable.
View MonitorRecordPreview schema changes[].after fields and rules
See all MonitorRecordPreview fields for the complete structure, required properties and constraints.