Docusign · Schema

EnvelopeDocument

Metadata about a document within an envelope.

AgreementsContractsDigital Transaction ManagementDocumentsElectronic SignatureseSignature

Properties

Name	Type	Description
documentId	string	The unique identifier of the document.
name	string	The name of the document.
type	string	The document type.
uri	string	URI for retrieving the document.
order	string	The order of the document in the envelope.
pages	array	Array of page objects for the document.
containsPdfFormFields	string	Whether the document contains PDF form fields.
display	string	Display setting for the document.
includeInDownload	string	Whether to include this document in downloads.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "EnvelopeDocument",
  "type": "object",
  "description": "Metadata about a document within an envelope.",
  "properties": {
    "documentId": {
      "type": "string",
      "description": "The unique identifier of the document."
    },
    "name": {
      "type": "string",
      "description": "The name of the document."
    },
    "type": {
      "type": "string",
      "description": "The document type."
    },
    "uri": {
      "type": "string",
      "description": "URI for retrieving the document."
    },
    "order": {
      "type": "string",
      "description": "The order of the document in the envelope."
    },
    "pages": {
      "type": "array",
      "description": "Array of page objects for the document."
    },
    "containsPdfFormFields": {
      "type": "string",
      "description": "Whether the document contains PDF form fields."
    },
    "display": {
      "type": "string",
      "description": "Display setting for the document."
    },
    "includeInDownload": {
      "type": "string",
      "description": "Whether to include this document in downloads."
    }
  }
}