Docusign · Schema

Document

A document to be included in an envelope. Documents can be provided as base64-encoded content or by reference.

AgreementsContractsDigital Transaction ManagementDocumentsElectronic SignatureseSignature

Properties

Name	Type	Description
documentId	string	A unique identifier for the document within the envelope, assigned by the sender. Must be unique within the envelope.
name	string	The name of the document.
fileExtension	string	The file extension of the document. DocuSign uses this to determine the correct content type.
documentBase64	string	The base64-encoded content of the document.
remoteUrl	string	URL from which to retrieve the document content.
order	string	The order of the document in the envelope.
pages	string	The number of pages in the document.
display	string	Display setting for the document.
includeInDownload	string	Whether to include this document in downloads.
transformPdfFields	string	When true, DocuSign transforms PDF form fields into DocuSign tabs.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Document",
  "type": "object",
  "description": "A document to be included in an envelope. Documents can be provided as base64-encoded content or by reference.",
  "properties": {
    "documentId": {
      "type": "string",
      "description": "A unique identifier for the document within the envelope, assigned by the sender. Must be unique within the envelope."
    },
    "name": {
      "type": "string",
      "description": "The name of the document."
    },
    "fileExtension": {
      "type": "string",
      "description": "The file extension of the document. DocuSign uses this to determine the correct content type."
    },
    "documentBase64": {
      "type": "string",
      "description": "The base64-encoded content of the document."
    },
    "remoteUrl": {
      "type": "string",
      "description": "URL from which to retrieve the document content."
    },
    "order": {
      "type": "string",
      "description": "The order of the document in the envelope."
    },
    "pages": {
      "type": "string",
      "description": "The number of pages in the document."
    },
    "display": {
      "type": "string",
      "description": "Display setting for the document."
    },
    "includeInDownload": {
      "type": "string",
      "description": "Whether to include this document in downloads."
    },
    "transformPdfFields": {
      "type": "string",
      "description": "When true, DocuSign transforms PDF form fields into DocuSign tabs."
    }
  }
}