Skip to navigation

Sending Group Document

View as Markdown

This element contains the details of the documents in the envelope.

Schema

NameSchema TypeDescription
IDLocalIdThe unique ID for the document in the specific envelope.
NameLongStringThe name of the document. This can be a maximum of 100 characters.
PDFBytesbase64BinaryThe document byte stream
PasswordPasswordThis is a legacy field and no longer used.
TransformPdfFieldsBooleanOptional element. When set to true PDF form field data will be transformed into document tab values when the PDF form field name matches the Docusign custom tab TabLabel. The resulting PDF form data will also be returned in the PDF meta data when requesting the document PDF.

Note: Docusign will not transform PDF form fields that have the text “DocusignIgnoreTransform” or “eSignIgnoreTransform” as part of the name of the PDF form field.
FileExtensionStringOptional element. File extension of the document. If the document is non-PDF it will be converted to PDF.
MatchBoxesStringOptional element. Only used when uploading and editing templates. Matchboxes are used to define areas in a document for document matching when creating envelopes.

The Matchbox schema is defined in the Request Template section.
AttachmentDescriptionLongStringOptional element. If present, indicates signer will be attaching a document here.
DocumentFieldsArrayOfDocumentFieldOptional element that allows the sender to add custom data to a document. This information is returned with status and template requests, but otherwise not used by Docusign.

Each DocumentField in the array contains the elements:

Name – A string that can be a maximum of 50 characters.

Value – A string that can be a maximum of 200 characters.