API REFERENCE · SCHEMA

CaseGovernance 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

retentionRequired

object

retention fields and rules

retention.triggerRequired: string
Values: "review_completed", "relationship_ended", "business_event".
retention.eventAtRequired: string or null
May be null.; retention.eventAt fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.
retention.eventReasonRequired: string or null
May be null.; retention.eventReason fields and rules
Allowed alternatives
string
null
May be null.
retention.eventActorRequired: string or null
May be null.; retention.eventActor fields and rules
Allowed alternatives
string
null
May be null.
retention.closedAtRequired: string or null
May be null.; retention.closedAt fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.
retention.expiresAtRequired: string or null
May be null.; retention.expiresAt fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.

holdsRequired

object[]

holds item fields

Each array item: object.

holds[].idRequired: string
Format: uuid.
holds[].reasonRequired: string
holds[].actorIdRequired: string
holds[].createdAtRequired: string
Format: date-time.
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[].releasedByRequired: string or null
May be null.; holds[].releasedBy fields and rules
Allowed alternatives
string
null
May be null.
holds[].releaseReasonRequired: string or null
May be null.; holds[].releaseReason fields and rules
Allowed alternatives
string
null
May be null.

documentsRequired

object[]

documents item fields

Each array item: object.

documents[].idRequired: string
Format: uuid.
documents[].screeningIdRequired: 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.

documentsTruncatedRequired

boolean

documentHostsRequired

string[]

documentHosts item fields

Each array item: string.

documentRepositoriesRequired

object[]

documentRepositories item fields

Each array item: object.

documentRepositories[].nameRequired: string
documentRepositories[].urlRequired: string