Skip to navigation

Supplemental Documents

View as Markdown

Supplemental documents are supporting materials, such as disclosures or informational documents, that recipients can view and acknowledge but do not need to sign.

You can identify a document as supplemental by checking its display property. If the display property has a value of modal, the document is considered supplemental.

Supplemental documents use the following properties in the document object:

PropertyDescription
includeInDownloadDetermines whether the supplemental document is included in the combined document download.
displaySpecifies how the supplemental document is displayed to the recipient.
The possible values are:
  • modal
    The document appears in a modal window as a supplement action strip. Recipients can view, download, or print it. This is the recommended value for supplemental documents.
  • inline
    The document is displayed in the normal signing window. This value is typically not used for supplemental documents but is the default for all other documents.
signerMustAcknowledgeIndicates whether the signer must acknowledge the supplemental document if they do not have Approve and View tabs.

If a signer does not have Approve and View tabs, the value of the signerMustAcknowledge property determines the required interaction with the supplemental document:

signerMustAcknowledgeSigner Action
no_interactionNo action is required.
viewThe signer must view the document.
acceptThe signer must accept the document.
view_acceptThe signer must view and accept the document.
view_read_acceptThe signer must view, read, and accept the document.

If the signer has Approve and View tabs, the platform disregards the signerMustAcknowledge property and instead uses the values of these tabs to determine signer requirements:

Approve Tab is presentView Tab’s requiredRead PropertyView Tab’s required PropertySigner Action
Nofalse

(default)
false

(default)
No requirements.
NofalsetrueThe signer must view the document.
Notrue—The signer must view and read the document.
YesfalsefalseThe signer must view and accept the document.
YesfalsetrueThe signer must view and accept the document.
Yestrue—The signer must view, read, and accept the document.

Note: The requiredRead property of a Viewtab takes precedence over its required property. If requiredRead is set to true, the platform assumes required is also true.