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

FieldTypeReqDescription
clausesarray[Will clause]Structured clauses of a will or testamentary document — enables per-clause provenance tracking, succession regime tagging, and validating authority assignment
contentstringBase64-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.
createdAtstringTimestamp when the document was created or executed
entityIdstringThe ID of the entity this document relates to. Combined with entityType, links the document to its subject
entityTypestringThe type of entity this document relates to. Combined with entityId, creates a contextual link: 'this PDF is the valuation certificate for asset X'
fileFormatstringFile format or extension. Use lowercase without a leading dot File extension or format identifier (e.g. pdf, docx, jpg).
fileSizeBytesintegerFile size in bytes. Zero for metadata-only entries where the document content is stored externally
formalityAdmittedAtstring
formalityAdmittedBystringCourt or authority that admitted the informal document
formalityJurisdictionJurisdiction
formalityNotesstringCircumstances of informal execution
formalityStatusenumWhether the document meets strict formalities or was admitted under a curative/dispensing power Australian Succession Act s.18, BC WESA s.58
idstringUnique identifier for this document within the INHERIT document
imagesarray[Media]Scans or photographs of this document — useful when the original is a physical paper document
mimeTypestringMIME type of the document file
notesstringFree-text notes about this document. Use for provenance, authenticity concerns, or handling instructions
provenanceProvenanceConsolidated provenance metadata — how this entity was created, by whom, and whether a human has verified it
registrationsarray[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
registryReferenceobjectStructured reference to a government registry entry Japan Legal Affairs Bureau, France FCDDV, UK HMCTS Probate Registry, Singapore OPG
storageRefstringStorage reference — an S3 URI, file path, external system reference, or document management system identifier
titlestringHuman-readable title of the document
typeobjectThe 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.
formal
informal_admitted
informal_contested
holographic
nuncupative
unknown

Australian Succession Act s.18, BC WESA s.58

Get in touch

Have feedback on the schema reference? We'd love to hear from you.

Subject: Schema Reference Feedback