(Lianja) 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.

For more information, see https://developers.docusign.com/esign-rest-api/code-examples/quickstart-request-signature-email

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loHttp = createobject("CkHttp")

// 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.
loPdfData = createobject("CkBinData")
llSuccess = loPdfData.LoadFile("qa_data/pdf/helloWorld.pdf")
if (llSuccess = .F.) then
    ? "Failed to load local PDF file."
    release loHttp
    release loPdfData
    return
endif

loJson = createobject("CkJsonObject")
loJson.UpdateString("emailSubject","Please sign this document")
loJson.UpdateString("documents[0].documentBase64",loPdfData.GetEncoded("base64"))
loJson.UpdateString("documents[0].name","Lorem Ipsum")
loJson.UpdateString("documents[0].fileExtension","pdf")
loJson.UpdateString("documents[0].documentId","1")
loJson.UpdateString("recipients.signers[0].email","joe_sample@example.com")
loJson.UpdateString("recipients.signers[0].name","Joe Sample")
loJson.UpdateString("recipients.signers[0].recipientId","1")
loJson.UpdateString("recipients.signers[0].routingOrder","1")
loJson.UpdateString("recipients.signers[0].tabs.signHereTabs[0].documentId","1")
loJson.UpdateString("recipients.signers[0].tabs.signHereTabs[0].pageNumber","1")
loJson.UpdateString("recipients.signers[0].tabs.signHereTabs[0].recipientId","1")
loJson.UpdateString("recipients.signers[0].tabs.signHereTabs[0].tabLabel","SignHereTab")
loJson.UpdateString("recipients.signers[0].tabs.signHereTabs[0].xPosition","195")
loJson.UpdateString("recipients.signers[0].tabs.signHereTabs[0].yPosition","147")
loJson.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
// }

loJsonToken = createobject("CkJsonObject")
llSuccess = loJsonToken.LoadFile("qa_data/tokens/docusign.json")

loSbAuth = createobject("CkStringBuilder")
loSbAuth.Append("Bearer ")
loSbAuth.Append(loJsonToken.StringOf("access_token"))

loHttp.SetRequestHeader("Authorization",loSbAuth.GetAsString())
loHttp.SetRequestHeader("Content-Type","application/json")

// Don't forget to modify this line to use your account ID
loResp = loHttp.PostJson3("https://demo.docusign.net/restapi/v2.1/accounts/${accountId}/envelopes","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loPdfData
    release loJson
    release loJsonToken
    release loSbAuth
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loPdfData
    release loJson
    release loJsonToken
    release loSbAuth
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

// 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

lcEnvelopeId = loJResp.StringOf("envelopeId")
lcUri = loJResp.StringOf("uri")
lcStatusDateTime = loJResp.StringOf("statusDateTime")
lcStatus = loJResp.StringOf("status")


release loHttp
release loPdfData
release loJson
release loJsonToken
release loSbAuth
release loSbResponseBody
release loJResp