Information Guide

DocuSign REST API Guide

Version 2

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

Copyright 2003-2013 DocuSign, Inc. All rights reserved.

For information about DocuSign trademarks, copyrights and patents refer to the DocuSign Intellectual Property page (https://www.docusign.com/IP) on the DocuSign website. All other trademarks and registered trademarks are the property of their respective holders. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of DocuSign, Inc. Under the law, reproducing includes translating into another language or format. Every effort has been made to ensure that the information in this manual is accurate. DocuSign, Inc. is not responsible for printing or clerical errors. Information in this document is subject to change without notice. DocuSign REST API Guide, version 2, December 6, 2013 If you have any comments or feedback on our documentation, please send them to us at: Documentation@DocuSign.com.

Summary of changes for this version: Added information about using Certificate-Based Authentication with the REST API. Updated Login information to include optional request parameters. Changed envelope emailBlurb limit from 2,000 characters to 10,000 characters. Added pages, fileExtension, documentBase64, and matchboxes parameters to the envelope document parameter. Added containPdfFormFields parameters to the GET List of Envelope Documents response. Added ownerUserId parameter to the GET Folder Lists response Added optional notifications, envelopeTemplateDefinition-folderId, and envelopeTeplateDefinition-owner parameters to POST Template request and GET Template response. Added an optional query parameter that will close a user signature when modifying a user signature. Added optional locked and required parameters to the Radio Group Tab.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

Table of Contents
Introduction.......................................................................................................................................... 9 Commonly Used Terms ................................................................................................................. 9 Basic Process Flow and Steps for Sending with the REST API ................................................... 10 Basic Process Flow for Requesting Status Changes with the REST API ..................................... 10 Request and Response Guidelines .............................................................................................. 12 Request and Response Formats.................................................................................................. 13 Envelope and Recipient Status Codes ......................................................................................... 13 Getting Started .................................................................................................................................. 14 Integrator Keys ............................................................................................................................ 14 API Call Rate Limits ..................................................................................................................... 15 File Size Limitations ..................................................................................................................... 15 REST API Versions...................................................................................................................... 16 REST API Base URL ................................................................................................................... 16 REST API Explorer ...................................................................................................................... 16 Send On Behalf Of Functionality in the DocuSign REST API ............................................................. 16 OAuth2 Authentication Support in DocuSign REST API .................................................................... 18 General Usage Notes .................................................................................................................. 18 OAuth2 Token Request ............................................................................................................... 18 Normal Usage .............................................................................................................................. 19 OAuth2 and SAML ....................................................................................................................... 20 Revoking Tokens ......................................................................................................................... 22 Acting as Other Account Users .................................................................................................... 23 OAuth2 Response Codes ............................................................................................................ 25 Certificate-Based Authentication ........................................................................................................ 26 Certificate-Based Authentication Requests and Responses......................................................... 26 Basic Scenarios ................................................................................................................................. 28 Creating an Envelope from a Document ...................................................................................... 28 Creating an Envelope from a Template ........................................................................................ 29 Embedded Sending ..................................................................................................................... 31 Embedded Signing ...................................................................................................................... 31 Requesting Envelope Status ........................................................................................................ 32 Retrieving Envelope and Documents ........................................................................................... 33 Sending HTTP Requests with cURL .................................................................................................. 34
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

Setting Up Your Client Application ............................................................................................... 34 Viewing Base Resources with cURL ............................................................................................ 35 Logging in with cURL ................................................................................................................... 35 Sending HTTP Requests Using REST API Resources ................................................................ 36 Chunked Transfer-Encoding Support................................................................................................. 37 Example Chunked Transfer-Encoding ......................................................................................... 37 REST API References ....................................................................................................................... 39 Login ............................................................................................................................................ 50 Change Password ....................................................................................................................... 52 Create Account ............................................................................................................................ 53 Delete Account ............................................................................................................................ 62 Get Account Information .............................................................................................................. 62 Get Account Billing Plan .............................................................................................................. 63 Update Account Billing Plan ......................................................................................................... 66 Purchase Additional Envelopes ................................................................................................... 68 Get Brand Profile Information ....................................................................................................... 69 Upload Brand Profiles .................................................................................................................. 70 Delete Brand Profiles ................................................................................................................... 72 Delete Captive Recipient Signature ............................................................................................. 72 Set Up a Connect Configuration................................................................................................... 74 Get Connect Configuration Information ........................................................................................ 77 Update a Connect Configuration .................................................................................................. 79 Get a Connect Configuration Information ..................................................................................... 82 Delete a Connect Configuration ................................................................................................... 83 Republish Connect Information for One Envelope ....................................................................... 83 Republish Connect Information for Multiple Envelopes ................................................................ 84 Get the Connect Failure Log ........................................................................................................ 85 Get a Connect Failure Log Entry .................................................................................................. 88 Clear a Connect Failure Log Entry ............................................................................................... 90 Get the Connect Log .................................................................................................................... 91 Clear the Connect Log ................................................................................................................. 92 Get One Connect Log Entry ......................................................................................................... 93 Clear One Connect Log Entry ...................................................................................................... 94 Get Consumer Disclosure ............................................................................................................ 94 Get List of Account Custom Fields ............................................................................................... 96

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

Send an Envelope or Create a Draft Envelope............................................................................. 98 Send an Envelope from a Template ........................................................................................... 109 Get Envelope Status Changes ................................................................................................... 120 Get Individual Envelope Status .................................................................................................. 124 Send Draft Envelope .................................................................................................................. 125 Void Envelope............................................................................................................................ 126 Get Envelope Audit Events ........................................................................................................ 127 Add Envelope Custom Fields to an Envelope ............................................................................ 128 Get Envelope Custom Field Information..................................................................................... 130 Modify Envelope Custom Fields for an Envelope ....................................................................... 132 Remove Envelope Custom Fields from an Envelope ................................................................. 135 Add Documents to a Draft Envelope .......................................................................................... 136 Remove Documents from a Draft Envelope ............................................................................... 137 Get List of Envelope Documents ................................................................................................ 138 Add a Document to a Draft Envelope ......................................................................................... 139 Get Document from Envelope .................................................................................................... 140 Get a Page Image ...................................................................................................................... 141 Rotate Page Image .................................................................................................................... 142 Remove a Page ......................................................................................................................... 142 Get Custom Document Fields for an Envelope Document ......................................................... 143 Add Custom Document Fields to an Envelope Document .......................................................... 144 Modify Custom Document Fields for an Envelope Document ..................................................... 146 Delete Custom Document Fields from an Envelope Document .................................................. 147 Get Envelope Certificate ............................................................................................................ 149 Get Envelope Documents and Certificate .................................................................................. 149 Get Envelope Notification Information ........................................................................................ 150 Get Envelope Recipient Status .................................................................................................. 151 Add Recipients to an Envelope .................................................................................................. 153 Delete Recipients from an Envelope .......................................................................................... 155 Modify or Correct and Resend Recipient Information ................................................................. 156 Set Initials Image for Accountless Signer ................................................................................... 157 Get Signature Information for Accountless Signer ...................................................................... 158 Set Signature Image for Accountless Signer .............................................................................. 159 Add Tabs for a Recipient ........................................................................................................... 160 Get Tab Information for a Recipient ........................................................................................... 161

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

Delete Tabs for a Recipient........................................................................................................ 162 Modify Tabs for a Recipient ....................................................................................................... 163 Get List of Templates Used in an Envelope ............................................................................... 164 Post Envelope Correction .......................................................................................................... 165 Post Recipient View ................................................................................................................... 166 Post Sender View ...................................................................................................................... 168 Get Envelope Status for more than one envelope ...................................................................... 169 Get Folder List ........................................................................................................................... 170 Get Folder Envelope List ........................................................................................................... 172 Move Envelope .......................................................................................................................... 174 Add a New Group ...................................................................................................................... 175 Get Group Information ............................................................................................................... 176 Modify Group Information........................................................................................................... 177 Get Group Brand ID Information ................................................................................................ 178 Add Group Brand ID Information ................................................................................................ 179 Delete Group Brand ID Information ............................................................................................ 180 Add Users to a Group ................................................................................................................ 181 Get List of Users in a Group....................................................................................................... 182 Remove Users from a Group ..................................................................................................... 183 Get a List of Permission Profiles ................................................................................................ 185 Get Recipient Names ................................................................................................................. 186 Get List of Envelopes in Folders ................................................................................................ 186 Get Account Settings ................................................................................................................. 190 Modify Account Settings ............................................................................................................ 191 Get List of Templates ................................................................................................................. 192 Post Template............................................................................................................................ 193 Get Template ............................................................................................................................. 202 Get Custom Document Fields for a Template Document ........................................................... 204 Add Custom Document Fields to a Template Document ............................................................ 205 Modify Custom Document Fields for a Template Document....................................................... 206 Delete Custom Document Fields from a Template Document .................................................... 208 Share a Template with a Group ................................................................................................. 210 Remove Template Sharing for a Group...................................................................................... 211 Get List of Unsupported File Types ............................................................................................ 212 Add User to Account .................................................................................................................. 213

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

Get User List .............................................................................................................................. 217 Close a User .............................................................................................................................. 218 Get User Information.................................................................................................................. 220 Get Custom User Settings ......................................................................................................... 221 Add or Modify Custom User Settings ......................................................................................... 222 Delete Custom User Settings ..................................................................................................... 224 Get User Profile ......................................................................................................................... 225 Modify User Profile..................................................................................................................... 228 Get User Profile Image .............................................................................................................. 231 Modify User Profile Image .......................................................................................................... 232 Delete User Profile Image .......................................................................................................... 232 Get User Account Settings ......................................................................................................... 233 Modify User Account Settings .................................................................................................... 234 Get a List of User Signature Definitions ..................................................................................... 235 Setting User Signature and Initials Images when Creating a Signature ...................................... 236 Get User Signature Information ................................................................................................. 239 Modify a User Signature ............................................................................................................ 240 Close a User Signature .............................................................................................................. 242 Get a User Initials Image ........................................................................................................... 242 Set a User Initials Image ............................................................................................................ 243 Delete a User Initials Image ....................................................................................................... 244 Get a User Signature Image ...................................................................................................... 246 Set a User Signature Image ....................................................................................................... 246 Delete a User Signature Image .................................................................................................. 248 Add a User Social Account ........................................................................................................ 249 Get User Social Accounts .......................................................................................................... 249 Remove a User Social Account ................................................................................................. 250 Post Authentication View ........................................................................................................... 251 Get Account Provisioning Information ........................................................................................ 252 Get List of Billing Plans .............................................................................................................. 253 Get Billing Plan Details .............................................................................................................. 254 Revoke an Authorization Token ................................................................................................. 257 Create an Authorization Token .................................................................................................. 258 Recipient Types and Parameters ............................................................................................... 259 Tab Types and Parameters........................................................................................................ 322

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

Error Code Information .................................................................................................................... 391 General Error Response Handling ............................................................................................. 391 Error Response Handling for API calls that Support Multiple Items ............................................ 392 Error Codes and Associated Messages ..................................................................................... 392 Appendix 1: DocuSign SOAP API to REST API ............................................................................... 404 Appendix 2: Time Zones and Date/Time Format Information ........................................................... 407 Account Settings ........................................................................................................................ 407 Time Zone and Date/Time Format Appearance ......................................................................... 407 Date/Time Formats for API Calls................................................................................................ 408

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

Introduction
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. The REST API uses the same underlying data model and standard objects as those in the DocuSign SOAP-based API. The REST API also has the same limits imposed on it as the SOAP-based API. See the Getting Started section for more information on prerequisites and limits. If you already use the DocuSign SOAP API, you might be able to leverage some of your existing code and experiences for use with the REST API. See Appendix 1: DocuSign SOAP API to REST API for the relationship between the SOAP and REST information. This section provides some background information for working with the REST API.

Commonly Used Terms

Definitions of some commonly used DocuSign terms are given below to familiarize you with their use in the DocuSign system. Envelope - This represents a container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients. Document - A document that is to be delivered, representing the content to be reviewed and/or signed by a Recipient. Documents have names and are always base64 encoded while in the system. Tab - This represents a DocuSign Tab (also known as a Tag or Stick-eTab) on a document. It is used in several ways. First, it is used to indicate to a recipient where a signature or initials are required.

Second, it is used to include various bits of information in a document in a manner similar to Form Fields or Macros (Example: a tab may automatically fill in the Company Name of a recipient when the document is signed).

Third, it is used as editable information fields where signers can add data to a document.

Recipient - Someone who receives the envelope and, depending on the settings, can sign (or initial) the documents or can add information where indicated by tabs. Template A pre-set envelope with specific documents, set recipient roles, recipient routing order, recipient authentication, signing tabs and information fields. Templates can also contain set signing instructions for the document and signature attachment requests. Templates can be set to allow the sender to make some changes before sending the envelope.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

10

Basic Process Flow and Steps for Sending with the REST API
The general use for the DocuSign service is sending documents for signature and the basic steps are described below:

1. A sender supplies the name and email address of each person they want to sign the document (these are the recipients), adds documents to an envelope and adds tabs to indicate where each person should sign, initial or add other information. Note: The sender does not have to add any tabs to a document. Sending without tabs is referred to as using free-form signing. Instead of seeing tabs on a document, the recipient will see the document with a note letting them know they must drag a signature or initial tab onto the document. 2. The sender places the envelope in the DocuSign system and DocuSign notifies each recipient, using the supplied email addresses, that they have been asked to sign a document, and provides a link to the envelope. 3. When a recipient clicks the link, they will see the documents with DocuSign Tabs in the locations specified by the sender, representing where they need to sign, initial or add information to the document. 4. When a recipient has clicked on all of their respective DocuSign Tabs (Stick-eTabs) or added their signature using free-form signing, the document is signed and the envelope is sent to other recipients for their signatures. When all the recipients have signed the documents, the envelope is completed.

Basic Process Flow for Requesting Status Changes with the REST API
You should periodically request the status changes of the envelopes from DocuSign to follow the envelope through the creation, sending and signing process. The basic process flow for requesting status changes is outlined below.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

11

1. Request the envelope status: Use the GET method to request envelope status starting from a specified date and time. Optionally, you can just check for any changes to envelope status or for envelopes that changed to a particular status (this is highly recommended). The best practice for recurring status requests is to set the date-time of the request so that each request overlaps the previous request by a short interval, one or two minutes. This limits the size of the response and prevents you from getting information for envelopes that have not changed status. The example that follows shows an instance of this process. 2. Save the date/time of your request: Saving the date/time of your request allows you to format the date-time for recurring requests. 3. DocuSign responds: DocuSign returns information for the envelopes that meet the specified date-time request. The response includes the uris for the envelope certificate, custom fields, documents, envelope along with the envelope ID, envelope status, and the date-time stamp for the envelope status change for the envelopes. If a query string was added to the original request, only the envelopes that meet those parameters are included in the response. 4. Process the envelope status changes in your system: Use the information in the request response to updated envelope information in your system. This might include triggering requests to retrieve certificates of completion and signed documents. 5. Wait and then repeat the process: The amount of time you wait between requests will depend your business processes, such as how many envelopes your organization sends during a day and how often updates are needed. The best practice for recurring status requests is to request the status no more than once every 15 minutes and only requesting status for those envelope that changed status. Important: DocuSign imposes API call limit restrictions to prevent flooding of API calls, so your request intervals should be should be appropriately timed. Request example: Based on how many envelopes you send, you decide to check for envelope status changes every 15 minutes with a 1 minute overlap to ensure that no changes are missed from the previous request.
Request 1 Request 2 Request 3

1 minute overlap

Your first request at 12:15 would be:

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes ?from_date=5-2-2012+12:15:00+AM&from_to_status=changed

Request 2 at 12:30 would be:

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes ?from_date=5-2-2012+12:14:00+AM&from_to_status=changed

And request 3 at 12:45 would follow a similar pattern:

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes ?from_date=5-2-2012+12:29:00+AM&from_to_status=changed

12

Request and Response Guidelines

Key names in requests and responses use camelcase, starting with a lowercase letter. Examples: userName, envelopeId. Values that represent constants, enums, etc. are lowercase. This allows the client to use the values without worrying about case conversion. The only exceptions to this are error code responses. Examples: status: created. Dates are formatted using ISO 8601 format. The following date formats are accepted in the DocuSign REST API: o o o o o o o o o o o "M/d/yyyy" "MMMM d, yyyy" "dd-MM-yy" "dd-MM-yyyy" "MMM-dd-yyyy" "MMMM d, yyyy | HH:mm" "dd-MM-yy | HH:mm" "dd-MM-yyyy | HH:mm" "MMM-dd-yyyy | HH:mm" "yyyy-MM-dd" "yyyy-MM-dd | HH:mm"

Response codes not in the 200 range include an error details response when possible. The response will contain the following: o o An errorCode field, with an uppercase string constant describing the error. A message field, that describes the error in more detail, if information is available.

Resource values that are relative to the Base URl will contain uri in the key name. Resources values that are fully qualified will contain url in the key name. Base64 content type encoding is supported for documents & images in the following manner: o For PUT or POST: Set the header Content-Transfer-Encoding to base64 to indicate that the document bytes and/or image bytes are encoded as base64 and the DocuSign server should decode the stream. For GET: Set the header Content-Transfer-Encoding to base64 to indicate that the document bytes and/or image bytes requested are to be encoded as base64 by DocuSign before sending them in the response. This header will be set in the response if the conversion was performed.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

13

Request and Response Formats

The DocuSign REST API resources can use JSON or XML for the request and response formats. The format used can be set in the file header when using a resource. You can also force the format used for a request/response by adding the format type at the end of a resource call. Example: To use json for your request/response format when sending an envelope you would append .json at the end of the resource. https://preview.docusign.net/restapi/v1/accounts/{accountId}/envelopes.json

Envelope and Recipient Status Codes

Knowing the status of envelopes and recipients at any particular time is important for your workflow. When requesting status for envelopes and recipients, DocuSign returns a status code. The possible values and descriptions are provided in this section. Envelope Status Code Descriptions The table below provides descriptions of the Envelope Status Codes. Code created deleted sent Description The envelope is in a draft state and has not been sent out for signing. This is a legacy status and is no longer used. An email notification with a link to the envelope has been sent to at least one recipient. The envelope remains in this state until all recipients have viewed it at a minimum. All recipients have viewed the document(s) in an envelope through the DocuSign signing web site. This is not an email delivery of the documents in an envelope. The envelope has been signed by all the recipients. This is a temporary state during processing, after which the envelope is automatically moved to Completed status. The envelope has been completed by all the recipients. The envelope has been declined for signing by one of the recipients. The envelope has been voided by the sender. This is a legacy status and is no longer used. The envelope is in an Authoritative state. Only Copy views of the documents will be shown. The envelope has been transferred out of DocuSign to another authority. The envelope is a Template. The envelope has been opened by the sender for correction. The signing process is stopped for envelopes with this status.

delivered

signed

completed declined voided timedout authoritativecopy transfercompleted template correct

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Recipient Status Code Descriptions The table below provides descriptions of the Recipient Status Codes. Code created sent delivered Description The recipient is in a draft state. This is only associated with draft envelopes (envelopes with a Created status).

14

The recipient has been sent an email notification that it is their turn to sign an envelope. The recipient has viewed the document(s) in an envelope through the DocuSign signing web site. This is not an email delivery of the documents in an envelope. The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient is automatically moved to Completed. The recipient declined to sign the document(s) in the envelope. The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. The recipient has finished signing and the system is waiting a fax attachment by the recipient before completing their signing step. The recipients email system auto-responded (bounced-back) to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This is only used if Send-on-behalf-of is turned off for the account.

signed

declined completed faxpending autoresponded

Getting Started
To get started you should get a DocuSign Integrator Key, review the Basic Scenarios, and review the REST API references.

Integrator Keys
An Integrator Key is a Unique Identifier for each DocuSign integration. It is used (and required) for all API calls (SOAP or REST) to any DocuSign service. Having an Integrator Key lets DocuSign tag each API call from all integrations, and helps provide both an additional layer of security and helps DocuSign support our partners. An Integrator Key is REQUIRED for all integrations, and if you want to move to Production (make calls to www.docusign.net) you also must be certified and get that Integrator Key authorized by DocuSign for Production. All Integrator Keys are used for development first, and as a result, they are all managed (and requested) in DocuSigns DEMO service. If you already have a developer account on demo, log in to request an Integrator Key. If you do not have a Demo Developer Account, go to the DocuSign Developer Center and request a free account. After you have developed your integration using your Demo Integrator Key, you must get that Integrator Key certified before moving to production. In order to become certified, you must be a member of our Developer Program. With that membership, you get access to all sorts on ongoing

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 support, certification help, and access to production. To join the program, or start the certification process, refer to the certification steps in the DocuSign Community.

15

API Call Rate Limits

To maintain reliability and stability within our demo and production environments, DocuSign operates with certain API call efficiency guidelines. To ensure effective load balance we continually monitor the API calls to our backend systems and we will contact developers that are putting unnecessary burden on the system. DocuSign has implemented the following API Call Rate Limits to balance loads on the system: The demo environment (demo.docusign.net) is limited to a call rate of 1,000 API calls per hour per account. The production environment (www.docusign.net) is limited to a call rate of 1,000 API calls per hour per account.

If the API call rate limit is reached, you will receive an exception for each call until the start of the next hour (this can be up to 60 minutes). The exception message states, The maximum number of hourly API invocations has been exceeded (error number 207). Hourly API usage is tracked from the start of one-hour to start of the next hour. Additionally, for polling compliance, DocuSign recommends that you do not exceed 1 status request per unique envelope (GET /accounts/{accountId}/envelopes) per 15 minutes. There are a number of ways to minimize API impact, such as: using bulk operations for requesting status, utilizing DocuSigns event notification feature, and refraining from repeatedly requesting information on envelopes that are in terminal state (Completed, Declined or Voided).

If you find your application still requires more than 1,000 calls per hour per account, please contact service@docusign.com for assistance in working on a solution. If you have any questions, please check our Developer Forum in the DocuSign Community.

File Size Limitations

DocuSign has the following limitations on files used in envelopes and as attachments: DocuSign recommends that you do not add files larger than 25MB to an envelope. Note that, depending on the recipients internet connection, large files might affect signing performance. DocuSign has not imposed a limit on the number of files that can be added to an envelope. However, as with file size, envelopes with a large number of files might affect signing performance. For signer-uploaded attachment files, DocuSign supports files sizes up to 25MB for an envelope. There is a file size limit of 5MB for attaching completed documents to emails sent by DocuSign to recipients when an envelope is completed. If the completed documents are greater than 5MB, the email still provides a link to the documents on the DocuSign system.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

16

REST API Versions

You can determine the REST API versions that are available by checking the following links: Note: You do not need an integrator key to view the REST API versions and resources. DocuSign Production system: https://www.docusign.net/restapi/service_information DocuSign Demo system: https://demo.docusign.net/restapi/service_information

To view the base resources available for a version, remove /service_information from the above URLs and add the version number for the version you want to view. Example: https://demo.docusign.net/restapi/v2 lists all of the base resources available in version 2 of the REST API on the DocuSign Demo system. To view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL. Example: https://demo.docusign.net/restapi/help lists the REST API operations on the DocuSign Demo system with XML and json request and response samples for the active REST API versions.

REST API Base URL

The base URL used for all operations is formatted as follows:
https://{server}/restapi/{apiVersion}/

The base URL for your account is retrieved by using the /login_information uri and is used in future API calls as the base of the request URL.

REST API Explorer

DocuSign has established a website (http://iodocs.docusign.com/) where you can walkthrough and try out the REST API methods. This website is useful when learning the different aspects of the REST API.

Send On Behalf Of Functionality in the DocuSign REST API

The DocuSign Send On Behalf Of functionality permits automated sending through the DocuSign API by an integrated sender on behalf of another sender. The Send On Behalf Of functionality is only available to accounts that use the DocuSign API to send envelopes and can be enabled for an account member by a DocuSign Customer Administrator through the DocuSign console or by contacting your DocuSign Account Manger. A user, known as the authenticating user in this circumstance, that wants to authenticate for other users in the account must have the following DocuSign userSettings enabled: apiAccountWideAccess allowSendOnBehalfOf

Note: If you are setting user permissions through the DocuSign web console, these correspond to the Account-Wide Rights and Send On Behalf Of Rights (API) settings. This allows an authenticating user to act as another user in the account, so the client application does not have to track the passwords for individual users. Instead, only the authenticating users
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

17

information is used. The operations, usually sending an envelope or checking status, are performed as the operating user, not as the authenticating user. The authenticating users information is used for authentication only, while the operating users userId is checked for proper authorization for the API method being called. The DocuSign REST API Send On Behalf Of function uses the <SendOnBehalfOf> node in the XDocuSign-Authentication header to add a Send On Behalf Of identifier for the operating user. The Send On Behalf Of identifier can be a properly formatted email address, with an optional semicolon delimited user name, or, if using the Single Sign On (SSO) environment, a User ID (UID) that can be looked up in the DocuSign SSO configuration. If the identifier is a properly formatted email address, the system conducts a look-up of the email address and user name (if provided) to see if that user is a member of the account. If membership in the account is not found, an error is returned. The account used for the check is the one associated with the authenticating users credentials. If the identifier is not an email address (the identifier fails the regular expression test for an email), it is assumed that the identifier is a UID. A search is conducted for the UID in the DocuSign system for a userId and the Single Sign On (SSO) customer system. If the UID is found the email address and user name associated with the UID are retrieved. Then the system conducts a look-up of the email address and user name to see if that user is a member of the account. If membership in the account is not found, an error is returned. The account used for the check is the one associated with the authenticating users credentials.

Send On Behalf Of REST Examples The Send On Behalf Of identifier is inserted in the <SendOnBehalfOf> node in the X-DocuSignAuthentication header. The examples below show Send On Behalf Of authentication using an email address, email address:user name combination and UID. The Send On Behalf Of information is highlighted in the examples. Example using Email Address
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId} X-DocuSign-Authentication: <DocuSignCredentials><SendOnBehalfOf>bob.smith@gmail.com</SendOnBehalfOf><Username>{name} </Username><Password>{password}</Password><IntegratorKey>{integrator_key}</IntegratorKey> </DocuSignCredentials> Accept: application/json Content-Type: application/json

Example using Email Address and User Name

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId} X-DocuSign-Authentication: <DocuSignCredentials><SendOnBehalfOf>bob.smith@gmail.com:Bob Smith</SendOnBehalfOf><Username>{name}</Username><Password>{password}</Password><Integrat orKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Example using UID

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

18

X-DocuSign-Authentication: <DocuSignCredentials><SendOnBehalfOf>P134325</SendOnBehalfOf><Username>{name}</Username>< Password>{password}</Password><IntegratorKey>{integrator_key}</IntegratorKey></DocuSignCr edentials> Accept: application/json Content-Type: application/json

OAuth2 Authentication Support in DocuSign REST API

OAuth2 is an open standard for authorization that can be used through the DocuSign REST API to obtain access tokens. The Resource Owner Password Grant is the only OAuth2 flow supported in the DocuSign REST API. This allows a client application to obtain an access token directly from the REST API by presenting the user name, password and integrator key for the user. After an access token is obtained, it is then used in API calls instead of the user name/password/integrator key combination. The descriptions in this section assume that a client application is being used for the actions.

General Usage Notes

The following general notes apply to when using the OAuth2 Authentication. The OAuth2 client_id is the same as the DocuSign Integrator Key. Integrator Keys can be managed by client application developers in the DocuSign Demo Environment through the DocuSign web console on the Preferences API page. The access_token does not expire, even when the user changes their password. As a result, refresh_token is not supported. Up to 10 access_tokens are supported per userId. This allows multiple instances of a client application to connect to a user. Users can revoke access_tokens through the REST API or through the DocuSign web console. A client application can use the access_token for a user to act as another user in the account if the access_token is associated with a user who has account-wide access and Send on behalf of privileges. This provides functionality that is identical to the Send On Behalf Of feature. The X-DocuSign-Act-As-User header is used in conjunction with the Authentication Header for this feature. See the Acting as Other Account Users section for more information. A client application can use the access_token for a user who has account-wide access and send on behalf of rights to create an access_token for other users of the account. The access_token created can then be stored in a user record on the client and used by that user to authenticate. The user identified in the access_token can see that a token was issued in the DocuSign web console on the Preferences Connected Apps page. That user also has rights to revoke the token from the web console.

OAuth2 Token Request

The client application uses the following steps to obtain an access token that can be stored locally with the client. Once authentication is complete, the access token is used instead of the username/password/integrator key combination for all API calls. The client application normally wants to obtain, and store locally, other information used in API calls including:

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 The baseUrl of the DocuSign site where the users accounts are stored. The accountId of the account that the user is using.

19

The client application should take the following actions to obtain an access token and other information: 1. Prompt the user for email/password. The client shows the UI for this prompt and is responsible to keep the information confidential and not store it locally. 2. Call the Login_Information API. The UserName/Password/IntegratorKey are set in the X-DocuSign-Authentication header for this call. The client uses this API call to obtain the baseUrl, accountId, and userId for the user and stores this information on the client side. 3. Post to Token Endpoint to obtain the access_token. The baseUrl retrieved in the login_information API is used with the token endpoint. The client users username, password are used, along with the client applications integrator key (set as client_id). The username and password should be urlencoded to encode any special characters (such as +). The OAuth2 scope is always set to api. The format of the token api call is as follows:
POST https://{server}/restapi/{apiVersion}/oauth2/token Accept: application/json Content-Type: application/x-www-form-urlencoded grant_type=password&client_id={IntegratorKey}&username={email}&password={password}&scope =api

The response, if successful, is:

{ "access_token":"{access token}", "scope":"api", "token_type":"bearer" }

The client application then stores the access_token for future use. The access_token is valid in all future API calls to authenticate this user, until the token is revoked. It is not affected by password changes. The client application is responsible for storing and protecting this token. Important: The length of the access token is variable. It is normal for the token to be at least 550 characters or longer. Dont make assumptions about the length.

Normal Usage
Once the access_token, baseUrl, accountId and other information has been obtained, other API calls may be made without returning to the token and login_information APIs. The only time the client application should need to repeat that sequence (login_information, token) is if other API calls return an error indicating that the client was not authorized. To use the access_token in REST API calls: Set the Authorization header in each call as follows:

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId} Authorization:bearer{accessToken} Accept: application/json Content-Type: application/json

20

Do not use the X-DocuSign-Authentication header if the Authorization header is used.

OAuth2 and SAML

Security Assertion Markup Language (SAML) is an XML-based framework for communicating user authentication, entitlement and attribute information. As an extension of the OAuth2 authentication support in the DocuSign REST API, DocuSign supports SAML assertion XML when obtaining an access token. The OAuth 2.0 SAML bearer assertion flow is similar to a refresh token flow within OAuth. The SAML assertion is POSTed to the OAuth token endpoint, which in turn processes the assertion, and issues an access_token based upon prior approval of the application. The general steps involved in using the OAuth 2.0 SAML bearer assertion flow are: 1. The developer obtains a DocuSign integrator key. 2. The developer registers an X509 certificate that will be used to sign SAML assertion. 3. The developer creates an application that generates a SAML assertion and signs it with their certificate. 4. The assertion is POSTed to the token endpoint https://{server}/restapi/{apiversion}/oauth2/token. 5. The token endpoint validates the signature using the certificate registered by the developer. 6. The token endpoint validates the Audience, Issuer, Subject, and validity of the assertion. 7. If the assertion is valid and the application has been authorized an Access Token is validated. The token provided expires after 1 hour and no refresh token is issued. SAML Assertion The client must create a valid SAML bearer assertion that conforms to the following rules: The Signature must be valid against the stored X509 signing certificate. The SAML assertion can use a users email address or user ID. When using an email address in the SAML assertion, set the subject name ID format to email address. For example:
<saml:Subject> <saml:NameIDFormat="urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress">{user emailaddress}</saml:NameID> </saml:Subject>

When using a user Id in the SAML assertion, set the subject name ID format to persistent. For example:
<saml:Subject> <saml:NameIDFormat="urn:oasis:names:tc:SAML:2.0:nameid-format:persistent">{user id(GUID)}</saml:NameID> </saml:Subject>

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 SubjectConfirmation/Method must be urn:oasis:names:tc:SAML:2.0:cm:bearer SubjectConfirmationData/Recipient must match the token endpoint url.

21

SubjectConfirmatinData/NotOnOrAfter must be greater than or equal to the current date and time. Audience must match RESTAPI URL.

When requesting the OAuth token, the assertion must use base64url encoding as defined at the link: http://tools.ieft.org/html/rfc4648#page-7 Example SAML Assertion
<saml:Assertion Version="2.0" ID="_b4105a9b-5c0a-493a-beac-0759a8b5bed6" IssueInstant="2012-12-04T19:37:23.143Z" xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"> <saml:Issuer>{DOCU_Integrator_Key}</saml:Issuer> <Signature xmlns="http://www.w3.org/2000/09/xmldsig#"> <SignedInfo> <CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-excc14n#" /> <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsasha1"/> <Reference URI="#_b4105a9b-5c0a-493a-beac-0759a8b5bed6"> <Transforms> <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" /> <Transform Algorithm="http://www.w3.org/2001/10/xml-excc14n#"> <InclusiveNamespaces PrefixList="#default saml ds xs xsi" xmlns="http://www.w3.org/2001/10/xml-exc-c14n#" /> </Transform> </Transforms> <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1" /> <DigestValue>tOxTTQyG2qhfwXnx4ozYFpS/D38=</DigestValue> </Reference> </SignedInfo> <SignatureValue>QtGWSSUdlzEi26p09etY2PbXfKr72TdM81TK662HvlUuNYeBahintlwvHPhFrJisA17mE 5BqAxcaiBY41+nU3AzujnNzmXpFH9Svrq0kBERjFVWGZVKbm4FKlmUF8fxYgiZIVJ5MY vaPowglaWfNhyHG2CkSUeNAUIJQSlzuf9I=</SignatureValue> <KeyInfo> <X509Data> <X509Certificate>[removed for brevity]</X509Certificate> </X509Data> </KeyInfo> </Signature> <saml:Subject> <saml:NameID Format="urn:oasis:names:tc:SAML:1.1:nameidformat:emailAddress">{user email address}</saml:NameID> <saml:SubjectConfirmation Method="urn:oasis:names:tc:SAML:2.0:cm:bearer"> <saml:SubjectConfirmationData NotOnOrAfter="{SAML Assertion Expiration Date}" Recipient="https://{server}/restapi/{apiversion}/oauth2/token" /> </saml:SubjectConfirmation> </saml:Subject> <saml:Conditions> <saml:AudienceRestriction> <saml:Audience>https://www.docusign.net</saml:Audience> </saml:AudienceRestriction> </saml:Conditions> <saml:AuthnStatement AuthnInstant="2012-12-04T19:37:23.143Z"> <saml:AuthnContext>

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

<saml:AuthnContextClassRef>urn:oasis:names:tc:SAML:2.0:ac:classes: X509</saml:AuthnContextClassRef> </saml:AuthnContext> </saml:AuthnStatement> </saml:Assertion>

22

Token Request When submitting the token request, the grant type should be: urn:ietf:params:oauth:grant-type:saml2bearer and the SAML bear assertion must use base64url encoding as defined at the link: http://tools.ieft.org/html/rfc4648#page-7 Example Request
POST https://{server}/restapi/v2/oauth2/token Accept: application/json Content-Type: application/x-www-form-urlencoded grant_type=urn:ietf:params:oauth:grant-type:saml2-bearer&assertion={base64url encoded SAML Assertion XML}

If successful, DocuSign returns an access token that can be stored for future use. Example Response
{ "access_token":"Access_Token", "scope":"api", expires_in: 3600 "token_type":"bearer" }

Revoking Tokens
Both the client application and the user can revoke access_tokens. A revoked access_token is no longer valid and attempts to use it will result in an error response. A client application should provide a mechanism for revoking access. This could be something like a Disconnect <myApp> from DocuSign button in the client application. When selected, the client application would revoke the access_token and remove it from the client applications storage. The client application would then go through the OAuth2 Token Request steps previously described to reestablish authentication. Revoking tokens through the REST API: The client application POSTs to the revoke endpoint with the content type set to application/x-wwwform-urlencoded and the body of the request set as token=<access token to revoke>
POST https://{server}/restapi/{apiVersion}/oauth2/revoke Accept: application/json Content-Type: application/x-www-form-urlencoded token={access token to revoke}

200-OK will be returned if the token was revoked.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Revoking tokens through the Web Console:

23

The DocuSign web console provides a way to revoke tokens for the user identified in the token. The user goes to the Preferences pages and clicks Connected Apps under Member Profile. This page shows the applications that are connected to this user with access tokens.

The user can revoke access by clicking the Revoke button on the same line as the application.

Note: An application, as defined by its integrator key, can appear up to 10 times in this list. There is currently no indication of which instance of a given client application will be revoked, other than the date that the client was attached. For example, if the client application were an iPad app and the user owned two iPads, then both might appear in the list. The user would not know which row in the table is associated with which iPad, unless the user knew the date/time the iPad application created the token.

Acting as Other Account Users

Depending on the account holder, a DocuSign account can support a number of individual users. Some client application integrations, especially those installed in other multi-user environments (such as Salesforce, Dynamics, SugarCRM) have the option to store login information for each of the client application users or to designate a single user as the authenticating user, who will authenticate for other users in the account. This allows a client application to store less information about individual DocuSign users and also avoid requesting password information for each user of the client application. A user, known as the authenticating user in this circumstance, that wants to authenticate for other users in the account must have the following DocuSign userSettings enabled: apiAccountWideAccess allowSendOnBehalfOf

Note: If you are setting user permissions through the DocuSign web console, these correspond to the Account-Wide Rights and Send On Behalf Of Rights (API) settings. The two methods of for acting as other users are described below:

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Acting as Other Account Users Note: This provides functionality that is identical to the Send On Behalf Of feature.

24

This allows an authenticating user to act as another user in the account. The operations, usually sending an envelope or checking status, are performed as the operating user, not as the authenticating user. The authenticating users access_token is used for authentication only, while the operating users userId is checked for proper authorization for the API method being called. This allows the client application to avoid storing any tokens for individual users. To act as other account users, the client application specifies the operating user by adding the XDocuSign-Act-As-User header to the request. For example:
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId} Authorization: bearer <access token for authenticating user> X-DocuSign-Act-As-User: bob.smith@gmail.com Accept: application/json Content-Type: application/json

The syntax email:name is also supported in the <SendOnBehalfOf> node in the X-DocuSignAuthentication header. Obtaining access_tokens for Other Account Users The authenticating user can also obtain access_tokens for other members in the account. This model would be used if the client application wishes to store individual access tokens for each account user. The advantage of this method is that each user does not need to enter their DocuSign password during a setup sequence. Only the Administrator needs to provide login credentials. The disadvantage of this is that the client application must store and manage access_tokens for each individual account member. The client application obtains this token by POSTing a request to the token endpoint that contains: An Authentication header containing the access_token for the authenticating user. A request body that identifies the user in the account that an access_token is being requested for. Note that the password for this user is not specified and should not be requested from the user by the client application. The request would be similar to:
POST https://{server}/restapi/{apiVersion}/oauth2/token Authorization: bearer {access_token for authenticating user} Accept: application/json Content-Type: application/x-www-form-urlencoded grant_type=password&client_id={IntegratorKey}&username=bob.smith@example.com&password =&scope=api

The response returns:

200 OK Content-Length: 605 Cache-Control: private Content-Type: application/json; charset=utf-8 Date: Mon, 29 Oct 2012 19:36:02 GMT Server: Microsoft-IIS/7.5 {

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"access_token":"{access token for bob smith}", "scope":"api", "token_type":"bearer" }

25

Once obtained, this access_token should be stored with the individual users information and protected from unauthorized use, since it will remain valid until revoked. It will be valid across user password changes.

OAuth2 Response Codes

The OAuth2 related endpoints return 200-OK on success. On failure, they typically return 400-Bad Request, or 401-Unauthorized. In order to be consistent with OAuth2 documentation, the OAuth2-related endpoints support a different error response format than other DocuSign REST API calls. The body of an error response to the oauth2/token and oauth2/revoke endpoints have the format:
{ "error":"<error code>", "error_description":"<optional description>" }

Oauth2/token Endpoint error codes: Error code values are all lower-case to match OAuth2 documentation. Error Code invalid_request invalid_client invalid_grant unauthorized_client unsupported_grant_type invalid_scope Error Description The request was malformed, or contains unsupported parameters The client authentication failed. The provided authorization is invalid. The client application is not allowed to use this grant_type. A grant_type other than password was used in the request. The scope was not set to api.

OAuth2/revoke Endpoint error codes Error code values are all lower-case to match OAuth2 documentation. Error Code unsupported_token_type Error Description The client tried to revoke an access token on a server not supporting this feature. This error is not supported in DocuSign. The presented token is invalid.

invalid_token

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

26

Certificate-Based Authentication
Certificate-based authentication is an optional way to provide additional security checks for REST API calls. When this option is enabled, it requires that REST API calls are signed and validates the call against the certificate specified by the header containing the certificate thumbprint. The REST API looks up the PublicKeyXML information stored in the DocuSign system based on the thumbprint header and Account ID and uses the information to validate the signature against the request body. If the validation information matches, the REST API confirms that the message body was not tampered with during transmission. If the information is not sent or does not validate, then a 401 Unauthorized message is returned. DocuSign signs responses with DocuSigns certificate. The clients PublicKey information is stored in DocuSigns signing certificates table. The information must be provided to DocuSign by the client. To enable this option and add the client PublicKey information to the DocuSigns signing certificates table, you must coordinate with your Account Manager and, in some circumstance, DocuSign Professional Services.

Certificate-Based Authentication Requests and Responses

After certificate-based authentication is enabled and you make requests to DocuSign, all your REST API calls must be signed with your certificate information in the X-DocuSign-Signature and the certificate thumbprint in the X-DocuSign-Thumbprint in the request header. The REST API looks up the PublicKeyXML information based on the thumbprint header and your Account ID and validates the signature against the request body. If the validation information matches, the REST API confirms that the message body was not tampered with during transmission and DocuSign sends a response with DocuSigns certificate information in the X-DocuSign-Signature in the response header. Certificate-Based Authentication Examples The following example is a request to send an envelope with certificate-based authentication.
POST http://localhost/restapi/v2/accounts/{accountId}/envelopes X-DocuSign-Authentication: <DocuSignCredentials><Username>docu.user@docusign.com</Username><Password>docuuser
</Password><IntegratorKey>DOCUUSER-ad1d9282-4f95-4a22-af6d-4287d3b21507</IntegratorKey> </DocuSignCredentials>

X-DocuSign-Signature: KEyUSk1P612XWglPE6TyE4udKRq2ZRe67zEhMVrGWWrOhcPkJ8VDrOGXETkQWlMXeq7wlA25blWldc+BEKaX4w6fT T9Nc0+UpOFy+EwVNekFKyB/tfGkzu9GYpbhQtjDwH77FfCM1bva/j2+fsKK7zidP+psdoHryGu4LfP4ON3F/CxOLQ OGNijY2xAKlKQESllWRg6WkT7zi2dUB1Ejch7SJGCFyXG7uVdrEdj3h3kUO5RbAlO+lMSYv2B3Sh2As+fBzfDlsTH hWxKd/MkpJOhJ2qjbVj28pWPaIJwPA5Ook+Ox4key2WHsmOsTzqeD27l6dNjijuAToWbYpVPuqg== X-DocuSign-Thumbprint: 3E571CB172041F02B1F1A4894092FDE79B43731B Accept: application/json Content-Type: multipart/form-data; boundary=637627d1-581c-4d9e-8430-d3a86f571355 --637627d1-581c-4d9e-8430-d3a86f571355 Content-Type: application/json Content-Disposition: form-data { 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"documents": [ { "documentId": "1", "name": "test2.pdf" } ], "status": "sent", "emailSubject": "Subject GetEnvelope_20130925094933", "emailBlurb": "Blurb GetEnvelope_20130925094933", "recipients": { "signers": [ { "tabs": { "dateSignedTabs": [ { "value": "default", "documentId": "1", "recipientId": "1", "pageNumber": "1", "xPosition": "100", "yPosition": "100", "tabId": "1" } ] }, "name": "Mr. Don L. Bits", "email": "dbits@bitmail.com", "recipientId": "1", "customFields": [ "CustomField1", "CustomField2" ], "routingOrder": "1" } ] } } --637627d1-581c-4d9e-8430-d3a86f571355 Content-Type: application/pdf Content-Disposition: file; filename="document.pdf"; documentId=1 Content-Transfer-Encoding: base64 <<docbytes> --637627d1-581c-4d9e-8430-d3a86f571355

27

The following example shows the response to the previous request.

201 Created Pragma: no-cache X-DocuSign-Signature: UY+byH+ynuemEPj3cbgogf4vws2Y6cGz6ekfPlV8ajjFAy4RlrsQwpZkHEXAr/+nCP0Ht+CkOR/IIQJxWYanP8Nyd B3Enc8L5oMOkFDy0nvLlVlojPupgbWHaXVVKW4pX3+qU+fDQAjIi7+3ps+gxuTbUwHvgnTfVF/NWE3/NMu5zlWj4A mk/Rf5LQ4r8I0tmeKB+6B1XypgrKwkWA29r84UzBqURPgcXstR7D1Dwmbcb50ILIdSA/eH0V32jGRA5tYC1r0gico Zqk4rhBeQw3zJk7hf07iOUx2sjpgKGzNB7pVN/19XFUBJCY3JPxsCI0BR07ulLaipQNhcJsl7mA== Content-Length: 173 Cache-Control: no-cache Content-Type: application/json; charset=utf-8

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

Date: Wed, 25 Sep 2013 16:49:56 GMT Expires: -1 { "envelopeId": "8b07f822-a2d4-413f-a7ea-b1d262e2379b", "uri": "/envelopes/8b07f822-a2d4-413f-a7ea-b1d262e2379b", "statusDateTime": "2013-09-25T16:49:55.2007571Z", "status": "sent" }

28

Basic Scenarios
This section provides some basic scenarios for using the DocuSign REST API. The examples in this section explain basic tasks such as creating envelopes, checking envelope status and retrieving envelopes and documents.

Creating an Envelope from a Document

In this scenario, we are sending a text document for signature to a single recipient. This basic scenario example only uses a portion of the envelope parameters, refer to the Send an Envelope or Create a Draft Envelope section for information about all the envelope parameters. The basic information needed to create and send an envelope is an email subject, recipient (with name and email address) and a document. This example does not include any tabs, so the recipient will drag their signature into place on the document (this is referred to as free-form signing). The /accounts/{accountId}/envelopes uri is appended to the baseUrl value with the /login_information api to send a document for signing. Note: After using login_information to get the baseUrl, the base Url and apiPassword can be stored by the client. The login_information call is not needed in subsequent sessions, unless another call fails and the user needs to re-authenticate. Each call performs authentication. This is a multipart form request. The general envelope information (status, email text and email subject) appears first, followed by the document bytes and recipient information. In this example, a text document is used for clarity, but other document types (pdf, Word, etc.) can be used. The status value in the envelope is used to set if the envelope should be sent (status = sent) or saved as a draft (status = created). In this example there is only one document and recipient. Example Request
POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: multipart/form-data; boundary=AAA --AAA Content-Type: application/json Content-Disposition: form-data { status:sent, "emailBlurb":"Test Email Body", 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"emailSubject": "Test Email Subject EnvelopeDefFull", "documents": [{ "name": "test1.pdf", "documentId":"1" }], "recipients": { "signers" : [{ "email": "m.rosey@thomasind.com", "name": "Mike Rosey", "recipientId":"1" }] } --AAA Content-Type: application/pdf Content-Disposition: file; filename="test1.pdf"; documentid=1 <documents removed> --AAA--

29

Response The response returns the envelope ID, status, and date-time stamp for the envelope status. It also includes the uri for the envelope. The following example shows the header followed by the response json body. Example Response
201 Created Content-Length: 175 Cache-Control: private Content-Type: application/json; charset=utf-8 Date: Tue, 06 Mar 2012 17:22:17 GMT { "envelopeId": "c254d988-f501-42d3-a858-feeb50f361e2", "status": "sent", "statusDateTime": "2012-03-06T17:22:17.2030000Z", "uri": "\/envelopes\/c254d988-f501-42d3-a858-feeb50f361e2" }

Creating an Envelope from a Template

A template is a standard envelope with specific documents, set recipient roles, recipient routing order, recipient authentication, signing tabs and information fields. Templates can also contain set signing instructions for the document and signature attachment requests. Sending from a template is similar to sending an envelope from a document, but a template definition is used instead of adding a document to the envelope and template roles instead of normal recipients. This basic scenario example only uses a portion of the template parameters, refer to the Send an Envelope from a Template section for information about all the template parameters. As with sending an envelope with a document, the /accounts/{accountId}/envelopes uri is appended to the baseUrl value with the /login_information api to send a document for signing. Note: After using login_information to get the baseUrl, the base Url and apiPassword can be stored by the client. The login_information call is not needed in subsequent sessions, unless another call fails and the user needs to re-authenticate. Each call performs authentication.
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

30

The general envelope information (status, email text and email subject) appears first, followed by the template definition, which contains the unique ID for the template and the recipient roles, which have pre-assigned tags. The status value in the envelope is used to set if the envelope should be sent (status = sent) or saved as a draft (status = created). In this example, there are two recipients that are assigned to templateRoles. Example Request
POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json Content-Disposition: form-data { status:sent, "emailBlurb":"Test Email Body (Template)", "emailSubject": "Test Email Subject (Template)", "templateId":"270D920E-C65A-410D-9640-75D2FBEADAC2", "templateRoles":[ { "email":"mike.rosey@docusign.com", "name":"Mike Rosey", "roleName":"Signer 1" }, { "email":"mike.rosey@docusign.com", "name":"Lara Roseleip", "roleName":"Signer 2" } ] }

Response The response returns the envelope ID, status, and date-time stamp for the envelope status. It also includes the uri for the envelope. The following example shows the header followed by the response json body. Example Response
201 Created Content-Length: 175 Cache-Control: private Content-Type: application/json; charset=utf-8 Date: Tue, 06 Mar 2012 17:22:17 GMT { "envelopeId": "c254d988-f501-42d3-a858-feeb50f361e2", "status": "sent", "statusDateTime": "2012-03-06T17:22:17.2030000Z", "uri": "/envelopes/c254d988-f501-42d3-a858-feeb50f361e2" }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

31

Embedded Sending
The embedded sending resource retrieves a url for accessing the tagging and sending page of the DocuSign console. The envelope ID used here is the envelope that is opened in the console view. To open an envelope in the console for embedded sending, the
/accounts/{accountId}/envelopes/{envelopeId}/views/sender uri is appended to the base Url

value to get the url to open the envelope in the DocuSign console. After opening the envelope in the console, you can make changes to the envelope and send it. Example Request
POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/views/sender X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "returnUrl":"https://www.docusign.com" }

Response The response returns the url to access the console. The following example shows the header followed by the response json body. Example Response
201 Created Content-Length: 168 Cache-Control: private Content-Type: application/json; charset=utf-8 Date: Fri, 30 Mar 2012 14:53:16 GMT {"url":"https:\/\/fanyv88.com:443\/http\/localhost\/Member\/StartInSession.aspx?StartConsole=1&t=6cafaeaa-cc6b496d-812d-421b72f854de&DocuEnvelope=AB52A90E-BDC7-4F59-BFBD-90E32E984EA7&send=1"}

Embedded Signing
The embedded signing resource retrieves a url for accessing the recipient view of a DocuSign envelope. This could be used to incorporate the DocuSign signing process directly into your online process flow, without requiring the signer to leave your web page. To open an envelope embedded signing, the
/accounts/{accountId}/envelopes/{envelopeId}/views/recipient uri is appended to the base

Url value to get the url to open the envelope. The basic information needed is the envelope ID and recipient information (email, user name). Example Request
POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/views/recipient

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

32

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "authenticationMethod":"email", "email":"mike.rosey@docusign.com", "returnUrl":"http://www.docusign.com", "userName":"Mike Rosey" }

Response The response returns the url to access a recipients view. The following example shows the header followed by the response json body. Example Response
201 Created Content-Length: 96 Cache-Control: private Content-Type: application/json; charset=utf-8 Date: Fri, 30 Mar 2012 14:52:58 GMT {"url":"https:\/\/fanyv88.com:443\/http\/localhost\/Member\/StartInSession.aspx?t=d1cf42f2-30b6-499b-ab54058fbf438103"}

Requesting Envelope Status

This API should be used to periodically determine if the document has been signed and envelope completed by the recipients. DocuSign imposes API call limit restrictions to prevent flooding of API calls, so this API should be called at periodic intervals, for example, once per hour. To get general envelope status the /accounts/{accountId}/envelopes uri is appended to the baseUrl value. The information returned can be modified by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. Unless you are requesting the status for specific envelopes (using envelopeIds), you must add a from_date in the request. Refer to the Get Envelope Status Changes section for information about the query strings. Example Request This example requests any envelopes that changed Completed status since May 2, 2012.
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes ?from_date=5-2-2012+12:00:00+AM&from_to_status=changed&status=completed X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Response

33

The response returns the uris for the envelope certificate, custom fields, documents, envelope along with the envelope ID, envelope status, and the date-time stamp for the envelope status change for the envelopes. If a query string was added to the original request, only the envelopes that meet those parameters are included in the response. The following example shows the header followed by the response json body. Example Response
200 OK Content-Length: 1221 Cache-Control: private Content-Type: application/json; charset=utf-8 Date: Tue, 06 May 2012 17:22:22 GMT X-AspNet-Version: 4.0.30319 { "envelopes": [{ "certificateUri": "\/envelopes\/fd1afecb-5fc4-4f11-aac40d6fe089105f\/documents\/certificate", "customFieldsUri": "\/envelopes\/fd1afecb-5fc4-4f11-aac40d6fe089105f\/custom_fields", "documentsCombinedUri": "\/envelopes\/fd1afecb-5fc4-4f11-aac40d6fe089105f\/documents\/combined", "documentsUri": "\/envelopes\/fd1afecb-5fc4-4f11-aac40d6fe089105f\/documents", "envelopeId": "fd1afecb-5fc4-4f11-aac4-0d6fe089105f", "envelopeUri": "\/envelopes\/fd1afecb-5fc4-4f11-aac4-0d6fe089105f", "notificationUri": "\/envelopes\/fd1afecb-5fc4-4f11-aac40d6fe089105f\/notification", "recipientsUri": "\/envelopes\/fd1afecb-5fc4-4f11-aac40d6fe089105f\/recipients", "status": "completed", "statusChangedDateTime": "2012-05-23T16:21:09.2830000Z" }, { "certificateUri": "\/envelopes\/23306db8-261a-43c5-b078ac020113af09\/documents\/certificate", "customFieldsUri": "\/envelopes\/23306db8-261a-43c5-b078ac020113af09\/custom_fields", "documentsCombinedUri": "\/envelopes\/23306db8-261a-43c5-b078ac020113af09\/documents\/combined", "documentsUri": "\/envelopes\/23306db8-261a-43c5-b078ac020113af09\/documents", "envelopeId": "23306db8-261a-43c5-b078-ac020113af09", "envelopeUri": "\/envelopes\/23306db8-261a-43c5-b078-ac020113af09", "notificationUri": "\/envelopes\/23306db8-261a-43c5-b078ac020113af09\/notification", "recipientsUri": "\/envelopes\/23306db8-261a-43c5-b078ac020113af09\/recipients", "status": "completed", "statusChangedDateTime": "2012-05-23T16:20:44.7830000Z" }], "resultSetSize": 2 }

Retrieving Envelope and Documents

When an envelope reaches the completed status, the signed document and associated certificate can be downloaded from the server. The envelope uri information from the envelope status call can

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

34

be used with the uri part /documents/combined appended to download the combined document and certificate in PDF format. There are two optional flags associated with this action: watermark and certificate. watermark adds a watermark to the PDF if the envelope is not complete. It is a Boolean (true/false) setting that is set to true by default. certificate adds the certificate to the documents. It is a Boolean (true/false) that is set to false by default.

Example Request
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/documents/combined X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/pdf Content-Type: application/json

Response The response returns the document and certificate as a PDF document. The following example shows the header followed by the response json body (the byte stream is not included to limit the size of the example). Example Response
200 OK Content-Length: 100079 Cache-Control: private Content-Type: application/pdf Date: Tue, 06 Mar 2012 17:22:10 GMT <Bytes of PDF omitted>

Sending HTTP Requests with cURL

To interact with the DocuSign REST API, you need to set up your client application (we use cURL) to construct HTTP requests. Note: The examples in this section have hard returns (\n) added so the text is easier to read. If you copy and paste the examples, you will need to remove the returns in order for the example to function correctly. Additionally, you must replace the DocuSign Credentials with your specific credentials.

Setting Up Your Client Application

The REST API uses HTTP GET and HTTP POST methods to send and receive JSON and XML content, so it is easy to build client applications using the tool or the language of your choice. In this example, we use a command-line tool called cURL to simplify sending and receiving HTTP requests and responses. cURL is pre-installed on many Linux and Mac systems. Windows users can download a version at: curl.haxx.se/.
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 When using HTTPS on Windows, ensure that your system meets the cURL requirements for SSL.

35

Viewing Base Resources with cURL

You can use cURL to request the base resources available for a particular REST version. The following example requests the base resources for REST version 2.
curl -i -k -H "Accept: application/json" https://demo.docusign.net/restapi/v2/

The response would appear as:

{"resources":[{"name":"accounts","value":"https:\/\/fanyv88.com:443\/https\/demo.docusign.net\/restapi\/v2\/accou nts"},{"name":"billing_plans","value":"https:\/\/fanyv88.com:443\/https\/demo.docusign.net\/restapi\/v2\/billing_ plans"},{"name":"login_information","value":"https:\/\/fanyv88.com:443\/https\/demo.docusign.net\/restapi\/v2\/lo gin_information"}]}

Logging in with cURL

Before sending any requests, you need to log on to the system to get the account and baseUrl information for future calls. You can log on with json or xml. cURL json Login An example cURL Login (login_information) using json would be (you would have to replace the credentials in the example with your actual DocuSign credentials):
curl https://demo.docusign.net/restapi/v2/login_information -i -k -H "Accept: application/json" -H "Content-Type: application/json" -H "X-DocuSign-Authentication: <DocuSignCredentials><Username>account@domain.com</Username><Password>account_password</P assword><IntegratorKey>your integrator key</IntegratorKey></DocuSignCredentials>"

The response returns account information for the account associated with your DocuSign credentials.
{"loginAccounts":[{"accountId":"accountId#","baseUrl":"https:\/\/fanyv88.com:443\/https\/demo.docusign.net\/resta pi\/v2\/accounts\/accountId#","email":"account@domain.com","isDefault":"true","name":"Use r Name","siteDescription":"","userId":"userId#","userName":"User Name"}]}

cURL XML Login An example cURL Login (login_information) using xml would be (you would have to replace the credentials in the example with your actual DocuSign credentials):
curl https://demo.docusign.net/restapi/v2/login_information.XML -i -k -H "Accept: application/json" -H "Content-Type: application/json" -H "X-DocuSign-Authentication: <DocuSignCredentials><Username>account@domain.com</Username><Password>account_password</P assword><IntegratorKey>your integrator key</IntegratorKey></DocuSignCredentials>"

The response returns account information for the account associated with your DocuSign credentials.
<loginInformation xmlns="http://www.docusign.com/restapi" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <loginAccounts><loginAccount><accountId>account#</accountId><baseUrl>https://demo.docusig n.net/restapi/v2/accounts/accountId#</baseUrl><email> account@domain.com </email><isDefault>true</isDefault><name>User Name</name><siteDescription/><userId>usedId#</userId><userName>User Name</userName></loginAccount></loginAccounts></loginInformation>

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

36

Sending HTTP Requests Using REST API Resources

Your HTTP requests to a REST API resource should contain the following information: An HTTP method (GET, POST, PUT, or DELETE) Your HTTP Authentication Token () An HTTP ACCEPT header used to indicate the resource format (XML or JSON), or a .json or .xml extension to the URI. The default is JSON. The DocuSign REST resource. Any JSON or XML files containing information needed for requests, such as updating a record with new information.

The HTTP methods are used to indicate the desired action, such as retrieving information, as well as creating, updating, and deleting records. HEAD is used to retrieve resource metadata. GET is used to retrieve information, such as basic resource summary information. POST is used to create a new object. PUT is used to add information or items to an existing object. DELETE is used to delete a record.

To access a resource, submit an HTTP request containing a header, method, and resource name. Example Sending HTTP Requests with cURL For example, assume that we want to create an envelope from a template. The envelope information is stored in a json-formatted file called envelopeFromTemplate.json. Note: You should create a template with one signer before trying to send an envelope from a template. envelopeFromTemplate.json contains the following data:
{ "emailBlurb":"Test Email Body (Template)", "emailSubject": "Test Email Subject (Template)", "templateId":"270D920E-C65A-410D-9640-75D2FBEADAC2", "templateRoles":[ { "email":"mike.rosey@myDomain.com", "name":"Mike Rosey", "roleName":"Signer 1" } ] }

The REST Resource for creating an envelope from a template:

https://demo.docusign.net/restapi/:version/:accountId/envelopes

:version REST API version :accountId user account id An example of using the cURL on demo.docusign.net, the request would be:

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

curl x POST -- upload-file envelopeFromTemplate.json https://demo.docusign.net/restapi/v2/532/envelopes -H Content-Type: application/json -H Accept: application/json -H X-DocuSign-Authentication: <DocuSignCredentials><Username>account@domain.com</Username><Password>account passworld</Password><IntegratorKey>your integrator key</IntegratorKey></DocuSignCredentials>

37

An example of the cURL one-line command would be:

curl x POST -- upload-file envelopeFromTemplate.json https://demo.docusign.net/restapi/v2/532/envelopes -H "Content-Type: application/json" -H Accept: application/json -H X-DocuSign-Authentication: <DocuSignCredentials><Username>account@domain.com</Username><Password>account password</Password><IntegratorKey>your integrator key</IntegratorKey></DocuSignCredentials>

Chunked Transfer-Encoding Support

Because an API user might not always know the size of a document at the time of transmission, for example a document that is dynamically generated or retrieved from a network, a way to transfer the document as it is received is needed. The chunked transfer-encoding support allows POST/PUT with Transfer-Encoding: chunked instead of by setting Content-Length header. This allows API users to upload data without knowing size in advance and without pre-buffering. Note: Because it can be a complicated operation, this is best used from client toolkits that support chunked Transfer-Encoding. For more information see the HTTP Spec regarding transfer-encoding: chunked at:

http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.4 http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6

Example Chunked Transfer-Encoding

In general, chunked requests add HTTP/1.1 to the POST/PUT and a Transfer-Encoding:chunked header. The body of the request is then provided in chunked transfer coding format, where the length of each chunk, listed as a HEX number, precedes the chunk. The last chunk length must be 0. This section has an example of sending a request to create an envelope via the C#/.Net HttpWebRequest. To do this, the sendChunked property is set to true and the AllowWriteStreamBuffering property is set to false. Otherwise the HttpWebRequest is identical to the non-chunked request. The bold sections in the example show the difference from a normal request. Note that chunk lengths are spread throughout the request, corresponding to chunks written by the client to the request stream.
POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes HTTP/1.1 X-DocuSign-Authentication: [credentials omitted for brevity] Accept: application/json Content-Type: multipart/form-data; boundary=c009ab22-d9ff-4f9d-87ca-3b7a79d092e3

Transfer-Encoding:chunked
Expect: 100-continue

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

Connection: Keep-Alive

38

2A
--c009ab22-d9ff-4f9d-87ca-3b7a79d092e3

E
Content-Type:

12
application/json

15
Content-Disposition:

B
form-data

2 2706
{ "status" : "sent", "emailBlurb":"Test Email Body", "emailSubject": "Test Email Subject - EnvelopeDefFull", "asynchronous": true, "enforceSignerVisibility": true, "documents": [{ "name": "test1.pdf", "documentId": 1 }], "recipients": { "signers" : [ { "email": "m.rosey@thomasind.com", "name": "Mike Rosey", "recipientId": "1", "enforceSignerVisibility": true, "tabs": { [tabs ommitted for brevity] } } ] } }

2A
--c009ab22-d9ff-4f9d-87ca-3b7a79d092e3

E
Content-Type:

11
application/pdf

15
Content-Disposition:

1C
file; filename="test1.pdf"

1B
Content-Transfer-Encoding:

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

base64

39

2 3014
[base64 buffer omitted for brevity]

2A
--c009ab22-d9ff-4f9d-87ca-3b7a79d092e3

REST API References

This table below lists the supported REST resources, with the Login shown first followed by the other resources in URI alphabetical order, and provides a brief description and link for each resource. In all cases, the URI for the resource follows the base URI, which is retrieved from the login. Name Login HTTP Method GET URI https://{server}/restapi/{apiVersion}/ login_information Description Authenticates and provides account login information and a Base Url. Changes the password for a user. Creates an account for the DocuSign service. Delete the specified account. Returns Account information for specified account. Returns billing plan information for the specified account. Updates the billing plan for an account. Updates purchased envelope information.

Change Password Create Account Delete Account Get Account Information Get Account Billing Plan Update Account Billing Plan Purchase Additional Envelopes

PUT

/login_information/password

POST

/accounts

DELETE GET

/accounts/{accountId} /accounts/{accountId}

GET

/accounts/{accountId}/billing_plan

PUT

/accounts/{accountId}/billing_plan

PUT

/accounts/{accountId}/billing_plan/ purchased_envelopes

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Get Brand Profile Information HTTP Method GET URI /accounts/{accountId}/brands Description

40

Upload Brand Profiles

POST

/accounts/{accountId}/brands

Delete Brand Profiles

DELETE

/accounts/{accountId}/brands

Delete Captive Recipient Signature

DELETE

/accounts/{accountId}/captive_recipients/signature

Set Up a Connect Configuration Get All Connect Configuration Information Update a Connect Configuration Get a Connect Configuration Information

POST

/accounts/{accountId}/connect

GET

/accounts/{accountId}/connect

PUT

/accounts/{accountId}/connect

GET

/accounts/{accountId}/connect/{connectId}

Delete a Connect Configuration Republish Connect Information for One Envelope

DELETE

/accounts/{accountId}/connect/{connectId}

PUT

/accounts/{accountId}/connect/envelopes/ {envelopeId}/retry_queue

Returns a list of brand profiles associated with the account and the default brand profiles. Uploads one or more brand profile files in a zip file for the account. Deletes one or more brand profiles from an account. This deletes the signature for one or more captive recipient records; it is primarily used for testing. Sets up and configures a DocuSign Custom Connect definition. Retrieves all the DocuSign Custom Connect definitions for your account. Updates a DocuSign Connect configuration. Retrieves the information about one DocuSign Connect configuration. Deletes one DocuSign Connect configuration. Republishes Connect information for a single envelope.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Republish Connect Information for Multiple Envelopes Get the Connect Failure Log Get a Connect Failure Log Entry Clear a Connect Failure Log Entry Get the Connect Log Clear the Connect Log Get One Connect Log Entry Clear One Connect Log Entry Get Consumer Disclosure HTTP Method PUT URI /accounts/{accountId}/connect/envelopes/ retry_queue Description

41

Republishes Connect information for the set of envelopes. Retrieves the Connect Failure Log information. Retrieves the Connect Failure Log information for one entry. Clears (removes) the Connect Failure Log information for one entry. Retrieves a list of connect log entries for your account. Clears (removes) the entries from the Connect Log. Retrieves one Connect log entry. Clears (removes) one entry from the Connect Log. Returns the consumer disclosure, with html formatting, associated with the account Gets a list of all envelope custom fields associated with the account.

GET

/accounts/{accountId}/connect/failures

GET

/accounts/{accountId}/connect/failures/{failureId}

DELETE

/accounts/{accountId}/connect/failures/{failureId}

GET

/accounts/{accountId}/connect/logs

DELETE

/accounts/{accountId}/connect/logs

GET

/accounts/{accountId}/connect/logs/{logId}

DELETE

/accounts/{accountId}/connect/logs/{logId}

GET

/accounts/{accountId}/consumer_disclosure

Get List of Account Custom Fields

GET

/accounts/{accountId}/custom_fields

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Send an Envelope or send an Envelope from a Template including creating Draft Envelopes HTTP Method POST URI /accounts/{accountId}/envelopes Description

42

Get Envelope Status changes Get Envelope Status for one envelope Send Draft Envelope

GET

/accounts/{accountId}/envelopes

GET

/accounts/{accountId}/envelopes/{envelopeId}

PUT

/accounts/{accountId}/envelopes/{envelopeId}

Void an Envelope

PUT

/accounts/{accountId}/envelopes/{envelopeId}

Get Envelope Audit Events Add Envelope Custom Fields to an Envelope

GET POST

/accounts/{accountId}/envelopes/{envelopeId}/ audit_events /accounts/{accountId}/envelopes/{envelopeId}/ custom_fields

Get Envelope Custom Field Information

GET

/accounts/{accountId}/envelopes/{envelopeId}/ custom_fields

If status is set to sent, this creates an envelope and sends it to recipients. If status is set to created, this creates an envelope in the draft folder. This can use a multipart/form-data format that may include binary files. This can use a template. Returns envelope status changes for all envelopes. Returns the overall status for a single envelope. Sends a draft envelope by adding status:sent to request body. Voids an in process envelope by adding status:voided and a reason to voidReason to the request body. Returns the events for this envelope. Adds envelope custom fields to draft and inprocess envelopes. Returns the custom field information for a single envelope.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Modify Envelope Custom Fields for an Envelope Remove Envelope Custom Fields from an Envelope Add Documents to a Draft Envelope Remove Documents from a Draft Envelope Get list of Envelope documents Add one Document to Draft Envelope Get document from Envelope Get a Page Image Rotate a Page Image Remove a Page HTTP Method PUT URI /accounts/{accountId}/envelopes/{envelopeId}/ custom_fields Description

43

DELETE

/accounts/{accountId}/envelopes/{envelopeId}/ custom_fields

PUT

/accounts/{accountId}/envelopes/{envelopeId}/ documents

Modify the envelope custom fields for draft and in-process envelopes. Removes envelope custom fields for draft and inprocess envelopes. Adds one or more documents to draft envelope. Removes one or more documents from draft envelope. Returns a list of documents associated with the specified envelope. Adds one document to draft envelope. Retrieves a document from the envelope. Returns a page image for display. Rotates a page image for display. Removes a page from a document based on the page ID. Retrieves the custom document field information for an existing envelope document.

DELETE

/accounts/{accountId}/envelopes/{envelopeId}/ documents

GET

/accounts/{accountId}/envelopes/{envelopeId}/ documents

PUT

/accounts/{accountId}/envelopes/{envelopeId}/ documents/{documentId} /accounts/{accountId}/envelopes/{envelopeId}/ documents/{documentId} /accounts/{accountId}/envelopes/{envelopeId}/ documents/{documentId}/pages/{pageId}/ page_image /accounts/{accountId}/envelopes/{envelopeId}/ documents/{documentId}/pages/{pageId}/ page_image /accounts/{accountId}/envelopes/{envelopeId}/ documents/{documentId}/pages/{pageId}

GET

GET

PUT

DELETE

Get Custom Document Fields for an Envelope Document

GET

/accounts/{accountId}/envelopes/{envelopeId}/doc uments/{documentId}/fields

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Add Custom Document Fields to an Envelope Document Modify Custom Document Fields for an Envelope Document Delete Custom Document Fields from an Envelope Document Get Envelope Certificate HTTP Method POST URI /accounts/{accountId}/envelopes/{envelopeId}/doc uments/{documentId}/fields Description

44

PUT

/accounts/{accountId}/envelopes/{envelopeId}/doc uments/{documentId}/fields

DELETE

/accounts/{accountId}/envelopes/{envelopeId}/doc uments/{documentId}/fields

GET

/accounts/{accountId}/envelopes/{envelopeId}/ documents/certificate

Get Envelope GET documents and Certificate

/accounts/{accountId}/envelopes/{envelopeId}/ documents/combined

Get Envelope Notification Information

GET

/accounts/{accountId}/envelopes/{envelopeId}/ notification

Get Envelope Recipient Status Add Recipients to an Envelope Remove Recipients from an Envelope

GET

/accounts/{accountId}/envelopes/{envelopeId}/ recipients /accounts/{accountId}/envelopes/{envelopeId}/ recipients /accounts/{accountId}/envelopes/{envelopeId}/ recipients

POST

DELETE

Adds custom document fields for an existing envelope document. Modifies existing custom document fields for an existing envelope document. Deletes custom document fields for an existing envelope document. Retrieves a PDF document containing the certificate of completion for the envelope. Retrieves a PDF containing the combined envelope documents and certificate of completion. Returns the reminder and expiration information for the envelope. Returns the status for all recipients of a single envelope. Adds one or more recipients to an envelope. Removes one or more recipients from an envelope.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Modify or Correct and Resend Recipient Information HTTP Method PUT URI /accounts/{accountId}/envelopes/{envelopeId}/ recipients Description

45

Set Initials Image for Accountless Signer Get Signature Information for Accountless Signer Set Signature Image for Accountless Signer Add Tabs for a Recipient Get Tab Information for a Recipient Delete Tabs for a Recipient Modify Tabs for a Recipient

PUT

/accounts/{accountId}/envelopes/{envelopeId}/ recipients/{recipientId}/initials_image

Modifies a recipient in a draft envelope or to update and resend recipient information for an in process envelope. Can also be used to resend an envelope. Sets a recipient signature initials image. Gets a recipients signature information. Sets a recipient signature image.

GET

/accounts/{accountId}/envelopes/{envelopeId}/ recipients/{recipientId}/signature

PUT

/accounts/{accountId}/envelopes/{envelopeId}/ recipients/{recipientId}/signature_image

POST GET

/accounts/{accountId}/envelopes/{envelopeId}/ recipients/{recipientId}/tabs /accounts/{accountId}/envelopes/{envelopeId}/ recipients/{recipientId}/tabs /accounts/{accountId}/envelopes/{envelopeId}/ recipients/{recipientId}/tabs /accounts/{accountId}/envelopes/{envelopeId}/ recipients/{recipientId}/tabs

DELETE PUT

Get a List of Templates used in an envelope Post an Envelope Correction Post Recipient View

GET

/accounts/{accountId}/envelopes/{envelopeId}/ templates

POST

/accounts/{accountId}/envelopes/{envelopeId}/ views/correct

POST

/accounts/{accountId}/envelopes/{envelopeId}/ views/recipient

Adds one or more tabs for a recipient. Retrieve tabs information for a recipient. Delete one or more tabs for a recipient. Modify one or more tabs for a ricipeint in a draft envelope. Returns a list of the templates, name and ID, used in an envelope. Provides a URL to start the correction view of the DocuSign UI. Provides a URL to start the recipient view of the DocuSign UI.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Post Sender View HTTP Method POST URI /accounts/{accountId}/envelopes/{envelopeId}/ views/sender Description

46

Get Envelope PUT Status for more than one envelope Get Folder List GET

/accounts/{accountId}/envelopes/status

/accounts/{accountId}/folders

Get Folder Envelope List Move Envelopes or delete envelopes

GET

/accounts/{accountId}/folders/{folderId}

PUT

/accounts/{accountId}/folders/{folderId}

Add a New Group Get Group Information Modify Group Information Get Group Brand ID Information

POST GET

/accounts/{accountId}/groups /accounts/{accountId}/groups

PUT GET

/accounts/{accountId}/groups /accounts/{accountId}/groups/{groupId}/brands

Add Group Brand ID Information Delete Group Brand ID Information Add Users to a Group

PUT

/accounts/{accountId}/groups/{groupId}/brands

DELETE

/accounts/{accountId}/groups/{groupId}/brands

PUT

/accounts/{accountId}/groups/{groupId}/users

Provides a URL to start the sending view of the DocuSign UI. Returns envelope status for a selected list of envelopes. Returns a list of the folders for the account, including the folder hierarchy. Returns a list of envelopes in the folder. Moves envelopes to the listed folder. This can be used to delete envelopes by moving the envelope to the recycle bin folder. Adds new user groups. Returns a list of user groups in the account. Modifies user group information. Returns information about the brands associated with the requested group. Adds brand information to a group. Removes brand information from the requested group. Adds users to a user group.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Get List of Users in a Group Remove Users from a Group Get a List of Permission Profiles Get Recipient Names HTTP Method GET URI /accounts/{accountId}/groups/{groupId}/users Description

47

DELETE

/accounts/{accountId}/groups/{groupId}/users

GET

/accounts/{accountId}/permission_profiles

GET

/accounts/{accountId}/recipient_names

Get List of Envelopes in a Folders Get Account Settings

GET

/accounts/{accountId}/search_folders/ {search_folder} /accounts/{accountId}/settings

GET

Modify Account PUT Settings Get List of Templates Post a Template Get a Template Get Custom Document Fields for a Template Document Add Custom Document Fields to a Template Document GET

/accounts/{accountId}/settings

/accounts/{accountId}/templates

POST

/accounts/{accountId}/templates

GET

/accounts/{accountId}/templates/{templateId}

GET

/accounts/{accountId}/templates/{templateId}/docu ments/{documentId}/fields

POST

/accounts/{accountId}/templates/{templateId}/docu ments/{documentId}/fields

Returns a list of users in a user group. Removes a user from a user groups. Returns a list of permission profiles for the account. Returns the recipient names associated with an email address in the account. Returns a list of envelopes from the specified folder. Returns the settings list for specified account Modifies the setting list for specified account Retrieves the list of templates for this account. Posts a template definition using a multipart request. Retrieves the definition for an existing template. Retrieves the custom document fields for an existing document in a template. Adds custom document fields for an existing template document.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Modify Custom Document Fields for a Template Document Delete Custom Document Fields from a Template Document Share a Template with a Group Remove Template Sharing for a Group Get List of Unsupported File Types Add User to Account Get User list HTTP Method PUT URI /accounts/{accountId}/templates/{templateId}/docu ments/{documentId}/fields Description

48

DELETE

/accounts/{accountId}/templates/{templateId}/docu ments/{documentId}/fields

PUT

/accounts/{accountId}/templates/{templateId}/ groups /accounts/{accountId}/templates/{templateId}/ groups

Modifies existing custom document fields for an existing template document. Deletes custom document fields for an existing template document. Shares a template with a user group. Removes template sharing from a user group. Retrieves a list of file types that are not supported for uploads. Add users to an account Returns a list of users in the specified account. Closes a user for the account. Retrieves the user information for specified user. Retrieves a list of custom user settings for a single user. Add or update custom user settings for a single user. Deletes the specified custom user settings for a single user.

DELETE

GET

/accounts/{accountId}/unsupported_file_types

POST GET

/accounts/{accountId}/users /accounts/{accountId}/users

Close a User Get User Information Get Custom User Settings

DELETE GET

/accounts/{accountId}/users /accounts/{accountId}/users/{userId}

GET

/accounts/{accountId}/users/{userId}/ custom_settings

Add or Modify Custom User Settings Delete Custom User Settings

PUT

/accounts/{accountId}/users/{userId}/ custom_settings

DELETE

/accounts/{accountId}/users/{userId}/ custom_settings

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Get User Profile HTTP Method GET URI /accounts/{accountId}/users/{userId}/profile Description

49

Modify User Profile

PUT

/accounts/{accountId}/users/{userId}/profile

Get User Profile image Modify User Profile image Delete User Profile image Get User Account Settings Modify User Account Settings Get a List of User Signature Definitions Set User Signature and Initials Images

GET

/accounts/{accountId}/users/{userId}/profile/image

PUT

/accounts/{accountId}/users/{userId}/profile/image

DELETE

/accounts/{accountId}/users/{userId}/profile/image

GET

/accounts/{accountId}/users/{userId}/settings

PUT

/accounts/{accountId}/users/{userId}/settings

Returns the user profile information for the specified user. Updates the user profile information for the specified user. Returns the profile (ID card) image for the specified user. Updates the profile (ID card) image for the specified user. Deletes the profile (ID card) image for the specified user. Returns settings list for specified user. Update settings for specified user. Returns the list of signature definitions for the specified user. This allows user signature and/or initials images to be set when a signature is created. Returns information about a single signature. Updates a user signature. Closes the user signature. Returns a specific initials image. Saves a specific initials image.

GET

/accounts/{accountId}/users/{userId}/signatures

POST

/accounts/{accountId}/users/{userId}/signatures

Get information about a user signature Modify a user signature Close a user signature Get a user initials image Set a user initials image

GET

/accounts/{accountId}/users/{userId}/signatures/ {signatureIdOrName} /accounts/{accountId}/users/{userId}/signatures/ {signatureIdOrName} /accounts/{accountId}/users/{userId}/signatures/ {signatureIdOrName} /accounts/{accountId}/users/{userId}/signatures/ {signatureIdOrName}/initials_image /accounts/{accountId}/users/{userId}/signatures/ {signatureIdOrName}/initials_image

PUT DELETE GET PUT

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Delete a user initials image Get a user signature image Set a user signature image Delete a user signature image Add a User Social Account Get User Social Accounts Remove a User Social Account Post Authentication View Get Account provisioning information Get list of billing plans Get billing plan details Revoke an Authorization Token Create an Authorization Token HTTP Method DELETE GET URI /accounts/{accountId}/users/{userId}/signatures/ {signatureIdOrName}/initials_image /accounts/{accountId}/users/{userId}/signatures/ {signatureIdOrName}/signature_image /accounts/{accountId}/users/{userId}/signatures/ {signatureIdOrName}/signature_image /accounts/{accountId}/users/{userId}/signatures/ {signatureIdOrName}/signature_image /accounts/{accountId}/users/{userId}/social Description

50

Deletes a specific initials image. Returns a specific signature image. Saves a specific signature image. Deletes a specific signature image. Add social account information for a user. Returns a list of social accounts for a user. Removes a social account for a user. Provides a URL to start the authentication view of the DocuSign UI Returns Account provisioning information. Returns the plans associated with a distributor. Returns details for a specified billing plan. Revokes an authorization token Creates an OAuth2 authorization server token endpoint.

PUT

DELETE

PUT

GET

/accounts/{accountId}/users/{userId}/social

DELETE

/accounts/{accountId}/users/{userId}/social

POST

/accounts/{accountId}/views/console

GET

/accounts/provisioning

GET

/billing_plans

GET

/billing_plans/{planId}

POST

/oauth2/revoke

POST

/oauth2/token

Login
The /login_information API is used to determine if a user is authenticated and to choose the account to be used for other operations. Each account associated with the login credentials is listed.
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

51

The baseUrl parameter is used in all future API calls as the base of the request URL. This baseUrl contains the DocuSign server, the API version, and the accountId to be used for the login. This request uses your DocuSign credentials to retrieve the account information. URL: https://{server}/restapi/{apiVersion}/login_information Optional query strings: api_password={true or false}, include_account_id_guid={true or false}, login_settings={all or none} Formats: XML, JSON HTTP Method: GET Parameters: There are no required parameters, but the following optional query strings can be added to the request. Name api_password include_account_id_guid login_settings Reqd? No No No Type Boolean Boolean String Description When set to true, shows the account API password in the response. When set to true, shows the account ID GUID in the response. Can be set to all or none. When set to all, all the login settings are returned. When set to none, no login settings are returned.

Example Request Body

GET https://{server}/restapi/{apiVersion}/login_information X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns account information for the account associated with your DocuSign credentials, along with any optional information included in the request. The baseUrl information for future calls is included in the response. The following example shows the header followed by the response json body.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Example Response Body

200 OK Content-Length: 557 Cache-Control: private Content-Type: application/json; charset=utf-8 Date: Tue, 06 Mar 2012 17:22:07 GMT { "apiPassword":"String content", "loginAccounts":[{ "accountId":"String content", "baseUrl":"String content", "email":"String content", "isDefault":"String content", "loginAccountSettings":[{ "name":"String content", "value":"String content" }], "loginUserSettings":[{ "name":"String content", "value":"String content" }], "name":"String content", "siteDescription":"String content", "userId":"String content", "userName":"String content" }] }

52

Change Password
This changes the password for a user. URL: /login_information/password Formats: XML, JSON HTTP Method: PUT Parameters: Name currentPassword email forgottenPasswordInfo Reqd? Yes Yes No Type String String String Description The users current password The users email address for the associated account. A complex element that has up to four Question/Answer pairs for forgotten password information.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name newPassword Example Request Body
PUT https://{server}/restapi/{apiVersion}/login_information/password

53 Type String Description The users new password.

Reqd? Yes

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "currentPassword": "String content", "email": "String content", "forgottenPasswordInfo": { "forgottenPasswordAnswer1": "String content", "forgottenPasswordAnswer2": "String content", "forgottenPasswordAnswer3": "String content", "forgottenPasswordAnswer4": "String content", "forgottenPasswordQuestion1": "String content", "forgottenPasswordQuestion2": "String content", "forgottenPasswordQuestion3": "String content", "forgottenPasswordQuestion4": "String content" }, "newPassword": "String content" }

Response The response returns a success or failure.

Create Account
This creates a new account for using the DocuSign service. URL: /accounts Formats: XML, JSON HTTP Method: POST Parameters: Name accountName Reqd? Yes Type String Description The account name for the new account.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name accountSettings Reqd? No Type Description

54

The name/value pair information for account settings. These determine the features available for the account. The accountSettings are listed and described below. String A complex type that contains the following information for the new account (all string content): address1, address2, city, country, fax, phone, postalCode and state. Note: If country is US (United States) then State codes are validated for US States. Otherwise, State is treated as a non-validated string and serves the purpose of entering a state/province/region. The maximum characters for the strings are: - address1, address2, city, country and state: 100 characters - postalCode, phone, and fax: 20 characters A complex type that has information about the credit card used to pay for this account. It included the elements (all string content): cardNumber, cardType, expirationMonth, expirationYear and nameOnCard The Distributor Code that identifies the billing plan groups and plans for the new account. The Distributor Password for the distributorCode. A complex type with the initial user information for the new account. See Add User To Account for more information on the settings needed for a user. This is the ISO currency code for the account.

addressInformation

No

creditCardInformation

No

String

distributorCode

No

String

distributorPassword initialUser

No Yes

String

planInformation currencyCode

Yes

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name planInformation planFeatureSets Reqd? No Type Description

55

A complex type that sets the feature sets for the account. It contains the following information (all string content): currencyFeatureSetPrices - This contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, seatFee that are configured for this plan feature set. envelopeFee - An incremental envelope cost for plans with envelope overages (when isEnabled=true). featureSetId - A unique ID for the feature set. fixedFee - A one-time fee associated with the plan (when isEnabled=true). isActive - Determines if the feature set is actively set as part of the plan. isEnabled - Determines if the feature set is actively enabled as part of the plan. name - The name of the feature set. seatFee - An incremental seat cost for seat-based plans (when isEnabled=true). String The DocuSign Plan ID for the account A complex type that contains the following information (all string content): EnableSupport, IncludedSeats, ReferrerName, ReferralCode, AdvertisementID, PublisherID, ShopperID, PromoCode, GroupMemberID, IdType, and Industry. A complex type that contains the following information: email The users email address. provider The social account provider (Facebook, Yahoo, etc.). socialId userName The full user name for the account.

planInformation planId referralInformation

No No

socialAccountInformation.

No

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 accountSettings: The accountSettings set the account feature information. Setting Name allowInPerson allowOfflineSigning Value Boolean Boolean Authorization Required SysAdmin Admin Description

56

allowSignerReassign

Boolean

Admin

attachCompletedEnvelope

Boolean

Admin

autoNavRule

String

Admin

canSelfBrandSend

Boolean

SysAdmin

canSelfBrandSign

Boolean

SysAdmin

enableAutoNav

Boolean

SysAdmin or EnableAutoNa vByDSAdmin is set Admin & AllowExpressi on is set

When true, the account allows In Person Signing. When true, the account can use Offline Signing and envelopes signed using offline signing on mobile devices are synchronized with this account. This option and the inSessionEnabled option must both be enabled (true) for a caller to use offline signing. When true, the account allows signers to reassign an envelope. When true, envelope documents are included as a PDF file attachment for signing completed emails. The auto-navigation rule for the account. Enumeration values are: Off, RequiredFields, RequiredAndBlankFields, AllFields, PageThenRequiredFields, PageThenRequiredAndBlankFi elds, PageThenAllFields. When true, account administrators can self-brand their sending console through the DocuSign Console. When true, account administrators can self-brand their signing console through the DocuSign Console. When true, the auto-navigation is enabled for the account.

enableCalculatedFields

Boolean

When true, this account can use the Calculated Fields feature.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 enableDSPro Boolean SysAdmin

57 When true, this account can send and manage envelopes from the DocuSign Desktop Client. When true, senders for this account can choose to have the envelope ID stamped in the document margins. When true, Payment Processing is enabled for the account. When true, PowerForm access is enabled for the account. When true, an account administrator can reserve web domain and users. When true, this account can use the Agent Recipient Type. When true, this account can use the Intermediary Recipient Type. When true, this account can use the Editor Recipient Type. When true, the account can define the routing order of recipients for envelopes sent using the DocuSign API. When true, the account can define the routing order of recipients for envelopes sent using the DocuSign console. When true, a user can request attachments from a signer. When true, a user can allow signers to use the sign on paper option. When true, a user can override the default account setting for the sign on paper option. When true, Transaction Point is enabled for this account. When true, this account can use electronic vaulting for

enableEnvelopeStampingByAccou ntAdmin

Boolean

SysAdmin or account has EnableEnvelo peStampingBy DSAdmin set Admin & AllowPayment Processing is set. SysAdmin SysAdmin

enablePaymentProcessing

Boolean

enablePowerForm enableReservedDomain

Boolean Boolean

enableSendToAgent enableSendToIntermediary

Boolean Boolean

SysAdmin Admin & AllowSendToI ntermediary is set Admin SysAdmin

enableSendToManage enableSequentialSigningAPI

Boolean Boolean

enableSequentialSigningUI

Boolean

SysAdmin

enableSignerAttachments enableSignOnPaper

Boolean Boolean

Admin Admin

enableSignOnPaperOverride

Boolean

Admin

enableTransactionPoint enableVaulting

Boolean Boolean

SysAdmin SysAdmin

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

58 documents. Shows the envelope integration rule for the account. Enumeration values are: NotAllowed, Full, IntegrationSendOnly. When true, envelope integration is enabled for the account. When true, envelopes sent by this account automatically have the envelope ID stamped in the margins, unless the sender selects not to have them stamped. Indicates when a users authentication expires. Enumeration values are: Always, Never, Variable. Variable uses the value in IDCheckExpireDays. The number of days before a users authentication expires. This is only active if the IDCheckExpire value is Variable. Indicates if authentication is required by envelope signers. Enumeration values are: Always, Never, or Optional. Optional means the authentication is determined by the sender. The default question used by the In Person signing host for an In Person signing session. When true, the account can use In Session (embedded) and offline signing. This option and the allowOfflineSigning option must both be enabled (true) for a caller to use offline signing. The policy for adding a digital certificate to downloaded, printed and emailed documents. Enumeration values are:

envelopeIntegrationAllowed

String

SysAdmin

envelopeIntegrationEnabled

Boolean

Admin & EnvelopeInteg rationAllowed is set (GET only)

envelopeStamplingDefaultValue

Boolean

idCheckExpire

String

Admin

idCheckExpireDays

Integer

Admin

idCheckRequired

String

Admin

inPersonIDCheckQuestion

String

Admin

inSessionEnabled

Boolean

Admin

pkiSignDownloadedPDFDocs

String

Admin

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

59 NoSign, NoSignAllowUserOverride, YesSign The amount of idle activity time, in minutes, before a user is automatically logged out of the system. The minimum setting is 20 minutes and the maximum setting is 120 minutes. The date/time format applied to Date Signed fields for the account. When true, the Certificate of Completion is included in the envelope documents PDF when it is downloaded. When true, the signer without a DocuSign account can create a DocuSign account after signing.

sessionTimeout

Integer

Admin

signDateFormat

String

Admin

signerAttachCertificateToEnvelop ePDF

Boolean

AccountAdmin & account is selected in AccountSignin gSettings AccountAdmin & account is selected in AccountSignin gSettings AccountAdmin & account is selected in AccountSignin gSettings Admin

signerCanCreateAccount

Boolean

signerCanSignOnMobile

Boolean

When true, signer can use the DocuSign mobile signing user interface.

signerInSessionUseEnvelopeCom pleteEmail

Boolean

signerMustHaveAccount

Boolean

AccountAdmin & account is selected in AccountSignin gSettings AccountAdmin & account is selected in AccountSignin gSettings

When true, an envelope complete email is sent to an In Session (embedded) or offline signer after DocuSign processes the envelope. When true, senders can only send an envelope to a recipient that has a DocuSign account.

signerMustLoginToSign

Boolean

When true, an envelope signer must log in to the DocuSign console to sign an envelope.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 signerShowSecureFieldInitialValu es Boolean AccountAdmin & account is selected in AccountSignin gSettings AccountAdmin & account is selected in AccountSignin gSettings SysAdmin

60 When true, the initial value of all SecureFields is written to the document when sent.

useAccountLevelEmail

Boolean

When true, the content of notification emails is determined at the account level. When true, the account can use the DocuSign API. Not needed if an Integrator Key is used.

usesAPI

Boolean

Example Request Body

POST https://{server}/restapi/{apiVersion}/accounts/ X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> { "accountName":"String content", "accountSettings":[{ "name":"String content", "value":"String content" }], "addressInformation":{ "address1":"String content", "address2":"String content", "city":"String content", "country":"String content", "fax":"String content", "phone":"String content", "postalCode":"String content", "state":"String content" }, "creditCardInformation":{ "cardNumber":"String content", "cardType":"String content", "expirationMonth":"String content", "expirationYear":"String content", "nameOnCard":"String content" }, "distributorCode":"String content", "distributorPassword":"String content", "initialUser":{ "activationAccessCode":"String content", "email":"String content", "enableConnectForUser":"String content", "firstName":"String content", "forgottenPasswordInfo":{ "forgottenPasswordAnswer1":"String "forgottenPasswordAnswer2":"String "forgottenPasswordAnswer3":"String "forgottenPasswordAnswer4":"String

content", content", content", content",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"forgottenPasswordQuestion1":"String "forgottenPasswordQuestion2":"String "forgottenPasswordQuestion3":"String "forgottenPasswordQuestion4":"String }, content", content", content", content"

61

"groupList":{ "groupId":"String content", "groupId":"String content" },

"lastName":"String content", "middleName":"String content", "password":"String content", "sendActivationOnInvalidLogin":"String content", "suffixName":"String content", "title":"String content", "userName":"String content", "userSettings":[{ "name":"String content", "value":"String content" }] }, "planInformation":{ "currencyCode":"String content", "planFeatureSets":[{ "currencyFeatureSetPrices":[{ "currencyCode":"String content", "currencySymbol":"String content", "envelopeFee":"String content", "fixedFee":"String content", "seatFee":"String content" }], "envelopeFee":"String content", "featureSetId":"String content", "fixedFee":"String content", "isActive":"String content", "isEnabled":"String content", "name":"String content", "seatFee":"String content" }], "planId":"String content" } "referralInformation":{ "advertisementId":"String content", "enableSupport":"String content", "groupMemberId":"String content", "idType":"String content", "includedSeats":"String content", "industry":"String content", "planStartMonth":"String content", "promoCode":"String content", "publisherId":"String content", "referralCode":"String content", "referrerName":"String content", "saleDiscountPercent":"String content", "shopperId":"String content" }, "socialAccountInformation":{ "email":"String content", "provider":"String content", "socialId":"String content", "userName":"String content" } }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Response The response returns the new account ID, password and the default user information. The following example shows the response json body. Example Response Body
{ "accountId":"String content", "apiPassword":"String content", "baseUrl":"String content", "userId":"String content" }

62

Delete Account
This deletes the specified account. URL: /accounts/{accountId} Formats: XML, JSON HTTP Method: DELETE Parameters: No parameters are required, only the specified account ID. Example Request Body
DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId} X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

Response The response body only returns a success or failure.

Get Account Information

This returns the account information for the specified account. URL: /accounts/{accountId}/
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Formats: XML, JSON HTTP Method: GET Parameters: No parameters are required, only the specified account ID. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}

63

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

Response The response returns the account information for the requested account. The following example shows the response json body. Example Response Body
{ "accountName":"String content", "billingPeriodEndDate":"String content", "billingPeriodEnvelopesAllowed":"String content", "billingPeriodEnvelopesSent":"String content", "billingPeriodStartDate":"String content", "connectPermission":"String content", "currencyCode":"String content", "currentPlanId":"String content", "distributorCode":"String content", "docuSignLandingUrl":"String content", "forgottenPasswordQuestionCount":"String content", "planEndDate":"String content", "planName":"String content", "planStartDate":"String content", "suspensionDate":"String content", "suspensionStatus":"String content" }

Get Account Billing Plan

This returns the billing plan information for the specified account. URL: /accounts/{accountId}/billing_plans

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/billing_plan

64

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

Response The response returns the billing plan information, including the currency code, for the plan. The parameters are the same as those shown in the Get Billing Plan Details reference. The following example shows the response json body. Example Response Body
{ "billingPlan": { "planId": "string", "planName": "string", "paymentCycle": "string", "paymentMethod": "string", "perSeatPrice": "string", "otherDiscountPercent": "string", "supportIncidentFee": "string", "supportPlanFee":"string", "includedSeats": "string", "enableSupport": "string", "currencyCode": "string", "seatDiscounts": [ { "beginSeatCount": "string", "endSeatCount": "string", "discountPercent": "string" } ], "planFeatureSets": [ { "featureSetId": "string", "isActive": "string", "name": "string", "fixedFee": "string", "envelopeFee": "string", "seatFee": "string", "isEnabled": "string", "currencyFeatureSetPrices": [ {

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"currencyCode": "string", "fixedFee": "string", "seatFee": "string", "envelopeFee": "string", "currencySymbol": "string" } ] } ] }, "successorPlans": [ { "planName": "string", "paymentCycle": "string", "paymentMethod": "string", "perSeatPrice": "string", "otherDiscountPercent": "string", "supportIncidentFee": "string", "supportPlanFee": "string", "includedSeats": "string", "enableSupport": "string", "planId": "string", "seatDiscounts": [ { "beginSeatCount": "string", "endSeatCount": "string", "discountPercent": "string" } ], "planFeatureSets": [ { "featureSetId": "string", "isActive": "string", "name": "string", "fixedFee": "string", "envelopeFee": "string" "seatFee": "string", "isEnabled": "string", "currencyFeatureSetPrices": [ { "currencyCode": "string", "fixedFee": "string", "seatFee": "string", "envelopeFee": "string", "currencySymbol": "string" } ] } ], "currencyPlanPrices": [ { "currencyCode": "string", "perSeatPrice": "string", "supportIncidentFee": "string", "supportPlanFee": "string", "currencySymbol": "string" } ] } ] }

65

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

66

Update Account Billing Plan

This updates the billing plan for the specified account. URL: /accounts/{accountId}/billing_plan Formats: XML, JSON HTTP Method: PUT Parameters: Name billingAddress Reqd? No Type String Description A complex type that contains the following information for the new account: address1, address2, city, country, fax, phone, postalCode and state. Note: If country is US (United States) then State codes are validated for US States. Otherwise, State is treated as a non-validated string and serves the purpose of entering a state/province/region. A complex type that has information about the credit card used to pay for this account. It included the elements: cardNumber, cardType, expirationMonth, expirationYear and nameOnCard If true, the plan has support enabled. The number of seats included in the plan This is the ISO currency code for the account.

creditCardInformation

No

String

enableSupport includeSeats planInformation currencyCode

No No Yes

Boolean String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name planInformation planFeatureSets Reqd? See Desc. Type Description

67

A complex type that sets the feature sets for the account. It contains the following information (all string content): currencyFeatureSetPrices - This contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, seatFee that are configured for this plan feature set. envelopeFee - An incremental envelope cost for plans with envelope overages (when isEnabled=true). featureSetId - A unique ID for the feature set. fixedFee - A one-time fee associated with the plan (when isEnabled=true). isActive - Determines if the feature set is actively set as part of the plan. isEnabled - Determines if the feature set is actively enabled as part of the plan. name - The name of the feature set. seatFee - An incremental seat cost for seat-based plans (when isEnabled=true). String The plan ID for the account. It uniquely identifies a plan and is used to set plans in other functions.

planInformation planId

No

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/billing_plan X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> { "billingAddress":{ "address1":"String content", "address2":"String content", "city":"String content", "country":"String content", "fax":"String content", "phone":"String content", "postalCode":"String content", "state":"String content" }, "creditCardInformation":{ "cardNumber":"String content", 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"cardType":"String content", "expirationMonth":"String content", "expirationYear":"String content", "nameOnCard":"String content" }, "enableSupport":"String content", "includedSeats":"String content", "planInformation":{ "planFeatureSets":[{ "currencyFeatureSetPrices":[{ "currencyCode":"String content", "currencySymbol":"String content", "envelopeFee":"String content", "fixedFee":"String content", "seatFee":"String content" }], "envelopeFee":"String content", "featureSetId":"String content", "fixedFee":"String content", "isActive":"String content", "isEnabled":"String content", "name":"String content", "seatFee":"String content"

68

}], "planId":"String content" }

}

Response The response returns a success or failure.

Purchase Additional Envelopes

IMPORTANT: At this time, this operation is limited to DocuSign internal use only. This completes the purchase of envelopes for your account. The actual purchase is done as part of an internal workflow interaction with an envelope vendor. URL: /accounts/{accountId}/billing_plan/purchased_envelopes Formats: XML, JSON HTTP Method: PUT Parameters: Name amount Reqd? Yes Type String Description The total amount of the purchase.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name appName currencyCode Reqd? No No Type String String Description

69

The AppName of the client application. The CurrencyCode of the purchase. This is based on the ISO 4217 currency code information. The Platform of the client application The Product ID from the AppStore. The quantity of envelopes to add to the account. The encrypted Base64 encoded receipt data. The name of the AppStore. The Transaction ID from the AppStore.

platform productId quantity receiptData storeName transactionId

No No Yes No No No

String String String String String String

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/billing_plan/ purchased_envelopes X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> { "amount":"String content", "appName":"String content", "currencyCode":"String content", "platform":"String content", "productId":"String content", "quantity":"String content", "receiptData":"String content", "storeName":"String content", "transactionId":"String content" }

Response The response returns a success or failure.

Get Brand Profile Information

This returns a list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings canSelfBrandSend and canSelfBrandSend are true) must be enabled for the account to use this. URL: /accounts/{accountId}/brands

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/brands

70

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns a list of brand profiles associated with the account and the default sending and signing brand profile. The following example shows the response json body. Example Response Body
{ "brands":[ { "brandCompany":"String content" "brandId":"String content", "brandName":"String content" }, { "brandCompany":"String content" "brandId":"String content", "brandName":"String content" } ] "recipientBrandIdDefault":"String content", "senderBrandIdDefault":"String content", }

Upload Brand Profiles

This is used to upload one or more brand profile files for the account. The Account Branding feature (accountSettings canSelfBrandSend and canSelfBrandSend are true) must be enabled for the account to use this. When uploading brand profile files, if the brandId for a brand profile already exisits for the account, an error is returned. If you want to upload a new version of an existing brand profile, you should delete the profile and then upload the newer version.
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

71

When brand profile files are being uploaded, they must be combined into one zip file and the ContentType must be application/zip. URL: /accounts/{accountId}/brands Formats: Request is application/zip and Response is XML or JSON HTTP Method: POST Parameters: No additional parameters are required.

Example Request Body

POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/brands X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/zip <base64bytes brand zip file removed for brevity>

Response The response returns if the upload is successful and the default brand profile for the account and a list of brand profiles added to the account. The following example shows the response json body. Example Response Body
{ "brands":[ { "brandCompany":"String content" "brandId":"String content", "brandName":"String content" }, { "brandCompany":"String content" "brandId":"String content", "brandName":"String content" } ] "recipientBrandIdDefault":"String content", "senderBrandIdDefault":"String content", }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

72

Delete Brand Profiles

This deletes one or more brand profiles from an account. The Account Branding feature (accountSettings canSelfBrandSend and canSelfBrandSend are true) must be enabled for the account to use this. URL: /accounts/{accountId}/brands/ Formats: XML, JSON HTTP Method: DELETE Parameters: Name brandId Reqd? Yes Type String Description The brandId to be deleted from the account.

Example Request Body

DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/brands X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "brands":[ {"brandId":"String content"}, {"brandId":"String content"} ] }

Response The response returns the success (200 OK) or failure.

Delete Captive Recipient Signature

This deletes the signature for one or more captive recipient records; it is primarily used for testing. This provides a way to reset the signature associated with a clientUserId so a new signature can be created the next time the clientUserId is used.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 URL: /accounts/{accountId}/captive_recipients/signature Formats: XML, JSON HTTP Method: DELETE Parameters: Name Email userName clientUserId Reqd? Yes Yes Yes Type String String String Description

73

The email address associated with the captive recipient. The user name associated with the captive recipient. The sender created value associated with the captive recipient.

Example Request Body

DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/ captive_recipients/signature X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "captiveRecipients": [ { "email": "String content", "userName": " String content", "clientUserId": " String content" }, { "email": " String content", "userName": " String content", "clientUserId": " String content" } ] }

Response The response returns success or failure and any error messages. The following example shows the response json body.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Example Response Body

{ "captiveRecipients": [ { "email": "sample string", "userName": "sample string", "clientUserId": "sample string", "errorDetails": { "errorCode": "sample string", "message": "sample string" } }, { "email": "sample string", "userName": "sample string", "clientUserId": "sample string", "errorDetails": { "errorCode": "sample string", "message": "sample string" } } ] }

74

Set Up a Connect Configuration

This allows you to set up and configure a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. Connect Service provides updated information about the status of these transactions and provides updates that include the actual content of document form fields; however, these updates might or might not include the document itself. Refer to the DocuSign Connect Service Guide for more information about Connect. Note: Connect must be enabled for your account to use this function. This can only be used to set up Custom Connect configurations; it cannot be used to set up Connect configurations for Box, eOriginal or Salesforce. URL: /accounts/{accountId}/connect Formats: XML, JSON HTTP Method: POST

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Parameters: Name allUsers Reqd? No Type Boolean Description

75

When true, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. When true, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information. This turns Connect logging on or off. When true, logging is turned on. A comma separated list of Envelope related events that are tracked through Connect. The possible event values are: Sent, Delivered, Signed, Completed, Declined, Voided When true, Connect will send the PDF document along with the update XML. When true, Connect will include the voidedReason for voided envelopes. When true, Connect will include the sender account as Custom Field in the data. When true, Connect will include the envelope time zone information. The name of this Connect configuration. A comma separated list of Recipient related events that are tracked through Connect. The possible event values are: Sent, Delivery Failed, Delivered, Signed/Completed, Declined, AuthenticationFailure

allowEnvelopePublish

No

Boolean

enableLog envelopeEvents

No No

Boolean String

includeDocuments

No

Boolean Boolean Boolean Boolean String String

includeEnvelopeVoidReason No includeSenderAccount includeTimeZoneInformation name recipientEvents No No Yes No

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name requireAcknowledgement Reqd? No Type Boolean Description

76

When true and a publication message fails to be acknowledged, the message goes back into the queue and the system will retry delivery after a successful acknowledgement is received. If the delivery fails a second time, the message is not returned to the queue for sending until Connect receives a successful acknowledgement and it has been at least 24 hours since the previous retry. There is a maximum of ten retries Alternately, you can use Republish Connect Information to manually republish the envelope information. When true, Connect messages are signed with an X509 certificate. This provides support for 2-way SSL in the envelope. The namespace of the SOAP interface. * This is required if useSoapInterface is set to true. This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address. Set to true if the urlToPublishTo is a SOAP endpoint. A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. * If allUsers is set to false then you must provide a list of user ids.

signMessageWithCertificate

No

Boolean

soapNameSpace

No*

String

urlToPublishTo

Yes

String

useSoapInterface userIds

No No*

Boolean String

Example Request Body

POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/connect X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "allUsers": "boolean", "allowEnvelopePublish": "boolean", "enableLog": "boolean", "envelopeEvents": "string content", "includeDocuments": "boolean", "includeEnvelopeVoidReason": "boolean", 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"includeSenderAccountasCustomField": "boolean", "includeTimeZoneInformation": "boolean", "name": "string content", "recipientEvents": "string content", "requiresAcknowledgement": "boolean", "signMessageWithX509Certificate": "boolean", "soapNamespace": "string content", "urlToPublishTo": "string content", "useSoapInterface": "boolean", "userIds": "string content" }

77

Response The response returns a success or failure with the Connect configuration information, including a DocuSign generated connectId. The following example shows the response json body. Example Response Body
{ "allUsers": "boolean", "allowEnvelopePublish": "boolean", "connectId":"String content", "enableLog": "boolean", "envelopeEvents": "string content", "includeDocuments": "boolean", "includeEnvelopeVoidReason": "boolean", "includeSenderAccountasCustomField": "boolean", "includeTimeZoneInformation": "boolean", "name": "string content", "recipientEvents": "string content", "requiresAcknowledgement": "boolean", "signMessageWithX509Certificate": "boolean", "soapNamespace": "string content", "urlToPublishTo": "string content", "useSoapInterface": "boolean", "userIds": "string content" }

Get Connect Configuration Information

This allows you to retrieve all the DocuSign Custom Connect definitions for your account. Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal or Salesforce. URL: /accounts/{accountId}/connect Formats: XML, JSON

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 HTTP Method: GET Parameters: No parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/connect

78

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the information for all the Connect configurations for the account and a count of the total number of configurations. The following example shows the response json body. Example Response Body
{ "configurations":[{ "allUsers":"String content", "allowEnvelopePublish":"String content", "connectId":"String content", "enableLog":"String content", "envelopeEvents":"String content", "includeCertSoapHeader":"String content", "includeDocuments":"String content", "includeSenderAccountasCustomField":"String content", "includeTimeZoneInformation":"String content", "name":"String content", "recipientEvents":"String content", "requiresAcknowledgement":"String content", "signMessageWithX509Certificate":"String content", "soapNamespace":"String content", "urlToPublishTo":"String content", "useSoapInterface":"String content", "userIds":"String content" }, { "allUsers":"String content", "allowEnvelopePublish":"String content", "connectId":"String content", "enableLog":"String content", "envelopeEvents":"String content", "includeCertSoapHeader":"String content", "includeDocuments":"String content", "includeSenderAccountasCustomField":"String content", "includeTimeZoneInformation":"String content", "name":"String content", "recipientEvents":"String content", "requiresAcknowledgement":"String content", "signMessageWithX509Certificate":"String content",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"soapNamespace":"String content", "urlToPublishTo":"String content", "useSoapInterface":"String content", "userIds":"String content" }], "totalRecords":"String content" }

79

Update a Connect Configuration

This allows you to update a DocuSign Custom Connect configuration for your account. Note: Connect must be enabled for your account to use this function. This is cannot be used to update Connect configurations for Box, eOriginal or Salesforce. URL: /accounts/{accountId}/connect Formats: XML, JSON HTTP Method: PUT Parameters: Name allUsers Reqd? No Type Boolean Description When true, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. When true, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information. The DocuSign generated ID for the Connect configuration. This turns Connect logging on or off. When true, logging is turned on. A comma separated list of Envelope related events that are tracked through Connect. The possible event values are: Sent, Delivered, Signed, Completed, Declined, Voided

allowEnvelopePublish

No

Boolean

connectId enableLog envelopeEvents

Yes No No

Integer Boolean String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name includeDocuments Reqd? No Type Boolean Boolean Boolean Boolean String String Description When true, Connect will send the PDF document along with the update XML. When true, Connect will include the voidedReason for voided envelopes.

80

includeEnvelopeVoidReason No includeSenderAccount includeTimeZoneInformation name recipientEvents No No No No

When true, Connect will include the sender account as Custom Field in the data. When true, Connect will include the envelope time zone information. The name of this Connect configuration. A comma separated list of Recipient related events that are tracked through Connect. The possible event values are: Sent, Delivery Failed, Delivered, Signed/Completed, Declined, AuthenticationFailure When true and a publication message fails to be acknowledged, the message goes back into the queue and the system will retry delivery after a successful acknowledgement is received. If the delivery fails a second time, the message is not returned to the queue for sending until Connect receives a successful acknowledgement and it has been at least 24 hours since the previous retry. There is a maximum of ten retries Alternately, you can use Republish Connect Information to manually republish the envelope information. When true, Connect messages are signed with an X509 certificate. This provides support for 2-way SSL. The namespace of the SOAP interface. * This is required if useSoapInterface is set to true. This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address. Set to true if the urlToPublishTo is a SOAP endpoint.

requireAcknowledgement

No

Boolean

signMessageWithCertificate

No

Boolean

soapNameSpace

No*

String

urlToPublishTo

No

String

useSoapInterface

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name userIds Reqd? No* Type String Description

81

A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. * If allUsers is set to false then you must provide a list of user ids.

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/connect X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "allUsers": "boolean", "allowEnvelopePublish": "boolean", "connectId":"String content", "enableLog": "boolean", "envelopeEvents": "string content", "includeDocuments": "boolean", "includeEnvelopeVoidReason": "boolean", "includeSenderAccountasCustomField": "boolean", "includeTimeZoneInformation": "boolean", "name": "string content", "recipientEvents": "string content", "requiresAcknowledgement": "boolean", "signMessageWithX509Certificate": "boolean", "soapNamespace": "string content", "urlToPublishTo": "string content", "useSoapInterface": "boolean", "userIds": "string content" }

Response The response returns a success or failure with the updated Connect configuration information. The following example shows the response json body. Example Response Body
{ "allUsers": "boolean", "allowEnvelopePublish": "boolean", "connectId":"String content", "enableLog": "boolean", "envelopeEvents": "string content", "includeDocuments": "boolean", "includeEnvelopeVoidReason": "boolean", "includeSenderAccountasCustomField": "boolean", "includeTimeZoneInformation": "boolean", "name": "string content", "recipientEvents": "string content", "requiresAcknowledgement": "boolean",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"signMessageWithX509Certificate": "boolean", "soapNamespace": "string content", "urlToPublishTo": "string content", "useSoapInterface": "boolean", "userIds": "string content" }

82

Get a Connect Configuration Information

This allows you to retrieve the information about one DocuSign Connect configuration. Note: Connect must be enabled for your account to use this function. URL: /accounts/{accountId}/connect/{connectId} Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/connect/{connectId} X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the information for the selected Connect configuration. The following example shows the response json body. Example Response Body
{ "allUsers":"String content", "allowEnvelopePublish":"String content", "connectId":"String content", "enableLog":"String content", "envelopeEvents":"String content", "includeCertSoapHeader":"String content", "includeDocuments":"String content", "includeSenderAccountasCustomField":"String content",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"includeTimeZoneInformation":"String content", "name":"String content", "recipientEvents":"String content", "requiresAcknowledgement":"String content", "signMessageWithX509Certificate":"String content", "soapNamespace":"String content", "urlToPublishTo":"String content", "useSoapInterface":"String content", "userIds":"String content" }

83

Delete a Connect Configuration

This allows you to delete one DocuSign Connect configuration. Note: Connect must be enabled for your account to use this function. URL: /accounts/{accountId}/connect/{connectId} Formats: XML, JSON HTTP Method: DELETE Parameters: No additional parameters are required. Example Request Body
DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/connect/ {connectId} X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns a success or failure.

Republish Connect Information for One Envelope

This is used to republish Connect information for a single envelope.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 URL: /accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue Formats: XML, JSON HTTP Method: PUT Parameters: No additional parameters are required. Example Request Body
PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/connect/envelopes/ {envelopeId}/retry_queue

84

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns a success or failure and the information about the retry queue for the request. The following example shows the response json body. Example Response Body
{ "retryQueue":[{ "configId":"String content", "configUrl":"String content", "envelopeId":"String content", "status":"String content", "statusMessage":"String content" }] }

Republish Connect Information for Multiple Envelopes

This is used to republish Connect information for the set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by getting the failure log. URL: /accounts/{accountId}/connect/envelopes/retry_queue

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Formats: XML, JSON HTTP Method: PUT Parameters: Name envelopeIds synchronous Reqd? Yes No Type String Boolean Description

85

An array list of envelope Ids to be republished. If true, the system attempts to publish failed posts again and returns the status of the post attempt.

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/connect/envelopes/ retry_queue X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "envelopeIds":["String content","String content","String content"], "synchronous":"String content" }

Response The response returns a success or failure and the information about the retry queue for the request. The following example shows the response json body. Example Response Body
{ "retryQueue":[{ "configId":"String content", "configUrl":"String content", "envelopeId":"String content", "status":"String content", "statusMessage":"String content" }] }

Get the Connect Failure Log

This is used to retrieve the Connect Failure Log information. It can be used to determine which envelopes failed to post, so a republish request can be created.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 URL: /accounts/{accountId}/connect/failures Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/connect/failures

86

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the Connect failures log and the total number of records in the log. Name accountId configUrl connectDebugLog Type String String Description The account ID associated with the envelope. The web address of the listener or Retrieving Service end point for Connect. A complex element containing information about the Connect configuration, error details, date/time, description and payload. The identifier for the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to look up the Connect configuration for the failed post. The date and time the entry was created. The email that sent the envelope. The envelope ID of the envelope status that failed to post. The error that caused the Connect post to fail. The failure log ID for the failure. The uri for the failure.

connectId

String

created email envelopeId error failureId failureUri

String String String String String String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 The date and time the last attempt to post. The Connect log ID for the entry. The uri for the log item. The number of times the Connect post has been retried. retryUri String The uri to retry to publish the Connect failure. status String The new envelope status for the failed Connect post. The possible values are: Any, Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut, Template, or Processing subject String The envelope subject. userName String The name of the envelope sender. The following example shows the response json body. Example Response Body
{ "failures":[{ "accountId":"String content", "configUrl":"String content", "connectDebugLog":[{ "connectConfig":"String content", "errorDetails":{ "errorCode":"String content", "message":"String content" }, "eventDateTime":"String content", "eventDescription":"String content", "payload":"String content" }], "connectId":"String content", "created":"String content", "email":"String content", "envelopeId":"String content", "error":"String content", "failureId":"String content", "failureUri":"String content", "lastTry":"String content", "logId":"String content", "logUri":"String content", "retryCount":"String content", "retryUri":"String content", "status":"String content", "subject":"String content", "userName":"String content" }, "accountId":"String content", "configUrl":"String content", "connectDebugLog":[{ "connectConfig":"String content", "errorDetails":{ "errorCode":"String content", "message":"String content" }, "eventDateTime":"String content",

87

lastTry logId logUri retryCount

String String String Integer

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"eventDescription":"String content", "payload":"String content" }], "connectId":"String content", "created":"String content", "email":"String content", "envelopeId":"String content", "error":"String content", "failureId":"String content", "failureUri":"String content", "lastTry":"String content", "logId":"String content", "logUri":"String content", "retryCount":"String content", "retryUri":"String content", "status":"String content", "subject":"String content", "userName":"String content" }], "totalRecords":"String content", "type":"String content" }

88

Get a Connect Failure Log Entry

This is used to retrieve the Connect Failure Log information for one entry. URL: /accounts/{accountId}/connect/failures/{failureId} Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/connect/failures/ {failureId} X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Response The response returns the Connect failure log information for the failure ID. Description The account ID associated with the envelope. configUrl String The web address of the listener or Retrieving Service end point for Connect. connectDebugLog A complex element containing information about the Connect configuration, error details, date/time, description and payload. connectId String The identifier for the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to look up the Connect configuration for the failed post. created String The date and time the entry was created. email String The email that sent the envelope. envelopeId String The envelope ID of the envelope status that failed to post. error String The error that caused the Connect post to fail. failureId String The failure log ID for the failure. failureUri String The uri for the failure. lastTry String The date and time the last attempt to post. logId String The Connect log ID for the entry. logUri String The uri for the log item. retryCount Integer The number of times the Connect post has been retried. retryUri String The uri to retry to publish the Connect failure. status String The new envelope status for the failed Connect post. The possible values are: Any, Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut, Template, or Processing subject String The envelope subject. userName String The name of the envelope sender. The following example shows the response json body. Example Response Body
{ "failures":[{ "accountId":"String content", "configUrl":"String content", "connectDebugLog":[{ "connectConfig":"String content",

89

Name accountId

Type String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"errorDetails":{ "errorCode":"String content", "message":"String content" }, "eventDateTime":"String content", "eventDescription":"String content", "payload":"String content" }], "connectId":"String content", "created":"String content", "email":"String content", "envelopeId":"String content", "error":"String content", "failureId":"String content", "failureUri":"String content", "lastTry":"String content", "logId":"String content", "logUri":"String content", "retryCount":"String content", "retryUri":"String content", "status":"String content", "subject":"String content", "userName":"String content" } }

90

Clear a Connect Failure Log Entry

This is used to clear (remove) the Connect Failure Log information for one entry. URL: /accounts/{accountId}/connect/failures/{failureId} Formats: XML, JSON HTTP Method: DELETE Parameters: No additional parameters are required. Example Request Body
DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/connect/failures/ {failureId} X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Response The response returns a success or failure message.

91

Get the Connect Log

This retrieves a list of connect log entries for your account. Note: The enableLog must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. URL: /accounts/{accountId}/connect/logs Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/connect/logs X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the Connect log information.

Name accountId created envelopeId logId logUri subject

Type String String String String String String

Description The account ID associated with the envelope. The date and time the entry was created. The envelope ID of the envelope status that failed to post. The Connect log ID for the entry. The uri for the log item. The envelope subject.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 The following example shows the response json body. Example Response Body
{ "logs":[{ "accountId":"String content", "created":"String content", "envelopeId":"String content", "logId":"String content", "logUri":"String content", "subject":"String content", }, { "accountId":"String content", "created":"String content", "envelopeId":"String content", "logId":"String content", "logUri":"String content", "subject":"String content", }], "totalRecords":"String content", "type":"String content" }

92

Clear the Connect Log

This is used to clear (remove) the entries from the Connect Log. URL: /accounts/{accountId}/connect/logs Formats: XML, JSON HTTP Method: DELETE Parameters: No additional parameters are required. Example Request Body
DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/connect/logs X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Response The response returns a success or failure message.

93

Get One Connect Log Entry

This retrieves one Connect log entry for your account. Note: The enableLog must be set to true to enable logging. If logging is not enabled, then no log entries are recorded. URL: /accounts/{accountId}/connect/logs/{logId} Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/connect/logs/{logId} X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the Connect log information for the requested log ID. Name accountId created envelopeId logId logUri subject Type String String String String String String Description The account ID associated with the envelope. The date and time the entry was created. The envelope ID of the envelope status that failed to post. The Connect log ID for the entry. The uri for the log item. The envelope subject.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 The following example shows the response json body. Example Response Body
{ "logs":[{ "accountId":"String content", "created":"String content", "envelopeId":"String content", "logId":"String content", "logUri":"String content", "subject":"String content", }], }

94

Clear One Connect Log Entry

This is used to clear (remove) one entry from the Connect Log. URL: /accounts/{accountId}/connect/logs/{logId} Formats: XML, JSON HTTP Method: DELETE Parameters: No additional parameters are required. Example Request Body
DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/connect/logs/ {logId} X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns a success or failure message.

Get Consumer Disclosure

This returns the consumer disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the consumer disclosure.
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 URL: /accounts/{accountId}/consumer_disclosure Optional query addition: langCode={value}

95

Formats: XML, JSON HTTP Method: GET Parameters: There are no required parameters, but the following optional query can be added to set the language of the consumer disclosure in the response. Name langCode Reqd? No Type String Description The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh-CN), Chinese Traditional (zhTW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en-GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr-CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt-BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es-MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to browser to automatically detect the browser language being used by the viewer and display the consumer disclosure in that language.

Example Request Body

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/consumer_disclosure X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Response

96

The response returns the accountEsignId with the GUID and the esignAgreement with the consumer disclosure text. The consumer disclosure text includes the html formatting. The following example shows the response json body. For brevity, the example only shows a portion of the consumer disclosure text. Example Response Body
{ "accountEsignId": "string", "esignAgreement": "\r\n<B>CONSUMER DISCLOSURE</B>\r\n<P></P>\r\nFrom time to time, Rest Tester Account (we, us or Company) may be required by law to provide to you certain written notices or disclosures. Described below are the terms and conditions for providing to you such notices and disclosures electronically through the DocuSign, Inc. (DocuSign) electronic signing system. Please read the information below carefully and thoroughly, and if you can access this information electronically to your satisfaction and agree to these terms and conditions, please confirm your agreement by clicking the I agree button at the bottom of this document.\r\n<P></P>" }

Get List of Account Custom Fields

This retrieves a list of envelope custom fields associated with the account. These fields can be used in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text and list. A text custom field lets the sender enter the value for the field. The list custom field lets the sender select the value of the field from a premade list. URL: /accounts/{accountId}/custom_fields Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/custom_fields X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

Accept: application/json Content-Type: application/json

97

Response The response returns a list of list custom fields and text custom fields associated with the account. . Name listCustomFields name required show Type String String (Boolean) String (Boolean) String Description The name of the Envelope Custom Field When true, information must be entered into the custom field to send the envelope. When true, the custom field is shown to senders in the DocuSign member console during sending. The list of values that can be selected by senders. The list values are entered with quotations, separated by commas. Example: ["one", "two", "three", "four"]

listItems

The name of the Envelope Custom Field When true, information must be entered into the custom field to send the envelope. show When true, the custom field is shown to senders in the DocuSign member console during sending. The following example shows the response json body. Example Response Body
{ "listCustomFields": [{ "name":"String", "required":"String", "show":"String", "listItems": ["String","String"] }, { "name":"String", "required":"String", "show":"String", "listItems": ["String","String"] }], "textCustomFields": [{ "name":"String", "required":"String", "show":"String", }, { "name":"String", "required":"String", "show":"String", }] }

textCustomFields name required

String String (Boolean) String (Boolean)

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

98

Send an Envelope or Create a Draft Envelope

This creates an envelope and sends it to recipients or saves it as a draft envelope. Setting the status parameter sets if the envelope is sent or if it is saved to the draft envelope folder after the request. This is a multipart/form request. This resource is also used for sending an envelope from a template; refer to Send an Envelope from a Template for information about sending from a template. This resource can also be used with offline signing client applications, see the Offline Signing section for more information about offline signing. Envelope Event Notification: eventNotification is an optional element that specifies a set of envelope and recipient status codes, a URL and some other options. When the envelope or recipient status changes to one of the specified status codes, a message containing the updated status is sent to the URL. Note: DocuSign Connect must be enabled to use eventNotification, but Connect does not need to be configured for the account since the configuration is done for each envelope. Rules for determining the brandId used in an envelope The following rules are used to determine the brandId used in an envelope: If a brandId is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. If more than one template is used in an envelope and more than one brandId is specified, the first brandId specified is used throughout the envelope. In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the accounts default signing brand is used. For envelopes that do not meet any of the previous rules, the account's default signing brand is used in the envelope.

URL: /accounts/{accountId}/envelopes Formats: XML, JSON HTTP Method: POST Parameters: The parameters for sending an envelope are broken down into sections. The parameters used depend on how you are sending the envelope, the recipient types used, and tabs included in the envelope. The parameters listed in this section are: Envelope, Document, Recipient, and Tab.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

99

Envelope Parameters: Name accessibility Reqd? No Type String Description An optional element that can only be used if Document Accessibility is enabled for the account. This sets the document reading zones for screen reader applications. Note: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here. If true, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this. If true, the recipient can redirect an envelope to a more appropriate recipient. When set to true, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order. If true, will queue the envelope for processing and the envelope status will have a value of Processing. Additionally, get status calls will return Processing until completed. Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. If true, auto-navigation is enabled for the envelope. The auto-navigation method used is determined by the account setting. This sets the brand profile format used for the envelope. The value in the string is the brandId associated with the profile. Account branding must be enabled for the account to use this option. Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. This can be a maximum of 10000 characters. The subject of the email that will be sent to all recipients. This can be a maximum of 100 characters.

allowMarkup

No

String

allowReassign

No

String String

allowRecipientRecursion No

asynchronous

No

String

authoritativeCopy

No

String

autoNavigation

No

String

brandId

No

String

emailBlurb

No

String

emailSubject

Yes

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name enableWetSign enforceSignerVisibility Reqd? No No Type String String Description If true, the signer is allowed to print the document and sign it on paper.

100

It true, the signer is required to have a signature or initial tab on the document or that the document has no signers in order to view it. Account must have Document Visibility enabled to use this. If true, Envelope ID Stamping is enabled. If true, prevents senders from changing the emailBlurb and emailSubject for the envelope. Additionally, this prevents users from making changes to the emailBlurb and emailSubject when correcting envelopes However, if the messageLock node is set to True and the emailSubject is empty, senders and correctors are able to add a subject to the envelope. An optional complex element that specifies the notification options for the envelope. It consists of: useAccountDefaults When true, the account default notification settings are used for the envelope. reminders A complex element that specifies reminder settings for the envelope. It consists of: o reminderEnabled When true a reminder message is sent to the recipient. o reminderDelay An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. o reminderFrequency An interger that sets the interval, in days, between reminder emails. expirations A complex element that specifies the expiration settings for the envelope. It consists of: o expireEnabled When true the envelope expires (is no longer available for signing) in the set number of days.

envelopeIdStamping messageLock

No No

String String

notification

No

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type Description o

101

expireAfter An integer that sets the number of days the envelope is active. expireWarn An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.

recipientsLock

No

String

If true, prevents senders from changing, correcting, or deleting the recipient information for the envelope. Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. Sets envelope status. There are two possible values: sent and created. If status = sent, the envelope is sent to the recipients. If status = created, the envelope is saved as a draft and can be modified and sent later. An optional element that can be used to identify an envelope. The id is a sendergenerated value and is valid in the DocuSign system for 7 days. It is recommended that a transactionId is used for offline signing to ensure that an envelope is not sent multiple times. The transactionId can be used determine if an envelope status (i.e. was created or not) for cases where an internet connection was lost before the envelope status could be returned.

signingLocation

No

String

status

Yes

String

transactionId

No

String

customFields

No

A complex element that can be used to record information about the envelope, help search for envelopes and track information. See the section on getting Custom Fields for more information about and descriptions of the custom fields.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name documents Reqd? No Type Document Description

102

Complex element contains the details on the documents in the envelope. See the Document parameter section for more information. Specifies the envelope recipients. See the Recipient parameter section for more information. This optional complex element allows a message to be sent a specified URL when the envelope or recipient changes status. It is similar to DocuSign Connect. For example, if an envelope changes from "Sent" to "Delivered", a message containing the updated envelope status and optionally the documents is sent to the URL. When an eventNotification is attached to an envelope using the API, it only applies to the envelope (treating the envelope as the sender). This is different from envelopes created through the console user interface, where the user is treated as the sender. eventNotification consists of: url The endpoint where envelope updates are sent. This will accept XML unless useSoapInterface is set to true. loggingEnabled When set to true, logging is turned on for envelope events on the Web Console Connect page. requireAcknowledgment When set to true, the DocuSign Connect service checks that the message was received and retries on failures. useSoapInterface When set to true, this tells the Connect service that the users endpoint has implemented a SOAP interface. soapNameSpace This lists the namespace in the SOAP listener provided. includeCertificateWithSoap When set to true, this tells the Connect service to send the DocuSign signedby certificate as part of the outgoing SOAP xml. This appears in the XML as wsse:BinarySecurityToken.

recipients

No

Recipient

eventNotification

No

eventNotification

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type Description

103

signMessageWithX509Cert When set to true, messages are signed with an X509 certificate. This provides support for 2-way SSL in the envelope. includeDocuments When set to true, the PDF documents are included in the message along with the updated XML. includeTimeZone When set to true, the envelope time zone information is included in the message. includeSenderAccountAsCustomField When set to true, the sender account ID is included as a envelope custom field in the data. envelopeEvents The list of envelopelevel events statuses that will trigger Connect to send updates to the url. It can be a two-part list with: o envelopeEventStatus The envelope status, this can be Sent, Delivered, Signed, Completed, Declined, or Voided. recipientEvents The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: o recipientEventStatus The recipient status, this can be AuthenticationFailed, AutoResponded, Completed, Declined, Delivered or Sent.

Documents Parameters: Name name Reqd? Yes Type String Description The name of the document. This can be a maximum of 100 characters. If the document is encrypted, this is the unencrypted name of the document. The unique Id for the document in this specific envelope.

documentId

Yes

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name order Reqd? No Type String Description

104

A numerical value that sets the order documents are presented in the envelope. This is only applicable when adding documents to a draft envelope. When creating and sending an envelope the documents use the order in which they are listed in the request. Optional element. When set to true PDF form field data will be transformed into document tab values when the PDF form field name matches the DocuSign custom tab TabLabel. The resulting PDF form data will also be returned in the PDF meta data when requesting the document PDF. See the Transform PDF Fields section for more information about how fields are transformed into DocuSign tabs. If true, the document is been already encrypted by the sender for use with the DocuSign Key Manager security appliance. An optional array of name-value strings that allows the sender to provide custom data for a document. This information is returned in the envelope status but otherwise not used by DocuSign. The array of DocumentField contains the elements: Name A string that can be a maximum of 50 characters. Value A string that can be a maximum of 200 characters. The total number of pages in the document. Optional element. File extension type of the document. If the document is nonPDF it will be converted to PDF. The document byte stream. This allows putting a base64 version of document bytes into an envelope.

transformPdfFields

No

String

encryptedWithKeyManager No

String

documentFields

No

documentField

pages fileExtension

No No

String String

documentBase64

No

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name matchboxes Reqd? No Type Description

105

Optional element. Only used when uploading and editing templates. Matchboxes are used to define areas in a document for document matching when creating envelopes. A matchbox consists of 5 elements: pageNumber - The document page number that the matchbox should be on. xPosition - The x position of the matchbox on a page. yPosition - The y position of the matchbox on a page. width - The width of the matchbox. height - The height of the matchbox.

Transform PDF Fields Only the FieldTypes and FieldProperties listed below are extrapolated from the forms: FieldTypes that are extrapolated are: CheckBox, DateTime, ListBox, Numeric, Radio, Text, Signature, and Password. FieldProperties that are extrapolated are: ReadOnly, Required, MaxLength, Positions, and Initial Data.

Note: When extrapolating Adobe Digital Signatures, the following Adobe names correspond to DocuSign names: Adobe name contains DocuSignSignHere or eSignSignHere = DocuSign Signature Adobe name contains DocuSignSignHereOptional or eSignSignHereOptional = DocuSign Optional Signature Adobe name contains DocuSignInitialHere or eSignInitialHere = DocuSign Initials Adobe name contains DocuSignInitialHereOptional or eSignInitialHereOptional = DocuSign Optional Initials Any other Adobe name will default to DocuSign Signature. When extrapolating Adobe text fields, the following Adobe names correspond to DocuSign names: Adobe name contains DocuSignSignHere or eSignSignHere = DocuSign Signature Adobe name contains DocuSignSignHereOptional or eSignSignHereOptional = DocuSign Optional Signature Adobe name contains DocuSignInitialHere or eSignInitialHere = DocuSign Initials Adobe name contains DocuSignInitialHereOptional or eSignInitialHereOptional = DocuSign Optional Initials Adobe name contains DocuSignEnvelopeID or eSignEnvelopeID = DocuSign EnvelopeID

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Adobe name contains DocuSignCompany or eSignCompany = DocuSign Company *Adobe name contains DocuSignDateSigned or eSignDateSigned = DocuSign DateSigned Adobe name contains DocuSignTitleor eSignTitle = DocuSign Title Adobe name contains DocuSignFullNameor eSignFullName = DocuSign FullName Any other name will default to a DocuSign data (text) field

106

Note: DocuSign will not transform PDF form fields that have the text "DocuSignIgnoreTransform" or "eSignIgnoreTransform" as part of the name of the PDF form field. * Adobe date fields can be transformed to DocuSignDateSigned fields using the same naming scheme.

Recipient Parameters: There are seven possible recipient types: Agents, Carbon Copies, Certified Deliveries, Editors, In Person Signers, Intermediaries, and Signers. Recipient types share some common parameters, but the exact parameters associated with a recipient depend on the recipient type. Refer to the specific recipient type below for more information. Agents In Person Signers Tab Parameters: The exact parameters associated with a tab depend on the type of tab. Tabs are associated with a specific recipient and are only used by the recipient types In Person Signers and Signers. Refer to the Tab Parameters section for more information. Example Request Body
POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: multipart/form-data; boundary=AAA --AAA Content-Type: application/json Content-Disposition: form-data { "accessibility":"string content", "allowMarkup":"String content", "allowReassign":"String content", "allowRecipientRecursion":"String content", "asynchronous":"String content", "authoritativeCopy":"String content", "autoNavigation":"String content", "brandId":"String content", "emailBlurb":"String content", "emailSubject":"String content", "enableWetSign":"String content", "enforceSignerVisibility":"String content",

Carbon Copies Intermediaries

Certified Deliveries Signers

Editors

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"envelopeIdStamping":"String content", "messageLock":"string content", "notifications":{ "useAccountDefaults":"String content", "reminders":[{ "reminderEnabled":"String content", "reminderDelay":"String content", "reminderFrequency":"String content" }], "expirations":[{ "expirationEnabled":"String content", "expirationAfter":"String content", "expirationWarn":"String content" }] }, "recipientsLock":"string content", "signingLocation":"String content", "status":"String content", "transactionId":"String content", "customFields":{ "listCustomFields":[{ "name":"String content", "required":"String content", "show":"String content", "value":"String content", "listItems":["String content"] }], "textCustomFields":[{ "name":"String content", "required":"String content", "show":"String content", "value":"String content" }] }, "documents": [{ "documentId":"1", "name":"String content", "documentFields": [{ "name": "string", "value": "string" }, { "name": "string", "value": "string" }], "encryptedWithKeyManager":"String Content", "transformPdfFields":"String Content", "order":"String Content", "pages":"String Content", "fileExtension":"String Content", "documentBase64":"String Content", "matchboxes": [{ "pageNumber": "string", "xPosition": "string", "yPosition": "string", "width": "string", "height": "string" }, { "pageNumber": "string", "xPosition": "string", "yPosition": "string", "width": "string", "height": "string"

107

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

}], }], "recipients": { "signers" : [{ "email":"String content", "name":"String content", "recipientId":"1" }], "eventNotification":{ "url":"String content", "loggingEnabled":"String content", "requireAcknowledgment":"String content", "useSoapInterface":"String content", "soapNameSpace" : "http://DocuSignConnectListener", "includeCertificateWithSoap" : "true", "signMessageWithX509Cert":"String content", "includeDocuments":"String content", "includeTimeZone" : "http://DocuSignConnectListener", "includeSenderAccountAsCustomField" : "true", "envelopeEvents" : [{ "envelopeEventStatusCode" : "sent" }, { "envelopeEventStatusCode" : "completed", "includeDocuments" : "true" }], "recipientEvents" : [{ "recipientEventStatusCode" : "Sent" }, { "recipientEventStatusCode" : "completed", "includeDocuments" : "true" }] }], } --AAA Content-Disposition:documentId=1 <bytes of PDF removed> --AAA--

108

Response The response returns the envelope ID, status, and date-time stamp for the envelope status. It also includes the uri for the envelope. The following example shows the response json body. Example Response Body
{ "envelopeId":"String content", "status":"String content", "statusDateTime":"String content", "uri":"String content" }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Offline Signing

109

Offline signing provides a way for customers to use DocuSign to obtain recipient signatures, even when the customer is not connected to the Internet. To use Offline Signing, the customer using a client application to create an envelope on an Internet-capable device, such as a smart phone or tablet, that is not connected to the Internet and has a recipient fill out and sign (or initial) the envelope documents. When the device later connects to the Internet, the client application uploads the envelope information to DocuSign where it is processed. When processing, the events in envelope audit trail are marked with the description Offline as appropriate. The Certificate of Completion will include a separate Offline section that will have the offline signing view event and complete event date/time information, the recipient photo (if included), and any custom information (such as the offlineAttributes) for the signer. Offline Signing Settings and Restrictions The following settings and restrictions apply to offline signing use cases. Offline signing is not allowed when sending from templates. All offline signers must be in routing order 1 and must have at least one required signature or initials tag. Other recipients can be included in the envelope. Offline signing supports the following tab types: Sign Here, Initial Here, Date Signed, Full Name, Company, Title, Text and Checkbox When sending an offline signing envelope, the envelope status must be set to sent (status=created is not allowed and will cause an error). When sending an offline signing envelope, the following Signers Recipient type settings are required: clientUserId, deliveryMethod (must be set to offline) and signedDateTime. An image of the signers signature/initials must be included for each signature or initials tab. The image is included as part of the multipart section. Optionally, you can include a deliveredDateTime parameter, but if this parameter is not included DocuSign will set it to the signedDateTime value.

Send an Envelope from a Template

Creates an envelope from an existing template and sends it or saves it as a draft envelope. When creating an envelope by using a templateId, the recipients structure is used to assign recipients to template roles via the roleName property, override recipient settings that have been specified in the template and set values for tab fields that were defined in the template. Rules for determining the brandId used in an envelope The following rules are used to determine the brandId used in an envelope: If a brandId is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. If more than one template is used in an envelope and more than one brandId is specified, the first brandId specified is used throughout the envelope. In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the accounts default signing brand is used.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

110

For envelopes that do not meet any of the previous rules, the account's default signing brand is used in the envelope.

Composite Templates: This structure can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope. Each Composite Template consists of server templates, inline templates, PDF Metadata templates and documents. Server Templates are server-side templates stored on the DocuSign server. If supplied they are overlaid into the envelope in the order of their Sequence value. Inline Templates provide the container to pass inline XML properties. Inline templates allow you to add documents and, for PDF documents, transform the PDF fields into DocuSign tabs. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobats XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied the PDF meta data template will be overlaid into the envelope in the order of their Sequence value. Document objects are optional structure that provide a container to pass in a document or form. If this object is not passed, the composite template inherits the first document it finds from some other server template or inline template, starting with the lowest sequence value (discussed below). Acrobat form objects are only extrapolated from the document object. DocuSign does not derive Acrobat form properties from server templates or inline templates. To instruct DocuSign to extrapolate objects from the Acrobat form, set transformPdfFields to true for the document. See the Transform PDF Fields section for more information about how fields are transformed into DocuSign tabs. Sequence Each type of template has a sequence property, which enables the templates to be over-laid in a particular order. This is significant because last-out wins in cases of the same property being specified in multiple places in the method schema. URL: /accounts/{accountId}/envelopes Formats: XML, JSON

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 HTTP Method: POST Parameters: Name accessibility Reqd? No Type String Description

111

An optional element that can only be used if Document Accessibility is enabled for the account. This sets the document reading zones for screen reader applications. Note: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here. If true, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this. If true, the recipient can redirect an envelope to a more appropriate recipient. When set to true, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order. If true, will queue the envelope for processing and the envelope status will have a value of Processing. Additionally, get status calls will return Processing until completed. Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. If true, auto-navigation is enabled for the envelope. The auto-navigation method used is determined by the account setting. This sets the brand profile format used for the envelope. The value in the string is the brandId associated with the profile. Account branding must be enabled for the account to use this option. Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. The subject of the email that will be sent to all recipients.

allowMarkup

No

String

allowReassign

No

String String

allowRecipientRecursion No

asynchronous

No

String

authoritativeCopy

No

String

autoNavigation

No

String

brandId

No

String

emailBlurb

No

String

emailSubject

Yes

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name enableWetSign enforceSignerVisibility Reqd? No No Type String String Description If true, the signer is allowed to print the document and sign it on paper.

112

It true, the signer is required to have a signature or initial tab on the document or that the document has no signers in order to view it. Account must have Document Visibility enabled to use this. If true, Envelope ID Stamping is enabled. If true, prevents senders from changing the emailBlurb and emailSubject for the envelope. Additionally, this prevents users from making changes to the emailBlurb and emailSubject when correcting envelopes However, if the messageLock node is set to True and the emailSubject is empty, senders and correctors are able to add a subject to the envelope.

envelopeIdStamping messageLock

No No

String String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name notification Reqd? No Type Description

113

An optional complex element that specifies the notification options for the envelope. It consists of: useAccountDefaults When true, the account default notification settings are used for the envelope. reminders A complex element that specifies reminder settings for the envelope. It consists of: o reminderEnabled When true a reminder message is sent to the recipient. o reminderDelay An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. o reminderFrequency An interger that sets the interval, in days, between reminder emails. expirations A complex element that specifies the expiration settings for the envelope. It consists of: o expireEnabled When true the envelope expires (is no longer available for signing) in the set number of days. o expireAfter An integer that sets the number of days the envelope is active. o expireWarn An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent. String If true, prevents senders from changing, correcting, or deleting the recipient information for the envelope. Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online.

recipientsLock

No

signingLocation

No

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name status Reqd? Yes Type String Description

114

Sets envelope status. There are two possible values: sent and created. If status = sent, the envelope is sent to the recipients. If status = created, the envelope is saved as a draft and can be modified and sent later. A complex element that can be used to record information about the envelope, help search for envelopes and track information. See the section on getting Custom Fields for more information about and descriptions of the custom fields.

customFields

No

transactionId

No

String

An optional element that can be used to identify an envelope. The id is a sendergenerated value and is valid in the DocuSign system for 7 days. It is recommended that a transactionId is used for offline signing to ensure that an envelope is not sent multiple times. The transactionId can be used determine if an envelope status (i.e. was created or not) for cases where an internet connection was lost before the envelope status could be returned.

templateId templateRoles

Yes Yes

String Recipients

Unique identifier of the template. Specifies the template recipients. Each roleName in the template must have a recipient assigned to it. This is made up elements: email The recipients email address. Name The recipients name. roleName The template roleName associated with the recipient. clientUserId Optional, this sets if the signer is This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. defaultRecipient Optional, when set to true, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type Description

115

accessCode This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. emailNotification This is an optional complex element that has a role specific emailSubject, emailBody, and language. It follows the same format as the emailNotification node for Recipients. tabs This allows the tab values to be specified for matching to tabs in the template.

eventNotification

No

eventNotification

This optional complex element allows a message to be sent a specified URL when the envelope or recipient changes status. It is similar to DocuSign Connect. For example, if an envelope changes from "Sent" to "Delivered", a message containing the updated envelope status and optionally the documents is sent to the URL. When an eventNotification is attached to an envelope using the API, it only applies to the envelope (treating the envelope as the sender). This is different from envelopes created through the console user interface, where the user is treated as the sender. eventNotification consists of: url The endpoint where envelope updates are sent. This will accept XML unless useSoapInterface is set to true. loggingEnabled When set to true, logging is turned on for envelope events on the Web Console Connect page. requireAcknowledgment When set to true, the DocuSign Connect service checks that the message was received and retries on failures. useSoapInterface When set to true, this tells the Connect service that the users endpoint has implemented a SOAP interface. soapNameSpace This lists the namespace in the SOAP listener provided. includeCertificateWithSoap When set to true, this tells the Connect service to

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type

116 Description send the DocuSign signedby certificate as part of the outgoing SOAP xml. This appears in the XML as wsse:BinarySecurityToken. signMessageWithX509Cert When set to true, messages are signed with an X509 certificate. This provides support for 2-way SSL in the envelope. includeDocuments When set to true, the PDF documents are included in the message along with the updated XML. includeTimeZone When set to true, the envelope time zone information is included in the message. includeSenderAccountAsCustomField When set to true, the sender account ID is included as a envelope custom field in the data. envelopeEvents The list of envelopelevel events statuses that will trigger Connect to send updates to the url. It can be a two-part list with: o envelopeEventStatus The envelope status, this can be Sent, Delivered, Signed, Completed, Declined, or Voided. recipientEvents The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: o recipientEventStatus The recipient status, this can be AuthenticationFailed, AutoResponded, Completed, Declined, Delivered or Sent. Each CompositeTemplate adds a new document and template overlays into the envelope. There can be any number of CompositeTemplate structures. Each CompositeTemplate consists of: ServerTemplates - 0 or more server-side templates and their position in the overlay. If supplied they are overlaid into the envelope in the order of their Sequence value. InlineTemplates - 0 or more inline templates and their position in the overlay. If supplied

compositeTemplates

No

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type

117 Description they are overlaid into the envelope in the order of their Sequence value. PDFMetaDataTemplate 0 or 1 embedded template in the PDF meta data. If supplied the PDF meta data template will be overlaid into the envelope in the order of their Sequence value. Document - 0 or 1 document. The document is used to specify a different document than the ones in the overlay templates. The PDF fields from this document will be transformed to DocuSign Secure Fields if the TransformPdfFields option is set to true. Note: DocuSign will not transform PDF form fields that have the text "DocuSignIgnoreTransform" or "eSignIgnoreTransform" as part of the name of the PDF form field. If PDFMetaDataTemplate is supplied this is the document the template is extracted from. This information is unchanged from the current schema.

Example Request Body

POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json Content-Disposition: form-data { "accessibility":"string content", "allowMarkup":"String content", "allowReassign":"String content", "allowRecipientRecursion":"String content", "asynchronous":"String content", "authoritativeCopy":"String content", "autoNavigation":"String content", "brandId":"String content", "emailBlurb":"String content", "emailSubject":"String content", "enableWetSign":"String content", "enforceSignerVisibility":"String content", "envelopeIdStamping":"String content", "messageLock":"string content", "recipientsLock":"string content", "signingLocation":"String content",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"status":"String content", "transactionId":"String content", "customFields":{ "listCustomFields":[ { "name":"String content", "required":"String content", "show":"String content", "value":"String content", "listItems":[ "String content" ] } ], "textCustomFields":[ { "name":"String content", "required":"String content", "show":"String content", "value":"String content" } ] }, "templateId":"String content", "templateRoles":[ { "email":"String content", "name":"String content", "roleName":"String content", "clientUserId":"String content", "defaultRecipient":"String content", "emailNotification":{ "emailSubject":"String content", "emailBody":"String content", "supportedLanguage":"String content" }, "tabs": { "textTabs": [ { "tabLabel": "String content", "name": "String content", "value": "String content" } ] }, "eventNotification":{ "url":"String content", "loggingEnabled":"String content", "requireAcknowledgment":"String content", "useSoapInterface":"String content", "soapNameSpace" : "http://DocuSignConnectListener", "includeCertificateWithSoap" : "true", "signMessageWithX509Cert":"String content", "includeDocuments":"String content", "includeTimeZone" : "http://DocuSignConnectListener", "includeSenderAccountAsCustomField" : "true", "envelopeEvents" : [ { "envelopeEventStatusCode" : "sent" }, { "envelopeEventStatusCode" : "completed", "includeDocuments" : "true" }

118

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

], "recipientEvents" : [ { "recipientEventStatusCode" : "Sent" }, { "recipientEventStatusCode" : "completed", "includeDocuments" : "true" } ]

119

}, "compositeTemplates":[ { "serverTemplates":[ { "sequence":"String content", "templateId":"String content" }, { "sequence":"String content", "templateId":"String content" } ], "inlineTemplates":[ { "sequence":"String content", "documents":[ { "documentId":"String content", "name":"String content", "transformPdfFields":"String" }, { "documentId":"String content", "name":"String content", "transformPdfFields":"String" } ] } ], "pdfMetaDataTemplateSequence":"String content", "document" : [ { "documentId" : 1 } ] } ] } ] }

Response The response returns the envelope ID, status, and date-time stamp for the envelope status. It also includes the uri for the envelope. The following example shows the response json body. Example Response Body
{ "envelopeId":"String content",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"status":"String content", "statusDateTime":"String content", "uri":"String content" }

120

Get Envelope Status Changes

This returns envelope status changes for all envelopes. The information returned can be modified by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. Important: Unless you are requesting the status for specific envelopes (using envelopeIds or transactionIds), you must add a from_date in the request. Getting envelope status using transactionIds is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. Request Envelope Status Notes The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for any status change instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (from_to_status) set to Delivered the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of Delivered and a status of Created,Sent, DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were Delivered between the begin and end dates that have a current status of Created or Sent, and since an envelope that has been delivered can never have a status of Created or Sent, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier. Status Qualifier (from_to_status) Any (changed) Created Sent Effective Status Qualifier StatusChanged Created Sent Valid Current Statuses Any, Created, Sent, Delivered, Signed, Completed, Declined, Voided, Deleted Any, Created, Sent, Delivered, Signed, Completed, Declined, Voided, Deleted Any, Sent, Delivered, Signed, Completed, Declined, Voided, Deleted

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Status Qualifier (from_to_status) Delivered Signed Completed Declined TimedOut - Always return zero results Voided Deleted URL: /accounts/{accountId}/envelopes Optional query strings: from_date={dateTime}, to_date={dateTime}, status={status code}, from_to_status={changed or any or list of statuses}, envelopeId={envelopeId}, custom_field={envelope custom field name}={envelope custom field value}, transaction_ids={transactionId or request_body} Formats: XML, JSON HTTP Method: GET Parameters: Effective Status Qualifier StatusChanged StatusChanged Completed StatusChanged StatusChanged Voided StatusChanged Valid Current Statuses Any, Delivered, Signed, Completed, Declined, Voided, Deleted Any, Signed, Completed, Declined, Voided, Deleted Any, Completed, Declined, Voided, Deleted Any, Declined, Deleted Any, Voided, Deleted Any, Voided, Deleted Any, Deleted

121

There are no required parameters, but the following optional parameters can be added to narrow the search results. Name from_date Reqd? No* Schema Type DateTime Description The date/time setting that specifies the date/time when the request begins checking for status changes for envelopes in the account. * This is required unless envelopeIds are used.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name to_date Reqd? No Schema Type DateTime Description

122

Optional date/time setting that specifies the date/time when the request stops for status changes for envelopes in the account. If not specified, the system uses the time of the call as the to_date. This is the status type checked for in the from_date/to_date period. If "changed" is specified, then envelopes that changed status during the period are found. If for example, "created" is specified, then envelopes created during the period are found. Default is changed. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. The list of current statuses to include in the response. By default, all envelopes found are returned. If values are specified, then of the envelopes found, only those with the current status specified are returned in the results. Possible values are: Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing. Specifies the Authoritative Copy Status for the envelopes. The possible values are: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed. The envelope ID for the envelope.

from_to_status

No

EnvelopeStatusChange

status

No

String

ac_status

No

String

envelopeId

No

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name custom_field Reqd? No Schema Type String Description

123

This specifies the envelope custom field name and value searched for in the envelope information. The value portion of the query can use partial strings by adding % (percent sign) around the custom field query value. Example 1: If you have an envelope custom field called Region and you want to search for all envelopes where the value is West you would use the query: ?custom_field=Region=West. Example 2: To search for envelopes where the ApplicationID custom field has the value or partial value of DocuSign in field, the query would be: ?custom_field=ApplicationId=%DocuSign% This would find envelopes where the custom field value is DocuSign for Salesforce or DocuSign envelope. If included in the query string, this is a comma separated list of envelope transactionIds. If included in the request_body, this is a list of envelope transactionIds. Note: transactionIds are only valid in the DocuSign system for 7 days.

transactionIds

No

String

Example Request Body

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes? transaction_ids=request_body X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "transactionIds":[ "String content", "String content" ] }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Response

124

The response returns the uris for the envelope certificate, custom fields, documents, envelope along with the envelope ID, envelope status, and the date-time stamp for the envelope status change for the envelopes. If a query string was added to the original request, only the envelopes that meet those parameters are included in the response. If transactionIds were part of the query or request body, the envelopeTransactionStatuses with the transactionID, envelopeId and status for the envelope are returned. The following example shows the response json body. Example Response Body
{ "envelopes": [{ "certificateUri": "String content", "customFieldsUri": "String content", "documentsCombinedUri": "String content", "documentsUri": "String content", "envelopeId": "String content", "envelopeUri": "String content", "notificationUri": "String content", "recipientsUri": "String content", "status": "String content", "statusChangedDateTime": "String content" }, { "certificateUri": "String content", "customFieldsUri": "String content", "documentsCombinedUri": "String content", "documentsUri": "String content", "envelopeId": "String content", "envelopeUri": "String content", "notificationUri": "String content", "recipientsUri": "String content", "status": "String content", "statusChangedDateTime": "String content" }], "resultSetSize": "String content" }

Get Individual Envelope Status

This returns the overall status for a single envelope. URL: /accounts/{accountId}/envelopes/{envelopeId} Formats: XML, JSON HTTP Method: GET

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Parameters: The only required parameter is the envelope ID. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}

125

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the envelope status information for the requested envelope. Example Response Body
{ "allowReassign":"String content", "certificateUri":"String content", "createdDateTime":"String content", "customFieldsUri":"String content", "documentsCombinedUri":"String content", "documentsUri":"String content", "emailBlurb":"String content", "emailSubject":"String content", "emailWetSign":"String content", "envelopeId":"String content", "envelopeUri":"String content", "notificationUri":"String content", "recipientsUri":"String content", "status":"String content", "statusChangedDateTime":"String content", "templatesUri":"String content" }

Send Draft Envelope

This sends a single draft envelope. URL: /accounts/{accountId}/envelopes/{envelopeId} Add {status:sent} to the request body to send the envelope. Formats: XML, JSON HTTP Method: PUT

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Parameters: The only required parameter is the envelope ID. Example Request Body
PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}

126

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "status":"sent" }

Response The response returns success or failure of the operation.

Void Envelope
This voids a single in-process envelope. URL: /accounts/{accountId}/envelopes/{envelopeId} Add {status:voided, voidedReason:void reason} to the request body to void the envelope. Formats: XML, JSON HTTP Method: PUT Parameters: The only required parameter is the envelope ID. Example Request Body
PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId} X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"status":"voided", "voidedReason":"voided for incorrect recipient" }

127

Response The response returns success or failure of the operation.

Get Envelope Audit Events

This returns the events for this envelope. URL: /accounts/{accountId}/envelopes/{envelopeId}/audit_events Formats: XML, JSON HTTP Method: GET Parameters: The only required parameter is the envelope ID. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/audit_events X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns a list of audit events, in name/value pairs, for the specified envelope. The audit events are listed below. Name logTime Source UserName Action Message Value The date-time the audit event occurred. The source of the envelope. Values can be web or API. The name of the user that sent the envelope. The current action status. The message associated with the action.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 EnvelopeStatus

128

Status of the envelope. Values can be Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined and TimedOut. ClientIPAddress The client IP address associated with the action. Information Base information associated with the action. GeoLocation The geographic location associated with the action. Language The language used in the envelope. The following example shows the response json body. Example Response Body
{ "auditEvents":[{ "eventFields":[{ "name":"String content", "value":"String content" }] }] }

Add Envelope Custom Fields to an Envelope

This allows you to add envelope custom fields to draft and in-process envelopes. Note: Custom Fields added with this are not shown in the Envelope Custom Fields list for the account. URL: /accounts/{accountId}/envelopes/{envelopeId}/custom_fields Formats: XML, JSON HTTP Method: POST Parameters: The parameters for an Envelope Custom Field are only required if you are adding that type of custom field. Name listCustomFields name required Yes Yes String String (Boolean) The name of the Envelope Custom Field When true, information must be entered into the custom field to send the envelope. Reqd? Type Description

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name show Reqd? Yes Type String (Boolean) String String Description

129

When true, the custom field is shown to senders in the DocuSign member console during sending. The selected value for the custom field in this envelope. The list of values that can be selected by senders. The list values are entered with quotations, separated by commas. Example: ["one", "two", "three", "four"]

value listItems

Yes Yes

textCustomFields name required show Yes Yes Yes String String (Boolean) String (Boolean) String The name of the Envelope Custom Field When true, information must be entered into the custom field to send the envelope. When true, the custom field is shown to senders in the DocuSign member console during sending. The value for the custom field in this envelope.

value

Yes

Example Request Body

POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/custom_fields X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "listCustomFields": [{ "name":"String", "required":"String", "show":"String", "value":"String", "listItems": ["String","String"] }, { "name":"String", "required":"String", "show":"String", "value":"String", "listItems": ["String","String"] }], "textCustomFields": [{ "name":"String", "required":"String", "show":"String", "value":"String" }, { "name":"String", "required":"String",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"show":"String", "value":"String" }] }

130

Response The response returns success or failure and any error messages. For all successes, DocuSign will generate a fieldId for the custom envelope field. The fieldId is used when editing or removing the envelope custom field in an envelope. The following example shows the response json body. Example Response Body
{ "listCustomFields": [{ "fieldId":"String", "name":"String", "required":"String", "show":"String", "value":"String", "listItems": ["String","String"] }, { "fieldId":"String", "name":"String", "required":"String", "show":"String", "value":"String", "listItems": ["String","String"] }], "textCustomFields": [{ "fieldId":"String", "name":"String", "required":"String", "show":"String", "value":"String" }, { "fieldId":"String", "name":"String", "required":"String", "show":"String", "value":"String" }] }

Get Envelope Custom Field Information

This returns the custom field information for a single envelope. These fields can be used in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a premade list.
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 URL: /accounts/{accountId}/envelopes/{envelopeId}/custom_fields Formats: XML, JSON HTTP Method: GET Parameters: The only required parameter is the envelope ID. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/custom_fields

131

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns information about the custom fields included in the envelope. The response splits the custom fields by list and text types. If there are no custom fields in the envelope, the response returns an empty list. Name listCustomFields fieldId name required show Type String String String String Description The DocuSign generated ID number for the Envelope Custom Field. The name of the Envelope Custom Field When true, information must be entered into the custom field to send the envelope. When true, the custom field is shown to senders in the DocuSign member console during sending. The selected value for the field. The list of values that can be selected by senders. The list values are entered with quotations, separated by commas. Example: ["one", "two", "three", "four"] The DocuSign generated ID number for the Envelope Custom Field. The name of the Envelope Custom Field

value listItems

String String

textCustomFields fieldId name

String String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 required show String String

132 When true, information must be entered into the custom field to send the envelope. When true, the custom field is shown to senders in the DocuSign member console during sending. The entered value for the field.

value

String

Example Response Body

{ "listCustomFields":[{ "fieldId":"String", "name":"String content", "required":"String content", "show":"String content", "value":"String content", "listItems":["String content"] }], "textCustomFields":[{ "fieldId":"String", "name":"String content", "required":"String content", "show":"String content", "value":"String content" }] }

Modify Envelope Custom Fields for an Envelope

This allows you to edit the envelope custom fields for draft and in-process envelopes. URL: /accounts/{accountId}/envelopes/{envelopeId}/custom_fields Formats: XML, JSON HTTP Method: PUT Parameters: The parameters for an Envelope Custom Field are only required if you are editing that custom field. Name listCustomFields fieldId Yes String The DocuSign generated ID number for the Envelope Custom Field. Reqd? Type Description

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name name required show Reqd? Yes Yes Yes Type String String (Boolean) String (Boolean) String String Description The name of the Envelope Custom Field

133

When true, information must be entered into the custom field to send the envelope. When true, the custom field is shown to senders in the DocuSign member console during sending. The new value for the custom field in this envelope. The list of values that can be selected by senders. The list values are entered with quotations, separated by commas. Example: ["one", "two", "three", "four"]

value listItems

Yes Yes

textCustomFields fieldId name required show Yes Yes Yes Yes String String String (Boolean) String (Boolean) String The DocuSign generated ID number for the Envelope Custom Field. The name of the Envelope Custom Field When true, information must be entered into the custom field to send the envelope. When true, the custom field is shown to senders in the DocuSign member console during sending. The new value for the custom field in this envelope.

value

Yes

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/custom_fields X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "listCustomFields": [{ "fieldId":"String", "name":"String", "required":"String", "show":"String", "value":"String", "listItems": ["String","String"] }, { "fieldId":"String", "name":"String", "required":"String",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"show":"String", "value":"String", "listItems": ["String","String"] }], "textCustomFields": [{ "fieldId":"String", "name":"String", "required":"String", "show":"String", "value":"String" }, { "fieldId":"String", "name":"String", "required":"String", "show":"String", "value":"String" }] }

134

Response The response returns success or failure and any error messages. The response also returns the list of envelope custom fields with the updated values. The following example shows the response json body. Example Response Body
{ "listCustomFields": [{ "fieldId":"String", "name":"String", "required":"String", "show":"String", "value":"String", "listItems": ["String","String"] }, { "fieldId":"String", "name":"String", "required":"String", "show":"String", "value":"String", "listItems": ["String","String"] }], "textCustomFields": [{ "fieldId":"String", "name":"String", "required":"String", "show":"String", "value":"String" }, { "fieldId":"String", "name":"String", "required":"String", "show":"String", "value":"String" }] }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

135

Remove Envelope Custom Fields from an Envelope

This allows you to remove envelope custom fields for draft and in-process envelopes. URL: /accounts/{accountId}/envelopes/{envelopeId}/custom_fields Formats: XML, JSON HTTP Method: DELETE Parameters: Name listCustomFields fieldId textCustomFields fieldId Yes String The DocuSign generated ID number for the Envelope Custom Field. Yes String The DocuSign generated ID number for the Envelope Custom Field. Reqd? Type Description

Example Request Body

DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/custom_fields X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "listCustomFields": [{ "fieldId":"String" }, { "fieldId":"String" }], "textCustomFields": [{ "fieldId":"String" }, { "fieldId":"String" }] }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Response

136

The response returns success or failure and any error messages. The response also returns the list of envelope custom field IDs that were removed from the envelope. The following example shows the response json body. Example Response Body
{ "listCustomFields": [{ "fieldId":"String" }, { "fieldId":"String" }], "textCustomFields": [{ "fieldId":"String" }, { "fieldId":"String" }] }

Add Documents to a Draft Envelope

This can be used to add one or more documents to an existing draft envelope or change the order of documents in a draft envelope. URL: /accounts/{accountId}/envelopes/{envelopeId}/documents Formats: XML, JSON HTTP Method: PUT Parameters: See Document parameters. Example Request Body
PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/{envelopeId}/ documents X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Content-Type: multipart/form-data; boundary=AAA --AAA Content-Type: application/json

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

Content-Disposition: form-data { "documents": [{ "documentId": "String content", "name": "String content", "order": "String content" }, { "documentId": "String content", "name": "String content", "order": "String content" }] } --AAA Content-Type: application/pdf Content-Disposition: file; filename="String content"; documentId=10 --AAA Content-Type: application/pdf Content-Disposition: file; filename=" String content"; documentId=40 --AAA--

137

Response The response returns the success or failure of each document being added to the envelope and the envelope ID. Failed operations on array elements will add the errorDetails structure containing an error code and message. If errorDetails is null, then the operation was successful for that item.

Remove Documents from a Draft Envelope

This removes one or more document from an existing draft envelope. URL: /accounts/{accountId}/envelopes/{envelopeId}/documents Formats: XML, JSON HTTP Method: DELETE Parameters: See Document parameters. Example Request Body
DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/{envelopeId}/ documents

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

138

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Content-Type: application/json { "documents": [{ "documentId": "String content", }, { "documentId": "String content", }] }

Response The response returns the success or failure of each document being added to the envelope and the envelope ID. Failed operations on array elements will add the errorDetails structure containing an error code and message. If errorDetails is null, then the operation was successful for that item.

Get List of Envelope Documents

This returns a list of documents associated with the specified envelope. URL: /accounts/{accountId}/envelopes/{envelopeId}/documents Formats: XML, JSON HTTP Method: GET Parameters: The only required parameter is the envelope ID. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/documents X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns a list of the documents in the selected envelope, with the document ID, name, type, uri, order, pages, and if the document contains PDF form fields (this is a true/false).
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 The following example shows the response json body. Example Response Body
{ "envelopeId":"String content", "envelopeDocuments":[ { "documentId":"String content", "name":"String content", "type":"String content", "uri":"String content", "order":"String content", "pages":"String content", "containPdfFormFields":"String content" }, { "documentId":"String content", "name":"String content", "type":"String content", "uri":"String content", "order":"String content", "pages":"String content", "containPdfFormFields":"String content" }, ], }

139

Add a Document to a Draft Envelope

This adds one document to an existing draft envelope. URL: /accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId} Formats: XML, JSON HTTP Method: PUT Parameters: See Document parameters. Example Request Body
PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/documents/{documentId} X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Content-Type: application/pdf

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

Content-Disposition: file; filename="test1.pdf"; documentid=1; fileExtension="pdf" <Bytes of PDF omitted>

140

Response The response only returns a success or failure.

Get Document from Envelope

This retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. URL: /accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId} Optional additions: show_changes={true} Formats: XML, JSON HTTP Method: GET Parameters: The only required parameters are the envelope ID and document ID. Name show_changes Reqd? No Schema Type Boolean Description Optional. When set to true, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red.

Example Request Body

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/documents/{documentId} X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the PDF document as a byte stream. If show_changes was included, any changed fields are highlighted in the PDF.
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

141

Get a Page Image

This returns a page image for display. URL: /accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageId}/ page_image Optional query strings: dpi={dpi for the image}, max_width={maximum width in pixels}, max_height={maximum height in pixels} Formats: XML, JSON HTTP Method: GET Parameters: There are no required parameters, but the following query string parameters can be added to change the page image settings. Name dpi max_width max_height Reqd? No No No Type String String String Description Sets the dpi for the image. Sets the maximum width for the page image. The dpi is recalculated based on this setting. Sets the maximum height for the page image. The dpi is recalculated based on this setting.

Example Request Body

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes /{envelopeId}/documents/{documentId}/pages/{pageId}/page_image X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the requested page image with the requested settings.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

142

Rotate Page Image

This rotates a page image for display. The page image can be rotated to the left or right. URL: /accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageId}/ page_image Formats: XML, JSON HTTP Method: PUT Parameters: Name rotate Reqd? Yes Type String Description Sets the direction the page image is rotated. The possible settings are: left or right

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes /{envelopeId}/documents/{documentId}/pages/{pageId}/page_image X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "rotate":"String content" }

Response The response a success or failure.

Remove a Page
This removes a page from a document based on the page ID. URL: /accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageId}

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Formats: XML, JSON HTTP Method: DELETE Parameters: No additional parameters are required. Example Request Body
DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes /{envelopeId}/documents/{documentId}/pages/{pageId}

143

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns a success or failure.

Get Custom Document Fields for an Envelope Document

This returns the custom document field information for an existing envelope document. URL: /accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/documents/{documentId}/fields X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

Accept: application/json Content-Type: application/json

144

Response The response returns the custom document field name-value pairs for the requested document ID. The following example shows the response json body.

Example Response Body

{ "documentFields": [ { "name": "sample string", "value": "sample string" }, { "name": "sample string", "value": "sample string" } ] }

Add Custom Document Fields to an Envelope Document

This adds custom document fields for an existing envelope document. URL: /accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields Formats: XML, JSON HTTP Method: POST Parameters: Name Reqd? Type Description

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name documentFields Reqd? Yes Type documentField Description

145

The array of name-value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the elements: Name A string that can be a maximum of 50 characters. Value A string that can be a maximum of 200 characters.

Example Request Body

POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/documents/{documentId}/fields X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "documentFields": [ { "name": "sample string 1", "value": "sample string 2", }, { "name": "sample string 1", "value": "sample string 2", } ] }

Response The response returns the custom document field name-value pairs added to the document and any errors associated with the fields. The following example shows the response json body. Example Response Body
{ "documentFields": [ { "name": "sample string", "value": "sample string", "errorDetails": { "errorCode": "sample string", "message": "sample string" } }, { "name": "sample string", "value": "sample string",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"errorDetails": { "errorCode": "sample string", "message": "sample string" } } ] }

146

Modify Custom Document Fields for an Envelope Document

This modifies existing custom document fields for an existing envelope document. URL: /accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields Formats: XML, JSON HTTP Method: PUT Parameters: Name documentFields Reqd? Yes Type documentField Description The array of name-value strings that modifies custom data on a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the elements: Name A string that can be a maximum of 50 characters. Value A string that can be a maximum of 200 characters.

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/documents/{documentId}/fields X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "documentFields": [ { "name": "sample string 1", "value": "sample string 2", 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

}, { "name": "sample string 1", "value": "sample string 2", } ] }

147

Response The response returns the modified custom document field name-value pairs for the document and any errors associated with the fields. The following example shows the response json body. Example Response Body
{ "documentFields": [ { "name": "sample string", "value": "sample string", "errorDetails": { "errorCode": "sample string", "message": "sample string" } }, { "name": "sample string", "value": "sample string", "errorDetails": { "errorCode": "sample string", "message": "sample string" } } ] }

Delete Custom Document Fields from an Envelope Document

This deletes custom document fields for an existing envelope document. URL: /accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields Formats: XML, JSON HTTP Method: DELETE Parameters: Name Reqd? Type Description

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name documentFields Reqd? Yes Type documentField Description

148

The array of name-value custom data strings to be deleted from a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the elements: Name A string that can be a maximum of 50 characters. Value A string that can be a maximum of 200 characters.

Example Request Body

DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/documents/{documentId}/fields X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "documentFields": [ { "name": "sample string 1", "value": "sample string 2", }, { "name": "sample string 1", "value": "sample string 2", } ] }

Response The response returns success or failure and any error messages. The response also returns the list of custom document field name-value pairs that were removed from the document. The following example shows the response json body. Example Response Body
{ "documentFields": [ { "name": "sample string 1", "value": "sample string 2", }, { "name": "sample string 1", "value": "sample string 2", } ] }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

149

Get Envelope Certificate

This retrieves a PDF document containing the certificate of completion for the envelope. URL: /accounts/{accountId}/envelopes/{envelopeId}/documents/certificate Formats: XML, JSON HTTP Method: GET Parameters: The only required parameter is the envelope ID. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/documents/certificate X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns a PDF version of the envelope certificate as a byte stream.

Get Envelope Documents and Certificate

This retrieves a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. URL: /accounts/{accountId}/envelopes/{envelopeId}/documents/combined Optional additions: certificate={true or false}, show_changes={true}, watermark={true or false} Formats: XML, JSON

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 HTTP Method: GET Parameters: The only required parameter is the envelope ID. Name certificate Reqd? No Schema Type Boolean Description

150

Optional. This option can remove the envelope signing certificate from the download. Optional. When set to true, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. Optional. If the account has the watermark feature enabled and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark.

show_changes

No

Boolean

watermark

No

Boolean

Example Request Body

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/documents/combined X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns all the PDFs in an envelope and a PDF version of the envelope certificate as a byte stream. If show_changes was included, any changed fields are highlighted in the PDF.

Get Envelope Notification Information

This returns the reminder and expiration information for the envelope. URL: /accounts/{accountId}/envelopes/{envelopeId}/notification Formats: XML, JSON

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 HTTP Method: GET Parameters: The only required parameter is the envelope ID. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/notification

151

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the expiration and reminder settings for the envelope. The following example shows the response json body. Example Response Body
{ "expirations": { "expireAfter": "String content", "expireEnabled": "String content", "expireWarn": "String content" }, "reminders": { "reminderDelay": "String content", "reminderEnabled": "String content", "reminderFrequency": "String content" } }

Get Envelope Recipient Status

This returns the status for all recipients of a single envelope and identifies the current routing order. The current routing order is a number that matches up to the routingOrder for envelope recipients, which shows that the envelope has been sent to a recipient, but the recipient has not completed their actions. URL: /accounts/{accountId}/envelopes/{envelopeId}/recipients Optional query items: include_tabs={true or false}, include_extended={true or false} Formats: XML, JSON

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 HTTP Method: GET Parameters:

152

The only required parameter is the envelope ID. If the optional query include_tabs is set to true, the tabs associated with the recipient are returned. If the optional query include_extended is set to true, the extended properties are returned. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/recipients X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the recipient types and current routing order. The recipient types includes the recipient name, email, ID, recipient type, routing order, authentication status (including the date/time and result of the authentication) status (including the date/time of the status changes) and, if the recipient status is declined and a reason is required, a decline reason added by the recipient. The following example shows the response json body. Example Response Body
{ "agents":[] "carbonCopies":[], "certifiedDeliveries":[], "currentRoutingOrder":"String content", "editors":[], "inPersonSigners":[], "intermediaries":[], "recipientCount":"String content", "signers":[{ "deliveredDateTime": "String content", "recipientAuthenticationStatus":{ "(authentication status result)": "eventTimestamp":"String content" "status":"String content" } }, "recipientId": "String content", "requireIdLookup": "String content", "roleName":"String content", "routingOrder": "String content", "signedDateTime": "String content", "status": "String content", "email": "String content", "name": "String content" }] }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

153

Add Recipients to an Envelope

This is used to add one or more recipeints to an envelope. Note: For In Process envelopes (one that has been sent and is not completed or voided), an email will be sent to a new recipient when they are reached in the routing order. If the new recipients routing order is before or the same as the envelopes next recipient, an email is only sent if the optional resend_envelope query string is set to true. URL: /accounts/{accountId}/envelopes/{envelopeId}/recipients Optional query string: resend_envelope={true or false} Formats: XML, JSON HTTP Method: POST Parameters: The parameters used to add recipients are the same as those used in an envelope. See the Recipient Types and Parameters for more information. Example Request Body
POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/recipients X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json "signers":[{ "accessCode":"String content", "addAccessCodeToEmail":"String content", "clientUserId":"String content", "customFields":["String content"], "emailNotification":{ "emailBody":"String content", "emailSubject":"String content", "supportedLanguage":"String content" }, "idCheckConfigurationName":"String content", "inheritEmailNotificationConfiguration":"String content", "note":"String content", "phoneAuthentication":{ "recipMayProvideNumber":"String content", "recordVoicePrint":"String content", "senderProvidedNumbers":["String content"], "validateRecipProvidedNumber":"String content" }, "recipientAttachments":[{

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"attachmentType":"String content", "label":"String content" }], "recipientId":"String content", "requireIdLookup":"String content", "roleName":"String content", "routingOrder":"String content", "socialAuthentications":[{ "authentication":"String content" }], "email":"String content", "name":"String content", "defaultRecipient":"String content", "signInEachLocation":"String content", "signatureInfo":{ "fontStyle":"String content", "signatureInitials":"String content", "signatureName":"String content" } }] }

154

Response The response returns if the API execution is successful (200 OK) or failed. The response contains a recipient structure similar to that input. If an error occurred during the POST operation for any of the recipients, that recipient will contain an error node with an errorCode and message. The following example shows the response json body. Example Response Body
{ "agents":[{ }] "carbonCopies":[{ }] "certifiedDeliveries":[{ }] "editors":[{ }] "agents":[{ }] "inPersonSigners":[{ "accessCode":"String content", "note":"String content", "recipientId":"String content", "requireIdLookup":"String content", "roleName":"String content", "routingOrder":"String content", "signerName":"String content", "status":"Created", "email":"String content", "name":"String content" }] "intermediaries":[{ }] "signers":[{ "accessCode":"String content", "note":"String content", "recipientId":"String content", "requireIdLookup":"String content", "roleName":"String content", 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"routingOrder":"String content", "status":"Created", "email":"String content", "name":"String content" }] }

155

Delete Recipients from an Envelope

This is used to delete one or more recipients from an envelope. The recipients that need to be deleted are listed in the request, with the recipientId being used as the key for deleting recipients. If the envelope is In Process (has been sent and is not completed or voided), recipients that have completed their actions cannot be deleted. URL: /accounts/{accountId}/envelopes/{envelopeId}/recipients Formats: XML, JSON HTTP Method: DELETE Parameters: The only required parameter is recipientId. Example Request Body
DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/recipients X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "signers":[{ "recipientId":"String content", }] }

Response The response returns if the API execution is successful (200 OK) or failed. The response contains a recipient structure similar to that input. If an error occured during the DELETE operation for any of the recipients, that recipient will contain an error node with an errorCode and message. The following example shows the response json body.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Example Response Body

{ "agents":[{ }] "carbonCopies":[{ }] "certifiedDeliveries":[{ }] "editors":[{ }] "agents":[{ }] "inPersonSigners":[{ }] "intermediaries":[{ }] "signers":[{ "recipientId":"String content", "routingOrder":"String content", "status":"Deleted", "email":"String content", "name":"String content" }] }

156

Modify or Correct and Resend Recipient Information

This lets you modify recipients in a draft envelope or correct recipient information for an in process envelope. For draft envelopes, you can edit: email, userName, routingOrder, faxNumber, deliveryMethod, accessCode and requireIdLookup. Note: If you send information for a recipient that does not already exist in a draft envelope, the recipient will be added to the envelope (similar to the POST). Once an envelope has been sent, you can only edit: email, userName, signerName, routingOrder, faxNumber, and deliveryMethod. You can also select to resend an envelope by using the resend_envelope option. URL: /accounts/{accountId}/envelopes/{envelopeId}/recipients Optional addition: resend_envelope {true or false} Formats: XML, JSON HTTP Method: PUT

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Parameters: The parameters used to modify recipients are the same as those used in an envelope. See the Recipient Types and Parameters for more information. The resend_envelope flag is only used to resend an In Process envelope. Name resend_envelope Reqd? No Type String Description

157

True or false setting that defaults to false. Setting this to true will resend the envelope to the recipient.

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/recipients X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "signers" : [ { "email": "mike.roseleip@docusign.com", "name": "Mike Roseleip", "recipientId": "1" } ] }

Response The response returns if the correction was successful. The following example shows the response json body. Example Response Body
{ "recipientUpdateResults": [{ "errorDetails": { "errorCode": "SUCCESS", "message": "" }, "recipientId": "1" }] }

Set Initials Image for Accountless Signer

This sets the initials image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 URL: /accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image

158

Note: For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or inperson signer, the Account has CanSendEnvelope enabled and the SendingUser does not have ExpressSendOnly enabled. Formats: XML, JSON HTTP Method: PUT Parameters: No additional parameters are required. Example Request Body
PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/{envelopeId}/ recipients/{recipientId}/initials_image X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Content-Type: image/gif <image removed>

Response The response returns a success or failure.

Get Signature Information for Accountless Signer

This returns the structure of a single signature with a known signature name. URL: /accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature Note: For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer, the Account has CanSendEnvelope enabled and the SendingUser does not have ExpressSendOnly enabled. Formats: XML, JSON

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 HTTP Method: GET Parameters: No additional parameters are required. Example Request Body

159

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/{envelopeId}/ recipients/{recipientId}/signature X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

Response The response returns information for the request recipient signature. The following example shows the response json body. Example Response Body
{ "adoptedDateTime":"String content", "createdDateTime":"String content", "initials150ImageId":"String content", "initialsImageUri":"String content", "signature150ImageId":"String content", "signatureFont":"String content", "signatureId":"String content", "signatureImageUri":"String content", "signatureInitials":"String content", "signatureName":"String content", "signatureType":"String content" }

Set Signature Image for Accountless Signer

This sets the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. URL: /accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image Note: For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer, the Account has CanSendEnvelope enabled and the SendingUser does not have ExpressSendOnly enabled. Formats: XML, JSON

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 HTTP Method: PUT Parameters: No additional parameters are required. Example Request Body

160

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/{envelopeId}/ recipients/{recipientId}/signature_image X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Content-Type: image/gif <image removed>

Response The response returns a success or failure.

Add Tabs for a Recipient

This adds one or more tabs for a recipient. If can be used to add tabs to a draft envelope or to add tabs to an in process envelope. To add tabs to an in process envelope, the account must have envelope correct enabled, the envelope status must be Sent and the recipient status must be Created or Sent. If these conditions are met, the POST opens the envelope in correct mode, adds the tabs and exits correct mode. URL: /accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs Formats: XML, JSON HTTP Method: POST Parameters: The parameters used to add tabs are the same as those used in an envelope. See the Tab Types and Parameters section for more information about the tabs.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Example Request Body

161

POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/{envelopeId}/ recipients/{recipientId}/tabs X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "approveTabs":[{ <Tab information removed> }], "titleTabs":[{ <Tab information removed> }], "signHereTabs":[{ <Tab information removed> }] }

Response The response returns the success or failure of each tab being added to the envelope and the envelope ID. Failed operations on array elements will add the errorDetails structure containing an error code and message. If errorDetails is null, then the operation was successful for that item.

Get Tab Information for a Recipient

This retrieves information about the tabs associated with a recipient in a draft envelope. URL: /accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/{envelopeId}/ recipients/{recipientId}/tabs X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

Accept: application/json Content-Type: application/json

162

Response The response returns a list of tabs associated with the recipient. The tab information includes a tabId that can be used when deleting a tab. The following example shows the response json body. Example Response Body
{ "approveTabs":[{ <Tab information removed> }], "titleTabs":[{ <Tab information removed> }], "signHereTabs":[{ <Tab information removed> }] }

Delete Tabs for a Recipient

This deletes one or more tabs associated with a recipient in a draft envelope. URL: /accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs Formats: XML, JSON HTTP Method: DELETE Parameters: Name tabId Reqd? Yes Type String Description The unique identifier for the tab. The tabId can be retrieved with the GET call.

Example Request Body

DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/{envelopeId}/ recipients/{recipientId}/tabs X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

{ "approveTabs":[{ "tabId":"String }, { "tabId":"String } ], "titleTabs":[{ "tabId":"String }], "signHereTabs":[{ "tabId":"String }] } content"

163

content"

content"

content"

Response The response returns the success or failure of each document being added to the envelope and the envelope ID. Failed operations on array elements will add the errorDetails structure containing an error code and message. If errorDetails is null, then the operation was successful for that item.

Modify Tabs for a Recipient

This modifies one or more tabs for a recipient to a draft envelope. URL: /accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs Formats: XML, JSON HTTP Method: PUT Parameters: The parameters used to modify tabs are the same as those used in an envelope, but you can only modify existing tabs and the tabId must be included. See the Tab Types and Parameters section for more information about the tabs. Name tabId Reqd? Yes Type String Description The unique identifier for the tab. The tabId can be retrieved with the GET call.

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/{envelopeId}/ recipients/{recipientId}/tabs

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

164

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "approveTabs":[{ <Tab information removed> }], "titleTabs":[{ <Tab information removed> }], "signHereTabs":[{ <Tab information removed> }] }

Response The response returns the success or failure of each tab being modified and the envelope ID. Failed operations on array elements will add the errorDetails structure containing an error code and message. If errorDetails is null, then the operation was successful for that item.

Get List of Templates Used in an Envelope

This returns a list of the templates, name and ID, used in an envelope. Note: This only returns information for server side templates. URL: /accounts/{accountId}/envelopes/{envelopeId}/templates Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required.

Example Request Body

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes /{envelopeId}/templates X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

Content-Type: application/json

165

Response The response returns a list of the templates used in an envelope, showing the name, ID and uri for the template. The following example shows the response json body. Example Response Body
{ "templates":[{ "name":"String content", "templateId":"String content", "uri":"String content" }] }

Post Envelope Correction

This provides a URL to start the correction view of the DocuSign UI. Important: DocuSign recommends that you do not use iFrames for embedded operations on mobile devices. URL: /{accountId}/envelopes/{envelopeId}/views/correct Formats: XML, JSON HTTP Method: POST Parameters: Name returnUrl Reqd? Yes Type String Description Identifies the return point after correcting the envelope. The URL will have an event passed to it as a query parameter. The parameter will be named event, see In-session sending events below for description of the valid events. The DocuSign Envelope Id will also be returned in the envelopeId parameter. Sets whether the window is displayed with or without dressing.

suppressNavigation

No

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Example Request Body

166

POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/{envelopeId}/ views/correct X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "returnUrl":"String content", "suppressNavigation":"String content" }

Response The response returns the correction view url. The following example shows the response json body. Example Response Body
{ "url":"String content" }

Post Recipient View

This provides a URL to start the recipient view of the DocuSign UI. Important: DocuSign recommends that you do not use iFrames for embedded operations on mobile devices. URL: /accounts/{accountId}/envelopes/{envelopeId}/views/recipient Formats: XML, JSON HTTP Method: POST Parameters: Name authenticationMethod Reqd? Yes Type String Description The convention used to authenticate the end-user.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 clientUserId Yes String

167 A sender created value that shows the recipient is embedded (captive). This can be a maximum of 100 characters. Specifies the email of the recipient. * You can use either email and userName or userId to identify the recipient. The URL the recipient is directed to on certain events. DocuSign sends returns to the URL and includes an event parameter that can be used to redirect the recipient to another location. The possible event parameters returned are: cancel (recipient cancels signing) decline (recipient declines signing) exception (exception occurs) fax_pending (recipient has fax pending) id_check_faild (recipient failed an ID check) session_timeout (session times out) signing_complete (recipient completes signing) ttl_complete (the TTL expires) viewing_complete (recipient completes viewing the envelope) Specifies the user ID of the recipient. * You can use with userId or email and userName to identify the recipient. If userId is used and a clientUserId is provided, the userId must match a recipientId (which can be retrieved with a GET recipients call) for the envelope. If userId is used and a clientUserId is not provided, the userId match the userId of the authenticating user.

email

Yes*

String

returnUrl

String

userId

Yes*

String

userName

Yes*

String

Specifies the username of the recipient * You can use either email and userName or userId to identify the recipient.

Example Request Body

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/{envelopeId}/ views/recipient X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

{ "authenticationMethod":"String content", "clientUserId":"String content", "email":"String content", "returnUrl":"String content", "userId":"String content" "userName":"String content" }

168

Response The response returns the recipient view url. The following example shows the response json body. Example Response Body
{ "url":"String content" }

Post Sender View

This provides a URL to start the sending view of the DocuSign UI. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: DocuSign recommends that you do not use iFrames for embedded operations on mobile devices. URL: /accounts/{accountId}/envelopes/{envelopeId}/views/sender Formats: XML, JSON HTTP Method: POST Parameters: Name returnUrl Reqd? Yes Type String Description Identifies the return point after sending the envelope.

Example Request Body

POST https://{SERVER}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ {envelopeId}/views/sender

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

169

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "returnUrl":"String content" }

Response The response returns the sender view url. The following example shows the response json body. Example Response Body
{ "url":"String content" }

Get Envelope Status for more than one envelope

This returns envelope status for the requested envelopes. URL: /accounts/{accountId}/envelopes/status Formats: XML, JSON HTTP Method: PUT Parameters: Name envelopeIds Reqd? Yes Type String Description The envelope IDs for the envelopes being requested.

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/ status?envelope_ids=request_body X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "envelopeIds":[ 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"String content", "String content" ], }

170

Response The response returns the envelope status information for the requested envelopes. The following example shows the response json body. Example Response Body
{ "envelopes": [{ "certificateUri": "String content", "customFieldsUri": "String content", "documentsCombinedUri": "String content", "documentsUri": "String content", "envelopeId": "String content", "envelopeUri": "String content", "notificationUri": "String content", "recipientsUri": "String content", "status": "String content", "statusChangedDateTime": "String content" }, { "certificateUri": "String content", "customFieldsUri": "String content", "documentsCombinedUri": "String content", "documentsUri": "String content", "envelopeId": "String content", "envelopeUri": "String content", "notificationUri": "String content", "recipientsUri": "String content", "status": "String content", "statusChangedDateTime": "String content" }], "resultSetSize": "String content" }

Get Folder List

Returns a list of the folders for the account, including the folder hierarchy. There is an option to include the list of template folders and templates. URL: /accounts/{accountId}/folders Optional query string: template={string} Formats: XML, JSON

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 HTTP Method: GET Parameters: No additional parameters are required, but the following optional parameter can be added to the request. Name Template Reqd? No Type String Description

171

The two possible values are include or only. include - The folder list will return normal folders plus template folders. only - Only the list of template folders are returned.

Example Request Body

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/folders X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the list of folders for the account. The folder list includes the folder ID, the folder name, the name, user ID and email of the folders owner, the folder type and uri. If the folder is a sub-folder of another folder, the parent folder information is returned. If the template query is included, the template folder structure, along with the templates within each folder, is also returned. The following example shows the response json body. Example Response Body
{ "folders": [ { "ownerUserName": "String content", "ownerEmail": "String content", "ownerUserId": "String content", "type": "String content", "name": "String content", "uri": "String content", "parentFolderId": "String content", "parentFolderUri": "String content", "folderId": "String content", "filter": { "actionRequired": "String content", "expires": "String content", "isTemplate": "String content", "status": "String content", "fromDateTime": "String content", "toDateTime": "String content", "searchTarget": "String content", "searchText": "String content",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"folderIds": "String content", "orderBy": "String content", "order": "String content" } }, ] }

172

Get Folder Envelope List

Returns a list of the envelopes in the specified folder. You can narrow the query by adding some optional items. URL: /accounts/{accountId}/folders/{folderId} Optional query additions: start_position={ integer}, from_date = {date/time}, to_date= {date/time}, search_text={text}, status={envelope status}, owner_name={username}, owner_email={email} Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required, but the following optional query strings can be added to narrow the response results. Name start_position Reqd? No Type Integer Description The position of the folder items to return. This is used for repeated calls, when the number of envelopes returned is too much for one return (calls return 100 envelopes at a time). The default value is 0. Only return items on or after this date. If no value is provided, the default search is the previous 30 days. Only return items up to this date. If no value is provided, the default search is to the current date. The search text used to search the items of the envelope. The search looks at recipient names and emails, envelope custom fields, sender name, and subject. The current status of the envelope. If no value is provided, the default search is all/any status.

from_date

No

Date/time

to_date

No

Date/time

search_text

No

String

status

No

Envelope status

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name owner_name owner_email Reqd? No No Type username email Description The name of the folder owner. The email of the folder owner.

173

Example Request Body

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/folders/{folderId} X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the list of envelope in the folder that meet the query information. The following example shows the response json body. Example Response Body
{ "resultSetSize": "String content", "startPosition": "String content", "endPosition": "String content", "totalSetSize": "String content", "previousUri": "String content", "nextUri": "String content", "folderItems": [ { "ownerName": "String content", "envelopeId": "String content", "envelopeUri": "String content", "status": "String content", "senderName": "String content", "senderEmail": "String content", "createdDateTime": "String content", "sentDateTime": "String content", "completedDateTime": "String content", "subject": "String content", "templateId": "String content", "name": "String content", "shared": "String content", "password": "String content", "description": "String content", "lastModified": "String content", "pageCount": "String content", "uri": "String content", "customFields": [ { "fieldId": "String content", "name": "String content", "show": "String content", "required": "String content", "value": "String content", }, { "fieldId": "String content",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"name": "String content", "show": "String content", "required": "String content", "value": "String content", } ] }, ] }

174

Move Envelope
This moves an envelope from its current folder to selected folder. Note: This can be used to delete envelopes by using recyclebin as folderId. URL: /accounts/{accountId}/folders/{folderId} Formats: XML, JSON HTTP Method: PUT Parameters: Name envelopeIds fromFolderId Reqd? Yes No Type String String Description The envelope ID for the envelope that is being moved. The folder ID the envelope is being moved from.

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/folders/{folderId} X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "envelopeIds": ["String"], "fromFolderId": "FolderId" }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Response The response returns if the move was a success or failure.

175

Add a New Group

This adds one or more groups for the account. Groups can be used to help manage users by associating users with a group. A group can be associated with a Permission Profile, which sets the user permissions for users in that group without having to set the userSettings for each user. You are not required to set Permission Profiles for a group, but this makes it easier to manage user permissions for a large number of users. Groups can also be used with template sharing to limit user access to templates. URL: /accounts/{accountId}/groups Formats: XML, JSON HTTP Method: POST Parameters: Name groupName permissionProfileId Reqd? Yes No Type String String Description The name for the new user group. The ID number of the permission profile that the group is associated with. See Get a List of Permission Profiles for information on retrieving a list of IDs.

Example Request Body

POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/groups X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "groups":[{ "groupName":"String content", "permissionsProfileId":"String content" }] }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Response

176

The response returns if the API execution is successful (201 Created) or failed. The response contains a group structure similar to the request and includes the groupId assigned to the group. If an error occurred during the POST operation for any of the groups, that group will contain an errorDetails node with an errorCode and message. The following example shows the response json body. Example Response Body
{ "groups":[{ "errorDetails":{ "errorCode":"String content", "message":"String content" }, "groupId":"String content", "groupName":"String content", "groupType":"String content", "permissionsProfileId":"String content" }] }

Get Group Information

This retrieves information about groups associated with the account. URL: /accounts/{accountId}/groups Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/groups X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the information for the groups associated with the account.
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 The following example shows the response json body. Example Response Body
{ "groups":[{ "groupId":"String content", "groupName":"String content", "groupType":"String content", "permissionsProfileId":"String content" }] }

177

Modify Group Information

This lets you modify a group name and modify, or set, the permission profile for the group. URL: /accounts/{accountId}/groups Formats: XML, JSON HTTP Method: PUT Parameters: Name groupId groupName permissionProfileId Reqd? Yes No No Type String String String Description The group ID number. The new name for the group. The ID number of the permission profile that the group is associated with. See Get a List of Permission Profiles for information on retrieving a list of IDs.

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/groups X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "groups":[{ "groupId":"String content", "groupName":"String content", 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"permissionProfileId":"String content" }] }

178

Response The response returns if the API execution is successful (200 OK) or failed. The response contains a group structure similar to the request. If an error occurred during the PUT operation for any of the groups, that group will contain an errorDetails node with an errorCode and message. The following example shows the response json body. Example Response Body
{ "groups":[{ "errorDetails":{ "errorCode":"String content", "message":"String content" }, "groupId":"String content", "groupName":"String content", "groupType":"String content", "permissionProfileId":"String content" }] }

Get Group Brand ID Information

This returns information about the brands associated with the requested group. URL: /accounts/{accountId}/groups/{groupId}/brands Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required.

Example Request Body

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/groups/{groupId}/ brands X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

Content-Type: application/json

179

Response The response returns the brand information (brandId, brandName, and brandCompany) associated with the group. The following example shows the response json body. Example Response Body
{ "brands":[{ "brandId":"String content", "brandName":"String content", "brandCompany":"String content" }, { "brandId":"String content", "brandName":"String content", "brandCompany":"String content" }] }

Add Group Brand ID Information

This adds brand information to a group. URL: /accounts/{accountId}/groups/{groupId}/brands Formats: XML, JSON HTTP Method: PUT Parameters: Name brandId brandName brandCompany Reqd? Yes Yes Yes Type String String String Description The brandId of the brand profile being added to the group. The brand name associated with the brand profile. The brand company associated with the brand profile.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/groups/{groupId}/ brands

180

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "brands":[{ "brandId":"String content", "brandName":"String content", "brandCompany":"String content" }] }

Response The response returns as success or failure, along with the brand information (brandId, brandName, and brandCompany) added to the group. The following example shows the response json body. Example Response Body
{ "brands":[{ "brandId":"String content", "brandName":"String content", "brandCompany":"String content" }] }

Delete Group Brand ID Information

This removes brand information from the requested group. URL: /accounts/{accountId}/groups/{groupId}/brands Formats: XML, JSON HTTP Method: DELETE

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Parameters: Name brandId Reqd? Yes Type String Description

181

The brandId of the brand profile being removed from the group.

Example Request Body

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/groups/{groupId}/ brands X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "brands":[{ "brandId":"String content" }, "brandId":"String content" }] }

Response The response returns as success or failure, along with the brandIds of the brands removed from the group. The following example shows the response json body. Example Response Body
{ "brands":[{ "brandId":"String content" }, { "brandId":"String content" }] }

Add Users to a Group

This adds one or more users to an existing group. URL: /accounts/{accountId}/groups/{groupId}/users Formats: XML, JSON

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 HTTP Method: PUT Parameters: Name userId Reqd? Yes Type String Description

182

The user ID number for a user being added to the group.

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/groups/{groupId}/ users X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "users":[{ "userId":"String content", }] }

Response The response returns if the API execution is successful (200 OK) or failed. The response contains a user structure similar to the request and includes the user changes. If an error occurred during the PUT operation for any of the users, that user will contain an errorDetails node with an errorCode and message. The following example shows the response json body. Example Response Body
{ "users":[{ "errorDetails":{ "errorCode":"String content", "message":"String content" }, "uri":"String content", "userId":"String content", "userName":"String content", "userStatus":"String content", "userType":"String content" }] }

Get List of Users in a Group

This retrieves a list of users in a group.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 URL: /accounts/{accountId}/groups/{groupId}/users Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/groups/{groupId}/ users

183

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the information for the users in the group. The following example shows the response json body. Example Response Body
{ { "users":[{ "uri":"String content", "userId":"String content", "userName":"String content", "userStatus":"String content", "userType":"String content" }] } }

Remove Users from a Group

This removes one or more users from a group. URL: /accounts/{accountId}/groups/{groupId}/users

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Formats: XML, JSON HTTP Method: DELETE Parameters: Name userId Reqd? Yes Type String Description

184

The user ID number for a user being removed from the group.

Example Request Body

DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/groups/{groupId}/ users X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "users":[{ "userId":"String content", }] }

Response The response returns if the API execution is successful (200 OK) or failed. The response contains a user structure similar to the request and includes the user changes. If an error occurred during the DELETE operation for any of the users, that user will contain an errorDetails node with an errorCode and message. The following example shows the response json body. Example Response Body
{ "users":[{ "errorDetails":{ "errorCode":"String content", "message":"String content" }, "uri":"String content", "userId":"String content", "userName":"String content", "userStatus":"String content", "userType":"String content" }] }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

185

Get a List of Permission Profiles

This retrieves list of Permission Profiles. Permission Profiles are a standard set of user permissions that can be applied to individual users or users in a Group. This makes it easier to manage user permissions for a large number of users, without having to change permissions on a user-by-user basis. Currently Permission Profiles can only be created and modified in the DocuSign console. URL: /accounts/{accountId}/permission_profiles Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/permission_profiles X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns a list of permission profiles for the account. The following example shows the response json body. Example Response Body
{ "permissionProfiles":[ { "permissionProfileId":"String content", "permissionProfileName":"String content" }, { "permissionProfileId":"String content", "permissionProfileName":"String content" }, ] }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

186

Get Recipient Names

This returns a list of recipients that are available for the given email address. URL: /accounts/{accountId}/recipient_names The query string email = {email} is required. Formats: XML, JSON HTTP Method: GET Parameters: Name email Reqd? Yes Type String Description The email address for the user.

Example Request Body

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/recipient_names? email={email} X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the recipient names associated with the email is used by more than one user. Example Response Body
{ "multipleUsers": "false", "recipientNames": [ "Resty B. Tester", "Resty Tester", "Resty Tester III" ], "reservedRecipientEmail": "false" }

Get List of Envelopes in Folders

This returns a list of envelopes that match the criteria specified in the query.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 URL: /accounts/{accountId}/search_folders/{search_folder} Optional query additions: start_position={integer}, count={integer}, from_date={date/time}, to_date={date/time}, order_by={string}, order={string}, include_recipients={true/false}, all

187

Note: If the userId of the user making the call is the same as the userId for any returned recipient, then the userId is added to the returned information for those recipients. Formats: XML, JSON HTTP Method: GET

Parameters: Name search_folder Reqd? Yes Type String Description Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are listed table below. Starting value for the list. Number of records to return in the cache. The number must be greater than 1 and less than or equal to 100. Start of the date range. If no value is provided, the default search is the previous 30 days. End of the date range. Column used to sort the list. Valid values are listed in the table below. Direction order used to sort the list. Valid values are: asc = ascending sort order (a to z) desc = descending sort order (z to a) When true, the recipient information is returned in the response. This returns all envelopes that matches the criteria.

start_position count

No No

Integer Integer

from_date

No

Date/Time

to_date order_by order

No No No

Date/Time String String

include_recipients all

No No

True/False N/A

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 search_folder values Value Drafts

188

awaiting_my_signature completed out_for_signature order_by values Value action_required created completed sent signer_list status subject

Description Drafts Note that Draft envelopes are only held for 30 days before they are removed from the system. Envelopes awaiting the users signature Envelopes with the status of completed. Sent envelopes that have not been completed.

Description Awaiting Date/Time envelope was created Date/Time envelope was completed Date/Time envelope was sent List of Signers Envelope status Envelope subject

Example Request Body

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/search_folders/ {search_folder}?include_recipients=true X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the list of envelopes that match the specified criteria. Note: If the userId of the user making the call is the same as the userId for any returned recipient, then the userId is added to the returned information for those recipients. Value endPosition folderItems nextUri Description The last row id in the result set. Collection of folder items in the result set. See the table below for more information on the contents of folder items. Provides the Uri to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 previousUri

189

resultSetSize startPosition totalRows folderItems Value completedDateTime createdDateTime envelopeID envelopeUri expireDateTime folderId folderUri ownerName recipients

Provides the Uri to the previous chunk of records based on the search request. If this response is the first response for the search, this is null. Number of folder items returned in the result set. Starting position of the current result set. Total number of rows that meet the search criteria.

recipientUri senderName sentDateTime status subject

Description Date/Time the envelope was completed Date/Time envelope was created Identifier for the envelope Uri path for the envelope Date/Time envelope is set to expire Identifier of the folder where the envelope lives. Path to the folder Name of the envelope owner Recipient information and statuses listed by recipient types. This is the same as the information returned by the Get Envelope Recipient Status request. Uri path of the envelope recipients. Name of the envelope sender. Date/Time the envelope was sent. Current status of the envelope Subject of the envelope.

The following example shows the response json body. Example Response Body
{ "endPosition": "2", "folderItems": [{ "createdDateTime": "2012-07-13T15:57:00.6900000Z", "envelopeId": "463d30c4-3z29-417b-9789-010d221a76b7", "envelopeUri": "\/envelopes\/463d30c4-3e29-417b-9789-010d221a76b7", "expireDateTime": "2012-11-10T21:21:05.2649771Z", "folderID": "237f9912-b96b-4d96-8adb-05523d497225", "folderUri": "\/folders\/237f9912-b96b-4d96-8adb-05523d497225", "ownerName": "Bill Cat", "recipients": { "signers": [{ "email": "rc.cat@yahoo.com", "name": "Rod Cat", "routingOrder": 1, "status": "sent" }, { "email": "dccat@gmail.com", 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"name": "Don Cat", "routingOrder": 1, "status": "sent" }] }, "senderName": "Bill Cat", "sentDateTime": "2012-07-13T15:57:27.8670000Z", "status": "sent", "subject": "Please DocuSign this document: Agreement.pdf"

190

}], "nextUri": "accounts/{accountId}/search_folders/{search_name}?start_position=3 " "previousUri": "accounts/{accountId}/search_folders/{search_name}?start_position=1 " "resultSetSize": "1", "startPosition": "2", "totalRows": "3" }

Get Account Settings

This returns the account settings information for the specified account URL: /accounts/{accountId}/settings Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/settings X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the account setting name/value information for the specified account. See the accountSettings list for more information about the different account settings. The following example shows the response json body.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Example Response Body

{ "accountSettings":[{ "name":"String content", "value":"String content" }] }

191

Modify Account Settings

This updates the account settings list for the specified account. URL: /accounts/{accountId}/settings Formats: XML, JSON HTTP Method: PUT Parameters: Name accountSettings Reqd? Type String Description The name/value pair information for account settings. These determine the features available for the account. See the accountSettings list for more information about the accountSettings.

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/settings X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "accountSettings":[{ "name":"String content", "value":"String content" }] }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Response The response returns a success or failure.

192

Get List of Templates

Retrieves the list of templates for the specified account. The request can be limited to a specific folder. URL: /accounts/{accountId}/templates Optional query string: folder={string}, includeSubFolders={true or false} Formats: XML, JSON HTTP Method: GET Parameters: The only information needed for this is the account ID, but the following optional parameters can be added to the request. Name Folder Reqd? No Type String Description The query value can be a folder name or folder ID. The response will only return templates in the specified folder. When true, the response will include all subfolders.

includeSubFolders

No

Boolean

Example Request Body

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/templates X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response This returns a list of templates for the account with the following information. If the optional folder query is used, only the templates in the specified folder are returned. Name description Type String Description Description of the template.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name folderName folderUri lastModified name pageCount password Type String String String String number String Description The name of the folder where the template is located. The uri for accessing the folder. Last time the template was modified. Name of the template. Number of document pages in the template. Password, if the template is locked.

193

NOTE: This is only returned if the requestor is the creator of the template. shared String If true, the template is shared with the Everyone group in the account. If false, the template is only shared with the Administrator group. DocuSign Unique identifier for the template. The uri for accessing the template.

templateId uri

String String

The following example shows the response json body. Example Response Body
{ "envelopeTemplates":[{ "description":"String content", "folderName":"String content" "folderUri":"String content" "lastModified":"String content", "name":"String content", "pageCount":2147483647, "password":"String content", "shared":"String content", "templateId":"String content", "uri":"String content" }] }

Post Template
Saves a template definition using a multipart request. URL: /accounts/{accountId}/templates

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Formats: XML, JSON HTTP Method: POST Parameters: Name accessibility Reqd? No Type String Description

194

allowMarkup

No

String

An optional element that can only be used if Document Accessibility is enabled for the account. This sets the document reading zones for screen reader applications. Note: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here. If true, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this. If true, the recipient can redirect an envelope to a more appropriate recipient. When set to true, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order. If true, will queue the envelope for processing and EnvelopeStatus will have a value of Processing. Use SynchEnvelope to determine when the queued envelope has been processed. Additionally, RequestStatus calls will return Processing until completed. Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. If true, auto-navigation is enabled for the envelope. The auto-navigation method used is determined by the account setting.

allowReassign allowRecipientRecursion

No No

String String

asynchronous

No

String

authoritativeCopy

No

String

autoNavigation

No

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name brandId Reqd? No Type String Description

195

This sets the brand profile format used for the envelope. The value in the string is the brandId associated with the profile. Account branding must be enabled for the account to use this option. Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. The subject of the email that will be sent to all recipients. If true, the signer is allowed to print the document and sign it on paper. It true, the signer is required to have a signature or initial tab on the document or that the document has no signers in order to view it. Account must have Document Visibility enabled to use this. If true, Envelope ID Stamping is enabled. An optional complex element consisting of: url The endpoint where envelope updates are sent. This will accept XML unless useSoapInterface is set to true. loggingEnabled When set to true, logging is turned on for envelope events on the Web Console Connect page. requireAcknowledgment When set to true, the DocuSign Connect service checks that the message was received and retries on failures. useSoapInterface When set to true, this tells the Connect service that the users endpoint has implemented a SOAP interface. soapNameSpace This lists the namespace in the SOAP listener provided. includeCertificateWithSoap When set to true, this tells the Connect service to send the DocuSign signedby certificate as part of the outgoing SOAP xml. This appears in the XML as

emailBlurb

No

String

emailSubject enableWetSign enforceSignerVisibility

Yes No No

String String String

envelopeIdStamp eventNotification

No No

String Event Notification

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type

196 Description wsse:BinarySecurityToken. envelopeEvents The list of envelope-level events statuses that will trigger Connect to send updates to the url. It can be a two-part list with: o envelopeEventStatus The envelope status, this can be Sent, Delivered, Signed, Completed, Declined, or Voided. o includeDocuments When set to true, the documents in the envelope are included in the exported XML. If true, prevents senders from changing the emailBlurb and emailSubject for the envelope. Additionally, this prevents users from making changes to the emailBlurb and emailSubject when correcting envelopes However, if the messageLock node is set to True and the emailSubject is empty, senders and correctors are able to add a subject to the envelope. If true, prevents senders from changing, correcting, or deleting the recipient information for the envelope. Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. customFields are part of the json structure, but they are ignored when Posting. They are set in the console. Document Complex element contains the details on the documents in the envelope. See the Document parameter section for more information.

messageLock

No

String

recipientsLock

No

String

signingLocation

No

String

customFields

No

documents

Yes

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name recipients Reqd? Yes Type Recipient Description

197

Specifies the envelope recipients. It uses the same information as a standard envelope recipient, with the following exceptions: The email and name elements are not required. The roleName element is required. This can be a maximum of 100 characters. See the Recipient parameter sections for more information.

envelopeTemplateDefinition

Yes

Definition

A complex element with the following information: templateId: Unique identifier of the template. name: Name of the template. This can be a maximum of 100 characters. shared: If true, the template is shared with the Everyone group in the account. If false, the template is only shared with the Administrator group. password: Password, if the template is locked. description: Description of the template. This can be a maximum of 500 characters. pageCount: Number of document pages in the template. folderName: The name of the folder the template is located in. folderId: The ID for the folder. owner: The userName, email, userId, userType, and userStatus for the template owner. An optional complex element that specifies the notification options for the envelope. It consists of: useAccountDefaults When true, the account default notification settings are used for the envelope. reminders A complex element that specifies reminder settings for the envelope. It consists of: o reminderEnabled When true

notification

No

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type

198 Description a reminder message is sent to the recipient. o reminderDelay An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. o reminderFrequency An interger that sets the interval, in days, between reminder emails. expirations A complex element that specifies the expiration settings for the envelope. It consists of: o expireEnabled When true the envelope expires (is no longer available for signing) in the set number of days. o expireAfter An integer that sets the number of days the envelope is active. o expireWarn An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.

Example Request Body

POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/templates X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: multipart/form-data; boundary=AAA --AAA Content-Type: application/json Content-Disposition: form-data { "envelopeTemplateDefinition": { "templateId": "String content", "name": "String content", "shared": "String content", "password": "String content", "description": "String content", "lastModified": "String content", "pageCount": "String content", "folderName": "String content",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"folderId": "String content", "owner": { "userName": "String content", "email": "String content", "userId": "String content", "userType": "String content", "userStatus": "String content", } } "allowMarkup":"String content", "allowReassign":"String content", "allowRecipientRecursion":"String content", "asynchronous":"String content", "authoritativeCopy":""String content", "autoNavigation":"String content", "emailBlurb":"String content", "emailSubject":"String content", "enableWetSign":"String content", "enforceSignerVisibility":"String content", "signingLocation":"String content", "envelopeIdStamping":"String content", "eventNotification":{ "url":"String content", "loggingEnabled":"String content", "requireAcknowledgment":"String content", "useSoapInterface":"String content", "soapNameSpace" : "http://DocuSignConnectListener", "includeCertificateWithSoap" : "true", "envelopeEvents" : [{ "envelopeEventStatusCode" : "sent" }, { "envelopeEventStatusCode" : "completed", "includeDocuments" : "true" }] }], "customFields":{ "listCustomFields":[{ "name":"String content", "required":"String content", "show":"String content", "value":"String content", "listItems":["String content"] }], "textCustomFields":[{ "name":"String content", "required":"String content", "show":"String content", "value":"String content", }] }, "notification": { "useAccountDefaults": "sample string 1", "reminders": { "reminderEnabled": "sample string 1", "reminderDelay": "sample string 2", "reminderFrequency": "sample string 3" }, "expirations": { "expireEnabled": "sample string 1", "expireAfter": "sample string 2", "expireWarn": "sample string 3" } },

199

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"documents": [{ "documentId": "1", "name": "test1.pdf" }], "recipients": { "signers": [{ "accessCode": "", "addAccessCodeToEmail": false, "clientUserId": null, "customFields": null, "emailNotification": null, "idCheckConfigurationName": null, "idCheckInformationInput": null, "inheritEmailNotificationConfiguration": false, "note": "", "phoneAuthentication": null, "recipientAttachments": null, "recipientId": "1", "requireIdLookup": false, "roleName": "Signer 1", "routingOrder": 1, "socialAuthentications": null, "templateAccessCodeRequired": false, "templateLocked": false, "templateRequired": false, "email": "", "name": "", "autoNavigation": false, "defaultRecipient": false, "signatureInfo": null, "tabs": { "approveTabs": null, "checkboxTabs": null, "companyTabs": null, "dateSignedTabs": null, "dateTabs": null, "declineTabs": null, "emailTabs": null, "envelopeIdTabs": null, "fullNameTabs": null, "initialHereTabs": null, "listTabs": null, "noteTabs": null, "numberTabs": null, "radioGroupTabs": null, "signHereTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "157", "yPosition": "7", "name": "Sign Here", "optional": false, "scaleValue": 1, "tabLabel": "Signature 1"

200

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

}], "signerAttachmentTabs": null, "ssnTabs": null, "textTabs": null, "titleTabs": null, "zipTabs": null } }, { "accessCode": "", "addAccessCodeToEmail": false, "customFields": null, "emailNotification": null, "idCheckConfigurationName": null, "idCheckInformationInput": null, "inheritEmailNotificationConfiguration": false, "note": "", "phoneAuthentication": null, "recipientAttachments": null, "recipientCaptiveInfo": null, "recipientId": "2", "requireIdLookup": false, "roleName": "Signer 2", "routingOrder": 1, "socialAuthentications": null, "templateAccessCodeRequired": false, "templateLocked": false, "templateRequired": false, "email": "", "name": "", "autoNavigation": false, "defaultRecipient": false, "signatureInfo": null, "tabs": { "approveTabs": null, "checkboxTabs": null, "companyTabs": null, "dateSignedTabs": null, "dateTabs": null, "declineTabs": null, "emailTabs": null, "envelopeIdTabs": null, "fullNameTabs": null, "initialHereTabs": null, "listTabs": null, "noteTabs": null, "numberTabs": null, "radioGroupTabs": null, "signHereTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "2", "templateLocked": false, "templateRequired": false, "xPosition": "351", "yPosition": "12", "name": "Sign Here",

201

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"optional": false, "scaleValue": 1, "tabLabel": "Signature 2" }], "signerAttachmentTabs": null, "ssnTabs": null, "textTabs": null, "titleTabs": null, "zipTabs": null } }] }, } --AAA Content-Type: application/pdf Content-Disposition: file; filename="test1.pdf"; documentId=1 <PDF Bytes Rmeoved>

202

Response The response returns the template name, template ID and template uri. The following example shows the header followed by the response json body. Example Response Body
{ "name":"String content", "templateId":"String content", "uri":"String content" }

Get Template
This retrieves the definition of the specified template. URL: /accounts/{accountId}/templates/{templateId} Formats: XML, JSON HTTP Method: GET Parameters: The only required parameter is the template ID. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/templates/ {templateId} 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

203

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the template definition of the requested template. Refer to Post Template for information about the template parameters. The following example shows the response json body. Example Response Body
{ "envelopeTemplateDefinition": { "templateId": "String content", "name": "String content", "shared": "String content", "password": "String content", "description": "String content", "lastModified": "String content", "pageCount": "String content", "folderName": "String content", "folderId": "String content", "owner": { "userName": "String content", "email": "String content", "userId": "String content", "userType": "String content", "userStatus": "String content", } } "allowMarkup":"String content", "allowReassign":"String content", "allowRecipientRecursion":"String content", "asynchronous":"String content", "authoritativeCopy":""String content", "customFields":{ "listCustomFields":[{ "name":"String content", "required":"String content", "show":"String content", "value":"String content", "listItems":["String content"] }], "textCustomFields":[{ "name":"String content", "required":"String content", "show":"String content", "value":"String content" }] }, "documents":[{ "documentId":"String content", "fileExtension":"String content", "matchBoxes":[{ }], "name":"String content", "password":"String content", "uri":"String content"

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

}], "emailBlurb":"String content", "emailSubject":"String content", "enableWetSign":"String content", "enforceSignerVisibility":"String content", "notification":{ "expirations":{ "expireAfter":"String content", "expireEnabled":"String content", "expireWarn":"String content" }, "reminders":{ "reminderDelay":"String content", "reminderEnabled":"String content", "reminderFrequency":"String content" }, "useAccountDefaults":"String content" }, "recipients":{ }, "signingLocation":"String content", }

204

Get Custom Document Fields for a Template Document

This returns the custom document fields for an existing document in a template. URL: /accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/templates/ {templateId}/documents/{documentId}/fields X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Response

205

The response returns the custom document field name-value pairs for the requested document ID. The following example shows the response json body. Example Response Body
{ "documentFields": [ { "name": "sample string", "value": "sample string" }, { "name": "sample string", "value": "sample string" } ] }

Add Custom Document Fields to a Template Document

This adds custom document fields for an existing template document. URL: /accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields Formats: XML, JSON HTTP Method: POST Parameters: Name documentFields Reqd? Yes Type documentField Description The array of name-value custom data strings to be added to a document. Custom document field information is returned with template information and added to envelopes created with the template, but otherwise is not used by DocuSign. The array contains the elements: Name A string that can be a maximum of 50 characters. Value A string that can be a maximum of 200 characters.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Example Request Body

POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/templates/ {templateId}/documents/{documentId}/fields

206

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "documentFields": [ { "name": "sample string 1", "value": "sample string 2", }, { "name": "sample string 1", "value": "sample string 2", } ] }

Response The response returns the custom document field name-value pairs added to the document and any errors associated with the fields. The following example shows the response json body. Example Response Body
{ "documentFields": [ { "name": "sample string", "value": "sample string", "errorDetails": { "errorCode": "sample string", "message": "sample string" } }, { "name": "sample string", "value": "sample string", "errorDetails": { "errorCode": "sample string", "message": "sample string" } } ] }

Modify Custom Document Fields for a Template Document

This modifies existing custom document fields for an existing template document.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 URL: /accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields Formats: XML, JSON HTTP Method: PUT Parameters: Name documentFields Reqd? Yes Type documentField Description

207

The array of name-value custom data strings to be modified in a document. Custom document field information is returned with template information and added to envelopes created with the template, but otherwise is not used by DocuSign. The array contains the elements: Name A string that can be a maximum of 50 characters. Value A string that can be a maximum of 200 characters.

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/templates/ {templateId}/documents/{documentId}/fields X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "documentFields": [ { "name": "sample string 1", "value": "sample string 2", }, { "name": "sample string 1", "value": "sample string 2", } ] }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Response

208

The response returns the modified custom document field name-value pairs for the document and any errors associated with the fields. The following example shows the response json body. Example Response Body
{ "documentFields": [ { "name": "sample string", "value": "sample string", "errorDetails": { "errorCode": "sample string", "message": "sample string" } }, { "name": "sample string", "value": "sample string", "errorDetails": { "errorCode": "sample string", "message": "sample string" } } ] }

Delete Custom Document Fields from a Template Document

This deletes custom document fields for an existing template document. URL: /accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields Formats: XML, JSON HTTP Method: DELETE Parameters: Name Reqd? Type Description

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name documentFields Reqd? Yes Type documentField Description

209

The array of name-value custom data strings to be deleted from a document. Custom document field information is returned with template information and added to envelopes created with the template, but otherwise is not used by DocuSign. The array contains the elements: Name A string that can be a maximum of 50 characters. Value A string that can be a maximum of 200 characters.

Example Request Body

DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/templates/ {templateId}/documents/{documentId}/fields X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "documentFields": [ { "name": "sample string 1", "value": "sample string 2", }, { "name": "sample string 1", "value": "sample string 2", } ] }

Response The response returns success or failure and any error messages. The response also returns the list of custom document field name-value pairs that were removed from the document. The following example shows the response json body. Example Response Body
{ "documentFields": [ { "name": "sample string", "value": "sample string" }, { "name": "sample string", "value": "sample string" } ]

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

}

210

Share a Template with a Group

This shares a template with a group. URL: /accounts/{accountId}/templates/{templateId}/groups Formats: XML, JSON HTTP Method: PUT Parameters: Name groupId Reqd? Yes Type String Description The group ID number.

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/templates/ {templateId}/groups X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "groups":[{ "groupId":"String content", }] }

Response The response returns if the API execution is successful (200 OK) or failed. The response contains a group structure similar to the request. If an error occurred during the PUT operation for any of the groups, that group will contain an errorDetails node with an errorCode and message. The following example shows the response json body. Example Response Body
{ "groups":[{ "errorDetails":{ "errorCode":"String content",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"message":"String content" }, "groupId":"String content", "groupName":"String content", "groupType":"String content", "permissionProfileId":"String content" }] }

211

Remove Template Sharing for a Group

This removes template sharing for a group. URL: /accounts/{accountId}/templates/{templateId}/groups Formats: XML, JSON HTTP Method: DELETE Parameters: Name groupId Reqd? Yes Type String Description The group ID number.

Example Request Body

DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/templates/ {templateId}/groups X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "groups":[{ "groupId":"String content", }] }

Response The response returns if the API execution is successful (200 OK) or failed. The response contains a group structure similar to the request. If an error occurred during the DELETE operation for any of the groups, that group will contain an errorDetails node with an errorCode and message. The following example shows the response json body.
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Example Response Body

{ "groups":[{ "errorDetails":{ "errorCode":"String content", "message":"String content" }, "groupId":"String content", "groupName":"String content", "groupType":"String content", "permissionProfileId":"String content" }] }

212

Get List of Unsupported File Types

Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system. URL: /accounts/{accountId}/unsupported_file_types Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/unsupported_file_types X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns a list of the file extensions and mime types that are not supported. The following example shows the response json body. Example Response Body
{ "fileTypes":[ { 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"fileExtension":"String content", "mimeType":"String content" }, { "fileExtension":"String content", "mimeType":"String content" } ] }

213

Add User to Account

This adds new users to your account. URL: /accounts/{accountId}/users Formats: XML, JSON HTTP Method: POST Parameters: Name activationAccessCode email Reqd? No Yes Type String String Description The activation code the new user must enter when activating their account. The users email address for the associated account. This can be a maximum of 100 characters. Sets if the user is enabled for updates from DocuSign Connect. This is a true/false setting. The users first name. This can be a maximum of 50 characters. A complex element that has up to four Question/Answer pairs for forgotten password information. String String String A list of groupIds for groups to add the user to. The users last name. This can be a maximum of 50 characters. The users middle name This can be a maximum of 50 characters.

enableConnectForUser

No

String

firstName forgottenPasswordInfo

No No

String

groupList lastName middleName

No No No

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name password Reqd? No Type String

214 Description The users password for the associated account. This can be a maximum of 50 characters. Sets if another activation email is sent to the user if the fail a log on before activating their account. This is a true/false setting. The suffix for the users name. This can be a maximum of 50 characters. The users title. This can be a maximum of 10 characters. The full user name associated with the account. This can be a maximum of 100 characters. The name/value pair information for user settings. These determine the actions that a user can take in the account. The userSettings are listed and described below.

sendActivationOnInvalidLogin No

String

suffixName title userName

No No Yes

String String String

userSettings

No

userSettings: The userSettings determine the actions users can take in the account. Setting Name Value Authorization Required Admin Description When true, this provides the sender with the option to set the language used in the standard email format for a recipient when creating an envelope. When true, this user can send envelopes on behalf of other users through the API. When true, this user can send and manage envelopes for the entire account using the DocuSign API.

allowRecipientLanguageSelection Boolean

allowSendOnBehalfOf

Boolean

Admin

apiAccountWideAccess

Boolean

Admin

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Setting Name canEditSharedAddressBook Value String Authorization Required Admin Description

215

canManageAccount

Boolean

Admin & not setting for self

canManageTemplates

String

Admin & not setting for self

canSendAPIRequests

Boolean

Admin & Account:UsesAPI is set

canSendEnvelope

Boolean

Admin & not setting for self SysAdmin

enableDSPro

Boolean

enableSequentialSigningAPI

Boolean

SysAdmin

enableSequentialSigningUI

Boolean

SysAdmin

enableSignerAttachments

Boolean

Admin

This element sets the address book usage and management rights for the user. Enumeration values are: None, UseOnlyShared, UsePrivateAndShared, Share. When true, this user can manage account settings, manage user settings, add users, and remove users. This element sets the template usage and management rights for the user. Enumeration values are: None, Use, Create, Share. Only needed if Integrator Key is not used. When true, this user can send and manage envelopes using the DocuSign API. When true, this user can send envelopes though the DocuSign Console. When true, this user can send and manage envelopes from the DocuSign Desktop Client. When true, this user can define the routing order of recipients for envelopes sent using the DocuSign API. When true, this user can define the routing order of recipients while sending documents for signature. When true, this user can add requests for attachments from signers while sending documents.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Setting Name enableSignOnPaperOverride Value Boolean Authorization Required Admin Description

216

enableTransactionPoint

Boolean

SysAdmin

enableVaulting

Boolean

Admin

powerFormAdmin

Boolean

Admin

powerFormUser

Boolean

Admin

vaultingMode

String

Admin

When true, this user can override the account setting that determines if signers may sign their documents on paper as an option to signing electronically. When true, this user can select an envelope from their member console and upload the envelope documents to TransactionPoint. When true, this user can use electronic vaulting for documents. When true, this user can create, manage and download the PowerForms documents. When true, this user can view and download PowerForms documents. This element sets the electronic vaulting mode for the user. Enumeration values are: None, eStored and electronicOriginal.

Example Request Body

POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/users X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "newUsers":[{ "activationAccessCode":"String content", "email":"String content", "enableConnectForUser":"String content", "firstName":"String content", "forgottenPasswordInfo":{ "forgottenPasswordAnswer1":"String content", "forgottenPasswordAnswer2":"String content", "forgottenPasswordAnswer3":"String content",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"forgottenPasswordAnswer4":"String content", "forgottenPasswordQuestion1":"String content", "forgottenPasswordQuestion2":"String content", "forgottenPasswordQuestion3":"String content", "forgottenPasswordQuestion4":"String content" },

217

"groupList":{ "groupId":"String content", "groupId":"String content" },

"lastName":"String content", "middleName":"String content", "password":"String content", "sendActivationOnInvalidLogin":"String content", "suffixName":"String content", "title":"String content", "userName":"String content", "userSettings":[{ "name":"String content", "value":"String content" }] }] }

Response The response returns the new users information. The following example shows the response json body. Example Response Body
{ "newUsers":[{ "apiPassword":"String content", "email":"String content", "errorDetails":{ "errorCode":"String content", "message":"String content" }, "uri":"String content", "userId":"String content", "userName":"String content" }] }

Get User List

This returns a list of users for the specified account. URL: /accounts/{accountId}/users Optional query additions: additional_info={true/false} Formats: XML, JSON
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 HTTP Method: GET Parameters:

218

There are no required parameters, but the following optional query can be added to provide additional information in the response. Name additional_info Reqd? No Type Boolean Description When true, the full list of user information is returned for each user in the account.

Example Request Body

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/users X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the list of users for the specified account. If the additional_info query was added to the URL and set to true, the full user information is returned for each user. The following example shows the response json body. Example Response Body
{ "users":[{ "uri":"String content", "userId":"String content", "userName":"String content", "userStatus":"String content", "userType":"String content" }] }

Close a User
This closes one or more user records in the account. Users are never deleted from an account, but closing a user prevents them from using account functions. URL: /accounts/{accounted}/users Formats: XML, JSON

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 HTTP Method: DELETE

219

Parameters: Name userId userName Reqd? Yes No Type String String Description The user ID number for user being removed from the account. The user name for the user being removed from the account.

Example Request Body

DELETE https://{server}/restapi/{apiVersion}/accounts/{accounted}/users X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "users":[{ "userId":"String content", "userName":"String content" }] }

Response The response returns if the API execution is successful (200 OK) or failed. The response contains a user structure similar to the request and includes the user changes. If an error occurred during the DELETE operation for any of the users, that user will contain an errorDetails node with an errorCode and message. The following example shows the response json body. Example Response Body
{ "users":[{ "errorDetails":{ "errorCode":"String content", "message":"String content" }, "uri":"String content", "userId":"String content", "userName":"String content", "userStatus":"String content", "userType":"String content" }] }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

220

Get User Information

This retrieves the user information for specified user. URL: /accounts/{accountId}/users/{userId} Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId} X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the user information. The following example shows the response json body. Example Response Body
{ "activationAccessCode":"String content", "email":"String content", "enableConnectForUser":"String content", "firstName":"String content", "forgottenPasswordInfo":{ "forgottenPasswordAnswer1":"String content", "forgottenPasswordAnswer2":"String content", "forgottenPasswordAnswer3":"String content", "forgottenPasswordAnswer4":"String content", "forgottenPasswordQuestion1":"String content", "forgottenPasswordQuestion2":"String content", "forgottenPasswordQuestion3":"String content", "forgottenPasswordQuestion4":"String content" }, "groupList":[{ "errorDetails":{ "errorCode":"String content", "message":"String content" }, "groupId":"String content", 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"groupName":"String content", "groupType":"String content", "permissionProfileId":"String content" }], "homeAddress":{ "address1":"String content", "address2":"String content", "city":"String content", "country":"String content", "fax":"String content", "phone":"String content", "postalCode":"String content", "stateOrProvince":"String content" }, "lastName":"String content", "middleName":"String content", "sendActivationOnInvalidLogin":"String content", "suffixName":"String content", "title":"String content", "userName":"String content", "userSettings":[{ "errorDetails":{ "errorCode":"String content", "message":"String content" }, "name":"String content", "value":"String content" }], "workAddress":{ "address1":"String content", "address2":"String content", "city":"String content", "country":"String content", "fax":"String content", "phone":"String content", "postalCode":"String content", "stateOrProvince":"String content" } }

221

Get Custom User Settings

This retrieves a list of custom user settings for a single user. Custom settings are a flexible way to store and retrieve custom user information that can be used in your own system. Note: Custom user settings are not the same as user account settings. Getting Grouped Custom User Settings If the custom user settings you want to retrieve are grouped, you must include the following information in the header, after Content-Type, in the request: X-DocuSign-User-Settings-Key:group_name Where the group_name is your designated name for the group of customer user settings. If the extra header information is not included, only the custom user settings that were added without a group are retrieved.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 URL: /accounts/{accountId}/users/{userId}/custom_settings Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ custom_settings

222

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the list of the custom name/value pairs for the specified user that are not in a group. The following example shows the response json body. Example Response Body
{ "customSettings":[{ "name":"String content", "value":"String content", }, { "name":"String content", "value":"String content" }] }

Add or Modify Custom User Settings

This allows you to add or update custom user settings for a single user. Note: Custom user settings are not the same as user account settings. Custom settings are a flexible way to store and retrieve custom user information that can be used in your own system.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

223

Important: There is a limit on the size for all the custom user settings for a single user. All the custom user settings for a single user is limited to 4,000 characters, which includes the xml and json structure for the settings. Grouping Custom User Settings In addition to adding the custom user settings, you can group the settings when adding them. Grouping allows you to retrieve only those settings that are in a group, instead of retrieving all the user custom settings. To group custom user settings, add the following information in the header, after Content-Type: X-DocuSign-User-Settings-Key:group_name Where the group_name is your designated name for the group of customer user settings. Grouping is shown in the Example Request Body below. When getting or deleting grouped custom user settings, the extra header information must be included. Grouping custom user settings is not required and if the extra header information is not included, the custom user settings are added normally and can be retrieved or deleted without including the additional header. URL: /accounts/{accountId}/users/{userId}/custom_settings Formats: XML, JSON HTTP Method: PUT

Parameters: Name customSettings Reqd? Yes Type String Description The name/value pair information for the user custom setting.

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ custom_settings X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json X-DocuSign-User-Settings-Key:group_name 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

{ "customSettings":[{ "name":"String content", "value":"String content", }, { "name":"String content", "value":"String content" }] }

224

Response The response returns a success or failure message and a list of the added or updated user custom settings. The following example shows the response json body. Example Response Body
{ "customSettings":[{ "name":"String content", "value":"String content", }, { "name":"String content", "value":"String content" }] }

Delete Custom User Settings

This deletes the specified custom user settings for a single user. Deleting Grouped Custom User Settings If the custom user settings you want to delete are grouped, you must include the following information in the header, after Content-Type, in the request: X-DocuSign-User-Settings-Key:group_name Where the group_name is your designated name for the group of customer user settings. If the extra header information is not included, only the custom user settings that were added without a group are deleted. URL: /accounts/{accountId}/users/{userId}/custom_settings Formats: XML, JSON

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 HTTP Method: DELETE Parameters: Name customSettings Reqd? Yes Type String

225

Description The name/value pair information that should be deleted.

Example Request Body

DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ custom_settings X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "customSettings":[{ "name":"String content", "value":"String content", }, { "name":"String content", "value":"String content" }] }

Response The response returns a success or failure and the list of the custom name/value pairs that were deleted. The following example shows the response json body. Example Response Body
{ "customSettings":[{ "name":"String content", "value":"String content", }, { "name":"String content", "value":"String content" }] }

Get User Profile

This returns user profile information, the privacy settings and personal information (address, phone number, etc.).

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 URL: /accounts/{accountId}/users/{userId}/profile Note: The userId specified in the uri must match the authenticated users userId and the user must be a member of the account. Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ profile

226

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the user profile information from the users ID card. The User Profile contains the following information. Name Description address The users address information. A complex element consisting of the optional elements: address1, address2, city, country, fax, phone, postalCode, stateOrProvince. authenticationMethods companyName displayOrganizationInfo displayPersonalinfo displayProfile displayUsageHistory title usageHistory Shows the authentication methods used by the user. The users Company information. When true, the users company and title information are shown on the ID card. When true, the users Address and Phone number are shown on the ID card. When true, the users ID card can be viewed from signed documents and envelope history. When true, the users usage information is shown on the ID card. The users Title information. A complex element consisting of:

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 userDetails

227 lastSentDateTime the date and time the user last sent an envelope. lastSignedDateTime the date and time the user last signed an envelope. sentCount the number of envelopes the user has sent. signedCount the number of enevelopes the user has signed.

A complex element with the user name information consisting of: firstName The users first name. lastName The users last name. middleName The users middle name. suffixName The suffix for the users name. title The users title.

The following example shows the response json body. Example Response Body
{ "address":{ "address1":"String content", "address2":"String content", "city":"String content", "country":"String content", "fax":"String content", "phone":"String content", "postalCode":"String content", "stateOrProvince":"String content" }, "authenticationMethods":[{ "authenticationType":"String content", "lastProvider":"String content", "lastTimestamp":"String content", "totalCount":2147483647 }], "companyName":"String content", "displayOrganizationInfo":"String content", "displayPersonalInfo":"String content", "displayProfile":"String content", "displayUsageHistory":"String content", "title":"String content", "usageHistory":{ "lastSentDateTime":"String content", "lastSignedDateTime":"String content", "sentCount":2147483647, "signedCount":2147483647 } "userDetails":{ "firstName":"String content", "lastName":"String content", "middleName":"String content", "suffixName":"String content", "title":"String content", }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

}

228

Modify User Profile

This sets the users detail information, profile information, privacy settings and personal information in the user ID card. This can also be used to change a users name by changing the information in the user details (userDetails). When changing a users name, you can either change the information in the userName OR change the information in firstName, middleName, lastName, suffixName and title. Changes to firstName, middleName, lastName, suffixName and title take precedence over changes to the userName. URL: /accounts/{accountId}/users/{userId}/profile Note: The userId specified in the uri must match the authenticated users userId and the user must be a member of the account. Formats: XML, JSON HTTP Method: PUT Parameters: Name address Reqd? No Type address Description The users address information. A complex element consisting of the optional elements: address1, address2, city, country, fax, phone, postalCode, stateOrProvince.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name authenticationMethods Reqd? No Type autneticationMethod Description

229

These properties cannot be modified in the PUT. Shows the authentication methods used by the user. A complex element consisting of: authenticationMethodType (PhoneAuth, STAN, ISCheck, OFAC, AccessCode, AgeVerify, or SSOAuth) lastTimestamp the data and time the user last used the authentication method. lastProvider the last provider that authenticated the user. totalCount the number of times used. The users Company information. True/False setting. When true, the users company and title information are shown on the ID card. True/False setting. When true, the users Address and Phone number are shown on the ID card. True/False setting. When true, the users ID card can be viewed from signed documents and envelope history. True/False setting. When true, the users usage information is shown on the ID card. The users Title information. A complex element consisting of: lastSentDateTime the date and time the user last sent an envelope. lastSignedDateTime the date and time the user last signed an envelope. sentCount the number of envelopes the user has sent. signedCount the number of envelopes the user has signed.

companyName displayOrganizationInfo

No No

String String

displayPersonalinfo

No

String

displayProfile

No

String

displayUsageHistory

No

String

title usageHistory

No No

String usageHistory

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name userDetails Reqd? No Type userDetails Description

230

A complex element with the user name information consisting of: firstName The users first name. This can be a maximum of 50 characters. lastName The users last name. This can be a maximum of 50 characters. middleName The users middle name. This can be a maximum of 50 characters. suffixName The suffix for the users name. This can be a maximum of 50 characters. title The users title. This can be a maximum of 10 characters. username The users full name. This can be a maximum of 100 characters.

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ profile X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "address":{ "address1":"String content", "address2":"String content", "city":"String content", "country":"String content", "fax":"String content", "phone":"String content", "postalCode":"String content", "stateOrProvince":"String content" }, "authenticationMethods":[{ "authenticationType":"String content", "lastProvider":"String content", "lastTimestamp":"String content", "totalCount":2147483647 }], "companyName":"String content", "displayOrganizationInfo":"String content", "displayPersonalInfo":"String content", "displayProfile":"String content", "displayUsageHistory":"String content", "title":"String content",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"usageHistory":{ "lastSentDateTime":"String content", "lastSignedDateTime":"String content", "sentCount":2147483647, "signedCount":2147483647 } "userDetails":{ "firstName":"String content", "lastName":"String content", "middleName":"String content", "suffixName":"String content", "title":"String content", "userName":"String content" } }

231

Response The response returns success or failure.

Get User Profile Image

This returns the user profile picture. The image is returned in the same format as uploaded. URL: /accounts/{accountId}/users/{userId}/profile/image Note: The userId specified in the uri must match the authenticated users userId and the user must be a member of the account. Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ profile/image X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Response If successful, the response returns a 200 OK and the user profile image.

232

Modify User Profile Image

This uploads an image to the user profile. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K. For best viewing results, DocuSign recommends that the image is no more than 79 pixels wide and high. URL: /accounts/{accountId}/users/{userId}/profile/image Note: The userId specified in the uri must match the authenticated users userId and the user must be a member of the account. Formats: XML, JSON HTTP Method: PUT Parameters: The only item needed is the image. Example Request Body
PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ profile/image

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: image/x-ms-bmp <image removed>

Response The response returns a success (200 OK) or failure.

Delete User Profile Image

This removes the image from the user profile.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 URL: /accounts/{accountId}/users/{userId}/profile/image Note: The userId specified in the uri must match the authenticated users userId and the user must be a member of the account. Formats: XML, JSON HTTP Method: DELETE Parameters: No additional parameters are required. Example Request Body
DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ profile/image

233

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

Response The response returns a success (200 OK) or failure.

Get User Account Settings

This returns the account settings list for the specified user. URL: /accounts/{accountId}/users/{userId}/settings Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Example Request Body

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ settings

234

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

Response The response returns the account setting name/value information for the specified user. See the userSettings list for more information about the different user settings. The following example shows the response json body. Example Response Body
{ "userSettings":[{ "name":"String content", "value":"String content" }] }

Modify User Account Settings

This updates the account settings list for the specified user. URL: /accounts/{accountId}/users/{userId}/settings Formats: XML, JSON HTTP Method: PUT Parameters: Name userSettings Reqd? Type String Description The name/value pair information for user settings. These determine the features available for the user. See the userSettings list for more information about the different user settings.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ settings

235

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "userSettings":[{ "name":"String content", "value":"String content" }] }

Response The response returns success or failure.

Get a List of User Signature Definitions

This returns the signature definitions for the specified user. URL: /accounts/{accountId}/users/{userId}/signatures Note: The userId specified in the uri must match the authenticated users userId and the user must be a member of the account. Since the {signatureName} is a string name of a user that likely includes spaces, you might need to URL encode the signatureName before using the URL. For example: "Bob Smith" to "Bob%20Smith" Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ signatures

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

236

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

Response The response returns a list of signatures for the user. Example Response Body
{ "userSignatures":[{ "adoptedDateTime":"String content", "createdDateTime":"String content", "initialsImageUri":"String content", "signatureFont":"String content", "signatureImageUri":"String content", "signatureInitials":"String content", "signatureName":"String content", "signatureType":"String content" }] [{ "adoptedDateTime":"String content", "createdDateTime":"String content", "initialsImageUri":"String content", "signatureFont":"String content", "signatureImageUri":"String content", "signatureInitials":"String content", "signatureName":"String content", "signatureType":"String content" }] }

Setting User Signature and Initials Images when Creating a Signature

This allows user signature and/or initials images to be set when a signature is created. The rules and processes associated with this are:

If Content-Type is set to application/json, then default behavior for creating a default signature image, based on the name and a DocuSign font, is used. If Content-Type is set to multipart/form-data, then the request must contain a first part with the user signature information, followed by parts that contain the images. For each Image part, the Content-Disposition header has a filename value that is used to map to the signatureName and/or signatureInitials in the JSON to the image. For example: Content-Disposition: file; filename="Ron Test20121127083900" If no matching image (by filename value) is found then the image is not set. One, both or neither of the signature and initials images can be set with this call. The Content-Transfer-Encoding: base64 header, set in the header for the part containing the image, can be set to indicate that the images are formatted as base64 instead of as binary.

If successful, 200-OK is returned, and a JSON structure containing the signature information is provided, note that the signatureId can change with each API POST, PUT or

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

237

DELETE since the changes to the signature structure cause the current signature to be closed, and a new signature record to be created.
URL: /accounts/{accountId}/users/{userId}/signatures Note: The userId specified in the uri must match the authenticated users userId and the user must be a member of the account. Formats: XML, JSON HTTP Method: POST Parameters: Name signatureFont Reqd? No Type String Description The font type for the signature, if the signature is not drawn. The supported font types are: "7_DocuSign", "1_DocuSign", "6_DocuSign", "8_DocuSign", "3_DocuSign", "Mistral", "4_DocuSign", "2_DocuSign", "5_DocuSign", "Rage Italic" The initials associated with the signature. The signatures name in the system.

signatureInitials signatureName

No Yes

String String

Example Request Body The first example shows the default behavior and the second example shows a multipart request.
POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ signatures X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "userSignatures": [{ "signatureFont": "7_DocuSign", "signatureInitials": "R T20121127083847", "signatureName": "Ron Test20121127083847", }] }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

238

POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ signatures X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: multipart/form-data; boundary=AAA -AAA Content-Type: application/json Content-Disposition: form-data { "userSignatures":[{ "signatureFont":"7_DocuSign", "signatureInitials":"R T20121127083900", "signatureName":"Ron Test20121127083900" ]} } -AAA Content-Type: image/gif Content-Disposition: file;filename="Ron Test20121127083900" Content-Transer-Encoding: base64 <base64 image bytes omitted> -AAA Content-Type: image/gif Content-Disposition: file;filename="R T20121127083900" Content-Transer-Encoding: base64 <base64 image bytes omitted> -AAA

Response The response returns a success or failure and signature information. Example Response Body
{ "userSignatures":[{ "adoptedDateTime":"String content", "createdDateTime":"String content", "initials150ImageId":"String content", "initialsImageUri":"String content", "signature150ImageId":"String content", "signatureFont":"String content", "signatureId":"String content", "signatureImageUri":"String content", "signatureInitials":"String content", "signatureName":"String content", "signatureType":"String content" }] }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

239

Get User Signature Information

This returns the structure of a single signature with a known signature name. URL: /accounts/{accountId}/users/{userId}/signatures/{signatureIdOrName} Note: The userId specified in the uri must match the authenticated users userId and the user must be a member of the account. The {signatureIdOrName} accepts signature ID or signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that dont properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using the URL. For example: "Bob Smith" to "Bob%20Smith" Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ signatures/{signatureIdOrName} X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

Response The response returns information for the request user signature. The following example shows the response json body. Example Response Body
{ "adoptedDateTime":"String content", "createdDateTime":"String content", "initialsImageUri":"String content", "signatureFont":"String content", "signatureImageUri":"String content", "signatureInitials":"String content", "signatureName":"String content", "signatureType":"String content" }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

240

Modify a User Signature

This creates or modifies the signature font and initials for an existing signature. When creating a signature, you would use this resource to create the signature name and then put the signature and initials images into the signature. Note: This will also create a default signature for the user when one does not exist. URL: /accounts/{accountId}/users/{userId}/signatures/{signatureIdOrName} Optional query string: close_existing_signature={true or false} when true, this will close the current signature. Note: The userId specified in the uri must match the authenticated users userId and the user must be a member of the account. The {signatureIdOrName} accepts signature ID or signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that dont properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using the URL. For example: "Bob Smith" to "Bob%20Smith" Formats: XML, JSON HTTP Method: PUT Parameters: Name signatureFont Reqd? No Type String Description The font type for the signature, if the signature is not drawn. The supported font types are: "7_DocuSign", "1_DocuSign", "6_DocuSign", "8_DocuSign", "3_DocuSign", "Mistral", "4_DocuSign", "2_DocuSign", "5_DocuSign", "Rage Italic"

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name signatureId Reqd? No Type String Description

241

The signature ID associated with the signature name. The signatureId can be used in the URI in place of the signatureName, and the signatureName in the body will be used. This allows the use of special characters (such as &, <, >) in a signatureName. Note that with each update to signatures, the returned signautreId might change, so the caller will need to trigger off the signatureName to get the new signatureId. The initials associated with the signature. The user signature name.

signatureInitials signatureName

No No

String String

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ signatures/{signatureIdOrName} X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "signatureFont":"String content", "signatureId":"String content", "signatureInitials":"String content", "signatureName":"String content" }

Response The response returns a success or failure and signature name information. Example Response Body
{ "adoptedDateTime":"String content", "createdDateTime":"String content", "initials150ImageId":"String content", "initialsImageUri":"String content", "signature150ImageId":"String content", "signatureFont":"String content", "signatureId":"String content", "signatureImageUri":"String content", "signatureInitials":"String content", "signatureName":"String content", "signatureType":"String content" }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

242

Close a User Signature

This removes the signature information for the user. URL: /accounts/{accountId}/users/{userId}/signatures/{signatureIdOrName} Note: The userId specified in the uri must match the authenticated users userId and the user must be a member of the account. The {signatureIdOrName} accepts signature ID or signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that dont properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using the URL. For example: "Bob Smith" to "Bob%20Smith" Formats: XML, JSON HTTP Method: DELETE Parameters: No additional parameters are required. Example Request Body
DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ signatures/{signatureIdOrName} X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

Response The response returns a success or failure.

Get a User Initials Image

This returns a specific user initials image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. URL: /accounts/{accountId}/users/{userId}/signatures/{signatureIdOrName}/initials_image

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Note: The userId specified in the uri must match the authenticated users userId and the user must be a member of the account.

243

The {signatureIdOrName} accepts signature ID or signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that dont properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using the URL. For example: "Bob Smith" to "Bob%20Smith" Optional request string: include_chrome={true} to include chrome, the default value is false. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ signatures/{signatureIdOrName}/initials_image X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

Response The response returns the initials image file.

Set a User Initials Image

This updates the user initials image. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K. URL: /accounts/{accountId}/users/{userId}/signatures/{signatureIdOrName}/initials_image Note: The userId specified in the uri must match the authenticated users userId and the user must be a member of the account. The {signatureIdOrName} accepts signature ID or signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that dont properly URL

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

244

encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using the URL. For example: "Bob Smith" to "Bob%20Smith" Formats: XML, JSON HTTP Method: PUT Parameters: No additional parameters are required. Example Request Body
PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ signatures/{signatureIdOrName}/initials_image X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Content-Type: image/gif <image removed>

Response The response returns a success or failure and information about the user initials and signature. The following example shows the response json body.
{ "adoptedDateTime":"String content", "createdDateTime":"String content", "initials150ImageId":"String content", "initialsImageUri":"String content", "signature150ImageId":"String content", "signatureFont":"String content", "signatureId":"String content", "signatureImageUri":"String content", "signatureInitials":"String content", "signatureName":"String content", "signatureType":"String content" }

Delete a User Initials Image

This deletes a specific user initials image. Note: The user signature image associated with this user is not deleted.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 URL: /accounts/{accountId}/users/{userId}/signatures/{signatureIdOrName}/initials_image Note: The userId specified in the uri must match the authenticated users userId and the user must be a member of the account.

245

The {signatureIdOrName} accepts signature ID or signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that dont properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using the URL. For example: "Bob Smith" to "Bob%20Smith" Formats: XML, JSON HTTP Method: DELETE Parameters: No additional parameters are required. Example Request Body
DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ signatures/{signatureIdOrName}/initials_image X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

Response The response returns a success or failure and information about the user initials and signature. The following example shows the response json body.
{ "adoptedDateTime":"String content", "createdDateTime":"String content", "initials150ImageId":"String content", "initialsImageUri":"String content", "signature150ImageId":"String content", "signatureFont":"String content", "signatureId":"String content", "signatureImageUri":"String content", "signatureInitials":"String content", "signatureName":"String content", "signatureType":"String content" }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

246

Get a User Signature Image

This returns a specific user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. URL: /accounts/{accountId}/users/{userId}/signatures/{signatureIdOrName}/signature_image Note: The userId specified in the uri must match the authenticated users userId and the user must be a member of the account. The {signatureIdOrName} accepts signature ID or signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that dont properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using the URL. For example: "Bob Smith" to "Bob%20Smith" Optional request string: include_chrome={true} to include chrome, the default value is false. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ signatures/{signatureIdOrName}/signature_image X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

Response The response returns the signature image as a GIF file.

Set a User Signature Image

This updates the user signature image. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 URL: /accounts/{accountId}/users/{userId}/signatures/{signatureIdOrName}/signature_image Note: The userId specified in the uri must match the authenticated users userId and the user must be a member of the account.

247

The {signatureIdOrName} accepts signature ID or signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that dont properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using the URL. For example: "Bob Smith" to "Bob%20Smith" Formats: XML, JSON HTTP Method: PUT Parameters: No additional parameters are required. Example Request Body
PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ signatures/{signatureIdOrName}/initials_image

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Content-Type: image/gif

Response The response returns a success or failure and information about the user signature and initials. The following example shows the response json body.
{ "adoptedDateTime":"String content", "createdDateTime":"String content", "initials150ImageId":"String content", "initialsImageUri":"String content", "signature150ImageId":"String content", "signatureFont":"String content", "signatureId":"String content", "signatureImageUri":"String content", "signatureInitials":"String content", "signatureName":"String content", "signatureType":"String content" }

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

248

Delete a User Signature Image

This deletes a specific user signature image. Note: The user initials image associated with this user is not deleted by this. URL: /accounts/{accountId}/users/{userId}/signatures/{signatureIdOrName}/signature_image Note: The userId specified in the uri must match the authenticated users userId and the user must be a member of the account. The {signatureIdOrName} accepts signature ID or signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that dont properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using the URL. For example: "Bob Smith" to "Bob%20Smith" Formats: XML, JSON HTTP Method: DELETE Parameters: No additional parameters are required. Example Request Body
DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ signatures/{signatureIdOrName}/signature_image X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

Response The response returns a success or failure and information about the user signature and initials. The following example shows the response json body.
{ "adoptedDateTime":"String content", "createdDateTime":"String content", "initials150ImageId":"String content", "initialsImageUri":"String content", "signature150ImageId":"String content", "signatureFont":"String content", "signatureId":"String content", "signatureImageUri":"String content", "signatureInitials":"String content", "signatureName":"String content", "signatureType":"String content"

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

}

249

Add a User Social Account

This adds a new social account to a users account. URL: /accounts/{accountId}/users/{userId}/social Formats: XML, JSON HTTP Method: PUT Parameters: Name provider email userName Reqd? Yes Yes Yes Type String String String Description The name of the social account provider (Google, Facebook, Yahoo, etc.). The users email address for the social account. The full user name in the social account.

Example Request Body

PUT https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ social X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "provider":"String content", "email":"String content", "userName":"String content" }

Response The response returns if the API execution is successful (200 OK) or failed.

Get User Social Accounts

This returns a list of social accounts linked to a users account.
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 URL: /accounts/{accountId}/users/{userId}/social Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ social

250

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the list of social account information for the user and the userId for the user. The following example shows the response json body. Example Response Body
{ "socialAccountInformation":[{ "email":"String content", "provider":"String content", "socialId":"String content", "userName":"String content" }, { "email":"String content", "provider":"String content", "socialId":"String content", "userName":"String content" }], "userId":"String content" }

Remove a User Social Account

This removes a social account from a users account. URL: /accounts/{accountId}/users/{userId}/social
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Formats: XML, JSON HTTP Method: DELETE Parameters: Name provider email userName Reqd? Yes Yes Yes Type String String String Description The name of the social account provider (Google, Facebook, Yahoo, etc.).

251

The users email address for the social account. The full user name in the social account.

Example Request Body

DELETE https://{server}/restapi/{apiVersion}/accounts/{accountId}/users/{userId}/ social X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json { "provider":"String content", "email":"String content", "userName":"String content" }

Response The response returns if the API execution is successful (200 OK) or failed.

Post Authentication View

This provides a URL to start the authentication view of the DocuSign UI. URL: /accounts/{accountId}/views/console Formats: XML, JSON HTTP Method: POST
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Parameters: No parameters are required, but an optional envelopeId can be included in the request. Example Request Body
POST https://{server}/restapi/{apiVersion}/accounts/{accountId}/views/console

252

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials> Accept: application/json Content-Type: application/json

Response The response returns the authentication view url. The following example shows the header followed by the response json body.
{ "url":"String content" }

Get Account Provisioning Information

This returns the account provisioning information. URL: /accounts/provisioning Formats: XML, JSON HTTP Method: GET Parameters: No parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/accounts/provisioning X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

Response The response returns the account provisioning information.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 The following example shows the response json body.

253

Example Response Body

{ "defaultConnectionId":"String content", "defaultPlanId":"String content", "distributorCode":"String content", "distributorPassword":"String content", "passwordRuleText":"String content", "planPromotionText":"String content", "purchaseOrderOrPromAllowed":"String content" }

Get List of Billing Plans

This returns the billing plans associated with a distributor. URL: /billing_plans Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/billing_plans

Response The response returns the billing plan information. The following example shows the response json body. Example Response Body
{ "billingPlans":[{ "currencyPlanPrices":[{ "currencyCode":"String content", "currencySymbol":"String content", "perSeatPrice":"String content", "supportIncidentFee":"String content", "supportPlanFee":"String content" }], 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"enableSupport":"String content", "includedSeats":"String content", "otherDiscountPercent":"String content", "paymentCycle":"String content", "paymentMethod":"String content", "perSeatPrice":"String content", "planFeatureSets":[{ "currencyFeatureSetPrices":[{ "currencyCode":"String content", "currencySymbol":"String content", "envelopeFee":"String content", "fixedFee":"String content", "seatFee":"String content" }], "envelopeFee":"String content", "featureSetId":"String content", "fixedFee":"String content", "isActive":"String content", "isEnabled":"String content", "name":"String content", "seatFee":"String content" }], "planId":"String content", "planName":"String content", "seatDiscounts":[{ "beginSeatCount":"String content", "discountPercent":"String content", "endSeatCount":"String content" }], "supportIncidentFee":"String content", "supportPlanFee":"String content" }] }

254

Get Billing Plan Details

This returns the billing plan details for the specified billing plan ID. URL: /billing_plans/{planId} Formats: XML, JSON HTTP Method: GET Parameters: No additional parameters are required. Example Request Body
GET https://{server}/restapi/{apiVersion}/billing_plans/{planId}

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

255

X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>

Response The response returns the Billing plan and Successor plan details. The plan details are described below. Name currencyPlanPrices Type Description A complex type that contains the alternate currency values for perSeatPrice, supportIncidentFee, supportPlanFee that are configured for this plan. It also includes the alternate currencyCode and currenceySymbol. Boolean Integer Decimal String If true the plan has support enabled. The number of seats included in the plan. Any other percentage discount for the plan. The payment cycle associated with the plan. The possible values are: Monthly or Annually. The payment method used with the plan. The possible values are: CreditCard, PurchaseOrder, Premium, or Freemium. The per seat price for the plan. A complex type that sets the feature sets for the account. It contains the following information (all string content): currencyFeatureSetPrices - This contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, seatFee that are configured for this plan feature set. envelopeFee - An incremental envelope cost for plans with envelope overages (when isEnabled=true). featureSetId - A unique ID for the feature set. fixedFee - A one-time fee associated with the plan (when isEnabled=true). isActive - Determines if the feature set is actively set as part of the plan. isEnabled - Determines if the feature

enableSupport includedSeats otherDiscountPercent paymentCycle

paymentMethod

String

perSeatPrice planFeatureSets

Decimal

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Type

256 Description set is actively enabled as part of the plan. name - The name of the feature set. seatFee - An incremental seat cost for seat-based plans (when isEnabled=true). The plan ID for the account. It uniquely identifies a plan and is used to set plans in other functions. The name of the plan. A complex type that return any seat discount information. It contains the information: BeginSeatCount, EndSeatCount and SeatDiscountPercent. The support incident fee charged for each support incident. The support plan fee charged for this plan.

planId

String

planName seatDiscounts

String SeatDiscount

supportIncidentFee supportPlanFee

Decimal Decimal

The following example shows the response json body. Example Response Body
{ "billingPlan":{

"currencyPlanPrices":[{ "currencyCode":"String content", "currencySymbol":"String content", "perSeatPrice":"String content", "supportIncidentFee":"String content", "supportPlanFee":"String content" }],
"enableSupport":"String content", "includedSeats":"String content", "otherDiscountPercent":"String content", "paymentCycle":"String content", "paymentMethod":"String content", "perSeatPrice":"String content", "planFeatureSets":[{ "currencyFeatureSetPrices":[{ "currencyCode":"String content", "currencySymbol":"String content", "envelopeFee":"String content", "fixedFee":"String content", "seatFee":"String content" }], "envelopeFee":"String content", "featureSetId":"String content", "fixedFee":"String content", "isActive":"String content", "isEnabled":"String content", "name":"String content", "seatFee":"String content"

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

}], "planId":"String content", "planName":"String content", "seatDiscounts":[{ "beginSeatCount":"String content", "discountPercent":"String content", "endSeatCount":"String content" }], "supportIncidentFee":"String content", "supportPlanFee":"String content" }, "successorPlans":[{ "currencyPlanPrices":[{ "currencyCode":"String content", "currencySymbol":"String content", "perSeatPrice":"String content", "supportIncidentFee":"String content", "supportPlanFee":"String content" }], "enableSupport":"String content", "includedSeats":"String content", "otherDiscountPercent":"String content", "paymentCycle":"String content", "paymentMethod":"String content", "perSeatPrice":"String content", "planFeatureSets":[{ "currencyFeatureSetPrices":[{ "currencyCode":"String content", "currencySymbol":"String content", "envelopeFee":"String content", "fixedFee":"String content", "seatFee":"String content" }], "envelopeFee":"String content", "featureSetId":"String content", "fixedFee":"String content", "isActive":"String content", "isEnabled":"String content", "name":"String content", "seatFee":"String content" }], "planId":"String content", "planName":"String content", "seatDiscounts":[{ "beginSeatCount":"String content", "discountPercent":"String content", "endSeatCount":"String content" }], "supportIncidentFee":"String content", "supportPlanFee":"String content" }] }

257

Revoke an Authorization Token

This revokes an OAuth2 authorization server token. After this is done, a caller must re-authenticate to restore access. URL: /oauth2/revoke
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Formats: XML, JSON HTTP Method: POST Parameters: The call must have token_type and access_token for the server token to be revoked in the Authorization. Example Request Body
POST https://{server}/restapi/{apiVersion}/oauth2/revoke Authorization:<token_type><access_token> Accept: application/json Content-Type: application/json

258

Response The response returns if the API execution is successful (200 OK) or failed.

Create an Authorization Token

This creates an OAuth2 authorization server token endpoint. URL: /oauth2/token Formats: XML, JSON HTTP Method: POST Parameters: The call uses a request with the Example Request Body
POST https://{server}/restapi/{apiVersion}/oauth2/token Accept: application/json Content-Type: application/x-www-form-urlencoded grant_type=password&client_id={integrator_key}&username={name}&password={password}&scope= api

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Response The response returns if the API execution is successful (200 OK) or failed. If successful, the response will contain the server token information.

259

Name access_token scope token_type

Description Access token information. This should always be api This should always be bearer

The following example shows the response json body. Example Response Body
{ "access_token":"String content", "scope":"String content", "token_type":"String content" }

Recipient Types and Parameters

This section has the parameter information for the different recipient types. There are seven possible recipient types: Agents, Carbon Copies, Certified Deliveries, Editors, In Person Signers, Intermediaries, and Signers. Recipient types share some common parameters, but the exact parameters associated with a recipient depend on the recipient type. Refer to the specific recipient type below for more information. Agents In Person Signers Carbon Copies Intermediaries Certified Deliveries Signers Editors

Agents Recipient Type This recipient can add name and email information for recipients that appear after the recipient in routing order. This recipient type can only be used if enabled for your account. An example Agents json layout is shown below:
"agents": [{ "email": "email.name@company.com", "name": "recipient name", "accessCode": "", "addAccessCodeToEmail": false, "clientUserId": null, "customFields": { "sample string 1", "sample string 2" }, "emailNotification": { "emailBody":" ", "emailSubject":" ", "supportedLanguage":" "

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

}, "excludedDocuments": ["2", "4"] "idCheckConfigurationName": null, "idCheckInformationInput": { "addressInformationInput": { "addressInformation": { "street1": "sample string 1", "street2": "sample string 2", "city": "sample string 3", "state": "sample string 4", "zip": "sample string 5", "zipPlus4": "sample string 6" }, "displayLevelCode": "sample string 1", "receiveInResponse": "sample string 2" }, "dobInformationInput": { "dateOfBirth": "sample string 1", "displayLevelCode": "sample string 2", "receiveInResponse": "sample string 3" }, "ssn4InformationInput": { "ssn4": "sample string 1", "displayLevelCode": "sample string 2", "receiveInResponse": "sample string 3" }, "ssn9InformationInput": { "ssn9": "sample string 1", "displayLevelCode": "sample string 2" } }, "inheritEmailNotificationConfiguration": false, "note": "", "phoneAuthentication": null, "recipientAttachment": null, "recipientId": "1", "requireIdLookup": false, "roleName": "", "routingOrder": 1, "samlAuthentication": { "samlAssertionAttributes": [ { "name": "string", "value": "string" }, { "name": "string", "value": "string" } ] }, "smsAuthentication": { "senderProvidedNumbers":[ "sample string 1", "sample string 2" ] }, "socialAuthentications": null, "templateAccessCodeRequired": false, "templateLocked": false, "templateRequired": false, "canEditRecipientEmails": false, "canEditRecipientNames": false }],

260

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

261

The Agents recipient type parameters are: Name email Reqd ? Yes Type String Description Email of the recipient. Notification will be sent to this email id. This can be a maximum of 100 characters. The full legal name of the recipient. This can be a maximum of 100 characaters. This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. This optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. An optional complex type that has information for setting the language for the recipients email information. It is composed of three elements:

name

Yes

String

accessCode

No

String

addAccessCodeToEmail

No

Boolean

clientUserId

No

String

customFields

No

customField

emailNotification

No

emailNotification

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

262

emailBody: a string with the email message sent to the recipient. This can be a maximum of 2000 characters. emailSubject: a string with the subject of the email sent to the recipient. This can be a maximum of 100 characters. supportedLanguage: the simple type enumeration the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh-CN), Chinese Traditional (zhTW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en-GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr-CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (ptBR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es-MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi).

IMPORTANT: If this is
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

263

enabled for one recipient, it overrides the Envelope Subject and EmailBlurb. Also, you must enable emailNotification for all recipients. excludeDocuments No String Specifies the documents that are not visibile to this recipient. Document Visibility must be enabled for the account to use this. Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient). This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ID Check $ and SMS Auth $. To use ID check in an envelope, the iDCheckConfigurationName should be ID Check $. If you wanted to use SMS, it would be SMS Auth $ and you would need to add you would need to add phone number information to the smsAuthentication node. This complex element contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address

idCheckConfigurationName

No

String

idCheckInformationInput

No

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

264

information and consists of: addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum number of characters in each element are: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: dateOfBirth: Specifies the recipients date, month and year of birth. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

265

information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipients SSN information and consists of: ssn4: Specifies the last four digits of the recipients SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipients SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: ssn9: Specifies the recipients SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name inheritEmailNotificationConfigurati on Reqd ? No Type Boolean Description

266

Optional element. If true and the recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. A note that will be unique to this recipient. This note will be sent to the recipient via the signing email. This note will display in the signing UI near the upper left corner of the document on the signing screen. This can be a maximum of 1000 characters. Optional element. Contains the elements: RecipMayProvideNumbers Boolean (if true then recipient can use whatever phone number they want) SenderProvideNumbers ArrayOfString (a list of phone numbers the recipient may use) RecordVoicePrint Reserved ValidateRecipProvideNumber Reserved It would be possible to send attachments with recipients. This complex element contains data in base64Binary. It also contains label and type for the attachment. Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

note

No

String

phoneAuthentication

No

RecipientPhone Authentication

recipientAttachment

No

Attachment

recipientId

No

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name requireIdLookup Reqd ? No Type Boolean Description

267

If set true then the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity Optional element. This is the role name associated with the recipient. * - This is required when working with template recipients.

roleName

No*

String

routingOrder

Yes

String

This specifies the routing order of the recipient in the envelope Optional element, account must be set up to use SSO to use this. Contains the name/value pair information for the SAML assertion attributes: name The name of the SAML assertion attribute. value The value associated with the named SAML assertion attribute. Optional element. Contains the element: senderProvideNumbers Array with a list of phone numbers the recipient may use for SMS text authentication. Lists the social ID type that can be used for recipient authentication. Optional element. Used only when working with template recipients. If true and TemplateLocked = true, the sender must enter an access code.

samlAuthentication

No

samlAssertionAttributes

smsAuthentication

No

senderProvidedNumber s

socialAuthentications

No

Boolean

templateAccessCodeRequired

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name templateLocked Reqd ? No Type Boolean Description

268

Optional element. Used only when working with template recipients. If true, the sender cannot change any attributes of the recipient. Optional element. Used only when working with template recipients. If true, the sender may not remove the recipient. Optional element only used with recipient types Agents and Editors. If true, the Agent or Editor Recipient associated with this Recipient can change the Recipients pre-populated Email address. This element is only active if enabled for the account. Optional element only used with recipient types Agents and Editors. If true, the Agent or Editor Recipient associated with this recipient can change the recipients pre-populated name (UserName). This element is only active if enabled for the account.

templateRequired

No

Boolean

canEditRecipientEmail

No

Boolean

canEditRecipientName

No

Boolean

Carbon Copies Recipient Type Use this action if the recipient should get a copy of the envelope, but the recipient does not need to sign, initial, date or add information to any of the documents. This type of recipient can be placed in any order in the recipient list. The recipient receives a copy of the envelope when the envelope reaches the recipients order in the process flow and when the envelope is completed. An example Carbon Copies json layout is shown below:
"carbonCopies": [{ "email": "email.name@company.com", "name": "recipient name", "accessCode": "", "addAccessCodeToEmail": false, "clientUserId": null, "customFields": { "sample string 1", "sample string 2" },

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"emailNotification": { "emailBody":" ", "emailSubject":" ", "supportedLanguage":" " }, "excludedDocuments": ["2", "4"] "idCheckConfigurationName": null, "idCheckInformationInput": { "addressInformationInput": { "addressInformation": { "street1": "sample string 1", "street2": "sample string 2", "city": "sample string 3", "state": "sample string 4", "zip": "sample string 5", "zipPlus4": "sample string 6" }, "displayLevelCode": "sample string 1", "receiveInResponse": "sample string 2" }, "dobInformationInput": { "dateOfBirth": "sample string 1", "displayLevelCode": "sample string 2", "receiveInResponse": "sample string 3" }, "ssn4InformationInput": { "ssn4": "sample string 1", "displayLevelCode": "sample string 2", "receiveInResponse": "sample string 3" }, "ssn9InformationInput": { "ssn9": "sample string 1", "displayLevelCode": "sample string 2" } }, "inheritEmailNotificationConfiguration": false, "note": "", "phoneAuthentication": null, "recipientAttachment": null, "recipientId": "1", "requireIdLookup": false, "roleName": "", "routingOrder": 3, "samlAuthentication": { "samlAssertionAttributes": [ { "name": "string", "value": "string" }, { "name": "string", "value": "string" } ] }, "smsAuthentication": { "senderProvidedNumbers":[ "sample string 1", "sample string 2" ] }, "socialAuthentications": null, "templateAccessCodeRequired": false, "templateLocked": false,

269

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"templateRequired": false, }],

270

The Carbon Copies recipient type parameters are: Name email Reqd ? Yes Type String Description Email of the recipient. Notification will be sent to this email id. This can be a maximum of 100 characters. The full legal name of the recipient. This can be a maximum of 100 characaters. This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. This optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. An optional complex type that has information for setting the language for the recipients email information.

name

Yes

String

accessCode

No

String

addAccessCodeToEmail

No

Boolean

clientUserId

No

String

customFields

No

customField

emailNotification

No

emailNotification

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

271

It is composed of three elements: emailBody: a string with the email message sent to the recipient. This can be a maximum of 2000 characters. emailSubject: a string with the subject of the email sent to the recipient. This can be a maximum of 100 characters. supportedLanguage: the simple type enumeration the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh-CN), Chinese Traditional (zhTW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en-GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr-CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (ptBR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es-MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

272

(uk) and Vietnamese (vi). IMPORTANT: If this is enabled for one recipient, it overrides the Envelope Subject and EmailBlurb. Also, you must enable emailNotification for all recipients. excludeDocuments No String Specifies the documents that are not visibile to this recipient. Document Visibility must be enabled for the account to use this. Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient). This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ID Check $ and SMS Auth $. To use ID check in an envelope, the iDCheckConfigurationName should be ID Check $. If you wanted to use SMS, it would be SMS Auth $ and you would need to add you would need to add phone number information to the smsAuthentication node. This complex element contains input information related to a recipient ID check. It can include the following information.

idCheckConfigurationName

No

String

idCheckInformationInput

No

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

273

addressInformationInput: Used to set recipient address information and consists of: addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum number of characters in each element are: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: dateOfBirth: Specifies the recipients date, month and year of birth. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

274

receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn4InformationInput: Used to set the last four digits of the recipients SSN information and consists of: ssn4: Specifies the last four digits of the recipients SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipients SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: ssn9: Specifies the recipients SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name inheritEmailNotificationConfigurati on Reqd ? No Type Boolean Description

275

Optional element. If true and the recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. A note that will be unique to this recipient. This note will be sent to the recipient via the signing email. This note will display in the signing UI near the upper left corner of the document on the signing screen. This can be a maximum of 1000 characters. Optional element. Contains the elements: RecipMayProvideNumbers Boolean (if true then recipient can use whatever phone number they want) SenderProvideNumbers ArrayOfString (a list of phone numbers the recipient may use) RecordVoicePrint Reserved ValidateRecipProvideNumber Reserved It would be possible to send attachments with recipients. This complex element contains data in base64Binary. It also contains label and type for the attachment. Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

note

No

String

phoneAuthentication

No

RecipientPhone Authentication

recipientAttachment

No

Attachment

recipientId

Yes

string

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name requireIdLookup Reqd ? No Type Boolean Description

276

If set true then the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity Optional element. This is the role name associated with the recipient. * - This is required when working with template recipients.

roleName

No*

String

routingOrder

Yes

String

This specifies the routing order of the recipient in the envelope Optional element, account must be set up to use SSO to use this. Contains the name/value pair information for the SAML assertion attributes: name The name of the SAML assertion attribute. value The value associated with the named SAML assertion attribute. Optional element. Contains the element: senderProvideNumbers Array with a list of phone numbers the recipient may use for SMS text authentication. Lists the social ID type that can be used for recipient authentication. Optional element. Used only when working with template recipients. If true and TemplateLocked = true, the sender must enter an access code.

samlAuthentication

No

samlAssertionAttributes

smsAuthentication

No

senderProvidedNumber s

socialAuthentications

No

Boolean

templateAccessCodeRequired

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name templateLocked Reqd ? No Type Boolean Description

277

Optional element. Used only when working with template recipients. If true, the sender cannot change any attributes of the recipient. Optional element. Used only when working with template recipients. If true, the sender may not remove the recipient.

templateRequired

No

Boolean

Certified Deliveries Recipient Type Use this action if the recipient must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date or add information to any of the documents. This recipient type can only be used if enabled for your account. An example Certified Deliveries json layout is shown below:
"certifiedDeliveries": [{ "email": "email.name@company.com", "name": "recipient name", "accessCode": "", "addAccessCodeToEmail": false, "clientUserId": null, "customFields": { "sample string 1", "sample string 2" }, "emailNotification": { "emailBody":" ", "emailSubject":" ", "supportedLanguage":" " }, "excludedDocuments": ["2", "4"] "idCheckConfigurationName": null, "idCheckInformationInput": { "addressInformationInput": { "addressInformation": { "street1": "sample string 1", "street2": "sample string 2", "city": "sample string 3", "state": "sample string 4", "zip": "sample string 5", "zipPlus4": "sample string 6" }, "displayLevelCode": "sample string 1", "receiveInResponse": "sample string 2" }, "dobInformationInput": { "dateOfBirth": "sample string 1", "displayLevelCode": "sample string 2", "receiveInResponse": "sample string 3" }, "ssn4InformationInput": {

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"ssn4": "sample string 1", "displayLevelCode": "sample string 2", "receiveInResponse": "sample string 3" }, "ssn9InformationInput": { "ssn9": "sample string 1", "displayLevelCode": "sample string 2" } }, "inheritEmailNotificationConfiguration": false, "note": "", "phoneAuthentication": null, "recipientAttachment": null, "recipientId": "1", "requireIdLookup": false, "roleName": "", "routingOrder": 3, "samlAuthentication": { "samlAssertionAttributes": [ { "name": "string", "value": "string" }, { "name": "string", "value": "string" } ] }, "smsAuthentication": { "senderProvidedNumbers":[ "sample string 1", "sample string 2" ] }, "socialAuthentications": null, "templateAccessCodeRequired": false, "templateLocked": false, "templateRequired": false, }],

278

The Certified Deliveries recipient type parameters are: Name email Reqd ? Yes Type String Description Email of the recipient. Notification will be sent to this email id. This can be a maximum of 100 characters. The full legal name of the recipient. This can be a maxium of 100 characaters.

name

Yes

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name accessCode Reqd ? No Type String Description

279

This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. This optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. An optional complex type that has information for setting the language for the recipients email information. It is composed of three elements: emailBody: a string with the email message sent to the recipient. This can be a maximum of 2000 characters. emailSubject: a string with the subject of the email sent to the recipient. This can be a maximum of 100 characters. supportedLanguage: the

addAccessCodeToEmail

No

Boolean

clientUserId

No

String

customFields

No

customField

emailNotification

No

emailNotification

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

280

simple type enumeration the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh-CN), Chinese Traditional (zhTW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en-GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr-CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (ptBR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es-MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). IMPORTANT: If this is enabled for one recipient, it overrides the Envelope Subject and EmailBlurb. Also, you must enable emailNotification for all recipients. excludeDocuments No String Specifies the documents that are not visibile to this recipient. Document Visibility must be enabled for the account to use this.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name idCheckConfigurationName Reqd ? No Type String Description

281

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient). This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ID Check $ and SMS Auth $. To use ID check in an envelope, the iDCheckConfigurationName should be ID Check $. If you wanted to use SMS, it would be SMS Auth $ and you would need to add you would need to add phone number information to the smsAuthentication node. This complex element contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum number of characters in each element are:

idCheckInformationInput

No

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

282

street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

dobInformationInput: Used to set recipient date of birth information and consists of: dateOfBirth: Specifies the recipients date, month and year of birth. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipients SSN information and consists of: ssn4: Specifies the last four digits of the recipients SSN.
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

283

displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn9InformationInput: Used to set the recipients SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: ssn9: Specifies the recipients SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. inheritEmailNotificationConfigurati on No Boolean Optional element. If true and the recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. A note that will be unique to this recipient. This note will be sent to the recipient via the signing email. This note will display in the signing UI near the upper left corner of the document on the signing screen. This can be a maximum of 1000 characters.

note

No

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name phoneAuthentication Reqd ? No Type RecipientPhone Authentication Description

284

Optional element. Contains the elements: RecipMayProvideNumbers Boolean (if true then recipient can use whatever phone number they want) SenderProvideNumbers ArrayOfString (a list of phone numbers the recipient may use) RecordVoicePrint Reserved ValidateRecipProvideNumber Reserved It would be possible to send attachments with recipients. This complex element contains data in base64Binary. It also contains label and type for the attachment. Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. If set true then the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity Optional element. This is the role name associated with the recipient. * - This is required when working with template recipients.

recipientAttachment

No

Attachment

recipientId

Yes

String

requireIdLookup

No

Boolean

roleName

No*

String

routingOrder

Yes

String

This specifies the routing order of the recipient in the envelope

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name samlAuthentication Reqd ? No Type samlAssertionAttributes Description

285

Optional element, account must be set up to use SSO to use this. Contains the name/value pair information for the SAML assertion attributes: name The name of the SAML assertion attribute. value The value associated with the named SAML assertion attribute. Optional element. Contains the element: senderProvideNumbers Array with a list of phone numbers the recipient may use for SMS text authentication. Lists the social ID type that can be used for recipient authentication. Optional element. Used only when working with template recipients. If true and TemplateLocked = true, the sender must enter an access code. Optional element. Used only when working with template recipients. If true, the sender cannot change any attributes of the recipient. Optional element. Used only when working with template recipients. If true, the sender may not remove the recipient.

smsAuthentication

No

senderProvidedNumber s

socialAuthentications

No

Boolean

templateAccessCodeRequired

No

Boolean

templateLocked

No

Boolean

templateRequired

No

Boolean

Editors Recipient Type This recipient has the same management and access rights for the envelope as the sender and can make changes to the envelope as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and data fields for

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

286

the remaining recipients. The recipient must have a DocuSign account to be an editor. This recipient type can only be used if enabled for your account. An example Editors json layout is shown below:
"editors": [{ "email": "email.name@company.com", "name": "recipient name", "accessCode": "", "addAccessCodeToEmail": false, "clientUserId": null, "customFields": { "sample string 1", "sample string 2" }, "emailNotification": { "emailBody":" ", "emailSubject":" ", "supportedLanguage":" " }, "excludedDocuments": ["2", "4"] "idCheckConfigurationName": null, "idCheckInformationInput": { "addressInformationInput": { "addressInformation": { "street1": "sample string 1", "street2": "sample string 2", "city": "sample string 3", "state": "sample string 4", "zip": "sample string 5", "zipPlus4": "sample string 6" }, "displayLevelCode": "sample string 1", "receiveInResponse": "sample string 2" }, "dobInformationInput": { "dateOfBirth": "sample string 1", "displayLevelCode": "sample string 2", "receiveInResponse": "sample string 3" }, "ssn4InformationInput": { "ssn4": "sample string 1", "displayLevelCode": "sample string 2", "receiveInResponse": "sample string 3" }, "ssn9InformationInput": { "ssn9": "sample string 1", "displayLevelCode": "sample string 2" } }, "inheritEmailNotificationConfiguration": false, "note": "", "phoneAuthentication": null, "recipientAttachment": null, "recipientId": "1", "requireIdLookup": false, "roleName": "", "routingOrder": 1, "samlAuthentication": { "samlAssertionAttributes": [ { "name": "string", "value": "string" },

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

{ "name": "string", "value": "string" } ] }, "smsAuthentication": { "senderProvidedNumbers":[ "sample string 1", "sample string 2" ] }, "socialAuthentications": null, "templateAccessCodeRequired": false, "templateLocked": false, "templateRequired": false, "canEditRecipientEmails": false, "canEditRecipientNames": false }],

287

The Editors recipient type parameters are: Name email Reqd ? Yes Type String Description Email of the recipient. Notification will be sent to this email id. This can be a maximum of 100 characters. The full legal name of the recipient. This can be a maxium of 100 characaters. This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. This optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded.

name

Yes

String

accessCode

No

String

addAccessCodeToEmail

No

Boolean

clientUserId

No

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name customFields Reqd ? No Type customField Description

288

An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. An optional complex type that has information for setting the language for the recipients email information. It is composed of three elements: emailBody: a string with the email message sent to the recipient. This can be a maximum of 2000 characters. emailSubject: a string with the subject of the email sent to the recipient. This can be a maximum of 100 characters. supportedLanguage: the simple type enumeration the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh-CN), Chinese Traditional (zhTW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en-GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr-CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian

emailNotification

No

emailNotification

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

289

(hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (ptBR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es-MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). IMPORTANT: If this is enabled for one recipient, it overrides the Envelope Subject and EmailBlurb. Also, you must enable emailNotification for all recipients. excludeDocuments No String Specifies the documents that are not visibile to this recipient. Document Visibility must be enabled for the account to use this. Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient). This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ID Check $ and SMS Auth $. To use ID check in an envelope, the iDCheckConfigurationName

idCheckConfigurationName

No

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

290

should be ID Check $. If you wanted to use SMS, it would be SMS Auth $ and you would need to add you would need to add phone number information to the smsAuthentication node. idCheckInformationInput No This complex element contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum number of characters in each element are: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

291

dobInformationInput: Used to set recipient date of birth information and consists of: dateOfBirth: Specifies the recipients date, month and year of birth. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipients SSN information and consists of: ssn4: Specifies the last four digits of the recipients SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipients SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

292

ssn9: Specifies the recipients SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

inheritEmailNotificationConfigurati on

No

Boolean

Optional element. If true and the recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. A note that will be unique to this recipient. This note will be sent to the recipient via the signing email. This note will display in the signing UI near the upper left corner of the document on the signing screen. This can be a maximum of 1000 characrers. Optional element. Contains the elements: RecipMayProvideNumbers Boolean (if true then recipient can use whatever phone number they want) SenderProvideNumbers ArrayOfString (a list of phone numbers the recipient may use) RecordVoicePrint Reserved ValidateRecipProvideNumber Reserved

note

No

String

phoneAuthentication

No

RecipientPhone Authentication

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name recipientAttachment Reqd ? No Type Attachment Description

293

It would be possible to send attachments with recipients. This complex element contains data in base64Binary. It also contains label and type for the attachment. Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. If set true then the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity Optional element. This is the role name associated with the recipient. * - This is required when working with template recipients.

recipientId

Yes

String

requireIdLookup

No

Boolean

roleName

No*

String

routingOrder

Yes

String

This specifies the routing order of the recipient in the envelope Optional element, account must be set up to use SSO to use this. Contains the name/value pair information for the SAML assertion attributes: name The name of the SAML assertion attribute. value The value associated with the named SAML assertion attribute. Optional element. Contains the element: senderProvideNumbers Array with a list of phone numbers the recipient may use for SMS text authentication.

samlAuthentication

No

samlAssertionAttributes

smsAuthentication

No

senderProvidedNumber s

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name socialAuthentications Reqd ? No Type Boolean Description

294

Lists the social ID type that can be used for recipient authentication. Optional element. Used only when working with template recipients. If true and TemplateLocked = true, the sender must enter an access code. Optional element. Used only when working with template recipients. If true, the sender cannot change any attributes of the recipient. Optional element. Used only when working with template recipients. If true, the sender may not remove the recipient. Optional element only used with recipient types Agents and Editors. If true, the Agent or Editor Recipient associated with this Recipient can change the Recipients pre-populated Email address. This element is only active if enabled for the account. Optional element only used with recipient types Agents and Editors. If true, the Agent or Editor Recipient associated with this recipient can change the recipients pre-populated name (UserName). This element is only active if enabled for the account.

templateAccessCodeRequired

No

Boolean

templateLocked

No

Boolean

templateRequired

No

Boolean

canEditRecipientEmail

No

Boolean

canEditRecipientName

No

Boolean

In-Person Signers Recipient Type Use this action if the signer is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected. This recipient type can only be used if enabled for your account.
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 An example In-Person Signers json layout is shown below:
"inPersonSigners": [{ "hostEmail": "signing.host@company.com", "hostName": "Mike Host", "accessCode": "", "addAccessCodeToEmail": false, "clientUserId": null, "customFields": { "sample string 1", "sample string 2" }, "emailNotification": { "emailBody":" ", "emailSubject":" ", "supportedLanguage":" " }, "excludedDocuments": ["2", "4"] "idCheckConfigurationName": null, "idCheckInformationInput": { "addressInformationInput": { "addressInformation": { "street1": "sample string 1", "street2": "sample string 2", "city": "sample string 3", "state": "sample string 4", "zip": "sample string 5", "zipPlus4": "sample string 6" }, "displayLevelCode": "sample string 1", "receiveInResponse": "sample string 2" }, "dobInformationInput": { "dateOfBirth": "sample string 1", "displayLevelCode": "sample string 2", "receiveInResponse": "sample string 3" }, "ssn4InformationInput": { "ssn4": "sample string 1", "displayLevelCode": "sample string 2", "receiveInResponse": "sample string 3" }, "ssn9InformationInput": { "ssn9": "sample string 1", "displayLevelCode": "sample string 2" } }, "inheritEmailNotificationConfiguration": false, "note": "", "phoneAuthentication": null, "recipientAttachment": null, "recipientId": "2", "requireIdLookup": false, "roleName": "", "routingOrder": 1, "samlAuthentication": { "samlAssertionAttributes": [ { "name": "string", "value": "string" }, { "name": "string", "value": "string"

295

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

} ] }, "smsAuthentication": { "senderProvidedNumbers":[ "sample string 1", "sample string 2" ] }, "socialAuthentications": null, "templateAccessCodeRequired": false, "templateLocked": false, "templateRequired": false, "autoNavigation": false, "defaultRecipient": false, "signInEachLocation": false, "signatureInfo": null, "signerName": "MC Clap Your Hands", "tabs": { "approveTabs": null, "checkboxTabs": null, "companyTabs": null, "dateSignedTabs": null, "dateTabs": null, "declineTabs": null, "emailTabs": null, "envelopeIdTabs": null, "fullNameTabs": null, "initialHereTabs": null, "listTabs": null, "noteTabs": null, "numberTabs": null, "radioGroupTabs": null, "signHereTabs": [{ "signerAttachmentTabs": null, "ssnTabs": null, "textTabs": null, "titleTabs": null, "zipTabs": null } }],

296

The In-Person Signers recipient type parameters are: Name hostEmail Reqd? Yes Type String Description Specifies the email for the signing host. This can be a maximum of 100 characters. Required element for In Person Signers recipient Type. Specifies the name of the signing host. This can be a maximum of 100 characters. Required element for In Person Signers recipient Type. This optional element specifies the access code a recipient has to enter to validate the identity. This

hostName

Yes

String

accessCode

No

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type Description can be a maximum of 50 characters.

297

addAccessCodeToEmail

No

Boolean

This optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. An optional complex type that has information for setting the language for the recipients email information. It is composed of three elements: emailBody: a string with the email message sent to the recipient. This can be a maximum of 2000 characters. emailSubject: a string with the subject of the email sent to the recipient. This can be a maximum of 100 characters. supportedLanguage: the simple type enumeration the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh-CN), Chinese Traditional (zh-TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en-GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (frCA), German (de), Greek (el),

clientUserId

No

String

customFields

No

customField

emailNotification

No

emailNotificati on

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type

298 Description Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt-BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es-MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). IMPORTANT: If this is enabled for one recipient, it overrides the Envelope Subject and EmailBlurb. Also, you must enable emailNotification for all recipients.

excludeDocuments

No

String

Specifies the documents that are not visibile to this recipient. Document Visibility must be enabled for the account to use this. Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient). This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ID Check $ and SMS Auth $. To use ID check in an envelope, the iDCheckConfigurationName should be ID Check $. If you wanted to use SMS, it would be SMS Auth $ and you would need to add you would need to add phone number information to the smsAuthentication node. This complex element contains input information related to a recipient ID check. It can include

idCheckConfigurationName

No

String

idCheckInformationInput

No

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type Description the following information.

299

addressInformationInput: Used to set recipient address information and consists of: addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum number of characters in each element are: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: dateOfBirth: Specifies the recipients date, month and year of birth. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type Description

300

ssn4InformationInput: Used to set the last four digits of the recipients SSN information and consists of: ssn4: Specifies the last four digits of the recipients SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipients SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: ssn9: Specifies the recipients SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. inheritEmailNotificationConfiguration No Boolean Optional element. If true and the recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. A note that will be unique to this recipient. This note will be sent to the recipient via the signing email. This note will display in the signing UI near the upper left corner of the document on the signing screen. This can be a maximum of 1000 characters.

note

No

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name phoneAuthentication Reqd? No Type Recipient Phone Authentication Description

301

Optional element. Contains the elements: RecipMayProvideNumbers Boolean (if true then recipient can use whatever phone number they want) SenderProvideNumbers ArrayOfString (a list of phone numbers the recipient may use) RecordVoicePrint Reserved ValidateRecipProvideNumber Reserved It would be possible to send attachments with recipients. This complex element contains data in base64Binary. It also contains label and type for the attachment. Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. If set true then the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity Optional element. This is the role name associated with the recipient. * - This is required when working with template recipients.

recipientAttachment

No

Attachment

recipientId

Yes

String

requireIdLookup

No

Boolean

roleName

No*

String

routingOrder samlAuthentication

Yes No

String samlAssertion Attributes

This specifies the routing order of the recipient in the envelope Optional element, account must be set up to use SSO to use this. Contains the name/value pair information for the SAML assertion attributes: name The name of the SAML assertion attribute. value The value associated with the named SAML assertion attribute. Optional element. Contains the element:

smsAuthentication

No

senderProvide dNumbers

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type Description

302

senderProvideNumbers Array with a list of phone numbers the recipient may use for SMS text authentication. socialAuthentications templateAccessCodeRequired No No Boolean Boolean Lists the social ID type that can be used for recipient authentication. Optional element. Used only when working with template recipients. If true and TemplateLocked = true, the sender must enter an access code. Optional element. Used only when working with template recipients. If true, the sender cannot change any attributes of the recipient. Optional element. Used only when working with template recipients. If true, the sender may not remove the recipient. Optional element only used with recipient types In Person Signers and Signers. Specifies if the auto navigation setting is on or off for recipient. If true, this is the default recipient for the envelope. This option is used with the CreateEnvelopeFromTemplatesAn d Forms method.

templateLocked

No

Boolean

templateRequired

No

Boolean

autoNavigation

No

Boolean

defaultRecipient

No

Boolean

signInEachLocation

No

Boolean

If set to true and the feature is enabled in the senders account, then the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
Optional element only used with recipient types In Person Signers and Signers. Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.

signatureInfo

No

SignatureInfo

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name signerName Reqd? No Type SignerName Description

303

Optional element only used with recipient types In Person Signers and Signers. The full legal name of a signer for an InPersonSigner recipient Type. This can be a maximum of 100 characters. Optional element only used with recipient types In Person Signers and Signers. Specifies the Tabs associated with the recipient. See the Tab Parameters section for more information about tabs.

tabs

No

Tab

Intermediaries Recipient Type This recipient can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added). This recipient type can only be used if enabled for your account. An example Intermediaries json layout is shown below:
"intermediaries": [{ "email": "email.name@company.com", "name": "recipient name", "accessCode": "", "addAccessCodeToEmail": false, "clientUserId": null, "customFields": { "sample string 1", "sample string 2" }, "emailNotification": { "emailBody":" ", "emailSubject":" ", "supportedLanguage":" " }, "excludedDocuments": ["2", "4"] "idCheckConfigurationName": null, "idCheckInformationInput": { "addressInformationInput": { "addressInformation": { "street1": "sample string 1", "street2": "sample string 2", "city": "sample string 3", "state": "sample string 4", "zip": "sample string 5", "zipPlus4": "sample string 6" }, "displayLevelCode": "sample string 1", "receiveInResponse": "sample string 2" }, "dobInformationInput": { "dateOfBirth": "sample string 1", "displayLevelCode": "sample string 2", "receiveInResponse": "sample string 3" }, "ssn4InformationInput": {

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"ssn4": "sample string 1", "displayLevelCode": "sample string 2", "receiveInResponse": "sample string 3" }, "ssn9InformationInput": { "ssn9": "sample string 1", "displayLevelCode": "sample string 2" } }, "inheritEmailNotificationConfiguration": false, "note": "", "phoneAuthentication": null, "recipientAttachment": null, "recipientId": "1", "requireIdLookup": false, "roleName": "", "routingOrder": 1, "samlAuthentication": { "samlAssertionAttributes": [ { "name": "string", "value": "string" }, { "name": "string", "value": "string" } ] }, "smsAuthentication": { "senderProvidedNumbers":[ "sample string 1", "sample string 2" ] }, "socialAuthentications": null, "templateAccessCodeRequired": false, "templateLocked": false, "templateRequired": false, "canEditRecipientEmails": false, "canEditRecipientNames": false }],

304

The Intermediaries recipient type parameters are: Name email Reqd ? Yes Type String Description Email of the recipient. Notification will be sent to this email id. This can be a maximum of 100 characters. The full legal name of the recipient. This can be a maximum of 100 characaters.

name

Yes

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name accessCode Reqd ? No Type String Description

305

This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. This optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. An optional complex type that has information for setting the language for the recipients email information. It is composed of three elements: emailBody: a string with the email message sent to the recipient. This can be a maximum of 2000 characters. emailSubject: a string with the subject of the email sent to the recipient. This can be a maximum of 100 characters. supportedLanguage: the

addAccessCodeToEmail

No

Boolean

clientUserId

No

String

customFields

No

customField

emailNotification

No

emailNotification

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

306

simple type enumeration the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh-CN), Chinese Traditional (zhTW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en-GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr-CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (ptBR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es-MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). IMPORTANT: If this is enabled for one recipient, it overrides the Envelope Subject and EmailBlurb. Also, you must enable emailNotification for all recipients. excludeDocuments No String Specifies the documents that are not visibile to this recipient. Document Visibility must be enabled for the account to use this.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name idCheckConfigurationName Reqd ? No Type String Description

307

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient). This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ID Check $ and SMS Auth $. To use ID check in an envelope, the iDCheckConfigurationName should be ID Check $. If you wanted to use SMS, it would be SMS Auth $ and you would need to add you would need to add phone number information to the smsAuthentication node. This complex element contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum number of characters in each element are:

idCheckInformationInput

No

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

308

street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

dobInformationInput: Used to set recipient date of birth information and consists of: dateOfBirth: Specifies the recipients date, month and year of birth. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipients SSN information and consists of: ssn4: Specifies the last four digits of the recipients SSN.
221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd ? Type Description

309

displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.

ssn9InformationInput: Used to set the recipients SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: ssn9: Specifies the recipients SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. inheritEmailNotificationConfigurati on No Boolean Optional element. If true and the recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. A note that will be unique to this recipient. This note will be sent to the recipient via the signing email. This note will display in the signing UI near the upper left corner of the document on the signing screen. This can be a maximum of 1000 characters.

note

No

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name phoneAuthentication Reqd ? No Type RecipientPhone Authentication Description

310

Optional element. Contains the elements: RecipMayProvideNumbers Boolean (if true then recipient can use whatever phone number they want) SenderProvideNumbers ArrayOfString (a list of phone numbers the recipient may use) RecordVoicePrint Reserved ValidateRecipProvideNumber Reserved It would be possible to send attachments with recipients. This complex element contains data in base64Binary. It also contains label and type for the attachment. Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. If set true then the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity Optional element. This is the role name associated with the recipient. * - This is required when working with template recipients.

recipientAttachment

No

Attachment

recipientId

Yes

String

requireIdLookup

No

Boolean

roleName

No*

String

routingOrder

Yes

String

This specifies the routing order of the recipient in the envelope

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name samlAuthentication Reqd ? No Type samlAssertionAttributes Description

311

Optional element, account must be set up to use SSO to use this. Contains the name/value pair information for the SAML assertion attributes: name The name of the SAML assertion attribute. value The value associated with the named SAML assertion attribute. Optional element. Contains the element: senderProvideNumbers Array with a list of phone numbers the recipient may use for SMS text authentication. Lists the social ID type that can be used for recipient authentication. Optional element. Used only when working with template recipients. If true and TemplateLocked = true, the sender must enter an access code. Optional element. Used only when working with template recipients. If true, the sender cannot change any attributes of the recipient. Optional element. Used only when working with template recipients. If true, the sender may not remove the recipient.

smsAuthentication

No

senderProvidedNumber s

socialAuthentications

No

Boolean

templateAccessCodeRequired

No

Boolean

templateLocked

No

Boolean

templateRequired

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name canEditRecipientEmail Reqd ? No Type Boolean Description

312

Optional element only used with recipient types Agents and Editors. If true, the Agent or Editor Recipient associated with this Recipient can change the Recipients pre-populated Email address. This element is only active if enabled for the account. Optional element only used with recipient types Agents and Editors. If true, the Agent or Editor Recipient associated with this recipient can change the recipients pre-populated name (UserName). This element is only active if enabled for the account.

canEditRecipientName

No

Boolean

Signers Recipient Type Use this action if your recipient must sign, initial, date or add data to form fields on the documents in the envelope. An example Signers json layout is shown below:
"signers": [{ "email": "signer.name@company.com", "name": "Mike Signer", "accessCode": "", "addAccessCodeToEmail": , "clientUserId": , "customFields": { "sample string 1", "sample string 2" }, "emailNotification": { "emailBody":" ", "emailSubject":" ", "supportedLanguage":" " }, "excludedDocuments": ["2", "4"] "idCheckConfigurationName": , "idCheckInformationInput": { "addressInformationInput": { "addressInformation": { "street1": "sample string 1", "street2": "sample string 2", "city": "sample string 3", "state": "sample string 4", "zip": "sample string 5", "zipPlus4": "sample string 6" },

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"displayLevelCode": "sample string 1", "receiveInResponse": "sample string 2" }, "dobInformationInput": { "dateOfBirth": "sample string 1", "displayLevelCode": "sample string 2", "receiveInResponse": "sample string 3" }, "ssn4InformationInput": { "ssn4": "sample string 1", "displayLevelCode": "sample string 2", "receiveInResponse": "sample string 3" }, "ssn9InformationInput": { "ssn9": "sample string 1", "displayLevelCode": "sample string 2" } }, "inheritEmailNotificationConfiguration": false, "note": "", "phoneAuthentication": null, "recipientAttachment": null, "recipientId": "1", "requireIdLookup": false, "roleName": "", "routingOrder": 1, "samlAuthentication": { "samlAssertionAttributes": [ { "name": "string", "value": "string" }, { "name": "string", "value": "string" } ] }, "smsAuthentication": { "senderProvidedNumbers":[ "sample string 1", "sample string 2" ] }, "socialAuthentications": null, "templateAccessCodeRequired": false, "templateLocked": false, "templateRequired": false, "autoNavigation": false, "defaultRecipient": false, "signInEachLocation": false, "signatureInfo": null, "tabs": { "approveTabs": null, "checkboxTabs": null, "companyTabs": null, "dateSignedTabs": null, "dateTabs": null, "declineTabs": null, "emailTabs": null, "envelopeIdTabs": null, "fullNameTabs": null, "initialHereTabs": null, "listTabs": null,

313

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"noteTabs": null, "numberTabs": null, "radioGroupTabs": null, "signHereTabs": [{ "signerAttachmentTabs": null, "ssnTabs": null, "textTabs": null, "titleTabs": null, "zipTabs": null } "deliveryMethod":"offline", "deliveredDateTime":"String Content", "signedDateTime":"String Content", "offlineAttributes":{ "deviceName":"String Content", "deviceModel":"String Content", "gpsLatitude":"String Content", "gpsLongitude":"String Content", "accountEsignId":"String Content" } }], --[Multipart boundary (example of adding a Recipient Photo)] Content-Type: image/jpeg Content-Disposition: inline;recipientId=1 Content-Transfer-Encoding: base64 --[Multipart boundary (example of adding a Tab Image)] Content-Type: image/gif Content-Disposition: inline;tabId=1 Content-Transfer-Encoding: base64 --[Multipart boundary]

314

The Signers recipient type parameters are: Name email Reqd? Yes Type String Description Email of the recipient. Notification will be sent to this email id. This can be a maximum of 100 characters. The full legal name of the recipient. This can be a maximum of 100 characaters. This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. This optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. This specifies if the recipient is embedded or remote.

name

Yes

String

accessCode

No

String

addAccessCodeToEmail

No

Boolean

clientUserId

No*

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type Description

315

If the clientUserId is not null then the recipient is embedded. * This is required if the signer is an offline signer. customFields No customField An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. An optional complex type that has information for setting the language for the recipients email information. It is composed of three elements: emailBody: a string with the email message sent to the recipient. This can be a maximum of 2000 characters. emailSubject: a string with the subject of the email sent to the recipient. This can be a maximum of 100 characters. supportedLanguage: the simple type enumeration the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh-CN), Chinese Traditional (zh-TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en-GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (frCA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt-BR), Romanian (ro),Russian (ru), Serbian (sr),

emailNotification

No

emailNotificati on

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type

316 Description Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es-MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). IMPORTANT: If this is enabled for one recipient, it overrides the Envelope Subject and EmailBlurb. Also, you must enable emailNotification for all recipients.

excludeDocuments

No

String

Specifies the documents that are not visibile to this recipient. Document Visibility must be enabled for the account to use this. Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient). This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ID Check $ and SMS Auth $. To use ID check in an envelope, the iDCheckConfigurationName should be ID Check $. If you wanted to use SMS, it would be SMS Auth $ and you would need to add you would need to add phone number information to the smsAuthentication node. This complex element contains input information related to a recipient ID check. It can include the following information. addressInformationInput: Used to set recipient address information and consists of: addressInformation: consists of six elements, with stree2 and zipPlus4

idCheckConfigurationName

No

String

idCheckInformationInput

No

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type

317 Description being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum number of characters in each element are: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. dobInformationInput: Used to set recipient date of birth information and consists of: dateOfBirth: Specifies the recipients date, month and year of birth. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn4InformationInput: Used to set the last four digits of the recipients SSN information and consists of: ssn4: Specifies the last four digits of the recipients SSN. displayLevelCode: Specifies the display level for the recipient. Values are:

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type

318 Description ReadOnly, Editable, or DoNotDisplay. receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response. ssn9InformationInput: Used to set the recipients SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of: ssn9: Specifies the recipients SSN. displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.

inheritEmailNotificationConfiguratio n

No

Boolean

Optional element. If true and the recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. A note that will be unique to this recipient. This note will be sent to the recipient via the signing email. This note will display in the signing UI near the upper left corner of the document on the signing screen. This can be a maximum of 1000 characters. Optional element. Contains the elements: RecipMayProvideNumbers Boolean (if true then recipient can use whatever phone number they want) SenderProvideNumbers ArrayOfString (a list of phone numbers the recipient may use) RecordVoicePrint Reserved ValidateRecipProvideNumber

note

No

String

phoneAuthentication

No

Recipient Phone Authentication

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name recipientAttachment Reqd? No Type Attachment Description Reserved

319

It would be possible to send attachments with recipients. This complex element contains data in base64Binary. It also contains label and type for the attachment. Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. If set true then the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity Optional element. This is the role name associated with the recipient. * - This is required when working with template recipients.

recipientId

Yes

String

requireIdLookup

No

Boolean

roleName

No*

String

routingOrder samlAuthentication

Yes No

String samlAssertion Attributes

This specifies the routing order of the recipient in the envelope Optional element, account must be set up to use SSO to use this. Contains the name/value pair information for the SAML assertion attributes: name The name of the SAML assertion attribute. value The value associated with the named SAML assertion attribute. Optional element. Contains the element: senderProvideNumbers Array with a list of phone numbers the recipient may use for SMS text authentication. Lists the social ID type that can be used for recipient authentication. Optional element. Used only when working with template recipients. If true and TemplateLocked = true, the sender must enter an access code.

smsAuthentication

No

senderProvide dNumbers

socialAuthentications templateAccessCodeRequired

No No

Boolean Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name templateLocked Reqd? No Type Boolean Description

320

Optional element. Used only when working with template recipients. If true, the sender cannot change any attributes of the recipient. Optional element. Used only when working with template recipients. If true, the sender may not remove the recipient. Optional element only used with recipient types In Person Signers and Signers. Specifies if the auto navigation setting is on or off for recipient. If true, this is the default recipient for the envelope. This option is used with the CreateEnvelopeFromTemplatesAn d Forms method.

templateRequired

No

Boolean

autoNavigation

No

Boolean

defaultRecipient

No

Boolean

signInEachLocation

No

Boolean

If set to true and the feature is enabled in the senders account, then the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
Optional element only used with recipient types In Person Signers and Signers. Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Optional element only used with recipient types In Person Signers and Signers. Specifies the Tabs associated with the recipient. See the Tab Parameters section for more information about tabs. Sets if the signer is an offline signer. The only accepted value is: offline. * This is required if the signer is an offline signer.

signatureInfo

No

SignatureInfo

tabs

No

Tab

deliveryMethod

No*

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name deliveredDateTime Reqd? No Type DateTime Description

321

Optional item if the signer is an offline signer. If this is not included, DocuSign will set it to the signedDateTime value. The date/time setting that specifies when the envelope was delivered to the recipient. The sent date for the recipient is set to the same value. Dates are formatted using ISO 8601 format. It is recommended that you include a time value. If no time value is included, the time will default to Pacific Time. The date/time setting that specifies when the recipient signed the envelope. Dates are formatted using ISO 8601 format. It is recommended that you include a time value. If no time value is included, the time will default to Pacific Time. * This is required if the signer is an offline signer. Optional structure that contains attributes about the device used and location for an offline signer. You can include none, some or all of the attributes. This information is added to the Offline Signing section of the Certificate of Completion. The possible attributes are: deviceName: A string with information about the type of device used for offline signing. deviceModel: A string with information about the model of the device used for offline signing. gpsLatitude: A string with the latitude of the device location at the time of signing. gpsLongitude: A string with the longitude of the device location at the time of signing. accountEsignId: A string with GUID of the account. This can be retrieved with the Get Consumer

signedDateTime

No*

DateTime

offlineAttributes

No

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type Description Disclosure call.

322

Offline Signing Multipart section information: Name Recipient Photo Reqd? No Type Image Description An optional multipart section that associates an offline signer image with the with an offline recipient, as set by the recipientId. The photo image is placed in the Offline Signing section of the Certificate of Completion. After the multipart boundary, add the content information:
Content-Type: image/{image file type} Content-Disposition: inline; recipientId={recipientId} Content-Transfer-Encoding: {encoding type}

Tab Image

No*

Image

A multipart section with the signature or initial image that associates an offline signers signature or initials with a signature or image tag, as set by the tabId. The image is placed in the appropriate tab location on the documents. After the multipart boundary, add the content information:
Content-Type: image/{image file type} Content-Disposition: inline; tabId={tabId} Content-Transfer-Encoding: {encoding type}

* This is required for offline signers that use signature or initial images.

Tab Types and Parameters

Tabs are used to indicate locations in a document where the recipient should take some action. Tabs are associated with a specific recipient and are only used by the recipient types In Person Signers and Signers. There are 24 different tab types. Tab types share some common parameters, but the exact parameters associated with a tab depend on the tab type. Tabs are associated with a specific recipient and are only used by the recipient types In Person Signers and Signers. Refer to the specific tab type below for more information. Approve Date Envelope ID Initial Here Number SSN Checkbox Decline First Name Last Name Radio Group Text Company Email Formula List Sign Here Title Date Signed Email Address Full Name Note Signer Attachment Zip

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Anchoring Tabs

323

The tab anchoring option allows you to send documents for signature that do not have a fixed layout or format. In these documents, you might not know the absolute location of the tabs when you design your API client application because the tabs must move with text. As an alternative to sending X and Y coordinates for tabs, the DocuSign Service can derive an anchor location for the tab by correlating anchor information to data within the document. When the DocuSign Service receives a request that contains tabs with anchor information, it searches the document for instances of the anchorString. When found, it places a tab of the specified type for the designated recipient. Tab positions are established by setting offsets for the tab. When you apply tabs to the document, DocuSign does not remove or replace the anchorString text. You can hide codified anchors by using the same font color as the background of the document. So the anchor can be used by DocuSign processes and it will not be visible on the document. To use an anchoring option:
1. Identify the location in the document by text string. You can use a pre-existing text string or

add a new one. For example, Borrowers Signature might already exist in the document. If not, you could add the text string, BorrowersSignHere.
2. Reference the anchor through the anchorString element of the tab. 3. Determine the offset from the anchorString location to where the tab should be placed. The

bottom-left of the anchorString is equivalent to position (0,0), and the bottom-left of the Tab graphic is placed relative to that. Positive anchorXOffset values move the tab right on the page and positive anchorYoffset values move the tab up on the page. The anchorUnits specifies the units used for the offsets. DocuSign does not currently provide tools to derive the offset values. Determination of the proper offset will likely require some trial-and-error. Rules for working with anchor tags You set the text of the anchorString. DocuSign tabs are created for each instance of the anchorString within the document, so special care must be taken to establish unique anchorStrings that do not result in unintentional tabs. You cannot use the same anchored tab for different recipients for the same document. The DocuSign system cannot search for text that is embedded in an image when checking for anchorStrings. X or Y offsets supplied for a tab apply to all instances of the tab in the document. To use different offsets at different locations in the document for the same recipient, create multiple, unique anchor tabs. The X and Y offset values must not extend a tab beyond the boundaries of the page. If the offset do extend beyond the page boundaries, the error message Invalid_User_Offset is sent. The error message includes the X or Y offset that resulted in the exception. The system does not support an anchorString embedded in the form of a PDF X-object in the document. The system does not re-flow the text that surrounds the anchor tabs. It is the responsibility of the document author to provide sufficient whitespace to contain the potential width of the ultimate tab value.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Tips and Tricks The following are tips for effective use of anchor tags:

324

In order to avoid unintentional conflicts between anchorString text and the text that naturally exists in documents, establish a codified syntax for the anchorString text that is unlikely to appear elsewhere in a document. Develop an extensible and consistent syntax that can be used across multiple document types. Especially for documents that have variable numbers of tabs or signers, author the source document to include hidden anchor tabs for all potential signers/permutations. Then, control the tabs that are actually placed by including/excluding the anchor tabs in the request. This approach allows a single document to be used for all use cases instead of maintaining separate documents for each scenario.

Automatically Populating Tabs If you want similar tab types to automatically populate with the same data, you must follow these guidelines: Each tabLabel entry must have the characters \\* added in front of the actual tab label. If the \\* characters are not added, then only the first occurrence of the tab is populated. Example: In the JSON example below, the Text tabs Student Last Name and Student First Name will be auto-populated as specified (Doe and John) each place they appear throughout the envelope.
"tabs": { "textTabs": [ { "tabLabel": "\\*Student Last Name", "value": "Doe" }, { "tabLabel": "\\*Student First Name", "value": "John" }] }

Each occurence of the tab must have identical properties. Example: There are two Text tabs in a document, each with tabLabel = Name, but for the first tab has the property bold = true and the second tab has bold = false. When creating the envelope, only the first tab is populated. In order to automatically populate both occurrences of the "Name" Text tabs, the bold property must be set to the same value for both tabs.

Approve Tab Place this tag on the document where you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tag during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history. An example Approve tab json layout is shown below:
"approveTabs": [{ "anchorString": null, "anchorXOffset": null, 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "300", "yPosition": "100", "bold": false, "font": "lucidaconsole", "fontColor": null, "fontSize": "size9", "italic": false, "tabLabel": "Approve 11", "underline": false, "buttonText": "Approve", "height": 18, "width": 60 }],

325

The Approve tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility.

anchorYOffset

No

String

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name conditionalParentValue Reqd? No Type String Description

326

Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active.

documentId

Yes

String

This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute. Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. If true, the information in the tab is bold. The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.

pageNumber recipientId

Yes Yes

String String

templateLocked

No

Boolean

templateRequired

No

Boolean

xPosition

Yes

String

yPosition

Yes

String

bold font

No No

Boolean Font

fontColor

No

FontColor

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name fontSize Reqd? No Type FontSize Description

327

The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined. The text displayed in the tab. Only used in approveTabs and decineTabs. Height of the tab. Width of the tab.

italic tabLabel

No Yes

Boolean String

underline buttonText

No No

Boolean String

height width Checkbox Tab

No No

String String

Place this tag on the document in a location where the recipient can select an option. An example Checkbox tab json layout is shown below:
"checkboxTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "144", "yPosition": "155", "mergeFieldXml": null, "name": "Checkbox", "requireInitialOnSharedChange": false, "selected": false, "shared": false, "tabLabel": "Check Box 14" }],

The Checkbox tab parameters are:

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name anchorString anchorXOffset Reqd? No No Type String String

328 Description Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active.

anchorYOffset

No

String

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

documentId

Yes

String

This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute. Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender.

pageNumber recipientId

Yes Yes

String String

templateLocked

No

Boolean

templateRequired

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name xPosition Reqd? Yes Type String Description

329

This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. Reserved for future use. Optional element for field markup. When set to true it requires the signer to initial when they modify a shared field. If true, the checkbox is selected. Optional element for field markup. When set to true, enables field markup for the field. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data.

yPosition

Yes

String

mergeFieldXml requireInitialOnSharedChange

No No

String Boolean

selected shared

No No

Boolean Boolean

tabLabel

Yes

String

Company Tab Place this tag on the document where you want the recipients company name to appear. An example Company tab json layout is shown below:
"companyTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "394", "yPosition": "65", "bold": false, "font": "arial", "fontColor": null, "fontSize": null, "italic": false, "tabLabel": "Company",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"underline": false, "concealValueOnDocument": false, "disableAutoSize": false, "locked": false, "name": "Company", "required": true, "value": "Ro Corp 2", "width": 42 }],

330

The Company tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active. documentId Yes String This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute.

anchorYOffset

No

String

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

pageNumber recipientId

Yes Yes

String String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name templateLocked Reqd? No Type Boolean Description

331

Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. If true, the information in the tab is bold. The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined.

templateRequired

No

Boolean

xPosition

Yes

String

yPosition

Yes

String

bold font

No No

Boolean Font

fontColor

No

FontColor

fontSize

No

FontSize

italic tabLabel

No Yes

Boolean String

underline

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name concealValueOnDocument Reqd? No Type Boolean Description

332

Optional element. If true the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. Disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. If true, the Signer cannot change the data in the tab. The names associated with the tab type. If true, the signer is required to fill out this tab. This element specifies the value of the tab. Width of the tab.

disableAutoSize

No

Boolean

locked Name Required value width Date Signed Tab

No No No No No

Boolean String Boolean String String

Place this tag on the document where you want the date the recipient signed the document to appear. An example Date Signed tab json layout is shown below:
"dateSignedTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "147", "yPosition": "103",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"bold": false, "font": "arial", "fontColor": null, "fontSize": null, "italic": false, "tabLabel": "Date Signed", "underline": false, "name": "Date Signed", "value": "" }],

333

The Date Signed tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active. documentId Yes String This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute.

anchorYOffset

No

String

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

pageNumber recipientId

Yes Yes

String String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name templateLocked Reqd? No Type Boolean Description

334

Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. If true, the information in the tab is bold. The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined.

templateRequired

No

Boolean

xPosition

Yes

String

yPosition

Yes

String

bold font

No No

Boolean Font

fontColor

No

FontColor

fontSize

No

FontSize

italic tabLabel

No Yes

Boolean String

underline

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name name value Reqd? No No Type String String Description

335

The names associated with the tab type. This element specifies the value of the tab.

Date Tab Place this tag on the document where you want the recipient to enter a date. A date can be entered in any format and the date will be reformatted to MM/DD/YYYY. It uses the same parameters as a Text tab, with the validation message and pattern set for date information. An example Date tab json layout is shown below:
"dateTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "24", "yPosition": "153", "bold": false, "font": "arial", "fontColor": null, "fontSize": null, "italic": false, "tabLabel": "Date Field 13", "underline": false, "concealValueOnDocument": false, "disableAutoSize": false, "locked": false, "name": "Text", "required": true, "value": "", "width": 42, "mergeFieldXml": "", "requireInitialOnSharedChange": false, "shared": false, "height": 11, }],

The Date tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name anchorYOffset Reqd? No Type String

336 Description This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active.

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

documentId

Yes

String

This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute. Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin.

pageNumber recipientId

Yes Yes

String String

templateLocked

No

Boolean

templateRequired

No

Boolean

xPosition

Yes

String

yPosition

Yes

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name bold font Reqd? No No Type Boolean Font Description

337

If true, the information in the tab is bold. The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined. Optional element. If true the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

fontColor

No

FontColor

fontSize

No

FontSize

italic tabLabel

No Yes

Boolean String

underline concealValueOnDocument

No No

Boolean Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name disableAutoSize Reqd? No Type Boolean Description

338

Disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. If true, the Signer cannot change the data in the tab. The names associated with the tab type. If true, the signer is required to fill out this tab. This element specifies the value of the tab. Width of the tab. Reserved for future use. Optional element for field markup. When set to true it requires the signer to initial when they modify a shared field. Optional element for field markup. When set to true, enables field markup for the field. Height of the tab.

locked name required value width mergeFieldXml requireInitialOnSharedChange

No No No No No No No

Boolean String Boolean String String String Boolean

shared

No

Boolean

height Decline Tab

No

String

Place this tag on the document where you want to give the recipient the option of declining an envelope. If the recipient clicks the Decline tag during the signing process, the envelope is voided. An example Decline tab json layout is shown below:
"declineTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "408", "yPosition": "105", "bold": false, "font": "lucidaconsole", "fontColor": null, "fontSize": "size9", 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"italic": false, "tabLabel": "Decline 12", "underline": false, "buttonText": "Decline", "height": 18, "width": 60 }],

339

The Decline tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active. documentId Yes String This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute.

anchorYOffset

No

String

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

pageNumber recipientId

Yes Yes

String String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name templateLocked Reqd? No Type Boolean Description

340

Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. If true, the information in the tab is bold. The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined.

templateRequired

No

Boolean

xPosition

Yes

String

yPosition

Yes

String

bold font

No No

Boolean Font

fontColor

No

FontColor

fontSize

No

FontSize

italic tabLabel

No Yes

Boolean String

underline

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name buttonText Reqd? No Type String Description The text displayed in the tab. Only used in approveTabs and decineTabs. Height of the tab. Width of the tab.

341

height width Email Tab

No No

String String

Place this tag on the document where you want the recipient to enter an email. Email tags are singleline fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. An example Email tab json layout is shown below:
"emailTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "24", "yPosition": "153", "bold": false, "font": "arial", "fontColor": null, "fontSize": null, "italic": false, "tabLabel": "Email Field 3", "underline": false, "concealValueOnDocument": false, "disableAutoSize": false, "locked": false, "name": "Text", "required": true, "value": "", "width": 42, "mergeFieldXml": "", "requireInitialOnSharedChange": false, "shared": false, "height": 11, }],

The Email tab parameters are: Name anchorString Reqd? No Type String Description Specifies string searched for to place the tab in the document.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name anchorXOffset Reqd? No Type String Description

342

anchorYOffset

No

String

This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active.

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

documentId

Yes

String

This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute. Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin.

pageNumber recipientId

Yes Yes

String String

templateLocked

No

Boolean

templateRequired

No

Boolean

xPosition

Yes

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name yPosition Reqd? Yes Type String Description

343

This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. If true, the information in the tab is bold. The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined.

bold font

No No

Boolean Font

fontColor

No

FontColor

fontSize

No

FontSize

italic tabLabel

No Yes

Boolean String

underline

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name concealValueOnDocument Reqd? No Type Boolean Description

344

Optional element. If true the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. Disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. If true, the Signer cannot change the data in the tab. The names associated with the tab type. If true, the signer is required to fill out this tab. This element specifies the value of the tab. Width of the tab. Reserved for future use. Optional element for field markup. When set to true it requires the signer to initial when they modify a shared field. Optional element for field markup. When set to true, enables field markup for the field. Height of the tab.

disableAutoSize

No

Boolean

locked name required value width mergeFieldXml requireInitialOnSharedChange

No No No No No No No

Boolean String Boolean String String String Boolean

shared

No

Boolean

height Email Address Tab

No

String

Place this tag on a document where you want the recipients email, as entered in the recipient information, to appear. An example Email Address tab json layout is shown below:
"emailAddressTabs": [{

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "399", "yPosition": "35", "bold": false, "font": "arial", "fontColor": null, "fontSize": null, "italic": false, "tabLabel": "Email Address", "underline": false, "name": " Email Address" }],

345

The Email Address tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active.

anchorYOffset

No

String

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name documentId Reqd? Yes Type String Description

346

This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute. Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. If true, the information in the tab is bold. The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic.

pageNumber recipientId

Yes Yes

String String

templateLocked

No

Boolean

templateRequired

No

Boolean

xPosition

Yes

String

yPosition

Yes

String

bold font

No No

Boolean Font

fontColor

No

FontColor

fontSize

No

FontSize

italic

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name tabLabel Reqd? Yes Type String Description

347

The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined. The names associated with the tab type.

underline name Envelope ID Tab

No No

Boolean String

Place this tag on the document where you want the envelope ID for to appear. Recipients cannot enter or change the information in this tab, it is for informational purposes only. An example Envelope ID tab json layout is shown below:
"envelopeIdTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "documentId": "1", "pageNumber": "1", "xPosition": "24", "yPosition": "153", "tabLabel": "Envelope ID, }],

The Envelope ID tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches.

anchorYOffset

No

String

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name documentId Reqd? Yes Type String Description

348

This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data.

pageNumber xPosition

Yes Yes

String String

yPosition

Yes

String

tabLabel

Yes

String

First Name Tab Place this tag on a document where you want the recipients first name to appear. This tag takes the recipients name, as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. An example First Name tab json layout is shown below:
"firstNameTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "399", "yPosition": "35", "bold": false, "font": "arial", "fontColor": null, "fontSize": null, "italic": false, "tabLabel": "First Name", "underline": false, "name": "First Name" }],

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 The First Name tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description

349

Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active.

anchorYOffset

No

String

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

documentId

Yes

String

This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute. Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender.

pageNumber recipientId

Yes Yes

String String

templateLocked

No

Boolean

templateRequired

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name xPosition Reqd? Yes Type String Description

350

This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. If true, the information in the tab is bold. The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined. The names associated with the tab type.

yPosition

Yes

String

bold font

No No

Boolean Font

fontColor

No

FontColor

fontSize

No

FontSize

italic tabLabel

No Yes

Boolean String

underline name Formula Tab

No No

Boolean String

This tag is used to add a calculated field to a document. Envelope recipients cannot directly enter information into the tag; the formula tab calculates and displays a new value when changes are made to the reference tag values. The reference tag information and calculation operations are entered in

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

351

the formula element. See the Using the Calculated Fields Feature quick start guide or DocuSign Service User Guide for more information about formulas. An example Formula tab json layout is shown below:
"formulaTabs": [{ "formula": " [Line1]+[Line2]+[Tax] ", "isPaymentAmount": false "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "24", "yPosition": "153", "bold": false, "font": "arial", "fontColor": null, "fontSize": null, "italic": false, "tabLabel": "Data Field 13", "underline": false, "concealValueOnDocument": false, "disableAutoSize": false, "locked": true, "name": "Formula", "required": true, "value": "", "width": 42, "mergeFieldXml": "", "height": 11, }],

The Formula tab parameters are: Name formula Reqd? No Type String Description The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. This can be a maximum of 2000 characters. Example: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax]

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name isPaymentAmount Reqd? No Type Boolean Description

352

When true, sets this as a payment tab. Can only be used with Text, Number, Formula or List tabs. The value of the tab must be a number. Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute. Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. If true, the information in the tab is bold.

anchorString anchorXOffset

No No

String String

anchorYOffset

No

String

anchorIgnoreIfNotPresent

No

String

anchorUnits documentId

No Yes

String String

pageNumber recipientId

Yes Yes

String String

templateLocked

No

Boolean

templateRequired

No

Boolean

xPosition

Yes

String

yPosition

Yes

String

bold

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name font Reqd? No Type Font Description

353

The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined. Optional element. If true the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. Disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

fontColor

No

FontColor

fontSize

No

FontSize

italic tabLabel

No Yes

Boolean String

underline concealValueOnDocument

No No

Boolean Boolean

disableAutoSize

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name locked name required value width mergeFieldXml height Full Name Tab Place this tag on the document where you want the recipients name to appear. An example Full Name tab json layout is shown below:
"fullNameTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "399", "yPosition": "35", "bold": false, "font": "arial", "fontColor": null, "fontSize": null, "italic": false, "tabLabel": "Full Name", "underline": false, "name": "Full Name" }],

354 Type Boolean String Boolean String String String String Description This should always be set to true for formula tabs. The names associated with the tab type. If true, the signer is required to fill out this tab. This element specifies the value of the tab. Width of the tab. Reserved for future use. Height of the tab.

Reqd? No No No No No No No

The Full Name tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name anchorYOffset Reqd? No Type String

355 Description This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active.

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

documentId

Yes

String

This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute. Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin.

pageNumber recipientId

Yes Yes

String String

templateLocked

No

Boolean

templateRequired

No

Boolean

xPosition

Yes

String

yPosition

Yes

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name bold font Reqd? No No Type Boolean Font Description

356

If true, the information in the tab is bold. The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined. The names associated with the tab type.

fontColor

No

FontColor

fontSize

No

FontSize

italic tabLabel

No Yes

Boolean String

underline name Initial Here Tab

No No

Boolean String

Place this tag to have a recipient place their initials in the document. The optional parameter sets if the initials are required or optional. An example Initial Here tab json layout is shown below:
"initialHereTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"templateRequired": false, "xPosition": "249", "yPosition": "15", "name": "Initial Here", "optional": false, "scaleValue": 1, "tabLabel": "Initial 5" }, }],

357

The Initial Here tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active. documentId Yes String This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute.

anchorYOffset

No

String

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

pageNumber recipientId

Yes Yes

String String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name templateLocked Reqd? No Type Boolean Description

358

Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. The names associated with the tab type. When true, the Initial Here tab is optional and the recipient is not required to add initials to complete an envelope. Sets the size for Initial Here tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data.

templateRequired

No

Boolean

xPosition

Yes

String

yPosition

Yes

String

name optional

No No

String Boolean

scaleValue

No

String

tabLabel

Yes

String

Last Name Tab Place this tag on a document where you want the recipients last name to appear. This tag takes the recipients name, as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. An example Last Name tab json layout is shown below:
"lastNameTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, 221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"templateRequired": false, "xPosition": "399", "yPosition": "35", "bold": false, "font": "arial", "fontColor": null, "fontSize": null, "italic": false, "tabLabel": "Last Name", "underline": false, "name": "Last Name" }],

359

The Last Name tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active. documentId Yes String This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute.

anchorYOffset

No

String

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

pageNumber recipientId

Yes Yes

String String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name templateLocked Reqd? No Type Boolean Description

360

Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. If true, the information in the tab is bold. The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined.

templateRequired

No

Boolean

xPosition

Yes

String

yPosition

Yes

String

bold font

No No

Boolean Font

fontColor

No

FontColor

fontSize

No

FontSize

italic tabLabel

No Yes

Boolean String

underline

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name name List Tab Reqd? No Type String Description

361

The names associated with the tab type.

Use this tag to give your recipient a list of options, presented as a drop-down list, from which they can select. An example List tab json layout is shown below:
"listTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "286", "yPosition": "163", "bold": false, "font": "arial", "fontColor": null, "fontSize": null, "italic": false, "tabLabel": "Drop Down 16", "underline": false, "listItems": [{ "selected": false, "text": "Peach", "value": "peachValue" }, { "selected": true, "text": "Pear", "value": "PearValue" }, { "selected": false, "text": "Dog", "value": "DogValue" }], "mergeFieldXml": "", "requireInitialOnSharedChange": false, "shared": false, "value": "Pear", "width": 48 }],

The List tab parameters are: Name anchorString Reqd? No Type String Description Specifies string searched for to place the tab in the document.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name anchorXOffset Reqd? No Type String Description

362

anchorYOffset

No

String

This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active.

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

documentId

Yes

String

This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute. Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin.

pageNumber recipientId

Yes Yes

String String

templateLocked

No

Boolean

templateRequired

No

Boolean

xPosition

Yes

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name yPosition Reqd? Yes Type String Description

363

This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. If true, the information in the tab is bold. The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined.

bold font

No No

Boolean Font

fontColor

No

FontColor

fontSize

No

FontSize

italic tabLabel

No Yes

Boolean String

underline

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name listItems Reqd? Yes Type listItem Description

364

Only used with list tabs. These are the possible selections for a dropdown list. Each selection has three parts: selected: Sets if this is the default selection shown to a signer. Use true/false to show the value is selected or not. Only one selection can be true. text: The text shown in the dropdown list. value: The value used when the selected. Reserved for future use. Optional element for field markup. When set to true it requires the signer to initial when they modify a shared field. Optional element for field markup. When set to true, enables field markup for the field. This sets/gets the currently selected list value. Width of the tab.

mergeFieldXml requireInitialOnSharedChange

No No

String Boolean

shared

No

Boolean

Value width Note Tab

No No

String String

Place this tag on the document where you want to place additional information, in the form of a note, on a document for a recipient. An example Note tab json layout is shown below:
"noteTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "384", "yPosition": "154", "bold": false, "font": "arial", "fontColor": null, "fontSize": null, "italic": false,

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"tabLabel": "Note 17", "underline": false, "height": 33, "shared": false, "value": "This is a test note", "width": 66 }],

365

The Note tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active. documentId Yes String This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute.

anchorYOffset

No

String

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

pageNumber recipientId

Yes Yes

String String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name templateLocked Reqd? No Type Boolean Description

366

Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. If true, the information in the tab is bold. The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined.

templateRequired

No

Boolean

xPosition

Yes

String

yPosition

Yes

String

bold font

No No

Boolean Font

fontColor

No

FontColor

fontSize

No

FontSize

italic tabLabel

No Yes

Boolean String

underline

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name height shared Reqd? No No Type String Boolean Description Height of the tab.

367

Optional element for field markup. When set to true, enables field markup for the field. This element specifies the value of the tab. This can be a maximum of 2000 characters. Width of the tab.

value

No

String

width Number Tab

No

String

Place this tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information. An example Number tab json layout is shown below:
"numberTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "24", "yPosition": "153", "bold": false, "font": "arial", "fontColor": null, "fontSize": null, "italic": false, "tabLabel": "Number Field 13", "underline": false, "concealValueOnDocument": false, "disableAutoSize": false, "locked": false, "name": "Text", "required": true, "value": "", "width": 42, "mergeFieldXml": "", "requireInitialOnSharedChange": false, "shared": false, "height": 11, }],

The Number tab parameters are: Name Reqd? Type Description

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name anchorString anchorXOffset Reqd? No No Type String String Description

368

Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active.

anchorYOffset

No

String

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

documentId

Yes

String

This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute. Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender.

pageNumber recipientId

Yes Yes

String String

templateLocked

No

Boolean

templateRequired

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name xPosition Reqd? Yes Type String Description

369

This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. If true, the information in the tab is bold. The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined.

yPosition

Yes

String

bold font

No No

Boolean Font

fontColor

No

FontColor

fontSize

No

FontSize

italic tabLabel

No Yes

Boolean String

underline

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name concealValueOnDocument Reqd? No Type Boolean Description

370

Optional element. If true the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. Disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. If true, the Signer cannot change the data in the tab. The names associated with the tab type. If true, the signer is required to fill out this tab. This element specifies the value of the tab. Width of the tab. Reserved for future use. Optional element for field markup. When set to true it requires the signer to initial when they modify a shared field. Optional element for field markup. When set to true, enables field markup for the field. Height of the tab.

disableAutoSize

No

Boolean

locked name required value width mergeFieldXml requireInitialOnSharedChange

No No No No No No No

Boolean String Boolean String String String Boolean

shared

No

Boolean

height Radio Group Tab

No

String

Place this tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document. An example Radio Group tab json layout is shown below:
"radioGroupTabs": [{

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "groupName": "Radio Group 1", "radios": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "locked": false, "pageNumber": "1", "required": false, "selected": false, "value": "Radio", "xPosition": "234", "yPosition": "159" }, { "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "locked": false, "pageNumber": "1", "required": false, "selected": true, "value": "Radio", "xPosition": "236", "yPosition": "190" }], "recipientId": "1", "requireInitialOnSharedChange": false, "shared": false, "templateLocked": false, "templateRequired": false }],

371

The Radio Group tab parameters are: Name conditionalParentLabel Reqd? No Type String Description Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active. documentId Yes String This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute.

conditionalParentValue

No

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name groupName Reqd? No Type String Description

372

The group name for radio buttons that are grouped together. This can be a maximum of 500 characters. It works in conjunction with the radios parameter. This sets the locations and status for radio buttons that are grouped together. The information for each radio button is:: anchorString: Optional anchor text information for the radio button. If it is not used then the other anchor parameters are ignored anchorXOffset: This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. anchorYOffset: This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. anchorIgnoreIfNotPresent: True or false setting. If true, this tab is ignored if anchorString is not found in the document. anchorUnits: Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. locked: If true, the Signer cannot change the data in the tab. pageNumber: sets the page the radio button is located on. required: If true, the signer is required to fill out this tab. selected: Sets if this is radio button is selected. Use true/false to show the value is selected or not. Only one radio button can be true. value: if an X, this is the selected radio button. Only one radio button in a group can be selected. xPosition: This indicates the horizontal offset of the radio button on the page. yPosition: This indicates the vertical offset of the radio button on the page. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute.

Radios

No

Radio

recipientId

Yes

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name requireInitialOnSharedChange Reqd? No Type Boolean Description

373

Optional element for field markup. When set to true it requires the signer to initial when they modify a shared field. Optional element for field markup. When set to true, enables field markup for the field. Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender.

shared

No

Boolean

templateLocked

No

Boolean

templateRequired

No

Boolean

Sign Here Tab Place this tag to have a recipient place their signature in the document. The optional parameter sets if the signature is required or optional. An example Sign Here tab json layout is shown below:
"signHereTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "249", "yPosition": "15", "name": "Sign Here", "optional": false, "scaleValue": 1, "tabLabel": "Signature 3" }, }],

The Sign Here tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name anchorYOffset Reqd? No Type String

374 Description This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active.

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

documentId

Yes

String

This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute. Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin.

pageNumber recipientId

Yes Yes

String String

templateLocked

No

Boolean

templateRequired

No

Boolean

xPosition

Yes

String

yPosition

Yes

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name name optional Reqd? No No Type String Boolean Description

375

The names associated with the tab type. When true, the Sign Here tab is optional and the recipient is not required to add a signature in the tab to complete an envelope. Sets the size for Sign Here tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data.

scaleValue

No

String

tabLabel

Yes

String

Signer Attachment Tab Place this tag on the document when you want the recipient to add supporting documents to an envelope. An example Signer Attachment tab json layout is shown below:
"signerAttachmentTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "24", "yPosition": "153", "tabLabel": "Attachment 10", "required": true, }],

The Signer Attachment tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name anchorYOffset Reqd? No Type String

376 Description This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active.

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

documentId

Yes

String

This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute. Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin.

pageNumber recipientId

Yes Yes

String String

templateLocked

No

Boolean

templateRequired

No

Boolean

xPosition

Yes

String

yPosition

Yes

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name tabLabel Reqd? Yes Type String Description

377

The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the signer is required to fill out this tab.

required

No

Boolean

SSN Tab Place this tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. An example SSN tab json layout is shown below:
"ssnTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "24", "yPosition": "153", "bold": false, "font": "arial", "fontColor": null, "fontSize": null, "italic": false, "tabLabel": "SSN Field 13", "underline": false, "concealValueOnDocument": false, "disableAutoSize": false, "locked": false, "name": "Text", "required": true, "value": "", "width": 42, "mergeFieldXml": "", "requireInitialOnSharedChange": false, "shared": false, "height": 11, }],

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 The SSN tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description

378

Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active.

anchorYOffset

No

String

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

documentId

Yes

String

This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute. Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender.

pageNumber recipientId

Yes Yes

String String

templateLocked

No

Boolean

templateRequired

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name xPosition Reqd? Yes Type String Description

379

This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. If true, the information in the tab is bold. The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined.

yPosition

Yes

String

bold font

No No

Boolean Font

fontColor

No

FontColor

fontSize

No

FontSize

italic tabLabel

No Yes

Boolean String

underline

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name concealValueOnDocument Reqd? No Type Boolean Description

380

Optional element. If true the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. Disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. If true, the Signer cannot change the data in the tab. The names associated with the tab type. If true, the signer is required to fill out this tab. This element specifies the value of the tab. Width of the tab. Reserved for future use. Optional element for field markup. When set to true it requires the signer to initial when they modify a shared field. Optional element for field markup. When set to true, enables field markup for the field. Height of the tab.

disableAutoSize

No

Boolean

locked name required value width mergeFieldXml requireInitialOnSharedChange

No No No No No No No

Boolean String Boolean String String String Boolean

shared

No

Boolean

height Text Tab

No

String

This tag is an adaptable field that allows the recipient to enter different text information. An example Text tab json layout is shown below:
"textTabs": [{ "anchorString": null,

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "24", "yPosition": "153", "bold": false, "font": "arial", "fontColor": null, "fontSize": null, "italic": false, "tabLabel": "Data Field 13", "underline": false, "concealValueOnDocument": false, "disableAutoSize": false, "locked": false, "name": "Text", "required": true, "value": "", "width": 42, "mergeFieldXml": "", "requireInitialOnSharedChange": false, "shared": false, "validationMessage": "", "validationPattern": "", "height": 11, "isPaymentAmount": false }],

381

The Text tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility.

anchorYOffset

No

String

anchorIgnoreIfNotPresent

No

String

anchorUnits conditionalParentLabel

No No

String String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name conditionalParentValue Reqd? No Type String Description

382

Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active.

documentId

Yes

String

This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute. Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. If true, the information in the tab is bold. The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.

pageNumber recipientId

Yes Yes

String String

templateLocked

No

Boolean

templateRequired

No

Boolean

xPosition

Yes

String

yPosition

Yes

String

bold font

No No

Boolean Font

fontColor

No

FontColor

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name fontSize Reqd? No Type FontSize Description

383

The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined. Optional element. If true the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. Disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. If true, the Signer cannot change the data in the tab. The names associated with the tab type. If true, the signer is required to fill out this tab. This element specifies the value of the tab. Width of the tab. Reserved for future use.

italic tabLabel

No Yes

Boolean String

underline concealValueOnDocument

No No

Boolean Boolean

disableAutoSize

No

Boolean

locked name required value width mergeFieldXml

No No No No No No

Boolean String Boolean String String String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name Reqd? Type Boolean Description

384

requireInitialOnSharedChange No

Optional element for field markup. When set to true it requires the signer to initial when they modify a shared field. Optional element for field markup. When set to true, enables field markup for the field. Message to be displayed to the signer if the validation rule from validationPattern fails. This is optional and if not provided the default DocuSign message will be displayed. This can be a maximum of 250 characters. A regular expression that will be validated when data is entered in the field. This is optional and if not provided the default DocuSign validation rules will apply. This can be a maximum of 250 characters. Javascript RegEx object is used for regular expression validation. Regular expressions must be supported by this object to resolve. Height of the tab. When true, sets this as a payment tab. Can only be used with Text, Number, Formula or List tabs. The value of the tab must be a number.

shared

No

Boolean

validationMessage

No

String

validationPattern

No

String

height isPaymentAmount

No No

String Boolean

Title Tab Place this tag on the document where you want the recipients title to appear. An example Title tab json layout is shown below:
"titleTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1", "templateLocked": false, "templateRequired": false, "xPosition": "30", "yPosition": "103", "bold": false, "font": "arial", "fontColor": null, "fontSize": null, "italic": false,

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"tabLabel": "Title", "underline": false, "concealValueOnDocument": false, "disableAutoSize": false, "locked": false, "name": "Title", "required": true, "value": "Regular Guy", "width": 42 }],

385

The Title tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active. documentId Yes String This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute.

anchorYOffset

No

String

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

pageNumber recipientId

Yes Yes

String String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name templateLocked Reqd? No Type Boolean Description

386

Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. If true, the information in the tab is bold. The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic. The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined.

templateRequired

No

Boolean

xPosition

Yes

String

yPosition

Yes

String

bold font

No No

Boolean Font

fontColor

No

FontColor

fontSize

No

FontSize

italic tabLabel

No Yes

Boolean String

underline

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name concealValueOnDocument Reqd? No Type Boolean Description

387

Optional element. If true the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. Disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. If true, the Signer cannot change the data in the tab. The names associated with the tab type. If true, the signer is required to fill out this tab. This element specifies the value of the tab. Width of the tab.

disableAutoSize

No

Boolean

locked name required value width Zip Tab

No No No No No

Boolean String Boolean String String

Place this tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. An example Zip tab json layout is shown below:
"zipTabs": [{ "anchorString": null, "anchorXOffset": null, "anchorYOffset": null, "anchorIgnoreIfNotPresent": null, "anchorUnits": null, "conditionalParentLabel": null, "conditionalParentValue": null, "documentId": "1", "pageNumber": "1", "recipientId": "1",

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

"templateLocked": false, "templateRequired": false, "xPosition": "24", "yPosition": "153", "bold": false, "font": "arial", "fontColor": null, "fontSize": null, "italic": false, "tabLabel": "Zip Field 13", "underline": false, "concealValueOnDocument": false, "disableAutoSize": false, "locked": false, "name": "Text", "required": true, "value": "", "width": 42, "mergeFieldXml": "", "requireInitialOnSharedChange": false, "shared": false, "height": 11, }],

388

The Zip tab parameters are: Name anchorString anchorXOffset Reqd? No No Type String String Description Specifies string searched for to place the tab in the document. This specifies tab location as XOffset position, using the anchorUnits, from the anchorString. This specifies tab location as YOffset position, using the anchorUnits, from the anchorString. True or false setting. If true, this tab is ignored if anchorString is not found in the document. Specifies units of the X and Y offset. Units could be pixels, mms, cms or inches. Optional element. For conditional fields this is the TabLabel of the parent tab that controls this tabs visibility. Optional element. For conditional fields this is the Value of the parent tab that controls this tabs visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use on as the value to show that the parent tab is active.

anchorYOffset

No

String

anchorIgnoreIfNotPresent

No

String

anchorUnits

No

String

conditionalParentLabel

No

String

conditionalParentValue

No

String

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name documentId Reqd? Yes Type String Description

389

This is the document ID number that the tab is placed on. This must refer to an existing Documents ID attribute. This specifies the page number where the tab will be affixed. This specifies the recipient associated with the tab. Must refer to an existing recipients ID attribute. Optional element. Used only when working with template tabs. If true, the attributes of the tab cannot be changed by the sender. Optional element. Used only when working with template tabs. If true, the tab cannot be removed by the sender. This indicates the horizontal offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. This indicates the vertical offset of the tab on the page, in a coordinate space that has left top corner of the document as origin. If true, the information in the tab is bold. The font type used for the information in the tab. Possible values are: Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, and Verdana. The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. If true, the information in the tab is italic.

pageNumber recipientId

Yes Yes

String String

templateLocked

No

Boolean

templateRequired

No

Boolean

xPosition

Yes

String

yPosition

Yes

String

bold font

No No

Boolean Font

fontColor

No

FontColor

fontSize

No

FontSize

italic

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name tabLabel Reqd? Yes Type String Description

390

The label used with the tab. This can be a maximum of 500 characters. Notes: Making a tabs TabLabel the same will cause the all like fields to update when the user enters data. If true, the information in the tab is underlined. Optional element. If true the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. Disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. If true, the Signer cannot change the data in the tab. The names associated with the tab type. If true, the signer is required to fill out this tab. This element specifies the value of the tab. Width of the tab. Reserved for future use. Optional element for field markup. When set to true it requires the signer to initial when they modify a shared field. Optional element for field markup. When set to true, enables field markup for the field.

underline concealValueOnDocument

No No

Boolean Boolean

disableAutoSize

No

Boolean

locked name required value width mergeFieldXml requireInitialOnSharedChange

No No No No No No No

Boolean String Boolean String String String Boolean

shared

No

Boolean

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Name height Reqd? No Type String Description Height of the tab.

391

Error Code Information

The DocuSign REST APIs return either 200 (OK) or 201 (Created) when an API call successfully runs to completion, and status codes in the 400-500 range for failures. For APIs that process a single item, this overall status code determines success/failure. There are special considerations for PUT and POST calls that process multiple items, refer to the Error Response Handling for API calls that Support Multiple Items section for more information on error response handling. If an API call is not successful, the HTTP response code returned is generally one of the following: 400 (BadRequest) This indicates that a portion of the request made to the API call was not valid or could not be processed in the current context. 401 (Unauthorized) This indicates that the the authentication or authorization required for the API call did not pass. 404 (NotFound) This indicates that the resource being accessed does not exist. This might occur on GET or DELETE requests. 415 (UnsupportedMediaType) This indicates that the data type of some data in the request is not supported.

The following error codes occur with much less frequency: 405 (MethodNotAllowed) This generally indicates that the HTTP Method (GET, PUT, POST or DELETE) is not valid for this resource URI. 500 (InternalServerError) This indicates that an internal server-side error has occurred.

In most cases, a more detailed errorDetails structure is returned as the response body when an error occurs. However, depending on the error, it is also possible that the server will return HTML in place of the errorDetails structure or no errorDetails was deemed necessary and it is omitted. The table of Error Codes and Associated Messages lists the possible error codes and messages.

General Error Response Handling

The general flow for response handling is:
if (statusCode == 200 || statusCode == 201) { // successful call - but do special processing for multi-item } else if (statusCode == 404) { // call was processed but the resource being accessed was not // envelope doesnt exist, user doesnt exist, etc. There may in the errorDetails response. } else // other errors { var errorDetails = Json.Decode(response.body); if (errorDetails!= null) { // process errorDetails.errorCode - See table of error if (errorDetails.message != null)

PUT & POST requests

found not be any more details

codes

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

{

392

// use errorDetails.message to get more information in textual form. } } }

Error Response Handling for API calls that Support Multiple Items
The DocuSign REST API supports many calls that operate on multiple items, such as adding one or more users to an account or adding one or more documents to a draft envelope. This is done to decrease the number of web callouts required to perform some common operations. For API calls that support multiple items, the overall HTTP response code will be 200 (OK) or 201 (Created) if the API call has run to completion, which means all items in the request structure were able to be processed. This response code is returned even if there were failures for individual items in the array. The response body contains information about each item processed and the structure for each item contains a non-null errorDetails structure if that item was not successfully processed. The caller is responsible for checking for the errorDetails structure for each item in the array to perform proper error handling. The general response processing logic for these types of APIs is:
if (statusCode == 200 || statusCode == 201) { // check for errors with each item processed. var itemsArray = Json.Decode(response.body); foreach(var item in itemsArray) { if (item.errorDetails != null) { // an error occurred during processing - handle it string errorCode = item.errorDetails.errorCode; string errorMessage = item.errorDetails.message; // perform error handling based on errorCode } else { // item processing was successful } } } else { // statusCode indicated overall error with the request. }

Error Codes and Associated Messages

The following table lists all of the error codes (errorDetails.errorCode) and associated messages (errorDetails.message). Note that in many cases, additional information is added to the message string. Error Code ACCOUNT_DOES_NOT_EXIST_IN_SYSTEM Message (Base) The AccountID did not identify an Account in the system. The specified Account is suspended

ACCOUNT_HAS_BEEN_SUSPENDED

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Error Code ACCOUNT_LACKS_PERMISSIONS ACCOUNT_LACKS_PRICING_PLAN Message (Base) This Account lacks sufficient permissions.

393

The specified Account lacks an Account Pricing Plan This account is not authorized to access the requested envelope. The token for a recipient that has failed activation cannot be generated. Invalid address book share permissions. Invalid Email for the address book entry. Invalid ID for the address book entry. Invalid Owner for the address book entry. The specified Anchor Tab string was not found in the document. An Error Occurred during anchor tag processing. The billing plan could not be changed. Account does not have permission to set Allow Markup. Multiple Send to Manage Roles (Agent, Editor or Intermediary) cannot be assigned same routing order. Send to Manage Role (Agent, Editor or Intermediary) cannot have tabs assigned. Envelopes may not be deleted from the RecycleBin Account does not have permission to send to Agent recipient type. Account does not have permission to send to Certified Delivery recipient type. Account does not have permission to send to

ACCOUNT_NOT_AUTHORIZED_FOR_ ENVELOPE ACTIVATION_FAILED

ADDRESSBOOK_CANTSHARE ADDRESSBOOK_EMAIL_INVALID ADDRESSBOOK_ID_INVALID ADDRESSBOOK_NOTOWNER ANCHOR_TAB_STRING_NOT_FOUND

ANCHOR_TAG_PROCESSING_FAILURE BILLING_PLAN_ERROR CANNOT_ALLOW_MARKUP

CANNOT_ASSIGN_MANAGERS_SAME_ ROUTING_ORDER

CANNOT_ASSIGN_TAB_TO_MANAGERROLE

CANNOT_DELETE_FROM_RECYCLEBIN

CANNOT_SEND_TO_AGENT

CANNOT_SEND_TO_CERTIFIED_DELIVERY

CANNOT_SEND_TO_EDITOR

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Error Code Message (Base) Editor recipient type. CANNOT_SEND_TO_INTERMEDIARY

394

Account does not have permission to send to Intermediary recipient type. A carbon copy recipient has been specified as captive. This operation is not supported. Captive Recipient cannot be of type In Person Signer. A conditional tab references an invalid parent. Parent label must match another tab. Only one parent allowed. Signature tabs may not be parent tabs. The corrected email(s) are reserved. The specified envelope correction has a blank username. The specified envelope correction has a username with invalid characters.

CAPTIVE_CARBON_COPY_RECIPIENT_NOT_ SUPPORTED CAPTIVE_IN_PERSON_SIGNER_RECIPIENT_ NOT_SUPPORTED CONDITIONALTAB_HAS_INVALID_PARENT

CORRECTED_EMAIL_IS_RESERVED CORRECTION_HAS_A_BLANK_USERNAME

CORRECTION_HAS_A_USERNAME_WITH_ INVALID_CHARACTERS

CORRECTION_HAS_DUPLICATE_RECIPIENTS The specified envelope corrections have duplicate recipients. CORRECTION_RESULTS_IN_DUPLICATE_ RECIPIENTS CUSTOMTAB_IS_INCOMPLETE The specified envelope corrections result in duplicate recipients. A Custom Tab is not Complete. A Custom Tab requires both a Name and a TabLabel. The document specified was not found. The recipient Editor must be an existing DocuSign account member. The specified email(s) are reserved. The email address does not specify an active user. The email address is not shared. Envelope already exported.

DOCUMENT_DOES_NOT_EXIST EDITOR_MUST_HAVE_ACCOUNT

EMAIL_IS_RESERVED EMAIL_NOT_ACTIVE

EMAIL_NOT_SHARED ENVELOPE_AC_EXPORT_COMPLETED

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Error Code ENVELOPE_AC_EXPORT_INVALID_STATUS ENVELOPE_AC_EXPORT_INVALID_TRANSID ENVELOPE_AC_EXPORT_NOT_AC_COPY ENVELOPE_ALLOWANCE_EXCEEDED Message (Base) Envelope is not in the correct export status. Invalid transaction ID. Envelope not authoritative copy.

395

The envelope allowance for the account has been exceeded. Only envelopes in the 'Sent' or 'Delivered' states may be corrected. Envelopes with AC Status - Deposit Pending or Deposited or Deposited As Authoritative Copy or Deposit Failed cannot be transferred. The specified envelope is not in a terminal state and cannot be transferred. Only envelopes in the 'Sent' or 'Delivered' states may be voided. The envelope specified either does not exist or you have no rights to it. The envelope you are attempting to access has been voided by the sender. For more information, please contact the sender: The specified envelope has duplicate recipients. The specified envelope has In-Session recipients. The specified envelope has no recipients. The Envelope is not Complete. A Complete Envelope Requires Documents, Recipients, Tabs, and a Subject Line. The requested envelope is not a draft. Sign on paper has not been enabled for this envelope. The envelope does not exist in the folder

ENVELOPE_CANNOT_CORRECT_INVALID_ STATE ENVELOPE_CANNOT_TRANSFER_INVALID_ ACSTATUS

ENVELOPE_CANNOT_TRANSFER_INVALID_ STATE ENVELOPE_CANNOT_VOID_INVALID_STATE

ENVELOPE_DOES_NOT_EXIST

ENVELOPE_HAS_BEEN_VOIDED

ENVELOPE_HAS_DUPLICATE_RECIPIENTS ENVELOPE_HAS_INSESSION_RECIPIENTS ENVELOPE_HAS_NO_RECIPIENTS ENVELOPE_IS_INCOMPLETE

ENVELOPE_NOT_DRAFT ENVELOPE_NOT_ENABLED_WETSIGN

ENVELOPE_NOT_IN_FOLDER

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Error Code ENVELOPE_ONLYTHREECUSTOMFIELDS_ ALLOWED Message (Base)

396

Only three custom fields allowed per envelope.

ENVELOPE_TRANSFEREE_ALREADY_OWNS_ The specified transfer recipient of the envelope is ENVELOPE already the owner of the envelope. FAILED_EMAIL_SENDING FAILED_SCHEMA_VALIDATION Email sending failed. Schema validation Failed. Additional Errors follow. Fax Recipient Token must be of type Signer. Fax Recipient cannot be corrected after sent. Fax Recipient must be the only recipient at a routing order. Fax Recipient Type must be a signer. The data could not be converted. Recipient Calculated Fields have a circular reference. The maximum number of hourly API invocations has been exceeded. For In Person Signer type, the Recipient Signer Name cannot be blank. The In Person Signing Host must be a valid and active DocuSign user. The value for 'country' is not supported. The value for 'state' is not supported. The Anchor Tab String Format is invalid. AppToken is invalid or distributor not found for AppToken The billing plan is retired and cannot be used. Invalid Successor Billing Plan.

FAX_BACK_MUST_BE_SIGNER FAX_RECIPIENT_CORRECT_WAS_SENT FAX_RECIPIENT_ROUTING

FAX_RECIPIENT_TYPE_NOT_SUPPORTED FORMAT_CONVERSION_ERROR FORMULA_CIRCULAR_REFERENCE

HOURLY_APIINVOCATION_LIMIT_EXCEEDED

IN_PERSON_SIGNER_NAME_CANNOT_BE_ BLANK IN_PERSON_SIGNING_HOST_MUST_BE_ VALID_USER INVALID_ADDRESS_COUNTRY INVALID_ADDRESS_STATE INVALID_ANCHOR_TAB_STRING INVALID_APPTOKEN

INVALID_BILLING_PLAN_RETIRED INVALID_BILLING_PLAN_SUCCESSOR

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Error Code INVALID_CAPTIVE_RECIPIENT_OPERATION INVALID_CHARACTERS_PROVIDED INVALID_CONTENT_TYPE INVALID_CONTENT_TRANSFER_ENCODING INVALID_CREDIT_CARD_INFORMATION Message (Base) Invalid operation on captive recipient. Invalid characters detected Content Type specified is not supported.

397

Invalid 'content transfer encoding' for envelope. The credit card information supplied was not valid. The Distributor specified is not valid. The DocumentId provided is invalid. Invalid email address. The email address for the recipient is invalid. The recipient Id follows. The email address for the sender is invalid. Invalid envelope expiration and/or reminder information provided. Fax Number is invalid. The folder type specified is not valid. An error was found while parsing the multipart request. The password is invalid. Invalid forgotten password challenge. The PlanId specified is not valid. A recipient ID is missing or invalid. Invalid recipient status for delete. The request body is missing or improperly formatted. The request contained at least one invalid

INVALID_DISTRIBUTOR INVALID_DOCUMENT_ID INVALID_EMAIL_ADDRESS INVALID_EMAIL_ADDRESS_FOR_RECIPIENT

INVALID_EMAIL_ADDRESS_FOR_SENDER INVALID_EXPIRATION_REMINDER_DATA

INVALID_FAXNUMBER INVALID_FOLDER_TYPE INVALID_MULTI_PART_REQUEST

INVALID_PASSWORD INVALID_PASSWORD_CHALLENGE INVALID_PLANID INVALID_RECIPIENT_ID INVALID_RECIPIENT_STATUS_FOR_DELETE INVALID_REQUEST_BODY

INVALID_REQUEST_PARAMETER

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Error Code Message (Base) parameter. INVALID_REQUEST_RESPONSE_OVERRIDE_ FORMAT INVALID_SOCIAL_INFORMATION

398

The URL override format is not supported. Use supported formats such as .json or .xml. The Social Provider information specified is not valid. Social Provider is not valid. Social Provider User Name is not valid. The Tab formula is not valid. The Tab specified is not valid for the requested operation. The security token format does not conform to expected schema. The specified User Offset exceeds the page boundaries. Invalid UserId. The user name is invalid. The user name for the recipient is invalid. Authentication is not setup correctly for the recipient. Janrain request Error. The maximum number of members for the account has been exceeded. The maximum number of tabs was exceeded. The HTTP method specified is not allowed with this resource. Mobile notifier configuration failed. More than one signer attachment tab is placed on a signer attachment document for a recipient.

INVALID_SOCIAL_PROVIDER INVALID_SOCIAL_USER_NAME INVALID_TAB_FORMULA INVALID_TAB_OPERATION

INVALID_TOKEN_FORMAT

INVALID_USER_OFFSET

INVALID_USERID INVALID_USERNAME INVALID_USERNAME_FOR_RECIPIENT INVALIDAUTHENTICATIONSETUP

JANRAIN_REQUEST_ERROR MAX_MEMBERS_EXCEEDED

MAX_TABS_EXCEEDED METHOD_NOT_ALLOWED

MOBILE_NOTIFIER_CONFIG_FAILED MULTIPLESATABSONDOCUMENT

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Error Code MUST_ENABLE_SIGNONPAPER NO_DOCUMENT_RECEIVED Message (Base)

399

EnableWetSign must be set on the envelope. The document element did not contain the encoded document, or there is a problem with the encoding. No signer attachment tabs found on a signer attachment document. Functionality not supported. Freeform signing is not allowed for your account because it conflicts with other settings, please place signing tabs for each signer. The sender specified is not part of a group that the Partner is authorized to send for. PDF URL Inaccessible A requested plan item is not enabled for this account. Purchased envelopes not added. This recipientId already exists.

NOSATABONSADOCUMENT

NOT_SUPPORTED ONESIGNALLSIGN_NOT_SATISFIED

PARTNER_NO_AUTHORITY_FOR_SENDER

PDF_INACCESSIBLE PLAN_ITEM_NOT_ENABLED

PURCHASED_ENVELOPES_NOT_ADDED RECIPIENT_ALREADY_EXISTS_IN_ ENVELOPE RECIPIENT_HAS_FAILED_SECURITY_CHECK

The requested user has failed the security check for the requested envelope. Correct the envelope to continue. The specified recipient has invalid Routing Order. Account settings indicate the recipient must be an active DocuSign user. Recipient must not have an active account. The specified recipient is not a captive recipient. This operation requires a captive recipient.

RECIPIENT_HAS_INVALID_ROUTINGORDER RECIPIENT_MUST_BE_VALID_USER

RECIPIENT_NOT_ACCOUNTLESS RECIPIENT_NOT_CAPTIVE

RECIPIENT_NOT_FOUND_FOR_CORRECTION The specified User is not a recipient of the specified envelope. RECIPIENT_NOT_IN_SEQUENCE The token for an out of sequence recipient cannot be generated.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Error Code RECIPIENT_NOT_SIGNER RECIPIENT_UPDATE_FAILED RECIPIENTS_NOT_PROVIDED REDUNDANT_API_DOCUMENT_ACCESS REGULAREXPRESSION_IS_INVALID REQUIRED_SECURITY_CHECK_URL_ MISSING Message (Base) Recipient is not a signer type. The recipient could not be updated. No recipients were found in the request. Redundant API document access violation The regular expression provided is not valid.

400

A security check was specified for the recipient but the appropriate callback URL was not provided. The URL provided does not resolve to a resource. A signer attachment tab is placed on a non-signer attachment document (a document without an AttachmentDescription). The UserName and Email did not identify a sender in the system. The signature specified was not found. One or more Signer type recipients have not been assigned any signable tabs. A 'Send on Behalf Of' user is not permitted for this operation. This social provider account is already mapped in the system. A Mergefield value for a Tab could not be retrieved. Tab is placed off of the page. Page number not specified in tab element. The pagenumber specified in the tab element is not in the document that the tab refers to. The DocumentId specified in the tab element does not refer to a document in this envelope.

RESOURCE_NOT_FOUND SATABONNONSADOCUMENT

SENDER_DOES_NOT_EXIST_IN_SYSTEM

SIGNATURE_NOT_FOUND SIGNER_RECIPIENT_HAS_NO_SIGNABLE_ TABS SOBO_USER_NOT_ALLOWED

SOCIAL_PROVIDER_ALREADY_MAPPED

TAB_MERGEFIELD_VALUE_NOT_RETRIEVED

TAB_OUT_OF_BOUNDS TAB_PAGE_NUMBER_NOT_SPECIFIED TAB_PAGENUMBER_IS_NOT_IN_DOCUMENT

TAB_REFERS_TO_MISSING_DOCUMENT

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Error Code TAB_REFERS_TO_MISSING_RECIPIENT Message (Base)

401

The RecipientId specified in the tab element does not refer to a recipient of this envelope. Unable to add AdditionalTabs from Templates to Envelope. Not authorized to change template. Cannot add the document for the template. The document ID has already been used.

TEMPLATE_ADDITIONALTABS_ERROR

TEMPLATE_AUTHENTICATION_FAILED TEMPLATE_CANNOT_ADD_DOCUMENT TEMPLATE_DOCUMENTID_MAPPING_ INVALID TEMPLATE_ID_INVALID TEMPLATE_MERGE_INVALID_ROUTE_ ORDER TEMPLATE_NOT_PROVIDED TEMPLATE_OVERRIDE_ ENVELOPEINFORMATION_ERROR TEMPLATE_OVERRIDE_RECIPIENTDATA_ ERROR TEMPLATE_RECIPIENTID_FOR_ROLE_ NOTFOUND TEMPLATE_REQUIRED_RECIP_NOT_ SATISFIED TEMPLATE_ROLESPECIFIED_DOES_NOT_ EXIST TEMPLATE_TO_ENVELOPE_ERROR

Invalid template ID. The routing order of the recipients is not valid.

Template was not provided. Unable to override Envelope data from EnvelopeInformation. Unable to override recipient data from Recipients to Envelope. Recipient ID not found in the Recipient list for the role. Required recipient in the template has not been provided. Role does not exist in the template.

Unable to transform Template and data to Envelope. Unable to flatting PDF for the Template. Unable to load template. Unable to load field data from PDF. Unable to process field data for the Template.

TEMPLATE_UNABLE_TO_FLATTEN_PDF TEMPLATE_UNABLE_TO_LOAD TEMPLATE_UNABLE_TO_LOAD_FIELDDATA TEMPLATE_UNABLE_TO_PROCESS_ FIELDDATA

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Error Code TRANSACTIONID_DOES_NOT_EXIST TRANSACTIONID_REDUNDANT TRANSACTIONID_UNABLE_TO_SUBMIT UNABLE_TO_CONVERT_DOCUMENT Message (Base) The transaction ID does not exist.

402

The transaction ID has already been submitted. Unable to submit the transaction for processing. System was unable to convert this document to a PDF. Unable to delete document. Unable to load the document. Unable to purge documents. The recipient you have identified is not a valid recipient of the specified envelope. Username and email combination already exists for this account. One or both of Username and Password are invalid. This user name and email are awaiting activation. The specified User is not a member of the specified Account. The UserID did not identify a User in the system. The UserID does not have a valid membership in this Account. This User lacks sufficient permissions. Account or user does not have permission to set recipient email notifications.

UNABLE_TO_DELETE_DOCUMENT UNABLE_TO_LOAD_DOCUMENT UNABLE_TO_PURGE_DOCUMENTS UNKNOWN_ENVELOPE_RECIPIENT

USER_ALREADY_EXISTS_IN_ACCOUNT

USER_AUTHENTICATION_FAILED

USER_AWAITING_ACTIVATION USER_DOES_NOT_BELONG_TO_SPECIFIED_ ACCOUNT USER_DOES_NOT_EXIST_IN_SYSTEM USER_LACKS_MEMBERSHIP

USER_LACKS_PERMISSIONS USER_LACKS_ RECIPIENTEMAILNOTIFICATION_ PERMISSION USER_NOT_ACCOUNT_ADMIN USER_NOT_ENVELOPE_SENDER

User is not an account administrator. This user is not the sender of the envelope. Only the sender of the envelope may perform the requested operation.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 Error Code USER_NOT_ENVELOPE_SENDER_OR_ RECIPIENT Message (Base)

403

This user is not the sender or a recipient of the envelope. Only the sender or a recipient of the envelope may perform the requested operation. The user does not own the folder The specified username(s) and email(s) are not in our system and the email does not allow new users.

USER_NOT_FOLDER_OWNER USERNAME_IS_NOT_ALLOWED

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

404

Appendix 1: DocuSign SOAP API to REST API

If you already use the DocuSign API you might be able to leverage some of your existing code and experiences for use with the REST API. The following table shows how DocuSign SOAP API methods related to REST URIs.

DocuSign SOAP
AddMembersToAccount (AcctMgmt) ChangeAccountPricePlan (AcctMgmt) ChangePassword (AcctMgmt) CheckAccountMember (AcctMgmt) CloseSignature (AcctMgmt) CorrectAndResendEnvelope (dsapi) CreateAndSendEnvelope (dsapi) CreateEnvelope (dsapi) CreateEnvelopeFromTemplates (dsapi) DeleteEnvelopes (dsapi)

REST URI and HTTP Method

/accounts/{accounted}/users POST /accounts/{accountsId}/billing_plan PUT /login_information/password PUT /accounts/{accountId}/users?email=<email> GET /accounts/{accountId}/users/{userId}/signatures/{signatureName} DELETE /accounts/{accountId}/envelopes/{envelopeId}/recipients PUT /accounts/{accountId}/envelopes POST /accounts/{accountId}/envelopes POST /accounts/{accountId}/envelopes POST /accounts/{accounted}folders/{folderId} Use recyclebin as folderId PUT /accounts/{accountId} GET /accounts/{accountId} GET /accounts/{accountId}/settings GET /accounts/{accountId}/settings GET /accounts/{accountId}/views/console POST /accounts/{accounted}folders/{folderId} GET /accounts/{accounted}folders GET /accounts/{accountId}/users/{userId}/settings GET

GetAccountDistributorCode (AcctMgmt) GetAccountInformation (AcctMgmt) GetAccountSettings (AcctMgmt) GetAccountSettingsList (dsapi) GetAutheticationToken (Cred, dsapi) GetFolderItems (dsapi) GetFolderList GetMemberSettings (AcctMgmt)

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 DocuSign SOAP

GetPlanGroupInformation (AcctMgmt) GetPlanPricingInformation (AcctMgmt) GetProvisioningInformation (AcctMgmt) GetRecipientList (dsapi) GetSuccessorPlanInformation (AcctMgmt) GetUserProfile (AcctMgmt) GetUserProfileImage (AcctMgmt) Login (Cred) MoveEnvelopes (dsapi) NewAccount (AcctMgmt) NewSocialAccount (AcctMgmt) RequestCertificate (dsapi) RequestCorrectToken (Cred) RequestEnvelope (dsapi) RequestPDF (dsapi)

405

REST URI and HTTP Method

/billing_plans GET /billing_plans/{planId} GET /accounts/provisioning GET /accounts/{accountId}/recipient_names?email=<email address> GET /accounts/{accounted}/billing_plan GET /accounts/{accountId}/users/{userId}/profile GET /accounts/{accountId}/users/{userId}/profile/image GET /login_information GET /accounts/{accounted}folders/{folderId} PUT /accounts POST /accounts POST /{accountId}/envelopes/{envelopeId}/documents/certificate GET /accounts/{accountId}/envelopes/{envelopeId}/views/correct POST /accounts/{accountId}/envelopes/{envelopeId} GET /accounts/{accountId}/envelopes/{envelopeId}/documents/{documen tId} GET /accounts/{accountId}/envelopes/{envelopeId}/documents/combined watermark=false GET /accounts/{accountId}/envelopes/{envelopeId}/documents/combined GET /accounts/{accountId}/envelopes/{envelopeId}/views/recipient POST /accounts/{accountId}/envelopes/{envelopeId}/views/sender POST /accounts/{accountId}/envelopes/{envelopeId}/recipients GET

RequestPDFNoWaterMark (dsapi)

RequestPDFWithCert (dsapi) RequestRecipientToken (dsapi) RequestSenderToken (Cred) RequestStatus (dsapi)

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2 DocuSign SOAP

RequestStatus (dsapi) RequestStatusChanges (dsapi) RequestStatusCodes (dsapi) RequestTemplate (dsapi) RequestTemplates (dsapi) SaveTemplate (dsapi) SendEnvelope (dsapi)

406

REST URI and HTTP Method

/accounts/{accountId}/envelopes/{envelopeId} GET /accounts/{accountId}/envelopes GET /accounts/{accountId}/templates/{templateId} GET /accounts/{accountId}/templates GET /accounts/{accountId}/templates POST /accounts/{accountId}/envelopes/{envelopeId}/status Add {status:sent} in request body. PUT /accounts/{accountId}/users/{userId}/signatures/{signatureName} PUT /accounts/{accountId}/users/{userId}/profile PUT /accounts/{accountId}/users/{userId}/profile/image PUT /accounts/{accountId}/settings PUT /accounts/{accountId}/users/{userId}/settings PUT /accounts/{accountId}/envelopes/{envelopeId} Add {status:voided, statusReason:voided reason} in request body. PUT

SetSignatureImage (AcctMgmt) SetUserProfile (AcctMgmt) SetUserProfileImage (AcctMgmt) UpdateAccountSettings (AcctMgmt) UpdateMemberSettings (AcctMgmt) VoidEnvelope (daspi)

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

407

Appendix 2: Time Zones and Date/Time Format Information

This appendix provides information on how time zone and date/time format information is set for an account and how it appears in the DocuSign web console, Certificate of Completion, and API responses. The appendix also has information on the expected date/time formats for API requests.

Account Settings
There are a number of account settings that determine the time zone and date/time format used for an account. These options are set in the DocuSign web console Preferences Features; some can be set through the API account settings. Default Account Time Zone: This option selects the default time zone to be used in the User Interface display. A member of the account can set their own time zone preference to override the account default if the Allow account member to set their own unique time zone option (see below) is enabled. Time Zone Used For API: This option selects the default time zone used for DocuSign SOAP API operations. Format for Date Signed: This option selects the date format applied to the Date Signed tags. Format for Time Signed: This option selects the time format applied to the Date Signed tags. You can also select to Include AM/PM designation for the time format. Allow account member to set their own unique time zone: When selected, account members can set their own personal time zone, which can be different that the default account time zone. If the Allow account member to set their own unique time zone option is selected, there are two options the account members can set by a user: My local time zone: This option selects the default time zone to be used in the account members DocuSign web console. Format my local date and time: This option selects the date/time format used in the account members DocuSign web console and the format used when the account member signs envelopes.

Time Zone and Date/Time Format Appearance

How the time zone and date/time format appears depends on what is being viewed, who is viewing the information, and the settings for the account. Signing user interface and PDF documents: The time zone and date/time format information shown in Date tags and form data in the signing user interface and PDF documents depends on the signer: If the signer has a DocuSign account, then the signer's time zone and the sender's date/time format settings are used for the information. If the senders account does not allow users to set their own date/time format, then the date/time format setting for the account is used. If the signer does not have a DocuSign account, then the sender's time zone and date/time format settings are used. If the senders account does not allow users to set their own time zones or date/time format, then the account settings are used. Certificate of Completion: The sender's time zone and date/time format settings are used. If the senders account does not allow users to set their own time zone and date/time format, then the account time zone and date/time format settings are used.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

DocuSign REST API Guide, version 2

408

Envelope History: When viewing History through the web console or signing user interface, the time zone and date/time format used depends on the viewer: If the sender is viewing the History, the sender's time zone and date/time format settings are used. If the senders account does not allow users to set their own time zones or date/time format, then the account settings are used. If the viewer has a DocuSign account that allows users to set their own time zone and date/time format, then the viewer's time zone and date/time format settings are used. If the viewer has a DocuSign account that does not allow users to set their own time zone and date/time format, then the account time zone and date/time format settings are used. If the viewer does not have a DocuSign account, then the sender's time zone and date/time format are used. If the senders account does not allow users to set their own time zones or date/time format, then the account settings are used. REST API: When getting information from the REST API, all non-PDF time zone responses are returned in ISO 8601 date/time format using GMT as the time zone. PDF items retrieved through the REST API, such as a Certificate of Completion or documents with date tags, use Certificate of Completion and PDF documents settings previously described. SOAP API: When getting information from the SOAP API, all non-PDF items use the time zone set by the Time Zone Used For API option. PDF items retrieved through the SOAP API, such as a Certificate of Completion or documents with date tags, use Certificate of Completion and PDF documents settings previously described.

Date/Time Formats for API Calls

All DocuSign SOAP and REST API requests must use ISO 8601 date/time formats. The following date/time formats are accepted in the DocuSign APIs: "M/d/yyyy" "MMMM d, yyyy" "dd-MM-yy" "dd-MM-yyyy" "MMM-dd-yyyy" "MMMM d, yyyy | HH:mm" "dd-MM-yy | HH:mm" "dd-MM-yyyy | HH:mm" "MMM-dd-yyyy | HH:mm" "yyyy-MM-dd" "yyyy-MM-dd | HH:mm"

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.

221 Main Street, Suite 1000, San Francisco, CA 94105 Tel. 866.219.4318 www.docusign.com DocuSign, Inc.