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.
Status: Preview |
Tier: Premium |
Version: v1 |
Name |
Summary |
Send SignRequest |
|
TeamsList ([Optional]integer page, [Optional]integer limit, [Optional]string include_personal) |
Retrieve a list of Teams |
TemplatesList ([Optional]integer page, [Optional]integer limit, [Optional]string subdomain) |
Retrieve a list of Templates |
Name |
Summary |
When a document status changes |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Send SignRequest
Description: Creates and sends a new SignRequest.
Syntax:
SignRequest.SignrequestQuickCreateCreate (SignRequestQuickCreate data)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
data |
|
|
True |
Returns:
Summary: Retrieve a list of Teams
Description: Retrieves a list of teams.
Syntax:
SignRequest.TeamsList ([Optional]integer page, [Optional]integer limit, [Optional]string include_personal)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
page |
integer
|
A page number within the paginated result set. |
False |
|
limit |
integer
|
Number of results to return per page. |
False |
|
include_personal |
string
|
|
False |
Returns:
Type:TeamsListResponse
Summary: Retrieve a list of Templates
Description: Retrieves a list of templates.
Syntax:
SignRequest.TemplatesList ([Optional]integer page, [Optional]integer limit, [Optional]string subdomain)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
page |
integer
|
A page number within the paginated result set. |
False |
|
limit |
integer
|
Number of results to return per page. |
False |
|
subdomain |
string
|
|
False |
Returns:
Summary: When a document status changes
Description: Triggers when the document status of a SignRequest changes.
Syntax:
SignRequest.WebhooksCreate (WebhookSubscription data)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
data |
|
|
True |
Returns:
Type:WebhookSubscription
Summary:
Description:
Properties:
Name |
Type |
Summary |
approve_only |
boolean
|
Require user to approve the document (without adding a signature), see: [Approve only](#section/Additional-signing-methods/Approve-only) |
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 `in_person` signer, see: [In person signing](#section/Additional-signing-methods/In-person-signing) |
needs_to_sign |
boolean
|
When `false` user does not need to sign, but will receive a copy of the signed document and signing log, see: [Copy only](#section/Additional-signing-methods/Copy-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](#section/Additional-signing-methods/Notify-only) |
order |
integer
|
|
placeholders |
array of (Placeholder)
|
|
signer_index |
integer
|
|
Summary:
Description: Prefill signer input data, see [prefill tags](#section/Preparing-a-document/Prefill-tags-templates)
Properties:
Name |
Type |
Summary |
checkbox_value |
boolean
|
|
date_value |
string(date)
|
|
external_id |
string
|
|
text |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
is_active |
boolean
|
|
is_admin |
boolean
|
|
is_owner |
boolean
|
|
url |
string(uri)
|
|
user |
|
|
uuid |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
checkbox_value |
boolean
|
|
date_value |
string(date)
|
|
external_id |
string
|
|
page_index |
integer
|
|
prefill |
boolean
|
|
text |
string
|
|
type |
string
|
Values: [s, i, n, d, t, c] |
uuid |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
|
uuid |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
after_document |
string(uri)
|
|
approve_only |
boolean
|
Require user to approve the document (without adding a signature), see: [Approve only](#section/Additional-signing-methods/Approve-only) |
attachments |
array of (SignerAttachment)
|
|
declined |
boolean
|
|
declined_on |
string(date-time)
|
|
display_name |
string
|
|
downloaded |
boolean
|
|
|
string(email)
|
|
email_viewed |
boolean
|
|
emailed |
boolean
|
|
embed_url |
string(uri)
|
|
embed_url_user_id |
string
|
|
first_name |
string
|
|
force_language |
boolean
|
|
forwarded |
boolean
|
|
forwarded_on |
string(date-time)
|
|
forwarded_reason |
string
|
|
forwarded_to_email |
string(email)
|
|
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 `in_person` signer, see: [In person signing](#section/Additional-signing-methods/In-person-signing) |
inputs |
array of (SignerInputs)
|
|
language |
string
|
Values: [en, en-gb, nl, fr, de, he, da, fi, hu, it, no, pl, pt, es, sv, ru] |
last_name |
string
|
|
message |
string
|
|
needs_to_sign |
boolean
|
When `false` user does not need to sign, but will receive a copy of the signed document and signing log, see: [Copy only](#section/Additional-signing-methods/Copy-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](#section/Additional-signing-methods/Notify-only) |
order |
integer
|
|
password |
string
|
Require the signer to enter this password before signing a document. This field is write only. |
redirect_url |
string(uri)
|
|
redirect_url_declined |
string(uri)
|
|
signed |
boolean
|
|
signed_on |
string(date-time)
|
|
use_stamp_for_approve_only |
boolean
|
Place an approval stamp on a document when a signer approves a document |
verify_bank_account |
string
|
|
verify_phone_number |
string
|
|
viewed |
boolean
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
file |
string(uri)
|
|
for_attachment |
|
|
name |
string
|
Defaults to filename |
uuid |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
checkbox_value |
boolean
|
|
date_value |
string(date)
|
|
external_id |
string
|
|
page_index |
integer
|
|
placeholder_uuid |
string
|
|
text |
string
|
|
type |
string
|
Values: [s, i, n, d, t, c] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
auto_delete_days |
integer
|
Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted |
auto_expire_days |
integer
|
Number of days after which a non finished document will be automatically expired |
disable_attachments |
boolean
|
Disable uploading/adding of attachments |
disable_blockchain_proof |
boolean
|
Disables storing timestamp proof hashes in blockchain integrations. |
disable_date |
boolean
|
Disable adding of dates |
disable_emails |
boolean
|
Disable all SignRequest status emails as well as the email that contains the signed documents |
disable_text |
boolean
|
Disable adding of text |
disable_text_signatures |
boolean
|
Disable usage of signatures generated by typing (text) |
disable_upload_signatures |
boolean
|
Disable usage of uploaded signatures (images) |
document |
string(uri)
|
|
events_callback_url |
string(uri)
|
URL at which to receive [event callbacks](#section/Events/Events-callback) for this document |
external_id |
string
|
ID used to reference document in external system |
file |
string(uri)
|
Temporary URL to original file, expires in five minutes |
file_from_content |
string(byte)
|
Base64 encoded document content |
file_from_content_name |
string
|
Filename, including extension. Required when using `file_from_content`. |
file_from_url |
string(uri)
|
Publicly accessible URL of document to be downloaded by SignRequest |
from_email |
string(email)
|
Email of user sending the SignRequest (must be a validated email) |
from_email_name |
string
|
Name to be used in the `From` email header, e.g. `{from_email_name} <no-reply@signrequest.com>` |
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 |
is_being_prepared |
boolean
|
Have the sender of a SignRequest prepare the document before sending the request out, see: [prepare using the web interface](#section/Preparing-a-document/Prepare-using-the-web-interface) |
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` |
name |
string
|
Defaults to filename, including extension |
prefill_tags |
array of (InlinePrefillTags)
|
Prefill signer input data, see [prefill tags](#section/Preparing-a-document/Prefill-tags-templates) |
prepare_url |
string(uri)
|
|
redirect_url |
string(uri)
|
URL at which SignRequest will redirect to when a document is signed |
redirect_url_declined |
string(uri)
|
URL at which SignRequest will redirect to when a document is declined |
required_attachments |
array of (RequiredAttachment)
|
Attachments that signers are required to upload |
send_reminders |
boolean
|
Automatically remind signers to sign a document, see: [automatic reminders](#section/Working-with-a-SignRequest/Automatic-reminders) |
signers |
array of (Signer)
|
|
subdomain |
string
|
|
subject |
string
|
Subject of SignRequest email |
template |
string(uri)
|
|
text_message_verification_locked |
boolean
|
When true a text message verification is needed before the signer can see the document |
url |
string(uri)
|
|
uuid |
string
|
|
who |
string
|
`m`: only me, `mo`: me and others, `o`: only others Values: [m, mo, o] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
delete_after |
string(date-time)
|
When filled this team will be deleted after this date |
events_callback_url |
string(uri)
|
|
logo |
string(uri)
|
|
members |
array of (InlineTeamMember)
|
|
name |
string
|
|
phone |
string
|
|
primary_color |
string
|
|
sandbox |
boolean
|
Indicates whether team is in Sandbox mode |
subdomain |
string(uri)
|
|
url |
string(uri)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
count |
integer
|
|
next |
string(uri)
|
|
previous |
string(uri)
|
|
results |
array of (Team)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
Defaults to filename |
signers |
array of (DocumentSignerTemplateConf)
|
|
team |
|
|
url |
string(uri)
|
|
user |
|
|
uuid |
string
|
|
who |
string
|
`m`: only me, `mo`: me and others, `o`: only others Values: [m, mo, o] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
|
subdomain |
string(uri)
|
|
url |
string(uri)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
count |
integer
|
|
next |
string(uri)
|
|
previous |
string(uri)
|
|
results |
array of (Template)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
display_name |
string
|
|
|
string(email)
|
|
first_name |
string
|
|
last_name |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
callback_url |
string(uri)
|
|
created |
string(date-time)
|
|
event_type |
string
|
Values: [convert_error, converted, sending_error, sent, declined, cancelled, expired, signed, viewed, downloaded, signer_signed, signer_email_bounced, signer_viewed_email, signer_viewed, signer_forwarded, signer_downloaded, signrequest_received] |
name |
string
|
Optional name to easily identify what webhook is used for |
subdomain |
string
|
|
team |
|
|
url |
string(uri)
|
|
uuid |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
|
subdomain |
string(uri)
|
|
url |
string(uri)
|
|