API REFERENCE · SCHEMA

AuditPacket 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

formatRequired

"sanctionskit-case-audit@1"

Must equal "sanctionskit-case-audit@1".

generatedAtRequired

string

Format: date-time.

environmentRequired

string

Values: "sandbox", "production".

investigationRequired

object

investigation fields and rules

investigation.idRequired

string

Format: uuid.

investigation.screeningIdRequired

string

Format: uuid.

investigation.counterpartyIdRequired

string or null

May be null.

investigation.counterpartyId fields and rules

Allowed alternatives

string
Format: uuid.
null
May be null.

investigation.decisionRequired

string

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

investigation.revisionRequired

integer

Minimum: 0.

investigation.assigneeIdRequired

string or null

May be null.

investigation.assigneeId fields and rules

Allowed alternatives

string
null
May be null.

investigation.priorityRequired

string

investigation.dueAtRequired

string or null

May be null.

investigation.dueAt fields and rules

Allowed alternatives

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

investigation.escalatedAtRequired

string or null

May be null.

investigation.escalatedAt fields and rules

Allowed alternatives

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

investigation.requiresSecondReviewRequired

boolean

investigation.reviewStateRequired

string

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

investigation.businessDispositionRequired

string

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

investigation.reviewStartedAtRequired

string

Format: date-time.

investigation.supersededByScreeningIdRequired

string or null

May be null.

investigation.supersededByScreeningId fields and rules

Allowed alternatives

string
Format: uuid.
null
May be null.

investigation.supersededByCaseIdRequired

string or null

May be null.

investigation.supersededByCaseId fields and rules

Allowed alternatives

string
Format: uuid.
null
May be null.

investigation.approvalRequiredByPolicyRequired

boolean

investigation.approvalRequiredForActionsRequired

string[]

investigation.approvalRequiredForActions item fields

Each array item: string.

investigation.approverRolesRequired

string[]

investigation.approverRoles item fields

Each array item: string.

investigation.reviewConcernRequired

string or null

May be null.

investigation.reviewConcern fields and rules

Allowed alternatives

string
null
May be null.

investigation.policyContextRequired

object or null

May be null.

investigation.policyContext fields and rules

Allowed alternatives

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

investigation.decisionHistoryRequired

object[]

investigation.decisionHistory item fields

Each array item: object.

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

investigation.decisionHistoryTruncatedRequired

boolean

investigation.checksRequired

object[]

investigation.checks item fields

Each array item: object.

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

investigation.checkHistoryRequired

object[]

investigation.checkHistory item fields

Each array item: object.

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

investigation.reuseChallengesRequired

object[]

investigation.reuseChallenges item fields

Each array item: object.

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

investigation.submittedByRequired

string or null

May be null.

investigation.submittedBy fields and rules

Allowed alternatives

string
null
May be null.

investigation.approvedByRequired

string or null

May be null.

investigation.approvedBy fields and rules

Allowed alternatives

string
null
May be null.

investigation.matchesRequired

object[]

investigation.matches item fields

Each array item: object.

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

investigation.subjectRequired

Subject or null

May be null.

investigation.subject fields and rules

Allowed alternatives

Subject
See all Subject fields for the complete structure, required properties and constraints.
null
May be null.

investigation.originCorrectionRequired

object or null

May be null.

investigation.originCorrection fields and rules

Allowed alternatives

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

investigation.evidenceRequired

object[]

investigation.evidence item fields

Each array item: object.

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

investigation.correctionsRequired

object[]

investigation.corrections item fields

Each array item: object.

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

investigation.reviewHistoryRequired

object[]

investigation.reviewHistory item fields

Each array item: object.

investigation.reviewHistory[].idRequired

string

Format: uuid.

investigation.reviewHistory[].screeningIdRequired

string

Format: uuid.

investigation.reviewHistory[].sourceIdRequired

string

investigation.reviewHistory[].recordIdRequired

string

investigation.reviewHistory[].reviewRequired

object

investigation.reviewHistory[].review fields and rules

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

investigation.reviewHistory[].replacedByRequired

string

investigation.reviewHistory[].reasonRequired

string

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

investigation.reviewHistory[].createdAtRequired

string

Format: date-time.

investigation.reviewHistory[].expiresAtRequired

string or null

May be null.

investigation.reviewHistory[].expiresAt fields and rules

Allowed alternatives

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

investigation.commentsRequired

object[]

investigation.comments item fields

Each array item: object.

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

investigation.attachmentsRequired

object[]

investigation.attachments item fields

Each array item: object.

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

evidenceRequired

object[]

evidence item fields

Each array item: object.

evidence[].idRequired: string
Format: uuid.
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.
evidence[].expiredRequired: boolean
evidence[].subjectRequired: Subject or null
May be null.; evidence[].subject fields and rules
Allowed alternatives
Subject
See all Subject fields for the complete structure, required properties and constraints.
null
May be null.
evidence[].resultRequired: ScreeningResult or null
May be null.; evidence[].result fields and rules
Allowed alternatives
ScreeningResult
See all ScreeningResult fields for the complete structure, required properties and constraints.
null
May be null.

decisionsRequired

object[]

decisions item fields

Each array item: object.

decisions[].idRequired: string
Format: uuid.
decisions[].actorIdRequired: string
decisions[].decisionRequired: string
decisions[].businessDispositionRequired: string
Values: "pending", "allow", "restrict", "escalate".
decisions[].appliedControlsRequired: AppliedDecisionControls or null
May be null.; decisions[].appliedControls fields and rules
Allowed alternatives
AppliedDecisionControls
See all AppliedDecisionControls fields for the complete structure, required properties and constraints.
null
May be null.
decisions[].notesRequired: string or null
May be null.; decisions[].notes fields and rules
Allowed alternatives
string
null
May be null.
decisions[].createdAtRequired: string
Format: date-time.
decisions[].screeningIdRequired: string or null
May be null.; decisions[].screeningId fields and rules
Allowed alternatives
string
Format: uuid.
null
May be null.
decisions[].evidenceExpiredRequired: boolean

attachmentsRequired

object[]

attachments item fields

Each array item: object.

attachments[].idRequired: string
Format: uuid.
attachments[].titleRequired: string
attachments[].sha256Required: string
attachments[].contentRequired: string
attachments[].createdAtRequired: string
Format: date-time.

documentsRequired

object[]

documents item fields

Each array item: object.

documents[].idRequired: string
Format: uuid.
documents[].titleRequired: string
documents[].urlRequired: string
documents[].repositoryRequired: string
documents[].documentVersionRequired: string
documents[].sha256Required: string or null
May be null.; documents[].sha256 fields and rules
Allowed alternatives
string
null
May be null.
documents[].provenanceRequired: string
documents[].verificationRequired: string
Values: "unverified", "reviewer_verified".
documents[].verifiedAtRequired: string or null
May be null.; documents[].verifiedAt fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.
documents[].actorIdRequired: string
documents[].createdAtRequired: string
Format: date-time.

holdsRequired

object[]

holds item fields

Each array item: object.

holds[].idRequired: string
Format: uuid.
holds[].reasonRequired: string
holds[].untilRequired: string or null
May be null.; holds[].until fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.
holds[].releasedAtRequired: string or null
May be null.; holds[].releasedAt fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.
holds[].releasedByOptional: string or null
May be null.; holds[].releasedBy fields and rules
Allowed alternatives
string
null
May be null.
holds[].releaseReasonOptional: string or null
May be null.; holds[].releaseReason fields and rules
Allowed alternatives
string
null
May be null.

limitationsRequired

string[]

limitations item fields

Each array item: string.