SignRequest

To use the SignRequest app, the user has to pay the API usage. For more information on pricing, see here.

The SignRequest modules allow you to monitor, create, update, send, retrieve, list, and delete the documents, document attachments, events, SignRequests, teams, and templates in your SignRequest account.

Getting Started with SignRequest

Prerequisites

The module dialog fields that are displayed in bold (in the Integromat scenario, not in this documentation article) are mandatory!

Connecting SignRequest to Integromat

1. Go to Integromat and open the SignRequest module's Create a connection dialog.

2. In the Connection name field, enter a name for the connection.

3. In the Subdomain field, enter your account domain details. For example, if your account URL address is https://www.xyz.signrequest.com then your subdomain is xyz.

4. Click Continue.

5. Confirm the access by clicking Authorize.

The connection has been established.

SignRequests

List SignRequests

Retrieves all SignRequests.

ConnectionEstablish a connection to your SignRequest account.
Filter by Who Signs DocumentSelect or map the option to choose the users to filter the SignRequests:
  • Only me
  • Me and Others
  • Only Others
Filter by Document Sender EmailEnter (map) the email address of the sender who is requesting the signature to list the requests that match the specified email address.
LimitSet the maximum number of SignRequests Integromat should return during one execution cycle.

Get a SignRequests

Retrieves a SignRequest.

ConnectionEstablish a connection to your SignRequest account.
SignRequest IDSelect or map the SignRequest ID whose details you want to retrieve.

Create Quick SignRequests

Creates a document and SignRequests in one call.

ConnectionEstablish a connection to your SignRequest account.
Document File Through Select or map the document file through for which you want to create the SignRequest:
  • URL
  • Data
  • Template
File URLEnter (map) the URL address of the document for which you are creating the SignRequest.
Source FileEnter the source file information for which you want to create the SignRequest:
File Data
Enter (map) the file data.
File Name
Enter (map) the file name.
TemplateSelect or map the Template of the document for which you want to create the SignRequest.
SignersAdd the signer's details:
EmailEnter (map) the email address of the signer.
Authorization RoleSelect or map the signer's applicable authorization role:
  • Sign
  • Sign in Person
  • Approve
  • Notify
  • Copy
User Stamp For Approve OnlySelect whether you want to place an approval stamp on a document when a signer approves the document.
Embed URL User IDEnter (map) the embed URL address of the User ID. For more information, see In-Person Signing.
Signing OrderEnter (map) the signing order details of the document.
First NameEnter (map) the signer's first name.
Last NameEnter (map) the signer's last name.
LanguageEnter (map) the document language.
Force LanguageSelect or map the language applicable to the signer.
PasswordEnter (map) the signer's password.
Verify by Phone NumberEnter (map) the phone number used for the text message verification. A country code including the plus-sign is required.
Verify by Bank AccountEnter (map) the bank account used for the bank account verification
Redirect URLEnter (map) the redirect URL address to which the user should be redirected after completing the sign.
Redirect URL DeclinedEnter (map) the redirect URL address to which the user should be redirected after declining the request.
Chained DocumentSelect or map the reference document that the signer should sign before signing this one. For more information, see the documentation.
About the Chained Document (in Signers)
The easiest way of working with the chained document is by sending the requests backward. Please see the following example:

Context: You want to send three different documents to a customer. 

1. Create three documents using the Create a Document module.
2. Create a SignRequest using the Create a SignRequest module with  Document 3 URL address in the documents field and Document 2  URL address in the after_documents field in the signers' array. This will not trigger a SignRequest email to be sent to the signer.
3. You create a SignRequest using the Create a SignRequest module with Document 2 URL address in documents field and Document 1 URL address in the after_documents field in the signers' array. This will not trigger a SignRequest email to be sent to the signer.
4. You create a SignRequest using the Create a SignRequest module with Document 1 URL address in the documents field without providing any details in the after_documents field. Because this SignRequest has no after_documents email, it triggers a SignRequest email to be sent to the signer.

Note: Resending the SignRequest email (in this case for Document 3 and Document 2) will trigger the SignRequest email to be sent to the signer even though there was none sent before.
When after_document references a document where the signer in question already has signed or declined they will still receive a SignRequest email as we cannot redirect them anymore. It's only possible to reference documents that are not fully signed (or declined) yet.

Email SenderEnter (map) the sender's email address. Required when authenticated as a Team. The reply-to email address 
Email Sender NameEnter (map) the sender's name who is sending the SignRequest.
Email SubjectEnter (map) the email subject line.
Email MessageEnter (map) the email message body.
Required AttachmentsAdd the required attachments for the SignRequest.
Needs PreparingSelect whether the sender of the SignRequest prepares the document before sending the request out.
Redirect URLEnter (map) the URL address the user must redirect to when a document is signed.
This only works when there are no chained documents for this signer anymore.
Redirect URL DeclinedEnter (map) the URL address the user must be redirected to when a document is declined.
This only works when there are no chained documents for this signer anymore.
Send RemindersSelect whether you want to enable the SignRequest to automatically remind the signers to sign a document on days 3, 8, 13, and 18.
Text Message Verification LockedSelect whether a text message verification is needed before the signer can see the document.
Document NameEnter (map) a document name that you want to send for the SignRequest.
Document External IDEnter (map) the document's External ID to access from the external systems.
Document Events Callback URLEnter (map) the document events callback URL address. 
Document Prefill TagsAdd the tags for the document:
External IDEnter (map) the External ID of the document that can be accessed from external systems.
TextEnter (map) the tag text.
Checkbox ValueSelect whether you want to provide a checkbox value for the tag.
Date ValueEnter (map) the date to add the date tag.
Document Auto Delete DaysEnter (map) the number of days after which a finished document (signed/canceled/declined) will be automatically deleted.
Document Auto Expire DaysEnter (map) the number of days after which a non-finished document will be automatically expired.
Force Signature Color
Enter (map) the specific color for the signature. For example, #0000ff.
This only works for the draw mode and does not affect the color-saved signatures.
Disable Text
Select whether you want to disable adding text to the document being sent for SignRequest.
Disable Date
Select whether you want to disable adding dates to the document being sent for SignRequest.
Disable Attachments
Select whether you want to disable uploading or add attachments to the document being sent for SignRequest.
Disable Emails
Select whether you want to disable all the SignRequest status emails and the email that contains the signed documents.
Disable Text Signatures
Select whether you want to disable the usage of signatures generated by typing the text.
Disable Upload Signatures
Select whether you want to disable the usage of uploaded signatures (images).
Disable Blockchain Proof 
Select whether you want to disable storing timestamp proof hashes in blockchain integrations.

Note: The endpoint might return an empty Document Name / External ID / File / File From URL / Event Callback URL/ File from SF / Auto Expire Days / Auto Delete Days (/ integration/integration_data) fields. But, if you retrieve the signrequest afterwards, they will no longer be empty.

Create a SignRequest

Creates a SignRequest.

ConnectionEstablish a connection to your SignRequest account.
Document URLSelect or map the Document URL address for which you want to create a SignRequest.
SignersAdd the signer details:
EmailEnter (map) the email address of the signer.
Authorization RoleSelect or map the signer's applicable authorization role:
  • Sign
  • Sign in Person
  • Approve
  • Notify
  • Copy
User Stamp For Approve OnlySelect whether you want to place an approval stamp on a document when a signer approves the document.
Embed URL User IDEnter (map) the embed URL address of the User ID. For more information, see In-Person Signing.
Signing OrderEnter (map) the signing order details of the document.
First NameEnter (map) the signer's first name.
Last NameEnter (map) the signer's last name.
LanguageEnter (map) the document language.
Force LanguageSelect or map the language applicable to the signer.
PasswordEnter (map) the signer's password.
Verify by Phone NumberEnter (map) the phone number used for the text message verification. A country code including the plus-sign is required.
Verify by Bank AccountEnter (map) the bank account used for the bank account verification. At present, it is only possible to verify bank accounts using iDEAL.
Redirect URLEnter (map) the redirect URL address to which the user should be redirected after completing the sign.
Redirect URL DeclinedEnter (map) the redirect URL address to which the user should be redirected after declining the request.
Chained DocumentSelect or map the reference document that the signer should sign before signing this one. For more information, see the documentation.

The easiest way of working with the chained documents is by sending the requests backward.
 
Please see the following example:

Context: You want to send three different documents to a customer. 

1. Create three documents using the Create a Document module.
2. Create a SignRequest using the Create a SignRequest module with  Document 3 URL address in the documents field and Document 2  URL address in the after_documents field in the signers' array. This will not trigger a SignRequest email to be sent to the signer.
3. You create a SignRequest using the Create a SignRequest module with Document 2 URL address in documents field and Document 1 URL address in the after_documents field in the signers' array. This will not trigger a SignRequest email to be sent to the signer.
4. You create a SignRequest using the Create a SignRequest module with Document 1 URL address in the documents field without providing any details in the after_documents field. Because this SignRequest has no after_documents email, it triggers a SignRequest email to be sent to the signer.

Note: Resending the SignRequest email (in this case for Document 3 and Document 2) will trigger the SignRequest email to be sent to the signer even though there was none sent before.
When after_document references a document where the signer in question already has signed or declined they will still receive a SignRequest email as we cannot redirect them anymore. It's only possible to reference documents that are not fully signed (or declined) yet.

Email SenderEnter (map) the sender's email address. Required when authenticated as a Team. The reply-to email address.
Email Sender NameEnter (map) the sender's name who is sending the SignRequest.
Email SubjectEnter (map) the email subject line.
Email MessageEnter (map) the email message body. The message may contain the following HTML tags: aabbracronymbblockquotecodeemiulliol, and strong.
Note: Ensure that when the text to HTML ratio is too high, the email may end up in spam filters. Custom styles on these tags are not allowed. 
Required AttachmentsAdd the required attachments for the SignRequest.
Needs PreparingSelect whether the sender of the SignRequest prepares the document before sending the request out.
Redirect URLEnter (map) the URL address the user must redirect to when a document is signed.
This only works when there are no chained documents for this signer anymore.  The fields in the mappable parameters will apply in general but will be overwritten for the specific signer by the signer's Redirect URL and Redirect URL Declined if they are defined. 
Redirect URL DeclinedEnter (map) the URL address the user must be redirected to when a document is declined.
This only works when there are no chained documents for this signer anymore. The fields in the mappable parameters will apply in general but will be overwritten for the specific signer by the signer's Redirect URL and Redirect URL Declined if they are defined. 
Send RemindersSelect whether you want to enable the SignRequest to automatically remind the signers to sign a document on days 3, 8, 13, and 18.
Text Message Verification LockedSelect whether a text message verification is needed before the signer can see the document.
Force Signature ColorEnter (map) the specific color for the signature. For example, #0000ff.
This only works for the draw mode and does not affect the color-saved signatures.
Disable TextSelect whether you want to disable adding text to the document being sent for SignRequest.
Disable DateSelect whether you want to disable adding dates to the document being sent for SignRequest.
Disable AttachmentsSelect whether you want to disable uploading or add attachments to the document being sent for SignRequest.
Disable EmailsSelect whether you want to disable all the SignRequest status emails and the email that contains the signed documents.
Disable Text SignaturesSelect whether you want to disable the usage of signatures generated by typing the text.
Disable Upload SignaturesSelect whether you want to disable the usage of uploaded signatures (images).
Disable Blockchain ProofSelect whether you want to disable storing timestamp proof hashes in blockchain integrations.

Resend a SignRequest

Resends a SignRequest.

ConnectionEstablish a connection to your SignRequest account.
SignRequest IDSelect or map the SignRequest ID which you want to resend.

Note: This module does not return errors if you try to resend a SignRequest that cannot be resent. It always returns OK.

Cancel a SignRequests

Cancels a SignRequest.

ConnectionEstablish a connection to your SignRequest account.
SignRequest IDSelect or map the SignRequest ID which you want to cancel.

Documents

Search Documents

Searches for documents using general or specific queries.

ConnectionEstablish a connection to your SignRequest account.
QueryEnter (map) the keywords or phrases to search the documents that match the specified query.
Partial QueryEnter (map) the characters to search the documents that match the specified characters.
Document NameEnter (map) the name to search the documents with the specified document name.
Signer EmailsEnter (map) the email address of the signer to search the document with the specified email addresses.
Filter by StatusSelect or map status to list the document with the specified status. For example, SignedDeclined.
Filter by Who SignsSelect or map the option to search the documents with the specified signers:
  • Only Me
  • Me and Others
  • Only Others
Export FormatSelect or map the format in which you want to export the search results:
  • JSON
  • CSV
  • XLS
Signer Data ModeSelect or map the signer data mode that can be used with the above CSV/XLS export format. Using Signer Data Mode will export each signer on a separate row. Also, the signer inputs that have an external ID specified on a tag will be exported. All external IDs found will be exported as columns. 
LimitSet the maximum number of documents Integromat should return during one execution cycle.

Note: All documents are only ordered by created (newest first) when Query, Partial Query, or Name are not used, else they are ordered by the strength of the match. 

List Documents

Retrieves all documents.

ConnectionEstablish a connection to your SignRequest account.
Filter by Who SignsSelect or map the option to list the documents with the specified signers:
  • Only Me
  • Me and Others
  • Only Others
Filter by StatusSelect or map status to list the document with the specified status. For example, SignedDeclined.
Filter by Sender EmailEnter (map) the sender's email address to list the documents with the specified email address.
Filter by External IDEnter (map) the External ID to list the documents with the specified ID.
Filter by User EmailEnter (map) the sender's email address to list the document with the specified email address.
Filter by User First NameEnter (map) the sender's user's first name to list the document with the specified name.
Filter by User Last NameEnter (map) the sender's user's last name to list the document with the specified name.
LimitSet the maximum number of documents Integromat should return during one execution cycle.

Get a Document

Retrieves a document.

ConnectionEstablish a connection to your SignRequest account.
Document IDSelect or map the Document ID whose details you want to retrieve.

Create a Document

Creates a document.

ConnectionEstablish a connection to your SignRequest account.
Document File ThroughSelect or map the document file through for which you want to create the document:
  • URL
  • Data
  • Template
File URLEnter (map) the publicly accessible URL of the document to be downloaded by SignRequest.
Source FileAdd the source file information:
File Name
Enter (map) the file name.
Data
Enter (map) the file data.
TemplateSelect or map the document template for which you want to create the document for SignRequest.
Document NameEnter (map) a name for the document.
External IDEnter (map) the External ID of the document that can be accessed from external systems.
Events Callback URLEnter (map) the URL address at which you want to receive event callbacks for this document. 
Prefill TagsAdd the tags for the document:
External IDEnter (map) the External ID of the document that can be accessed from external systems.
TextEnter (map) the tag text.
Checkbox ValueSelect whether you want to provide a checkbox value for the tag.
Date ValueEnter (map) the date to add the date tag.
Auto Delete DaysEnter (map) the number of days after which a finished document (signed/canceled/declined) will be automatically deleted.
Auto expire DaysEnter (map) the number of days after which a non-finished document will be automatically expired.

Delete a Document

Deletes a document.

ConnectionEstablish a connection to your SignRequest account.
Document IDSelect or map the Document ID whose details you want to retrieve.

Document Attachments

List a Document's Attachments

Retrieves a document's attachments.

ConnectionEstablish a connection to your SignRequest account.
Filter by DocumentSelect or map the option to choose the document whose attachments you want to list.
Document UUIDSelect or map the Document UUID whose attachments you want to list.
Document External IDSelect or map the Document External ID whose attachments you want to list.
LimitSet the maximum number of attachments Integromat should return during one execution cycle.

Get a Document Attachment

Retrieves a document attachment.

ConnectionEstablish a connection to your SignRequest account.
Document Attachment IDSelect or map the Document Attachment ID whose attachment details you want to retrieve.

Create a Document Attachment

Creates an attachment for a document.

ConnectionEstablish a connection to your SignRequest account.
Document URLSelect or map the document URL address to which you want to add an attachment.
Attachment NameEnter (map) a name for the attachment file.
File ThroughSelect or map the option to attach the document.
File URLEnter (map) the URL address of the attachment.
File DataEnter (map) the file data.
File NameEnter (map) the attachment file name.

Templates

List Templates

Retrieves all templates.

ConnectionEstablish a connection to your SignRequest account.
LimitSet the maximum number of templates Integromat should return during one execution cycle.

Get a Template

Retrieves a template.

ConnectionEstablish a connection to your SignRequest account.
Template UUIDSelect or map the Template UUID whose details you want to retrieve.

Teams

List Teams

Retrieves all teams.

ConnectionEstablish a connection to your SignRequest account.
LimitSet the maximum number of teams Integromat should return during one execution cycle.

List Team Members

Retrieves all team members.

ConnectionEstablish a connection to your SignRequest account.
Filter by is ActiveSelect whether you want to list the active team members.
Filter by Is OwnerSelect whether you want to list the team members who are owners.
Filter by Is AdminSelect whether you want to list the team members who are admins.
Filter by User EmailEnter (map) the user's email address to list the team members that match the specified email address.
Filter by User First NameEnter (map) the user's first name to list the team members that match the specified name.
Filter by User Last NameEnter (map) the user's last name to list the team members that match the specified name.
LimitSet the maximum number of team members Integromat should return during one execution cycle.

Get a Team Member

Retrieves a team member.

ConnectionEstablish a connection to your SignRequest account.
Team Member UUIDSelect or map the Team Member UUID whose details you want to retrieve.

Events

You do not have to add the webhooks in the SignRequest as it is automatically done for you once you add and save an instant trigger module to your scenario.

Watch Events

Watches SignRequests events.

Webhook NameEnter a name for the webhook.
ConnectionEstablish a connection to your SignRequest account.
Event TypeSelect or map the event type whose events you want to watch.
IntegrationSelect or map the integration you want to apply to watch the events. For example, Salesforce.
Optional Webhook NameEnter an optional name for the webhook.
You can set webhooks per document (while creating the document) and per event type (using the Watch Events module). Otherwise, it will be sent to the event callback URL you set on https://signrequest.com/#/teams.

List Events

Retrieves all events.

ConnectionEstablish a connection to your SignRequest account.
Filter by Event StatusSelect or map the status to list the events based on the selected status.
Filter by Event TypeSelect or map the event type you want to list.
Filter by DocumentSelect or map the documents whose events you want to list;
  • Document UUID
  • Document External ID
Document UUIDSelect or map the Document UUID whose events you want to list.
Document External UUIDSelect or map the Document External UUID whose events you want to list.
Filter by Who Signs DocumentSelect or map the signer to list the document's events that match the specified signer:
  • Only Me
  • Me and Others
  • Only Others
Filter by Document StatusSelect or map the status to list the events that match the document status. For example, newsent.
Filter by Document Sender EmailEnter (map) the sender's email address to list the events that match the specified email address.
Filter by Document User EmailEnter (map) the user's email address to list the events that match the specified email address.
Filter by Document User First NameEnter (map) the first name to list the events that match the specified name.
Filter by Document User Last Name
Enter (map) the last name to list the events that match the specified name.
Filter by DeliveredSelect whether you want to list the delivered events.
LimitSet the maximum number of events Integromat should return during one execution cycle.

Get an Event

Retrieves an event.

ConnectionEstablish a connection to your SignRequest account.
Event UUIDSelect or map the Event ID whose details you want to retrieve.

Other

Make an API Call

Performs an arbitrary authorized  API call.

ConnectionEstablish a connection to your SignRequest account.
URL

Enter a path relative to https://myDomain.signrequest.com/api  For example, /v1/documents/2e6b65de-1af9-4fc1-b78b-48d49f120e79 

For the list of available endpoints, refer to the SignRequest API Documentation.

Method

Select the HTTP method you want to use:

GET
to retrieve information for an entry.

POST
to create a new entry.

PUT
to update/replace an existing entry.

PATCH
to make a partial entry update.

DELETE
to delete an entry.

HeadersEnter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query StringEnter the request query string.
BodyEnter the body content for your API call.

Example of Use - List Documents

The following API call returns all the documents from your SignRequest account:

URL:
/v1/documents/

Method:
GET

Matches of the search can be found in the module's Output under BundleBody > results
In our example, 41 documents were returned:


Popular use cases from our blog

automated-data-collection-crm-illustration

How to Automate Data Collection - Part 5: CRM Systems

automated-data-collection-chatbot-marketing-illustration

How to Automate Data Collection - Part 4: Chatbot Marketing

automated-data-collection-paid-ads-illustration

How to Automate Data Collection - Part 3: Paid Ads

automated-data-collection-email-illustration

How to Automate Data Collection - Part 2: Email Marketing Segmentation

personalized-customer-experience-illustration-integromat

5 Automated Solutions to Personalize Customer Experience

data-collection-automation-forms-pt-1

How to Automate Data Collection - Part 1: Online Forms

Didn’t find what you were looking for?

Expert

Find an expert

We feature a network of 450+ certified partners across the globe who are ready to help

Find an expert

Automate any workflow in your business

Sign up for a free account today. No credit card required, no time limits on free plan.