(Objective-C) 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 Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoHttp.h>
#import <CkoBinData.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoHttpResponse.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL 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.
CkoBinData *pdfData = [[CkoBinData alloc] init];
success = [pdfData LoadFile: @"qa_data/pdf/helloWorld.pdf"];
if (success == NO) {
    NSLog(@"%@",@"Failed to load local PDF file.");
    return;
}

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"emailSubject" value: @"Please sign this document"];
[json UpdateString: @"documents[0].documentBase64" value: [pdfData GetEncoded: @"base64"]];
[json UpdateString: @"documents[0].name" value: @"Lorem Ipsum"];
[json UpdateString: @"documents[0].fileExtension" value: @"pdf"];
[json UpdateString: @"documents[0].documentId" value: @"1"];
[json UpdateString: @"recipients.signers[0].email" value: @"joe_sample@example.com"];
[json UpdateString: @"recipients.signers[0].name" value: @"Joe Sample"];
[json UpdateString: @"recipients.signers[0].recipientId" value: @"1"];
[json UpdateString: @"recipients.signers[0].routingOrder" value: @"1"];
[json UpdateString: @"recipients.signers[0].tabs.signHereTabs[0].documentId" value: @"1"];
[json UpdateString: @"recipients.signers[0].tabs.signHereTabs[0].pageNumber" value: @"1"];
[json UpdateString: @"recipients.signers[0].tabs.signHereTabs[0].recipientId" value: @"1"];
[json UpdateString: @"recipients.signers[0].tabs.signHereTabs[0].tabLabel" value: @"SignHereTab"];
[json UpdateString: @"recipients.signers[0].tabs.signHereTabs[0].xPosition" value: @"195"];
[json UpdateString: @"recipients.signers[0].tabs.signHereTabs[0].yPosition" value: @"147"];
[json UpdateString: @"status" value: @"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
// }

CkoJsonObject *jsonToken = [[CkoJsonObject alloc] init];
success = [jsonToken LoadFile: @"qa_data/tokens/docusign.json"];

CkoStringBuilder *sbAuth = [[CkoStringBuilder alloc] init];
[sbAuth Append: @"Bearer "];
[sbAuth Append: [jsonToken StringOf: @"access_token"]];

[http SetRequestHeader: @"Authorization" value: [sbAuth GetAsString]];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];

// Don't forget to modify this line to use your account ID
CkoHttpResponse *resp = [http PostJson3: @"https://demo.docusign.net/restapi/v2.1/accounts/${accountId}/envelopes" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"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

NSString *envelopeId = 0;
NSString *uri = 0;
NSString *statusDateTime = 0;
NSString *status = 0;

envelopeId = [jResp StringOf: @"envelopeId"];
uri = [jResp StringOf: @"uri"];
statusDateTime = [jResp StringOf: @"statusDateTime"];
status = [jResp StringOf: @"status"];