VB.NET

DocuSign: Requesting a Signature via Email (Remote Signing)

See more DocuSign Examples

This code example demonstrates the simplest and quickest workflow for requesting a signature for a document via email. The email will contain a signing link the recipient can use to electronically sign a document from their mobile or desktop computer. VB.NET

Dim success As Boolean = False

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

Dim http As New Chilkat.Http

' Implements the following CURL command:

' curl --request POST https://demo.docusign.net/restapi/v2.1/accounts/${accountId}/envelopes \
'      --header "Authorization: Bearer ${accessToken}" \
'      --header "Content-Type: application/json" \
'      --data '{
'     "emailSubject": "Please sign this document",
'     "documents": [
'         {
'             "documentBase64": "JVBERi0xLjMKMyAwIG9iag ... dGFydHhyZWYKNjk5CiUlRU9GCg==",
'             "name": "Lorem Ipsum",
'             "fileExtension": "pdf",
'             "documentId": "1"
'         }
'     ],
'     "recipients": {
'         "signers": [
'             {
'                 "email": "joe_sample@example.com",
'                 "name": "Joe Sample",
'                 "recipientId": "1",
'                 "routingOrder": "1",
'                 "tabs": {
'                     "signHereTabs": [
'                         {
'                             "documentId": "1", "pageNumber": "1",
'                             "recipientId": "1", "tabLabel": "SignHereTab",
'                             "xPosition": "195", "yPosition": "147"
'                         }
'                     ]
'                 }
'             }
'         ]
'     },
'     "status": "sent"
' }'

' Use this online tool to generate code from sample JSON:
' Generate Code to Create JSON

' The following JSON is sent in the request body.

' {
'   "emailSubject": "Please sign this document",
'   "documents": [
'     {
'       "documentBase64": "JVBERi0xLjMKMyAwIG9iag ... dGFydHhyZWYKNjk5CiUlRU9GCg==",
'       "name": "Lorem Ipsum",
'       "fileExtension": "pdf",
'       "documentId": "1"
'     }
'   ],
'   "recipients": {
'     "signers": [
'       {
'         "email": "joe_sample@example.com",
'         "name": "Joe Sample",
'         "recipientId": "1",
'         "routingOrder": "1",
'         "tabs": {
'           "signHereTabs": [
'             {
'               "documentId": "1",
'               "pageNumber": "1",
'               "recipientId": "1",
'               "tabLabel": "SignHereTab",
'               "xPosition": "195",
'               "yPosition": "147"
'             }
'           ]
'         }
'       }
'     ]
'   },
'   "status": "sent"
' }

' Load a PDF to be signed.
Dim pdfData As New Chilkat.BinData
success = pdfData.LoadFile("qa_data/pdf/helloWorld.pdf")
If (success = False) Then
    Debug.WriteLine("Failed to load local PDF file.")
    Exit Sub
End If


Dim json As New Chilkat.JsonObject
json.UpdateString("emailSubject","Please sign this document")
json.UpdateString("documents[0].documentBase64",pdfData.GetEncoded("base64"))
json.UpdateString("documents[0].name","Lorem Ipsum")
json.UpdateString("documents[0].fileExtension","pdf")
json.UpdateString("documents[0].documentId","1")
json.UpdateString("recipients.signers[0].email","joe_sample@example.com")
json.UpdateString("recipients.signers[0].name","Joe Sample")
json.UpdateString("recipients.signers[0].recipientId","1")
json.UpdateString("recipients.signers[0].routingOrder","1")
json.UpdateString("recipients.signers[0].tabs.signHereTabs[0].documentId","1")
json.UpdateString("recipients.signers[0].tabs.signHereTabs[0].pageNumber","1")
json.UpdateString("recipients.signers[0].tabs.signHereTabs[0].recipientId","1")
json.UpdateString("recipients.signers[0].tabs.signHereTabs[0].tabLabel","SignHereTab")
json.UpdateString("recipients.signers[0].tabs.signHereTabs[0].xPosition","195")
json.UpdateString("recipients.signers[0].tabs.signHereTabs[0].yPosition","147")
json.UpdateString("status","sent")

' Get our previously obtained OAuth2 access token, which should contain JSON like this:
' {
'   "access_token": "eyJ0eXA....YQyig",
'   "token_type": "Bearer",
'   "refresh_token": "eyJ0eXA....auE3eHKg",
'   "expires_in": 28800
' }

Dim jsonToken As New Chilkat.JsonObject
success = jsonToken.LoadFile("qa_data/tokens/docusign.json")

Dim sbAuth As New Chilkat.StringBuilder
sbAuth.Append("Bearer ")
sbAuth.Append(jsonToken.StringOf("access_token"))

http.SetRequestHeader("Authorization",sbAuth.GetAsString())
http.SetRequestHeader("Content-Type","application/json")

' Don't forget to modify this line to use your account ID
Dim resp As New Chilkat.HttpResponse
success = http.HttpJson("POST","https://demo.docusign.net/restapi/v2.1/accounts/${accountId}/envelopes",json,"application/json",resp)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(resp.Header)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "envelopeId": "d51cfdab-22ed-4832-bf68-446c44077ffc",
'   "uri": "/envelopes/d51cfdab-22ed-4832-bf68-446c44077ffc",
'   "statusDateTime": "2018-04-17T16:31:51.8830000Z",
'   "status": "sent"
' }

' Sample code for parsing the JSON response...
' Use the following online tool to generate parsing code from sample JSON:
' Generate Parsing Code from JSON

Dim envelopeId As String
Dim uri As String
Dim statusDateTime As String
Dim status As String

envelopeId = jResp.StringOf("envelopeId")
uri = jResp.StringOf("uri")
statusDateTime = jResp.StringOf("statusDateTime")
status = jResp.StringOf("status")