Request Content - Advanced Parameters

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Advanced Request Content

Table 1 describes the request content advanced optional parameters.

Table 1: Request Content Advanced Optional Parameters

Parameter	Type	Optional/Required	Discerption
requestId	string	Optional	A request Id provided by the caller, if provided, will replace EasySend's auto-generated request Id: Useful for Using an ID from some existing organizational system, to make it easier to connect the EasySend signature session with the originating system session Useful for making sure requests are idempotent, subsequent calls using an already-used request id will fail
expiryDate	string	Optional	Req ISO 8601 notation, yyyy-mm-ddThh:mm:ss, for example 2008-09-15T15:53:00
customData	any type	Optional	Any custom data provided by the caller, this data is replied when EasySend is sending data to a callback API upon document submission
consentPopup	object	Optional	Describes information about a mailing popup that should be displayed before the form is presented for signature NOTE For additional information, see the Consent Dialog section
mailingPopup	object	Optional	Describes information about a mailing popup that should be displayed before the form is presented for signature NOTE For additional information, see the Mailing Dialog section
redirectUrl	string	Optional	If provided, the client’s browser will be redirected to this url upon completion of the signing
businessGroup	string	Optional	If provided, this will be used for flirting
prefilledSignatures	object	Optional	If provided, will put the pictures (need to be sent in a base64 string format) provided in the object as signatures instead of asking the role of the signatures to fill it, for example: {"admin: <base64 string>}, now, each signature that has the role of admin will be filled by the picture provided as a base64 string
documentReadConfirmation	object	Optional	If provided, will require the request signer to approve that he read the document before signing it NOTE For additional information, see the Document Read Confirmation section
optionalFeatures	object	Optional	This object will contain data related to additional features. Please see Optional Features below for more details

Consent Dialog Section

Table 2 describes the parameters of the consentPopup object.

Table 2: ConsentPopup Parameters

Parameter	Type	Optional/Required	Discerption
displayAt	string	Optional	A One of the following preset values: none - will not show a consent dialog linkOpen - opens the dialog when the link is opened, before document signing begins
title	string	Optional	The text to show in the title of the dialog
body	string	Optional	The text to show in the body of the dialog
direction	string	Optional	One of the following preset values: ltr - left to right, default rtl - right to left
checkBoxText	string	Optional	The text to show near the checkbox
consentId	string	Optional	An id for identifying the status of consent for the current request
buttonText	string	Optional	Text for the button in the bottom of the dialog
additionalText	string	Optional	Additional text paragraph next to the checkbox

Mailing Dialog Section

Table 3 describes the parameters of the mailingPopup object.

Table 3: mailingPopup Parameters

Parameter	Type	Optional/Required	Discerption
displayAt	string	Optional	A One of the following preset values: none - will not show a consent dialog linkOpen - opens the dialog when the link is opened, before document signing begins
title	string	Optional	The text to show in the title of the dialog
body	string	Optional	The text to show in the body of the dialog
direction	string	Optional	One of the following preset values: ltr - left to right, default rtl - right to left
checkBoxText	string	Optional	The text to show near the checkbox
buttonText	string	Optional	Text for the button in the bottom of the dialog
emailList	array of string	Optional	The list of email options that will be able to be selected in the popup

Document Read Confirmation Section

Table 4 describes the parameters of the documentReadConfirmation object.

Table 4: documentReadConfirmation Parameters

Parameter	Type	Optional/Required	Discerption
displayAt	string	Optional	A One of the following preset values: none - will not show a consent dialog linkOpen - opens the dialog when the link is opened, before document signing begins
direction	string	Optional	One of the following preset values: ltr - left to right, default rtl - right to left
checkBoxText	string	Optional	The text to show near the checkbox
buttonText	string	Optional	Text for the button in the bottom of the dialog
readConfirmationId	string	Optional	An id for identifying the status of read confirmation for the current request

Was this article helpful?

What's Next

Overview

Table of contents

Advanced Request Content