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. Chilkat2 Java

import com.chilkatsoft.chilkat2.BinData;
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Http;
import com.chilkatsoft.chilkat2.HttpResponse;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.StringBuilder;

public class ChilkatExample {

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

        Http http = new 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.
        BinData pdfData = new BinData();
        try {
            pdfData.loadFile("qa_data/pdf/helloWorld.pdf");
        } catch (ChilkatException e) {
            System.out.println("Failed to load local PDF file.");
            return;
        }

        JsonObject json = new 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
        // }

        JsonObject jsonToken = new JsonObject();
        jsonToken.loadFile("qa_data/tokens/docusign.json");

        StringBuilder sbAuth = new 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
        HttpResponse resp = new HttpResponse();
        try {
            http.httpJson("POST", "https://demo.docusign.net/restapi/v2.1/accounts/${accountId}/envelopes", json, "application/json", resp);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        StringBuilder sbResponseBody = new StringBuilder();
        resp.getBodySb(sbResponseBody);
        JsonObject jResp = new JsonObject();
        jResp.loadSb(sbResponseBody);
        jResp.setEmitCompact(false);

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

        int respStatusCode = resp.getStatusCode();
        System.out.println("Response Status Code = " + respStatusCode);
        if (respStatusCode >= 400) {
            System.out.println("Response Header:");
            System.out.println(resp.getHeader());
            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 = jResp.stringOf("envelopeId");
        String uri = jResp.stringOf("uri");
        String statusDateTime = jResp.stringOf("statusDateTime");
        String status = jResp.stringOf("status");
    }
}