DocuSign.Api.EnvelopeDocuments.documents_get_document

You're seeing just the function documents_get_document, go back to DocuSign.Api.EnvelopeDocuments module for more information.
Link to this function

documents_get_document(connection, account_id, document_id, envelope_id, opts \\ [])

View Source

Specs

documents_get_document(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, String.t()} | {:error, Tesla.Env.t()}

Gets a document from an envelope. Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. The `{documentID}` parameter takes two special values: | Value | Description | | :--- | :--- | | `combined` | Retrieve a PDF that contains the combined content of all documents and the certificate. | | `archive` | Retrieve a ZIP archive that contains all of the PDF documents, the certificate, and any .WAV files used for voice authentication. |

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • document_id (String.t): The ID of the document being accessed.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :certificate (String.t): When set to false, the envelope signing certificate is removed from the download.
    • :encoding (String.t):
    • :encrypt (String.t): When set to true, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. The documents can be decrypted with the KeyManager Decrypt Document API.
    • :language (String.t): Specifies 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).
    • :recipient_id (String.t):
    • :show_changes (String.t): When set to true, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red.
    • :watermark (String.t): When set to true, the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark.

Returns

} on success {:error, info} on failure