(Java) 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 Java Downloads Java Libs for Windows, MacOS, Linux, Alpine Linux, Solaris Java Libs for Android

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

    // 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.
    CkBinData pdfData = new CkBinData();
    success = pdfData.LoadFile("qa_data/pdf/helloWorld.pdf");
    if (success == false) {
        System.out.println("Failed to load local PDF file.");
        return;
        }

    CkJsonObject json = new CkJsonObject();
    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
    // }

    CkJsonObject jsonToken = new CkJsonObject();
    success = jsonToken.LoadFile("qa_data/tokens/docusign.json");

    CkStringBuilder sbAuth = new CkStringBuilder();
    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
    CkHttpResponse resp = http.PostJson3("https://demo.docusign.net/restapi/v2.1/accounts/${accountId}/envelopes","application/json",json);
    if (http.get_LastMethodSuccess() == false) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);
    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    System.out.println("Response Body:");
    System.out.println(jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    System.out.println("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        System.out.println("Response Header:");
        System.out.println(resp.header());
        System.out.println("Failed.");

        return;
        }

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

    String envelopeId;
    String uri;
    String statusDateTime;
    String status;

    envelopeId = jResp.stringOf("envelopeId");
    uri = jResp.stringOf("uri");
    statusDateTime = jResp.stringOf("statusDateTime");
    status = jResp.stringOf("status");
  }
}