| 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 |
bool |
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 |
\SignRequest\Model\RequiredAttachment[] |
Attachments that signers are required to upload |
[optional] |
| disable_attachments |
bool |
Disable uploading/adding of attachments |
[optional] |
| disable_text_signatures |
bool |
Disable usage of signatures generated by typing (text) |
[optional] |
| disable_text |
bool |
Disable adding of text |
[optional] |
| disable_date |
bool |
Disable adding of dates |
[optional] |
| disable_emails |
bool |
Disable all SignRequest status emails as well as the email that contains the signed documents |
[optional] |
| disable_upload_signatures |
bool |
Disable usage of uploaded signatures (images) |
[optional] |
| disable_blockchain_proof |
bool |
Disables storing timestamp proof hashes in blockchain integrations. |
[optional] |
| text_message_verification_locked |
bool |
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 |
bool |
Automatically remind signers to sign a document, see: automatic reminders |
[optional] |
| signers |
\SignRequest\Model\Signer[] |
|
|
| uuid |
string |
|
[optional] |
| url |
string |
|
[optional] |
| document |
string |
|
[optional] |
| integration |
string |
|
[optional] |
| integration_data |
object |
|
[optional] |
| name |
string |
Defaults to filename, including extension |
[optional] |
| external_id |
string |
ID used to reference document in external system |
[optional] |
| frontend_id |
string |
Shared secret used in conjunction with <a href="#section/Frontend-API/SignRequest-js-client-(beta)">SignRequest-js client</a> to grant user access to a document that's not a member of the document's team |
[optional] |
| file |
string |
Temporary URL to original file, expires in five minutes |
[optional] |
| file_from_url |
string |
Publicly accessible URL of document to be downloaded by SignRequest |
[optional] |
| events_callback_url |
string |
URL at which to receive event callbacks for this document |
[optional] |
| file_from_content |
string |
Base64 encoded document content |
[optional] |
| file_from_content_name |
string |
Filename, including extension. Required when using `file_from_content`. |
[optional] |
| template |
string |
|
[optional] |
| prefill_tags |
\SignRequest\Model\InlinePrefillTags[] |
Prefill signer input data, see prefill tags |
[optional] |
| integrations |
\SignRequest\Model\InlineIntegrationData[] |
|
[optional] |
| file_from_sf |
\SignRequest\Model\FileFromSf |
|
[optional] |
| auto_delete_days |
int |
Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted |
[optional] |
| auto_expire_days |
int |
Number of days after which a non finished document will be automatically expired |
[optional] |