Docusign Retrieve Envelope Documents

• encryptstring
  A boolean parameter that, when set to true, encrypts the PDF bytes returned in the response for all key managers configured on the DocuSign account. The encrypted documents can be decrypted using the Key Manager DecryptDocument API method. This optional parameter enhances docume…
• encodingstring
  This parameter is reserved for DocuSign"s internal use. Its specific function is not detailed in the provided schema.
• languagestring
  Specifies the language for the Certificate of Completion in the response. Optional parameter that accepts language codes such as "en" for English US, "fr" for French, "de" for German, etc. Supported languages include Chinese (Simplified and Traditional), Dutch, English, French,…
• accountIdstring
  The external account number (integer) or account ID GUID. This parameter is required and identifies the DocuSign account from which to retrieve the envelope documents.
• watermarkstring
  A boolean parameter that controls the application of watermarks. When set to true, and if the account has the watermark feature enabled and the envelope is not complete, the account"s watermark is added to the PDF documents. This optional parameter can be used to remove the wate…
• documentIdstring

  Required
  The ID of the document to retrieve. This required parameter can be either a specific document ID or one of the following special keywords: "combined" (retrieves all documents as a single PDF), "archive" (retrieves a ZIP archive of all documents), "certificate" (retrieves only th…
• envelopeIdstring

  Required
  The envelope"s GUID (Globally Unique Identifier). This required parameter specifies the exact envelope from which to retrieve documents. It should be in the format of a UUID, e.g., "93be49ab-xxxx-xxxx-xxxx-f752070d71ec".
• certificatestring
  A boolean parameter used only when "documentId" is set to "combined". When true, the certificate of completion is included in the combined PDF file. When false (default), it is not included. This optional parameter allows control over the inclusion of the completion certificate…
• recipient_idstring
  Allows the sender to retrieve documents as one of the recipients they control. This optional parameter works only when "documents_by_userid" is set to false. It"s useful for viewing documents from a specific recipient"s perspective.
• show_changesstring
  A boolean parameter that, when set to true, highlights any changed fields in yellow and outlines optional signatures or initials in red in the returned PDF. This optional feature requires the account to have the "Highlight Data Changes" feature enabled.
• shared_user_idstring
  The ID of a shared user to impersonate for document retrieval. This optional parameter is used in the context of a shared inbox, specifically when envelopes are shared from one user to another through the DocuSign Admin console.
• documents_by_useridstring
  A boolean parameter that, when set to true, allows recipients to get documents by their user ID. This is particularly useful when a user is included in multiple routing orders with different visibilities, as it returns all documents from all relevant routing orders. Optional par…

• data

  Required
  Data from the action execution
• errorstring
  Error if any occurred during the execution of the action
• successfulboolean

  Required
  Whether or not the action execution was successful or not

No verified related use cases are linked yet.

No published Skills explicitly reference this Action yet.