Document
A document associated with an estate — wills, codicils, trust deeds, and other legal documents. Extension types use the x-inherit- prefix for jurisdiction-specific or religious document types
A document associated with an estate — wills, codicils, trust deeds, and other legal documents. Extension types use the x-inherit- prefix for jurisdiction-specific or religious document types
Required fields
idtypetitle
Fields
| Field | Type | Req | Description |
|---|---|---|---|
| clauses | array[Will clause] | Structured clauses of a will or testamentary document — enables per-clause provenance tracking, succession regime tagging, and validating authority assignment | |
| content | string | Base64-encoded file content for self-contained documents. Use for small, critical files (wills, certificates, attestations) that must travel with the estate plan. For large files, use storageRef instead Enables fully self-contained INHERIT documents per the data product model (data + structure + meaning + context in one artefact). Archival-safe: no external URL dependencies. Size limit ~7.5MB decoded (10MB base64). The mimeType field describes the decoded content type. | |
| createdAt | string | Timestamp when the document was created or executed | |
| entityId | string | The ID of the entity this document relates to. Combined with entityType, links the document to its subject | |
| entityType | string | The type of entity this document relates to. Combined with entityId, creates a contextual link: 'this PDF is the valuation certificate for asset X' | |
| fileFormat | string | File format or extension. Use lowercase without a leading dot File extension or format identifier (e.g. pdf, docx, jpg). | |
| fileSizeBytes | integer | File size in bytes. Zero for metadata-only entries where the document content is stored externally | |
| formalityAdmittedAt | string | ||
| formalityAdmittedBy | string | Court or authority that admitted the informal document | |
| formalityJurisdiction | Jurisdiction | ||
| formalityNotes | string | Circumstances of informal execution | |
| formalityStatus | enum | Whether the document meets strict formalities or was admitted under a curative/dispensing power Australian Succession Act s.18, BC WESA s.58 | |
| id | string | Unique identifier for this document within the INHERIT document | |
| images | array[Media] | Scans or photographs of this document — useful when the original is a physical paper document | |
| mimeType | string | MIME type of the document file | |
| notes | string | Free-text notes about this document. Use for provenance, authenticity concerns, or handling instructions | |
| provenance | Provenance | Consolidated provenance metadata — how this entity was created, by whom, and whether a human has verified it | |
| registrations | array[object] | Registries where this document has been registered. Tracks will registration with services such as the National Will Register (England & Wales) or the Register of Deeds (Scotland). Maps to Schema.org RegisterAction | |
| registryReference | object | Structured reference to a government registry entry Japan Legal Affairs Bureau, France FCDDV, UK HMCTS Probate Registry, Singapore OPG | |
| storageRef | string | Storage reference — an S3 URI, file path, external system reference, or document management system identifier | |
| title | string | Human-readable title of the document | |
| type | object | The type of document. Core types cover common law and civil law documents. Extension types use the x-inherit- prefix anyOf: first branch validates core types via closed enum. Second branch allows extension types matching ^x-inherit-.+$ pattern. |
Before you get in touch
These resources may answer your question straight away.
Get in touch
Have feedback on the schema reference? We'd love to hear from you.
Subject: Schema Reference Feedback