v1

latestSwagger 2.02026-08-063530171.1 KB
signrequests

Retrieve a SignRequest

get/signrequests/{uuid}/

Response

OK

from_emailstring email

Email of user sending the SignRequest (must be a validated email)

from_email_namestring nullable

Name to be used in the From email header, e.g. {from_email_name} <no-reply@signrequest.com>

is_being_preparedboolean nullable

Have the sender of a SignRequest prepare the document before sending the request out, see: prepare using the web interface

prepare_urlstring uri
redirect_urlstring uri nullable

URL at which SignRequest will redirect to when a document is signed

redirect_url_declinedstring uri nullable

URL at which SignRequest will redirect to when a document is declined

disable_attachmentsboolean

Disable uploading/adding of attachments

disable_text_signaturesboolean

Disable usage of signatures generated by typing (text)

disable_textboolean

Disable adding of text

disable_dateboolean

Disable adding of dates

disable_emailsboolean

Disable all SignRequest status emails as well as the email that contains the signed documents

disable_upload_signaturesboolean

Disable usage of uploaded signatures (images)

force_signature_colorstring nullable

Force specific color for the signature

disable_blockchain_proofboolean nullable

Disables storing timestamp proof hashes in blockchain integrations.

text_message_verification_lockedboolean nullable

When true a text message verification is needed before the signer can see the document

subjectstring nullable

Subject of SignRequest email

messagestring nullable

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

who'm' | 'mo' | 'o' nullable

m: only me, mo: me and others, o: only others

send_remindersboolean

Automatically remind signers to sign a document, see: automatic reminders

uuidstring
urlstring uri
documentstring uri required
integration'mfiles' | 'salesforce' | 'formdesk' | 'zapier' | 'microsoft-flow' nullable
integration_dataobject nullable