DocuSign

Overview

Quickly and easily create, manage, and send eSignatures using the DocuSign connected system. DocuSign envelopes can contain one or more documents, the fields in the document, recipient info, delivery progress, sender information, security, and more.

For information that pertains to all connected systems, see Connected System Object.

Properties

Two forms of authentication are available for DocuSign: Basic Authentication (single system login) and Authorization Code Grant (per user).

Basic Authentication

Uses the DocuSign Legacy Header Authentication Method, which requires a single DocuSign user's credentials to authenticate. See DocuSign documentation for more details.

A DocuSign connected system using the Legacy Header Authentication Method has the following properties:

Field Description
Name The name of the connected system. Use a name that will uniquely identify this connection to the external system.
Description Supplemental information about the connected system that is displayed when selecting the system in the integration designer and in the application contents grid.
Authentication Information The following authentication information can be found in the DocuSign Admin site. From your DocuSign instance, go to the Admin site. Then click Accounts and select your account to get started.
Instance URL This URL is used to configure your integration object and when executing your operations. For example: https://demo.docusign.net
API Account ID To find the API Account ID, go to the Account screen in DocuSign. Under Integrations, click API and Keys.
API Username The username used to sign into the provided DocuSign instance. To find the API Username, go to the Account screen in DocuSign. Under Users And Groups, click Users and select a user.
Password The password used to sign into the provided DocuSign instance.
Integration Key To find the Integration Key, go to the Account screen in DocuSign. Under Integrations, click API and Keys and select your App Name.

docusign-basic-authentication.png

Authorization Code Grant

Uses the DocuSign OAuth 2.0 Authentication Method, where each Appian user will be required to log in to their DocuSign account to authenticate. You must provide users a way to authenticate using OAuth 2.0. See DocuSign documentation for more details.

A DocuSign connected system using Authorization Code Grant has the following properties:

Field Description
Authentication Information The following authentication information can be found in the API and Keys page for your app. From your DocuSign instance, go to the Admin site. Then click Accounts and select your account. From the Account screen, under Integrations, select API and Keys and select your App Name.
Redirect URL Each connected system provides a callback URL that must be added to your DocuSign environment. From the Account screen, under Integrations, select API and Keys and select your App Name. Under Additional settings, add the Redirect URI.
Instance URL This URL is used to configure your integration object and when executing your operations. For example: https://demo.docusign.net
API Account ID To find the API Account ID, go to the Account screen in DocuSign. Under Integrations, click API and Keys.
Integration Key To find the API Username, go to the Account screen in Docusign. Under Users And Groups, click Users and select a user.
Secret Key From the API and Keys page for your app, under Authentication, select Authorization Code Grant and click ADD SECRET KEY.
DocuSign Environment This is either DocuSign Development, https://account-d.docusign.com, or Production, https://account.docusign.com.

Click AUTHORIZE to use the provided configuration information to authorize the designer in a new window. See OAuth 2.0: Authorization Code Grant for more details.

docusign-authorization-code.png

Operations

Name Description Type
Send Document for eSignature Sends a document to a specified recipient for eSignature WRITE
Create and Send Envelope Creates and sends an envelope for eSignature or creates a draft envelope WRITE
Get Envelope Definition Gets envelope information for a specified envelope READ
List Envelopes Gets a list of envelopes that match specified search parameters READ
Update Envelope Definition Modifies envelope definitions including status WRITE
List Documents of an Envelope Gets a list of all documents associated with a specified envelope READ
Upload New Documents to an Envelope Adds or updates documents to a specified envelope WRITE
Download Document from an Envelope Gets a document from a specified envelope and saves it into Appian WRITE
List Audit Events of an Envelope Gets envelope audit events for a specified envelope READ
Generate the Recipient Signing URL Gets a pre-authenticated URL to allow a user to eSign from Appian WRITE

Send Document for eSignature

Sends a document to a specified recipient for eSignature.

Note: Send Document for eSignature is a WRITE type Integration. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

docusign-send-for-esign.png

Create and Send Envelope

Creates and sends an envelope for eSignature or creates a draft envelope.

See the examples below of how to set up your DocuSign envelope.

Note: Create and Send Envelope is a WRITE type Integration. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

docusign-create-and-send.png

Get Envelope Definition

Gets envelope information for a specified envelope.

docusign-get-envelope.png

List Envelopes

Gets a list of envelopes that match specified search parameters.

docusign-list-envelope.png

Update Envelope Definition

Modifies envelope definitions including status.

Note: Update Envelope Definition is a WRITE type Integration. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

docusign-update-envelope.png

List Documents of an Envelope

Gets a list of all documents associated with a specified envelope.

docusign-list-document.png

Upload New Documents to an Envelope

Adds or updates documents to a specified envelope.

Note: Upload New Documents to an Envelope is a WRITE type Integration. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

docusign-upload-new-doc.png

Download Document from an Envelope

Gets a document from a specified envelope and saves it into Appian.

Note: Download Document from an Envelope is a WRITE type Integration. To protect against duplicate document creation, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

docusign-download-doc.png

List Audit Events of an Envelope

Gets envelope audit events for a specified envelope.

docusign-list-audit-events.png

Generate the Recipient Signing URL

Gets a pre-authenticated URL to allow a user to eSign from Appian.

Note: Generate the Recipient Signing URL is a WRITE type Integration. To prevent the integration from making the same update twice, it can only be used in the saveInto parameter of an interface component or in a Web API. See Call an Integration for more information.

docusign-generate-signing-url.png

DocuSign Envelope Examples

Request Signature on Single Document by Email

This example shows an integration configuration that includes:

  • A single PDF document to be signed
  • One tab positioned using anchor text
  • One recipient
  • For more information, see DocuSign examples

See full Envelope Definition below.

docusign_examples_single_document.png

Envelope Definition

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
a!toJson(
  {
    "emailSubject": "Please sign the NDA",
    "recipients": {
      "signers": {
        {
          "email": "the_nda_signer@example.com",
          "name": "Darlene Petersen",
          "recipientId": "1",
          "routingOrder": "1",
          "tabs": {
            "dateSignedTabs": {
              {
                "anchorString": "signer1date",
                "anchorYOffset": "-6",
                "fontSize": "Size12",
                "name": "Date Signed",
                "recipientId": "1",
                "tabLabel": "date_signed"
              }
            },
            "fullNameTabs": {
              {
                "anchorString": "signer1name",
                "anchorYOffset": "-6",
                "fontSize": "Size12",
                "name": "Full Name",
                "recipientId": "1",
                "tabLabel": "Full Name"
              }
            },
            "signHereTabs": {
              {
                "anchorString": "signer1sig",
                "anchorUnits": "mms",
                "anchorXOffset": "0",
                "anchorYOffset": "0",
                "name": "Please sign here",
                "optional": "false",
                "recipientId": "1",
                "scaleValue": 1,
                "tabLabel": "signer1sig"
              }
            }
          }
        }
      }
    }
  }
)

Multiple Documents and Tabs, Signer and CC Recipients

This example shows an integration configuration that includes:

  • Multiple documents.
  • Multiple tabs including signing, fullName, dateSigned, and text tabs.
  • Tabs positioned using anchor text.
  • Two recipients, a signer and a cc recipient.

For more information, see DocuSign examples.

See full expressions for Envelope Definition and Documents.

docusign-examples-DocuSign_MultipleDocumentsTabsSignerCC.png

Envelope Definition

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
a!toJson(
  {
    "emailSubject": "Please sign the house documentation package",
    "recipients": {
      "carbonCopies": {
        {
          "email": "cody_vigil@worldwidecorp.example.com",
          "name": "Cody Vigil",
          "recipientId": "2",
          "routingOrder": "2"
        }
      },
      "signers": {
        {
          "email": "darlene_petersen@newco.example.com",
          "name": "Darlene Petersen",
          "recipientId": "1",
          "routingOrder": "1",
          "tabs": {
            "dateSignedTabs": {
              {
                "anchorString": "signer1date",
                "anchorYOffset": "-6",
                "fontSize": "Size12",
                "name": "Date Signed",
                "recipientId": "1",
                "tabLabel": "date_signed"
              },
              {
                "documentId": "2",
                "fontSize": "Size12",
                "name": "Date Signed",
                "pageNumber": "1",
                "recipientId": "1",
                "tabLabel": "doc3_date_signed",
                "xPosition": "89",
                "yPosition": "100"
              }
            },
            "fullNameTabs": {
              {
                "anchorString": "signer1name",
                "anchorYOffset": "-6",
                "fontSize": "Size12",
                "name": "Full Name",
                "recipientId": "1",
                "tabLabel": "Full Name"
              }
            },
            "signHereTabs": {
              {
                "anchorString": "signer1sig",
                "anchorUnits": "mms",
                "anchorXOffset": "0",
                "anchorYOffset": "0",
                "name": "Please sign here",
                "optional": "false",
                "recipientId": "1",
                "scaleValue": 1,
                "tabLabel": "signer1sig"
              },
              {
                "documentId": "2",
                "name": "Please sign here",
                "optional": "false",
                "pageNumber": "1",
                "recipientId": "2",
                "scaleValue": 1,
                "tabLabel": "signer1_doc2",
                "xPosition": "89",
                "yPosition": "40"
              },
              {
                "anchorString": "Client Signature",
                "anchorUnits": "mms",
                "anchorXOffset": "0",
                "anchorYOffset": "-4",
                "name": "Please sign here",
                "optional": "false",
                "recipientId": "1",
                "scaleValue": 1,
                "tabLabel": "doc3_client_sig"
              }
            },
            "textTabs": {
              {
                "anchorString": "signer1company",
                "anchorYOffset": "-8",
                "fontSize": "Size12",
                "name": "Company",
                "recipientId": "1",
                "required": "true",
                "tabLabel": "Company"
              },
              {
                "anchorString": "Client Name",
                "anchorYOffset": "-38",
                "fontSize": "Size12",
                "name": "Company",
                "recipientId": "1",
                "required": "true",
                "tabLabel": "Company"
              },
              {
                "documentId": "3",
                "fontSize": "Size10",
                "name": "Company",
                "pageNumber": "1",
                "recipientId": "1",
                "required": "true",
                "tabLabel": "Company",
                "xPosition": "145",
                "yPosition": "195"
              }
            }
          }
        }
      }
    }
  }
)

Documents

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  documents: {
    {
      documentId: 1,
      name: "NDA",
      appianDocument: todocument(1234)
    },
    {
      documentId: 2,
      name: "House",
      appianDocument: todocument(5678)
    },
    {
      documentId: 3,
      name: "contractor_agreement",
      appianDocument: todocument(9012)
    }
  }
}
Open in Github Built: Fri, Nov 19, 2021 (11:59:11 AM)

On This Page

FEEDBACK