RequestPDFsWithOptions

This method returns all of the documents in an envelope as an array of DocumentPDF (see DocumentPDF for more about the returned information). If the account has the Highlight Data Changes feature enabled and the ShowChanges option is set to true, any changes one the documents are highlighted.

Schema

Name	Schema Type	Description
EnvelopeId	DSXId	The envelope ID for the PDF documents being requested.
PDFOptions		Optional display elements for the PDFs: - ShowChanges – When set to true, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. - DocumentID – The DocumentID of the document that should be returned by the call. - CertificateLanguage – Sets the language for the Certificate of Completion in the response. The supported languages, with the language value shown in parenthesis, are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es).

Sample Request XML

SOAPAction: "http://www.docusign.net/API/3.0/RequestPDFsWithOptions"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap: Body>
    <RequestPDFsWithOptions xmlns="http://www.docusign.net/API/3.0">
      <EnvelopeID>string</EnvelopeID>
      <PDFsOptions>
        <ShowChanges>boolean</ShowChanges>
        <DocumentID>positiveInteger</DocumentID>
        <CertificateLanguage>string</CertificateLanguage>
      </PDFsOptions>
    </RequestPDFsWithOptions>
  </soap:Body>
</soap:Envelope>