Docusign Properties

Beginning with Quik! Forms Engine version 5.5, the Docusign integration includes a comprehensive set of properties related to a Docusign account and envelopes. All available properties are described below. (Note: These properties can also be found on the Quik! Forms Engine Properties List page)

PropertyTypeDescriptionDefault Value (If Applicable)
AllowMarkupboolWhen 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
AllowReassignboolWhen TRUE, the recipient can redirect an envelope to a more appropriate recipient.FALSE
AllowRecipientRecursionboolWhen TRUE, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.FALSE
AsynchronousboolWhen 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 - FacebookenumAuthorize signers via a Facebook account
AuthTypes - GoogleenumAuthorize signers via a Google account
AuthTypes - IDCheckenumAuthorize signers via a list of questions
AuthTypes - LinkedInenumAuthorize signers via a Linkedin account
AuthTypes - LiveIDenumAuthorize signers via a LiveID account
AuthTypes - NoIDCheckenumSigners will not be authorized in any way before signing the form
AuthTypes - OpenIDenumAuthorize signers via an OpenID account
AuthTypes - PhoneenumAuthorize signers via a code called in to a phone number
AuthTypes - SalesforceenumAuthorize signers via a Salesforce account
AuthTypes - SMSenumAuthorize signers via a code texted to a phone number
AuthTypes - SocialAllenumShow only the social media options (Twitter, Facebook, etc.) for authorization, as well as No Identity Check
AuthTypes - TwitterenumAuthorize signers via a Twitter account
AuthTypes - YahooenumAuthorize signers via Yahoo account
AuthUserIDstringSets 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.""
AuthoritativeCopyboolWhen 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
AutoNavigationboolWhen TRUE, auto-navigation is enabled for the envelope. The auto-navigation method used is determined by the account setting.FALSE
BrandIdstringThis 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.""
BrandLockboolWhen TRUE, the brand profile associated with the envelope cannot be changed. This is only managed in the Docusign API.FALSE
CustomFieldsDocusignCustomFieldsComplex 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
EmailSettingsDocusignEmailSettings 
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
BccEmailAddresseslist of stringA 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
ReplyEmailAddressOverridestringThe 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.""
ReplyEmailNameOverridestringThe name associated with the Reply To email address. This can be a maximum of 100 characters.""
EnableWetSignboolWhen 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
EnforceSignerVisibilityboolWhen 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.AccountCodestringSet AccountCode metadata""
ESignMetaData.ClientCodestringSet ClientCode metadata""
ESignMetaData.FirmCodestringSet FirmCode metadata""
ESignMetaData.RepCodestringSet RepCode metadata""
ESignVendorSuccessJavaScriptstringAllows customers to implement custom JavaScript after a successful e-sign transaction in the E-Sign Pop-Up.""
MessageLockboolWhen 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 envelopesFALSE
NotificationDocusignNotificationSettingsAn optional complex element that specifies the notification options for the envelope. It consists of: UseAccountDefaults, Expirations, Remindersnull
UseAccountDefaultsboolWhen TRUE, the account default notification settings are used for the envelope. FALSE
ExpirationsDocusignNotificationExpirationA complex element that specifies the expiration settings for the envelope. It consists of: expireEnabled, expireAfter, expireWarn.null
ExpireEnabledboolWhen 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
ExpireAfterintAn integer that sets the number of days the envelope is active.0
ExpireWarnintAn 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


RemindersDocsignNotificationReminderA complex element that specifies reminder settings for the envelope. It consists of: ReminderDelay, ReminderEnabled, ReminderFrequencynull
ReminderDelayintAn interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.0
ReminderEnabledboolWhen true a reminder message is sent to the recipient.FALSE
ReminderFrequencyintAn interger that sets the interval, in days, between reminder emails.0
RecipientsLockboolWhen TRUE, prevents senders from changing, correcting, or deleting the recipient information for the envelope.FALSE
SenderUserIDstringSets 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""
SendTypesList of DocusignSendTypeLimits 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 - AgentenumUse when the recipient can add name and email information for recipients that appear after them in routing order.
SendTypes - CertifiedDeliveriesenumUse 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 - EditorenumUse 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 - EmailToSignenumUse when the recipient must sign, initial, date or add data to form fields on the documents in the envelope.
SendTypes - InPersonSignerenumUse when the signer is in the same physical location as the Docusign user who is requesting a signature.
SendTypes - SendCopyenumUse 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.
SetContentTypeCallBackURLenumSets the content types of the HTTP request when using the Callback approach for your Docusign integration. See configuration documentation here.0
SignAllDocsCombinedbool

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

TRUE
SignCallBackURLstring(Required) A customer-defined URL for the Quik! Form to post the EnvelopeID to so customer's system knows the transaction is complete""
SignEnvironmentIDint(Required) Sets the Docusign evironment to work with1
SignErrorMessagestringSets the error message""
SignHideEmptySignersbool

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
SignJavascriptstringJavascript to be run when clicking the Sign button""
SignMessagestring

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

""
SignMultipleDocsboolWhen 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
SignOrderLockboolWhen TRUE, locks the order column in the esign popupFALSE
SignRequireIDCheckNameESignRequireIDCheckName (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

SignSendJavascriptstringJavascript to be run when clicking the Send button in the esign popup""
SignShowAccessCodeboolWhen TRUE, the access code column is shown in the Quik! E-Signature pop-up. Previously named SignShowVerifyCode in versions 5.4 and earlier.FALSE
SignSubjectstringSets the Subject line of the email sent to signers. If not provided, default value is "Please e-sign these forms <dealer name>"""
SignTransDescriptionstringDescription of the transaction. This property is related to EsignMetaData so customers can more easily identify transactions. Not needed for generating envelopes at Docusign.Default value of first recipient's name, the first form's dealer name, and the first form's name
SignURLstringA URL that the Send button (in the E-Sign Popup) posts envelope data to for Self Service and Pass Thru models ONLY. If using the Callback model, customers will use the SignCallbackURL instead.""
SkipESignPopupboolWhen True, the e-sign pop-up is not displayed when the Sign button is clicked. Signing roles that have information supplied to the form will be set as signers without input by the user, and the signing ceremony will begin.FALSE
SOBOFlagboolEnables the SOBO (Send On Behalf of) functionalityFALSE
TransactionIdstringSets the TransactionID setting at Docusign. TransactionIds are used to define an envelope, and are only valid in the Docusign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The transactionId property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.""
UseDisclosureboolWhen set to FALSE, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. When set to TRUE, the disclosure is shown to recipients in accordance with the account’s Electronic Record and Signature Disclosure frequency setting. If there is no setting for use useDisclosure, then the account’s normal disclosure setting is used and the useDisclosure setting is not returned in responses when getting envelope information.FALSE
DocusignTabclassA wrapper class for Docusign Signature and initial tabs, which lets users configure signatures and intial fields as optional when signing a form in Docusign. For a description of all settings and how to use this, please see Configuring Optional Signature Fields documentation.
CreateEnvelopeAsDraftboolWhen TRUE, the envelope will be sent to Docusign in Draft status (Quik! does not support any other status options). A possible use case for this feature is when customers want to approve an envelope before it is sent to clients. More information hereFALSE
AccountIDstringCustomers that have more than one Docusign account can use the AccountID property to specify the usage of one specific account. If a customer has more than one Docusign account and does NOT include an AccountID, then the customer’s default (typically most used) Docusign account is used. More information here""


Related Objects



  1. DocusignCustomFields

    Property Name

    Type

    Default Value

    Description

    ListCustomFieldslist of DocusignListCustomFieldnullSets the Docusign's List Custom Fields
    TextCustomFieldslist of DocusignTextCustomFieldnullSets the Docusign's Text Custom Fields

           

    1. ListCustomFields

      Property Name

      Type

      Default Value

      Description

      Namestring""List Custom Field Name
      RequiredboolfalseList Custom Field Required flag
      ShowboolfalseList Custom Field Show flag
      Valuestring""List Custom Field Value
      ListItemslist of stringnullList Custom Field Items


    2. TextCustomFields

      Property Name

      Type

      Default Value

      Description

      Namestring""Text Custom Field Name
      RequiredboolfalseText Custom Field Required flag
      ShowboolfalseText Custom Field Show flag
      Valuestring""Text Custom Field Value

  2. DocusignEmailSettings

    Property Name

    Type

    Default Value

    Description

    ReplyEmailAddressOverridestring""Sets the Docusign's ReplyEmailAddressOverride setting for Emailing
    ReplyEmailNameOverridestring""Sets the Docusign's ReplyEmailNameOverride setting for Emailing
    BccEmailAddresseslist of stringnullSets the Docusign's BccEmailAddresses setting for Emailing
  3. DocusignNotificationSettings

    Property Name

    Type

    Default Value

    Description

    UseAccountDefaultsboolfalseSets the Docusign's Notification UseAccountDefaults setting
    RemindersDocusignNotificationRemindernullSets the Docusign's Notification Reminders
    ExpirationsDocusignNotificationExpirationnullSets the Docusign's Notification Expirations


      

    1. DocusignNotificationReminder

      Property Name

      Type

      Default Value

      Description

      ReminderEnabledboolfalseSets the Docusign's Notification ReminderEnabled setting
      ReminderDelayint0Sets the Docusign's Notification ReminderDelay setting
      ReminderFrequencyint0Sets the Docusign's Notification ReminderFrequency setting
    2. DocusignNotificationExpiration

      Property Name

      Type

      Default Value

      Description

      ExpireEnabledboolfalseSets the Docusign's Notification ExpireEnabled setting
      ExpireAfterint0Sets the Docusign's Notification ExpireAfter setting
      ExpireWarnint0Sets the Docusign's Notification ExpireWarn setting
  4. ESignMetaData

    Property Name

    Type

    Default Value

    Description

    ClientCodestring""
    AccountCodestring""
    RepCodestring""
    FirmCodestring""
  5. Recipients

    Property Name

    Type

    Default Value

    Description

    ExtraRecipientsList of ExtraRecipient nullIncludes a list of extra recipients that are added to the form package. These recipients are always Carbon Copies (Send Copy at Docusign)
    SignersList of SignernullIncludes a list of recipients that have at least one signature field on the form package.

       

            a. ExtraRecipient

    Property Name

    Type

    Default Value

    Description

    AccessCodeAccessCodenullSets the extra recipient's Access Code 
    Emailstring""Sets the extra recipient's Email
    IdentityCheckESignRequireIDCheckNamenullSets the extra recipient's Auth type
    Instanceint0Sets the extra recipient's Instance
    Namestring""Sets the extra recipient's Name
    Orderint0Sets the extra recipient's Order
    PhoneNumberint0Sets the extra recipient's PhoneNumber
    RecipientNumberint1Indicates the number of the Recipient, Always starting from 1

            b. Signers

    Property Name

    Type

    Default Value

    Description

    AccessCodeAccessCodenullSets the recipient's Access Code 
    IdentityCheckESignRequireIDCheckNamenullSets the recipient's Auth type
    Instanceint0Sets the recipient's Instance
    Orderint0Sets the recipient's Order
    PhoneNumberint0Sets the recipient's PhoneNumber
    SendTypeDocusignSendTypenullSets the recipient's SendType
    Rolestring""Required. This is the role to be associated in the form. E.g "1own" for Owner 1.

            AccessCode

    Property Name

    Type

    Default Value

    Description

    Codestring""Sets the AccesCode value. E.g: "AC123"
    RequiredboolfalseMakes the AccessCode input in the esign popup required for this recipient
    ReadOnlyboolfalseMakes the AccessCode input in the esign popup read-only for this recipient

For help regarding Quik! Forms and the Quik! API
Email: support@quikforms.com | Phone: (877) 456-QUIK