Skip to content

Latest commit

 

History

History
32 lines (29 loc) · 2.9 KB

SignRequest.md

File metadata and controls

32 lines (29 loc) · 2.9 KB

SignRequestClient::SignRequest

Properties

Name Type Description Notes
from_email String Email of user sending the SignRequest (must be a validated email) [optional]
from_email_name String Name to be used in the `From` email header, e.g. `{from_email_name} <[email protected]>` [optional]
is_being_prepared BOOLEAN Have the sender of a SignRequest prepare the document before sending the request out, see: prepare using the web interface [optional]
prepare_url String [optional]
redirect_url String URL at which SignRequest will redirect to when a document is signed [optional]
redirect_url_declined String URL at which SignRequest will redirect to when a document is declined [optional]
required_attachments Array<RequiredAttachment> Attachments that signers are required to upload [optional]
disable_attachments BOOLEAN Disable uploading/adding of attachments [optional]
disable_text_signatures BOOLEAN Disable usage of signatures generated by typing (text) [optional]
disable_text BOOLEAN Disable adding of text [optional]
disable_date BOOLEAN Disable adding of dates [optional]
disable_emails BOOLEAN Disable all SignRequest status emails as well as the email that contains the signed documents [optional]
disable_upload_signatures BOOLEAN Disable usage of uploaded signatures (images) [optional]
disable_blockchain_proof BOOLEAN Disables storing timestamp proof hashes in blockchain integrations. [optional]
text_message_verification_locked BOOLEAN When true a text message verification is needed before the signer can see the document [optional]
subject String Subject of SignRequest email [optional]
message String Message to include in SignRequest email, may contain the following html tags: `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong` [optional]
who String `m`: only me, `mo`: me and others, `o`: only others [optional] [default to 'o']
send_reminders BOOLEAN Automatically remind signers to sign a document, see: automatic reminders [optional]
signers Array<Signer>
uuid String [optional]
url String [optional]
document String
integration String [optional]
integration_data Object [optional]