SignRequest (Preview)
SignRequest is a secure and legally binding e-signature tool that enables you and your partners to sign contracts and other documents fast and without the hassle of having to print, sign and scan.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
tech-support@signrequest.com |
Connector Metadata | |
---|---|
Publisher | SignRequest B.V. |
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Send Sign |
Creates and sends a new SignRequest. |
Creates and sends a new SignRequest.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Auto delete days
|
auto_delete_days | integer |
Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted |
|
Auto expire days
|
auto_expire_days | integer |
Number of days after which a non finished document will be automatically expired |
|
Disable attachments
|
disable_attachments | boolean |
Disable uploading/adding of attachments |
|
Disable blockchain proof
|
disable_blockchain_proof | boolean |
Disables storing timestamp proof hashes in blockchain integrations. |
|
Disable date
|
disable_date | boolean |
Disable adding of dates |
|
Disable emails
|
disable_emails | boolean |
Disable all SignRequest status emails as well as the email that contains the signed documents |
|
Disable text
|
disable_text | boolean |
Disable adding of text |
|
Disable text signatures
|
disable_text_signatures | boolean |
Disable usage of signatures generated by typing (text) |
|
Disable upload signatures
|
disable_upload_signatures | boolean |
Disable usage of uploaded signatures (images) |
|
Document
|
document | uri | ||
Events callback url
|
events_callback_url | uri |
URL at which to receive event callbacks for this document |
|
External id
|
external_id | string |
ID used to reference document in external system |
|
File
|
file | uri |
Temporary URL to original file, expires in five minutes |
|
File from content
|
file_from_content | byte |
Base64 encoded document content |
|
File from content name
|
file_from_content_name | string |
Filename, including extension. Required when using |
|
File from url
|
file_from_url | uri |
Publicly accessible URL of document to be downloaded by SignRequest |
|
From email
|
from_email |
Email of user sending the SignRequest (must be a validated email) |
||
From email name
|
from_email_name | string |
Name to be used in the |
|
Frontend id
|
frontend_id | string |
Shared secret used in conjunction with SignRequest-js client to grant user access to a document that's not a member of the document's team |
|
Is being prepared
|
is_being_prepared | boolean |
Have the sender of a SignRequest prepare the document before sending the request out, see: prepare using the web interface |
|
Message
|
message | string |
Message to include in SignRequest email, may contain the following html tags: |
|
Name
|
name | string |
Defaults to filename, including extension |
|
Prefill Tags Checkbox Value
|
checkbox_value | boolean | ||
Prefill Tags Date Value
|
date_value | date | ||
Prefill Tags External Id
|
external_id | string | ||
Prefill Tags Text
|
text | string | ||
Prepare url
|
prepare_url | uri | ||
Redirect url
|
redirect_url | uri |
URL at which SignRequest will redirect to when a document is signed |
|
Redirect url declined
|
redirect_url_declined | uri |
URL at which SignRequest will redirect to when a document is declined |
|
Required Attachment Name
|
name | True | string | |
Required Attachment Uuid
|
uuid | string | ||
Send reminders
|
send_reminders | boolean |
Automatically remind signers to sign a document, see: automatic reminders |
|
Signer After Document
|
after_document | uri | ||
Signer Approve Only
|
approve_only | boolean |
Require user to approve the document (without adding a signature), see: Approve only |
|
File
|
file | uri | ||
Required Attachment Name
|
name | True | string | |
Required Attachment Uuid
|
uuid | string | ||
Name
|
name | string |
Defaults to filename |
|
Uuid
|
uuid | string | ||
Signer Declined
|
declined | boolean | ||
Signer Declined On
|
declined_on | date-time | ||
Signer Display Name
|
display_name | string | ||
Signer Downloaded
|
downloaded | boolean | ||
Signer Email
|
True | |||
Signer Email Viewed
|
email_viewed | boolean | ||
Signer Emailed
|
emailed | boolean | ||
Signer Embed Url
|
embed_url | uri | ||
Signer Embed Url User Id
|
embed_url_user_id | string | ||
Signer First Name
|
first_name | string | ||
Signer Force Language
|
force_language | boolean | ||
Signer Forwarded
|
forwarded | boolean | ||
Signer Forwarded On
|
forwarded_on | date-time | ||
Signer Forwarded Reason
|
forwarded_reason | string | ||
Signer Forwarded To Email
|
forwarded_to_email | |||
Signer In Person
|
in_person | boolean |
When used in combination with an embed url on the sender, after sender has signed, they will be redirected to the next |
|
Checkbox value
|
checkbox_value | boolean | ||
Date value
|
date_value | date | ||
External id
|
external_id | string | ||
Page index
|
page_index | True | integer | |
Placeholder uuid
|
placeholder_uuid | string | ||
Text
|
text | string | ||
Type
|
type | string | ||
Signer Language
|
language | string | ||
Signer Last Name
|
last_name | string | ||
Signer Message
|
message | string | ||
Signer Needs To Sign
|
needs_to_sign | boolean |
When |
|
Signer Notify Only
|
notify_only | boolean |
Send notifications about the document and a copy of the signed document and signing log, but don't require them to take any action, see: Notify only |
|
Signer Order
|
order | integer | ||
Signer Password
|
password | string |
Require the signer to enter this password before signing a document. This field is write only. |
|
Signer Redirect Url
|
redirect_url | uri | ||
Signer Redirect Url Declined
|
redirect_url_declined | uri | ||
Signer Signed
|
signed | boolean | ||
Signer Signed On
|
signed_on | date-time | ||
Signer Use Stamp For Approve Only
|
use_stamp_for_approve_only | boolean |
Place an approval stamp on a document when a signer approves a document |
|
Signer Verify Bank Account
|
verify_bank_account | string | ||
Signer Verify Phone Number
|
verify_phone_number | string | ||
Signer Viewed
|
viewed | boolean | ||
Team
|
subdomain | string | ||
Subject
|
subject | string |
Subject of SignRequest email |
|
Template
|
template | uri | ||
Text message verification locked
|
text_message_verification_locked | boolean |
When true a text message verification is needed before the signer can see the document |
|
Url
|
url | uri | ||
Uuid
|
uuid | string | ||
Who
|
who | string |
|
Returns
When a document status changes |
Triggers when the document status of a SignRequest changes. |
Triggers when the document status of a SignRequest changes.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Created
|
created | date-time | ||
Event type
|
event_type | True | string | |
Name
|
name | string |
Optional name to easily identify what webhook is used for |
|
Team
|
subdomain | string | ||
Team Name
|
name | string | ||
Team Subdomain
|
subdomain | uri | ||
Team Url
|
url | uri | ||
Url
|
url | uri | ||
Uuid
|
uuid | string |
Returns
Name | Path | Type | Description |
---|---|---|---|
document
|
document | Document |
Name | Path | Type | Description |
---|---|---|---|
Document Api Used
|
api_used | boolean |
Indicates whether document was created using the API |
attachments
|
attachments | array of DocumentAttachment | |
Document Auto Delete After
|
auto_delete_after | date-time |
Date and time calculated using |
Document Auto Delete Days
|
auto_delete_days | integer |
Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted |
Document Auto Expire After
|
auto_expire_after | date-time |
Date and time calculated using |
Document Auto Expire Days
|
auto_expire_days | integer |
Number of days after which a non finished document will be automatically expired |
Document Events Callback Url
|
events_callback_url | uri |
URL at which to receive event callbacks for this document |
Document External Id
|
external_id | string |
ID used to reference document in external system |
Document File
|
file | uri |
Temporary URL to original file, expires in five minutes |
Document File As Pdf
|
file_as_pdf | uri |
Temporary URL to original file as PDF, expires in five minutes |
Document File From Content
|
file_from_content | string |
Base64 encoded document content |
Document File From Content Name
|
file_from_content_name | string |
Filename, including extension. Required when using |
File from sf
|
file_from_sf | FileFromSf | |
Document File From Url
|
file_from_url | uri |
Publicly accessible URL of document to be downloaded by SignRequest |
Document Frontend Id
|
frontend_id | string |
Shared secret used in conjunction with SignRequest-js client to grant user access to a document that's not a member of the document's team |
Document Name
|
name | string |
Defaults to filename, including extension |
Document Pdf
|
uri |
Temporary URL to signed document as PDF, expires in five minutes |
|
prefill_tags
|
prefill_tags | array of InlinePrefillTags |
Prefill signer input data, see prefill tags |
Document Processing
|
processing | boolean |
Indicates whether a change to the document is processing and the PDF may be out of date. It is recommended to wait until processing has finished before downloading the PDF. Webhooks are not sent until processing has been completed. |
Document Sandbox
|
sandbox | boolean |
Indicates whether document was created as part of a sandbox team |
Document Security Hash
|
security_hash | string |
SHA256 hash of PDF contents |
Signing Log Pdf
|
signing_log.pdf | uri |
Temporary URL to signing log, expires in five minutes |
Signing Log Security Hash
|
signing_log.security_hash | string |
SHA256 hash of PDF contents |
Signrequest Disable Attachments
|
signrequest.disable_attachments | boolean |
Disable uploading/adding of attachments |
Signrequest Disable Blockchain Proof
|
signrequest.disable_blockchain_proof | boolean |
Disables storing timestamp proof hashes in blockchain integrations. |
Signrequest Disable Date
|
signrequest.disable_date | boolean |
Disable adding of dates |
Signrequest Disable Emails
|
signrequest.disable_emails | boolean |
Disable all SignRequest status emails as well as the email that contains the signed documents |
Signrequest Disable Text
|
signrequest.disable_text | boolean |
Disable adding of text |
Signrequest Disable Text Signatures
|
signrequest.disable_text_signatures | boolean |
Disable usage of signatures generated by typing (text) |
Signrequest Disable Upload Signatures
|
signrequest.disable_upload_signatures | boolean |
Disable usage of uploaded signatures (images) |
Signrequest From Email
|
signrequest.from_email |
Email of user sending the SignRequest (must be a validated email) |
|
Signrequest From Email Name
|
signrequest.from_email_name | string |
Name to be used in the |
Signrequest Is Being Prepared
|
signrequest.is_being_prepared | boolean |
Have the sender of a SignRequest prepare the document before sending the request out, see: prepare using the web interface |
Signrequest Message
|
signrequest.message | string |
Message to include in SignRequest email, may contain the following html tags: |
Signrequest Prepare Url
|
signrequest.prepare_url | uri | |
Signrequest Redirect Url
|
signrequest.redirect_url | uri |
URL at which SignRequest will redirect to when a document is signed |
Signrequest Redirect Url Declined
|
signrequest.redirect_url_declined | uri |
URL at which SignRequest will redirect to when a document is declined |
required_attachments
|
signrequest.required_attachments | array of RequiredAttachment | |
Signrequest Send Reminders
|
signrequest.send_reminders | boolean |
Automatically remind signers to sign a document, see: automatic reminders |
signers
|
signrequest.signers | array of Signer | |
Signrequest Subject
|
signrequest.subject | string |
Subject of SignRequest email |
Signrequest Text Message Verification Locked
|
signrequest.text_message_verification_locked | boolean |
When true a text message verification is needed before the signer can see the document |
Signrequest Uuid
|
signrequest.uuid | string | |
Signrequest Who
|
signrequest.who | string |
|
Document Status
|
status | string |
|
Team Name
|
team.name | string | |
Team Subdomain
|
team.subdomain | uri | |
Team Url
|
team.url | uri | |
Document Template
|
template | uri | |
Document Url
|
url | uri | |
User
|
user | User | |
Document Uuid
|
uuid | string |
Name | Path | Type | Description |
---|---|---|---|
Document Attachment Document
|
document | uri | |
Document Attachment File
|
file | uri |
Temporary URL to document attachment, expires in five minutes |
Document Attachment File From Content
|
file_from_content | string |
Base64 encoded document content |
Document Attachment File From Content Name
|
file_from_content_name | string |
Filename, including extension. Required when using |
Document Attachment File From Url
|
file_from_url | uri |
Publicly accessible URL of document to be downloaded by SignRequest |
Document Attachment Name
|
name | string |
Defaults to filename, including extension |
Document Attachment Url
|
url | uri | |
Document Attachment Uuid
|
uuid | string |
Name | Path | Type | Description |
---|---|---|---|
Object id
|
object_id | string | |
Object type
|
object_type | string | |
Uid
|
uid | string |
Prefill signer input data, see prefill tags
Name | Path | Type | Description |
---|---|---|---|
Prefill Tags Checkbox Value
|
checkbox_value | boolean | |
Prefill Tags Date Value
|
date_value | date | |
Prefill Tags External Id
|
external_id | string | |
Prefill Tags Text
|
text | string |
Name | Path | Type | Description |
---|---|---|---|
Required Attachment Name
|
name | string | |
Required Attachment Uuid
|
uuid | string |
Name | Path | Type | Description |
---|---|---|---|
Auto delete days
|
auto_delete_days | integer |
Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted |
Auto expire days
|
auto_expire_days | integer |
Number of days after which a non finished document will be automatically expired |
Disable attachments
|
disable_attachments | boolean |
Disable uploading/adding of attachments |
Disable blockchain proof
|
disable_blockchain_proof | boolean |
Disables storing timestamp proof hashes in blockchain integrations. |
Disable date
|
disable_date | boolean |
Disable adding of dates |
Disable emails
|
disable_emails | boolean |
Disable all SignRequest status emails as well as the email that contains the signed documents |
Disable text
|
disable_text | boolean |
Disable adding of text |
Disable text signatures
|
disable_text_signatures | boolean |
Disable usage of signatures generated by typing (text) |
Disable upload signatures
|
disable_upload_signatures | boolean |
Disable usage of uploaded signatures (images) |
Document
|
document | uri | |
Events callback url
|
events_callback_url | uri |
URL at which to receive event callbacks for this document |
External id
|
external_id | string |
ID used to reference document in external system |
File
|
file | uri |
Temporary URL to original file, expires in five minutes |
File from content
|
file_from_content | byte |
Base64 encoded document content |
File from content name
|
file_from_content_name | string |
Filename, including extension. Required when using |
File from url
|
file_from_url | uri |
Publicly accessible URL of document to be downloaded by SignRequest |
From email
|
from_email |
Email of user sending the SignRequest (must be a validated email) |
|
From email name
|
from_email_name | string |
Name to be used in the |
Frontend id
|
frontend_id | string |
Shared secret used in conjunction with SignRequest-js client to grant user access to a document that's not a member of the document's team |
Is being prepared
|
is_being_prepared | boolean |
Have the sender of a SignRequest prepare the document before sending the request out, see: prepare using the web interface |
Message
|
message | string |
Message to include in SignRequest email, may contain the following html tags: |
Name
|
name | string |
Defaults to filename, including extension |
prefill_tags
|
prefill_tags | array of InlinePrefillTags |
Prefill signer input data, see prefill tags |
Prepare url
|
prepare_url | uri | |
Redirect url
|
redirect_url | uri |
URL at which SignRequest will redirect to when a document is signed |
Redirect url declined
|
redirect_url_declined | uri |
URL at which SignRequest will redirect to when a document is declined |
required_attachments
|
required_attachments | array of RequiredAttachment |
Attachments that signers are required to upload |
Send reminders
|
send_reminders | boolean |
Automatically remind signers to sign a document, see: automatic reminders |
signers
|
signers | array of Signer | |
Team
|
subdomain | string | |
Subject
|
subject | string |
Subject of SignRequest email |
Template
|
template | uri | |
Text message verification locked
|
text_message_verification_locked | boolean |
When true a text message verification is needed before the signer can see the document |
Url
|
url | uri | |
Uuid
|
uuid | string | |
Who
|
who | string |
|
Name | Path | Type | Description |
---|---|---|---|
Signer After Document
|
after_document | uri | |
Signer Approve Only
|
approve_only | boolean |
Require user to approve the document (without adding a signature), see: Approve only |
attachments
|
attachments | array of SignerAttachment | |
Signer Declined
|
declined | boolean | |
Signer Declined On
|
declined_on | date-time | |
Signer Display Name
|
display_name | string | |
Signer Downloaded
|
downloaded | boolean | |
Signer Email
|
|||
Signer Email Viewed
|
email_viewed | boolean | |
Signer Emailed
|
emailed | boolean | |
Signer Embed Url
|
embed_url | uri | |
Signer Embed Url User Id
|
embed_url_user_id | string | |
Signer First Name
|
first_name | string | |
Signer Force Language
|
force_language | boolean | |
Signer Forwarded
|
forwarded | boolean | |
Signer Forwarded On
|
forwarded_on | date-time | |
Signer Forwarded Reason
|
forwarded_reason | string | |
Signer Forwarded To Email
|
forwarded_to_email | ||
Signer In Person
|
in_person | boolean |
When used in combination with an embed url on the sender, after sender has signed, they will be redirected to the next |
inputs
|
inputs | array of SignerInputs | |
Signer Language
|
language | string | |
Signer Last Name
|
last_name | string | |
Signer Message
|
message | string | |
Signer Needs To Sign
|
needs_to_sign | boolean |
When |
Signer Notify Only
|
notify_only | boolean |
Send notifications about the document and a copy of the signed document and signing log, but don't require them to take any action, see: Notify only |
Signer Order
|
order | integer | |
Signer Password
|
password | string |
Require the signer to enter this password before signing a document. This field is write only. |
Signer Redirect Url
|
redirect_url | uri | |
Signer Redirect Url Declined
|
redirect_url_declined | uri | |
Signer Signed
|
signed | boolean | |
Signer Signed On
|
signed_on | date-time | |
Signer Use Stamp For Approve Only
|
use_stamp_for_approve_only | boolean |
Place an approval stamp on a document when a signer approves a document |
Signer Verify Bank Account
|
verify_bank_account | string | |
Signer Verify Phone Number
|
verify_phone_number | string | |
Signer Viewed
|
viewed | boolean |
Name | Path | Type | Description |
---|---|---|---|
File
|
file | uri | |
for_attachment
|
for_attachment | RequiredAttachment | |
Name
|
name | string |
Defaults to filename |
Uuid
|
uuid | string |
Name | Path | Type | Description |
---|---|---|---|
Checkbox value
|
checkbox_value | boolean | |
Date value
|
date_value | date | |
External id
|
external_id | string | |
Page index
|
page_index | integer | |
Placeholder uuid
|
placeholder_uuid | string | |
Text
|
text | string | |
Type
|
type | string |
Name | Path | Type | Description |
---|---|---|---|
User Display Name
|
display_name | string | |
User Email Address
|
|||
User First Name
|
first_name | string | |
User Last Name
|
last_name | string |