Docusign Properties

AllowMarkup

bool

When TRUE, document markup is allowed. With document markup, recipients can make changes to your documents by covering up existing text and adding new text. This is an account-wide permission that must be turned on by a Docusign employee, i.e. an Account Manager.

FALSE

AllowReassign

bool

When TRUE, the recipient can redirect an envelope to a more appropriate recipient.

FALSE

AllowRecipientRecursion

bool

When TRUE, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.

FALSE

Asynchronous

bool

When 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. This property is useful when you do not want to wait for Docusign to respond with the API response. A synchronous call is made later that would include not only status but also EnvelopeID. Keep in mind that this does rely on TransactionID, so make sure that is included when leveraging this property.

FALSE

AuthTypes - Facebook

enum

Authorize signers via a Facebook account

AuthTypes - Google

enum

Authorize signers via a Google account

AuthTypes - IDCheck

enum

Authorize signers via a list of questions

AuthTypes - LinkedIn

enum

Authorize signers via a Linkedin account

AuthTypes - LiveID

enum

Authorize signers via a LiveID account

AuthTypes - NoIDCheck

enum

Signers will not be authorized in any way before signing the form

AuthTypes - OpenID

enum

Authorize signers via an OpenID account

AuthTypes - Phone

enum

Authorize signers via a code called in to a phone number

AuthTypes - Salesforce

enum

Authorize signers via a Salesforce account

AuthTypes - SMS

enum

Authorize signers via a code texted to a phone number

AuthTypes - SocialAll

enum

Show only the social media options (Twitter, Facebook, etc.) for authorization, as well as No Identity Check

AuthTypes - Twitter

enum

Authorize signers via a Twitter account

AuthTypes - Yahoo

enum

Authorize signers via Yahoo account

AuthUserID

string

Sets the CustomerUserID asociated to the token that will be used for authentication. Beginning in version 5.5, all tokens should have a CustomerUserID (not null). Note: CustomerUserID can be thought of as an alias string, created by you, to associate to different Docusign tokens. It is not assigned by Quik!. Quik! allows for unlimited CustomerUserIDs to be created, though there may be token creation limits with Docusign.

""

AuthoritativeCopy

bool

When TRUE, Docusign's Authoritative copy feature is enabled. When enabled, an authoritative copy of the signed document will be held on your Docusign account.

FALSE

AutoNavigation

bool

When TRUE, auto-navigation is enabled for the envelope. The auto-navigation method used is determined by the account setting.

FALSE

BrandId

string

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.

""

BrandLock

bool

When TRUE, the brand profile associated with the envelope cannot be changed. This is only managed in the Docusign API.

FALSE

CustomFields

DocusignCustomFields

Complex element contains a list of names and values. Element can specify if the name value pair needs to be entered before sending the envelope. It can also specify if the name value pair needs to be shown to user who is sending the envelope.

Reserved CustomField names:

##SFAccount

##SFContract

##SFOpportunity

##SFCase

Reserved field names can be used to link data from Docusign Connect to Salesforce.

Important: If custom fields are set here when sending the envelope, only the fields specified in this section are included in the envelope. This overrides any required account level custom fields.

null

EmailSettings

DocusignEmailSettings

 
This optional complex element allows sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent.

When the EmailSettings information is used for an envelope, it only applies to that envelope.

IMPORTANT: The EmailSettings information is not returned in the response when an envelope is created or in the RequestEnvelope response.

EmailSettings consists of: ReplyEmailAddressOverride, ReplyEmailNameOverride, BCCEmailAddresses

null

BccEmailAddresses

list of string

A list of up to 5 Email addresses the envelope is sent to as a BCC email. Docusign verifies that the email format is correct, but does not verify that the email is active. This can be a maximum of 100 characters. Using this overrides the BCC for Email Archive information setting for this envelope.

null

ReplyEmailAddressOverride

string

The Reply To email used for the envelope. Docusign will verify a correct email format is used, but does not verify that the email is active. This can be a maximum of 100 characters.

""

ReplyEmailNameOverride

string

The name associated with the Reply To email address. This can be a maximum of 100 characters.

""

EnableWetSign

bool

When true, allows the signer to print the document and sign it on paper. Signers will see a "print and sign" option in the Other Actions menu before signing. 

Note that this does not prevent signers from adding their e-signatures if they choose to--it just offers both options.

FALSE

EnforceSignerVisibility

bool

When TRUE, requires that a Signer have a signature or initial on the document or that the document has no signers in order to view it. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have signature fields are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. Your account must have Document Visibility enabled to use this.

FALSE

ESignMetaData.AccountCode

string

Set AccountCode metadata

""

ESignMetaData.ClientCode

string

Set ClientCode metadata

""

ESignMetaData.FirmCode

string

Set FirmCode metadata

""

ESignMetaData.RepCode

string

Set RepCode metadata

""

ESignVendorSuccessJavaScript

string

Allows customers to implement custom JavaScript after a successful e-sign transaction in the E-Sign Pop-Up.

""

MessageLock

bool

When TRUE, prevents senders from changing the EmailBlurb and Subject for the envelope. Additionally, this prevents users from making changes to the EmailBlurb and Subject when correcting envelopes

FALSE

Notification

DocusignNotificationSettings

An optional complex element that specifies the notification options for the envelope. It consists of: UseAccountDefaults, Expirations, Reminders

null

UseAccountDefaults

bool

When TRUE, the account default notification settings are used for the envelope. 

FALSE

Expirations

DocusignNotificationExpiration

A complex element that specifies the expiration settings for the envelope. It consists of: expireEnabled, expireAfter, expireWarn.

null

ExpireEnabled

bool

When TRUE, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the Docusign default value of 120 days is used.

FALSE

ExpireAfter

int

An integer that sets the number of days the envelope is active.

0

ExpireWarn

int

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.

0

InPersonSigningHost.Name

string

Allows customers to prefill the Name of the Host when In Person Signer send type is used

InPersonSigningHost.Email

string

Allows customers to prefill the Email of the Host when In Person Signer send type is used

Reminders

DocsignNotificationReminder

A complex element that specifies reminder settings for the envelope. It consists of: ReminderDelay, ReminderEnabled, ReminderFrequency

null

ReminderDelay

int

An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.

0

ReminderEnabled

bool

When true a reminder message is sent to the recipient.

FALSE

ReminderFrequency

int

An interger that sets the interval, in days, between reminder emails.

0

RecipientsLock

bool

When TRUE, prevents senders from changing, correcting, or deleting the recipient information for the envelope.

FALSE

SenderUserID

string

Sets the CustomerUserID asociated to the token that will act as the Sender when using SOBO. If it's not provided the default token will be used. If SOBO is turned off, this is ignored

""

SendTypes

List of DocusignSendType

Limits the items displayed in the Send Type drop down lists within the esign popup. If the list is empty, all items are displayed. DocusignSendType is an enumerator that has the following values:
EmailToSign
SendCopy
InPersonSigner
Agent
CertifiedDeliveries
Editor

Notes:
None is always shown, since it's the empty record for the drop down list (if selected, the recipient will not be part of the signing process).
Descriptions of these types can be seen here.

empty list

SendTypes - Agent

enum

Use when the recipient can add name and email information for recipients that appear after them in routing order.

SendTypes - CertifiedDeliveries

enum

Use when the recipient should get a copy of the envelope, but the recipient does not need to sign, initial, date or add any information to the documents.

SendTypes - Editor

enum

Use when the 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.

SendTypes - EmailToSign

enum

Use when the recipient must sign, initial, date or add data to form fields on the documents in the envelope.

SendTypes - InPersonSigner

enum

Use when the signer is in the same physical location as the Docusign user who is requesting a signature.

SendTypes - SendCopy

enum

Use when the recipient should get a copy of the envelope, but the recipient does not need to sign, initial, date or add any information to the documents.

SetContentTypeCallBackURL

enum

Sets the content types of the HTTP request when using the Callback approach for your Docusign integration. See configuration documentation here.

0

SignAllDocsCombined

bool

When TRUE, attachments will be pushed to Docusign along with forms. When FALSE, the envelope will not include attachments added in the Viewer.

TRUE

SignCallBackURL

string

(Required) A customer-defined URL for the Quik! Form to post the EnvelopeID to so customer's system knows the transaction is complete

""

SignEnvironmentID

int

(Required) Sets the Docusign evironment to work with

1

SignErrorMessage

string

Sets the error message

""

SignHideEmptySigners

bool

When TRUE any signing roles on the form that do not have a person's name (first, middle, last or full name) or email address filled in will not be displayed in the e-sign popup.

*Note: They will hide only if there are Name fields (such as 1own.FullName) for the desired hidden role(s) on the form.

FALSE

SignJavascript

string

Javascript to be run when clicking the Sign button

""

SignMessage

string

Sets the sign message in the Quik! E-Signature pop-up. If not provided, the following message is displayed: The attached forms were completed and prepared for you to sign. <Form Names> Please sign these forms by clicking the link. <FormViewID #>

""

SignMultipleDocs

bool

When TRUE each Form in the package will be available in it's own PDF within the e-sign envelope vs. a single combined PDF of all forms (when this property is FALSE)

FALSE

SignOrderLock

bool

When TRUE, locks the order column in the esign popup

FALSE

SignRequireIDCheckName

ESignRequireIDCheckName (enum)

Sets the Auth type to be used for ALL recipients, and hides the Auth Type column in the esign popup. The value is an enumerator called ESignRequireIDCheckName which has the following values. Note: If "None", then there will be no required Auth Type for all recipients (essentially turning this feature off.) See Auth Types properties for description of other enumerators.
None
NoIdentityCheck
IDCheck
SMS
Phone
LiveID
Facebook
LinkedIn
Google
Salesforce
Twitter
Yahoo
OpenID

SignSendJavascript

string

Javascript to be run when clicking the Send button in the esign popup

""

SignShowAccessCode

bool

When TRUE, the access code column is shown in the Quik! E-Signature pop-up. Previously named SignShowVerifyCode in versions 5.4 and earlier.