(Excel) DocuSign Download Envelope Document (PDF)

See more DocuSign Examples

Retrieves the specified document from the envelope. The response body of this method is the PDF file as a byte stream. You can get the file name and document ID from the response's Content-Disposition header.

For more information, see https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/get/

Download Excel Class Modules Chilkat Excel Class Modules

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

' Implements the following HTTP request:
' GET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/1

' Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
Dim jsonToken As Chilkat.JsonObject
Set jsonToken = Chilkat.NewJsonObject
' Load a previously obtained OAuth2 access token.
success = jsonToken.LoadFile("qa_data/tokens/docusign.json")
If (success = False) Then
    Debug.Print jsonToken.LastErrorText
    Exit Sub
End If

http.AuthToken = jsonToken.StringOf("access_token")

' Use your account ID and a valid envelopeId here:
Dim success As Boolean
success = http.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252")
success = http.SetUrlVar("envelopeId","90d7e40a-b4bd-4ccd-bf38-c80e37954a13")


url = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents/1"
Dim bd As Chilkat.BinData
Set bd = Chilkat.NewBinData

success = http.DownloadBd(url,bd)
If (success = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If


respStatusCode = http.LastStatus
Debug.Print "Response Status Code = "; respStatusCode
If (respStatusCode <> 200) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastResponseHeader
    ' The response body contains an error message.
    Debug.Print bd.GetString("utf-8")
    Debug.Print "Failed."
    Exit Sub
End If

' The response indicated success.
' Get the filename from the Content-Disposition header and save to a file.
Dim mime As Chilkat.Mime
Set mime = Chilkat.NewMime
success = mime.LoadMime(http.LastResponseHeader)


filename = mime.GetHeaderFieldAttribute("Content-Disposition","filename")
Debug.Print "filename = "; filename

Dim sbPath As Chilkat.StringBuilder
Set sbPath = Chilkat.NewStringBuilder
success = sbPath.Append("C:/aaworkarea/")
success = sbPath.Append(filename)
success = bd.WriteFile(sbPath.GetAsString())
If (success = False) Then
    Debug.Print "Failed to save to output file."
Else
    Debug.Print "Wrote "; sbPath.GetAsString()
End If