Document

Object - Document#

https://schema.opencaptablecoalition.com/v/1.2.0/objects/Document.schema.json

Description: Object describing a document

Data Type: OCF Object - DOCUMENT

Composed From:

schema/primitives/objects/Object

Properties:

Property	Type	Description	Required
id	`STRING`	Identifier for the object	`REQUIRED`
comments	[`STRING`]	Unstructured text comments related to and stored for the object	-
object_type	Constant: `DOCUMENT` Defined in schema/enums/ObjectType	Object type field	`REQUIRED`
path	`STRING`	Relative path/filename for the document. Path is understood to be a relative location within an associated ZIP archive (packaged separately from the OCF archive) e.g. './acceptance_records/John_Wayne_2017_Grant_Agreement.pdf'	-
related_objects	[ schema/types/ObjectReference ]	List of objects which this document is related to	-
uri	`STRING`	Uniform resource identifier for the document if not using the `path` property and associated ZIP archive separate from the OCF package.	-
md5	schema/types/Md5	MD5 file checksum	`REQUIRED`

Source Code: schema/objects/Document

Examples:

[
  {
    "object_type": "DOCUMENT",
    "id": "test-document-minimal-with-path",
    "path": "./document1.pdf",
    "md5": "d7f1a770b4a242658565092e3005972d"
  },
  {
    "object_type": "DOCUMENT",
    "id": "test-document-minimal-with-uri",
    "uri": "https://example.com/hosted/1239342348021.pdf",
    "md5": "d7f1a770b4a242658565092e3005972d"
  },
  {
    "object_type": "DOCUMENT",
    "id": "test-document-all-fields",
    "path": "./plan_docs/2017 Stock Plan agreement.pdf",
    "related_objects": [
      {
        "object_type": "STAKEHOLDER",
        "object_id": "7b2c6f32-a2dd-475c-b7de-b44ad5e36d3d"
      },
      {
        "object_type": "TX_EQUITY_COMPENSATION_ACCEPTANCE",
        "object_id": "a8c76b10-6566-4495-817c-6ad8bbb3da72"
      }
    ],
    "md5": "d7f1a770b4a242658565092e3005972d",
    "comments": [
      "comment-one",
      "comment-two"
    ]
  }
]