Dart

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. Dart

import 'package:chilkat/chilkat.dart';

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

  final http = 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.
  final pdfData = CkBinData();
  try {
    pdfData.loadFile('qa_data/pdf/helloWorld.pdf');
  } on ChilkatException {
    print('Failed to load local PDF file.');
    return;
  }

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

  final jsonToken = CkJsonObject();
  jsonToken.loadFile('qa_data/tokens/docusign.json');

  final sbAuth = 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
  final resp = CkHttpResponse();
  try {
    http.httpJson('POST', 'https://demo.docusign.net/restapi/v2.1/accounts/\${accountId}/envelopes', json, 'application/json', resp);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final sbResponseBody = CkStringBuilder();
  resp.getBodySb(sbResponseBody);
  final jResp = CkJsonObject();
  jResp.loadSb(sbResponseBody);
  jResp.emitCompact = false;

  print('Response Body:');
  print(jResp.emit());

  final respStatusCode = resp.statusCode;
  print('Response Status Code = $respStatusCode');
  if (respStatusCode >= 400) {
    print('Response Header:');
    print(resp.header);
    print('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

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