Dynamic Signer Attachment Properties
SignerAttachment
When used in an embedded text tag, the presence of this property indicates that the text tag is a signer attachment. The string value entered here will become the label of the item that will be displayed to signers. If the value for SignerAttachment matches the label value of an attachment that already exists on the template, the properties specified here will serve to overwrite the properties of the existing attachment.
Type |
Supported |
Text Tag |
yes |
XML |
no |
Instructions
Detailed instructions to display to the signer.
Type |
Supported |
Text Tag |
yes |
XML |
yes |
SignatoryEmail
SignatoryEmail need not be specified if the signer attachment has been previously assigned in the workflow. For new signer attachments one of SignatoryEmail, SignatoryEmailParameterName, SignatoryMobilePhone, or SignatoryMobilePhoneParameterName must be specified. If SignatoryEmail is specified, it must match a signatory email being passed in the document submission XML.
Data Type |
Default if not specified (New signer attachments) |
String |
Submission will error if new JotBlock and SignatoryEmailParameterName not specified |
Type |
Supported |
Text Tag |
yes |
XML |
yes |
Example:
Copy
{{!##{SignerAttachment:"Drivers License"Instructions:"Please upload a picture of your drivers license.",SignatoryEmail:"johndoe@jdoe.com",SigningStep:1}##!}}
SignatoryEmailParameterName
SignatoryEmailParameterName need not be specified if the signer attachment has been previously assigned in the workflow. For new signer attachments one of SignatoryEmail, SignatoryEmailParameterName, SignatoryMobilePhone, or SignatoryMobilePhoneParameterName must be specified. This must match the parameter name of a valid parameter for this document. If a value is provided for the SignatoryEmail attribute this attribute will be ignored.
Data Type |
Default if not specified (New signer attachments) |
String |
Submission will error if new signer attachment and SignatoryEmail not specified |
Type |
Supported |
Text Tag |
yes |
XML |
yes |
Example:
Copy
{{!##{SignerAttachment:"Drivers License"Instructions:"Please upload a picture of your drivers license.",SignatoryEmailParameterName:"Signatory 1 Email Address",SigningStep:1}##!}}
SignatoryMobilePhone
This is applicable only when SMS is used for signer notifications. SignatoryMobilePhone need not be specified if the signer attachment has been previously assigned in the workflow. For new signer attachments one of SignatoryEmail, SignatoryEmailParameterName, SignatoryMobilePhone, or SignatoryMobilePhoneParameterName must be specified. If SignatoryMobilePhone is specified, it must match a signatory mobile phone number being passed in the document submission XML.
Data Type |
Default if not specified (New signer attachments) |
String |
Submission will error if new JotBlock and SignatoryMobilePhoneParameterName not specified |
Type |
Supported |
Text Tag |
yes |
XML |
yes |
Example:
Copy
{{!##{SignerAttachment:"Drivers License"Instructions:"Please upload a picture of your drivers license.",SignatoryMobilePhone:"3215556789",SigningStep:1}##!}}
SignatoryMobilePhoneParameterName
This is applicable only when SMS is used for signer notifications. SignatoryMobilePhoneParameterName need not be specified if the signer attachment has been previously assigned in the workflow. For new signer attachments one of SignatoryEmail, SignatoryEmailParameterName, SignatoryMobilePhone, or SignatoryMobilePhoneParameterName must be specified. This must match the parameter name of a valid parameter for this document. If a value is provided for the SignatoryMobilePhone attribute this attribute will be ignored.
Data Type |
Default if not specified (New signer attachments) |
String |
Submission will error if new signer attachment and SignatoryMobilePhone not specified |
Type |
Supported |
Text Tag |
yes |
XML |
yes |
Example:
Copy
{{!##{SignerAttachment:"Drivers License"Instructions:"Please upload a picture of your drivers license.",SignatoryMobilePhoneParameterName:"Signatory 1 Mobile Phone",SigningStep:1}##!}}
SigningStep
SigningStep should be populated with an integer value that matches the number of an existing step previously defined in the workflow. In single-signatory documents, or cases where the signatory to whom the signer attachment will be presented only appears in one step, this property is irrelevant.
Data Type |
Default if not specified (New signer attachments) |
String |
Attempt to add to first signing step signatory is assigned to |
Type |
Supported |
Text Tag |
yes |
XML |
yes |
Required
If Required is true, then the signer attachment must be completed by the signatory; if false, then the signer attachment will be considered optional. If not specified, then the signer attachment will be optional.
Data Type |
Default if not specified (New signer attachments) |
String |
false |
Type |
Supported |
Text Tag |
yes |
XML |
yes |
AllowMultiple
If AllowMultiple is true, then the signer can upload more than one file. Otherwise the signer is limited to a single file only.
Data Type |
Default if not specified (New signer attachments) |
String |
false |
Type |
Supported |
Text Tag |
yes |
XML |
yes |