API REFERENCE · SCHEMA

ArchiveDocument 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

Retained record for archive category documents. Keys retain their stored snake_case spelling. Nullable columns are included with null values. Expired records use ArchiveExpiredRecord instead; holdings can omit expired reason text.

idRequired: string
Format: uuid.
organization_idRequired: string
environmentRequired: string
case_idRequired: string
Format: uuid.
screening_idRequired: string
Format: uuid.
titleRequired: string
urlRequired: string
repositoryRequired: string
document_versionRequired: string
sha256Required: string or null
May be null.; sha256 fields and rules
Allowed alternatives
string
null
May be null.
provenanceRequired: string
verificationRequired: string
verified_atRequired: string or null
May be null.; verified_at fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.
actor_idRequired: string
created_atRequired: string
Format: date-time.
expires_atRequired: string or null
May be null.; expires_at fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.