(Swift) 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 Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

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

    let http = CkoHttp()!
    var success: Bool

    // 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.
    let pdfData = CkoBinData()!
    success = pdfData.loadFile("qa_data/pdf/helloWorld.pdf")
    if success == false {
        print("Failed to load local PDF file.")
        return
    }

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

    let jsonToken = CkoJsonObject()!
    success = jsonToken.loadFile("qa_data/tokens/docusign.json")

    let sbAuth = CkoStringBuilder()!
    sbAuth.append("Bearer ")
    sbAuth.append(jsonToken.string(of: "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
    var resp: CkoHttpResponse? = http.postJson3("https://demo.docusign.net/restapi/v2.1/accounts/${accountId}/envelopes", contentType: "application/json", json: json)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)
    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    var envelopeId: String?
    var uri: String?
    var statusDateTime: String?
    var status: String?

    envelopeId = jResp.string(of: "envelopeId")
    uri = jResp.string(of: "uri")
    statusDateTime = jResp.string(of: "statusDateTime")
    status = jResp.string(of: "status")

}