Share via


SignNow

SignNow enables secure, compliant, and audit-ready eSignature workflows for businesses, legal, HR, healthcare, and finance teams. Send and track signature requests in role-based order, pre-fill document fields, and manage document groups using the SignNow connector.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Help Center
URL https://support.signnow.com/
Email integrations@pdffiller.com
Connector Metadata
Publisher DaDaDocs
Website https://signnow.com
Privacy policy https://www.signnow.com/privacy_policy
Categories Productivity;Human Resources

SignNow Connector

SignNow enables secure, compliant, and audit-ready eSignature workflows for businesses, legal, HR, healthcare, and finance teams. Send and track signature requests in role-based order, pre-fill document fields, and manage document groups using the SignNow connector.

Pre-requisites

You will need a SignNow account and SignNow API subscription to proceed.

Deploying the sample

First, update the clientId value in the apiProperties.json with your own.

Run the following commands and follow the prompts:

paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret <client_secret>

Supported Actions and Triggers

See documentation for more details.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Cancel invite

Signature invite cancellation

Create Document Embedded Invite

This action creates an embedded signing invite for a document. Once the invite is created, generate an embedded signing link

Create Document Embedded Sending Link

This action generates an embedded sending link for a specific document, allowing third-party users to prepare and send the document for signature

Create Document from Template

Generate a document from a selected template

Create Document Group Embedded Invite

This action creates an embedded signing invite for a document group. Once the invite is created, generate an embedded signing link

Create Document Group Embedded Sending Link

This action generates an embedded sending link for a specific document group, allowing third-party users to prepare and send the document group for signature

Create Document Group from Multiple Files

Create a document group by uploading multiple files as base64-encoded strings

Create Document Group from the Group Template

Create the document group from a selected group template

Create Signing Link

Generate a link to the document and share it to have the document signed

Delete Document

Delete a document from SignNow

Delete Document Embedded Invite

This action deletes an embedded invite for a document

Delete Document Group Embedded Invite

This action deletes an embedded invite for a specific document group

Deprecated - Advanced Document Invite

The action is deprecated. Invite request with manually defined schema. It allows to setup invite for a document that will be generated in the future

Deprecated - Invite to sign

The action is deprecated. Invite others to fill out and sign the document

Deprecated - Invite to sign the Document Group

The action is deprecated. Invite others to fill out and sign the document group

Download Document

Download a document from SignNow

Generate Document Embedded Invite Link

This action generates a link for the document embedded invite

Generate Document Group Embedded Invite Link

This action generates a link for the document group embedded invite

Get Document Fields

Retrieve values from the fillable fields in the document

Get Document Fields [DEPRECATED]

This action has been deprecated. Please use Get Document Fields instead.

Get document field values.

Get Document Group

Retrieve a list of user's document groups

Get Document Group Invite Status

This action retrieves information about a document group invite, including the status of each step and action

Get Document Groups

Retrieve a list of user's document groups

Get Document Information

Get document properties like name, id, create/update dates etc.

Get Document Invite Status

This action retrieves information about a document invite, including the status of each step and action

Get Document List

Retrieve a list of user's documents

Get document schema [DEPRECATED]

This action has been deprecated. Please use Get document schema instead.

Get OpenAPI document schema

Invite to Sign Document

This action creates and sends a field invite for a document to be signed

Invite to Sign Document Group

This action creates an invite for signing a document group. You can configure a multistep workflow, where different recipients act on the document group at different stages

Prefill Document Field Values

Automatically populate fillable fields in the document with specific values

Prefill Document Field Values [DEPRECATED]

This action has been deprecated. Please use Prefill Document Field Values instead.

Prefill field values and properties.

Prefill Document Group Field Values

Automatically populate fillable fields in the documents with specific values

Prefill Document Group Smart Field Values

Automatically populate smart fields in the documents with specific values

Prefill Smart Field Values

Prefill Smart Field values for the specified document

Replace Recipients In Document Group Invite

This action replaces recipients in a document group invite by its invite ID. You can also set an invite expiration, reminders, reassign permissions, and decline options for each document

Replace Recipients in Document Invite

This action replaces recipients in the document invite based on their roles. It also allows updating invite settings such as authentication type, expiration days, and other advanced parameters for each role

Upload Document

Upload a document to SignNow

Cancel invite

Signature invite cancellation

Parameters

Name Key Required Type Description
Document Id
doc_id True string

Specify document id for signature invite cancellation

Returns

response
object

Create Document Embedded Invite

This action creates an embedded signing invite for a document. Once the invite is created, generate an embedded signing link

Parameters

Name Key Required Type Description
Document ID
id True string

Document ID

Signer Email
email True email

Recipient email address

Role
role True string

Recipient role name e.g. 'Signer 1' (viewer roles are not supported)

Order
order True integer

The order of signing

Name Formula
name_formula string

A formula to generate a completed document name using a prefix (any text) and fillable field data. Example: 'Contract|signer_name|signed_date', where 'Contract' is the prefix, and 'signer_name' and 'signed_date' are names of fillable fields

Role
role True string

Recipient role name e.g. 'Signer 1' (viewer roles are not supported)

Language
language string

Specifies the language of the signing session and notification emails for the signer. Possible values: En for English, Es for Spanish, and Fr for French. If not set, the language is determined by the language of your SignNow account

First Name
first_name string

Recipient first name

Last Name
last_name string

Recipient last name

Required Preset Signature Name
required_preset_signature_name string

Pre-filled text for the signature field, locked for editing by the recipient. Cannot be used with 'prefill_signature_name' or 'force_new_signature'

Prefill Signature Name
prefill_signature_name string

A string with a signature name that appears when a signer clicks a signature field. The signer can edit the signature

Require New Signature
force_new_signature boolean

Defines whether the signer can use their saved signature or not. If set to 'true', the signer has to add a new signature. If set to 'false', the signer can use the saved signature

Redirect Uri
redirect_uri string

The link that opens after the signing session has been completed

Decline Redirect Uri
decline_redirect_uri string

The link that opens after the recipient declines to sign the document

Close Redirect Uri
close_redirect_uri string

The link that opens when the recipient clicks Save Progress and Finish Later during a signing session or Close in view mode

Redirect Target
redirect_target string

Determines whether to open the redirect URI in a new tab in the browser or in the same tab after the signing session. Possible values: 'In the new tab' – opens the link in a new tab, 'In the same tab' - opens the link in the same tab

Authentication Type
authentication_type string

Authentication type used for recipient authentication during the signing session. Allowed values: 'Password', 'Phone call', and 'Sms'

Authentication Password
authentication_password string

Password set for the signer authentication. Required for the 'Password' authentication type

Authentication Phone
authentication_phone string

Phone number used to authenticate the signer. Required for the 'Phone call' and 'Sms' authentication type. Example: +1XXXXXXXXX

Authentication Sms Message
authentication_sms_message string

Custom sms message sent to the signer, containing the {password} placeholder. Used with the 'Sms' authentication type. Without this parameter, the signer receives a default sms with an autogenerated password (unlock code) - 'SignNow document invite unlock code: 123456' Example: Enter the password {password} to unlock your document

Delivery Type
delivery_type string

Defines how the invite is sent

Link Expiration
link_expiration integer

In how many minutes the email invite expires. Can be used only if 'Delivery type=email'. Valid range: 15–43200 minutes

Session Expiration
session_expiration integer

In how many minutes the signing session expires. If a link is generated for this invite, the session expiration resets. Applicable only when 'Delivery type=email' and for 'sign' actions. Valid range: 15–1440 minutes

QES Signature
signature string

Type of QES. Possible values: 'Eideasy', 'Nom151'. Used to request QES signatures from signers. All signers in the invite must use the same signature type. To create an invite with QES, the user must belong to an organization with QES enabled

Returns

Name Path Type Description
data
data array of object

Data

Id
data.id string

ID of the created embedded invite

Email
data.email string

Recipient email

Role ID
data.role_id string

Recipient role ID

Order
data.order integer

Recipient order of signing

Status
data.status string

Embedded invite status

This action generates an embedded sending link for a specific document, allowing third-party users to prepare and send the document for signature

Parameters

Name Key Required Type Description
Document ID
id True string

Document ID

Type
type string

Specifies the sending step at which the link should open. Possible values: 'Invite': opens the Send Invite page for the document, where the user can add signer emails, subject, message, etc. 'Document': opens the document in the editor to add fillable fields, then opens the Send Invite page

Redirect Uri
redirect_uri string

The page that opens after embedded sending has been set up. Required if 'Redirect target' is added

Link Expiration
link_expiration integer

Specifies how many minutes the link will remain active. The allowed range: 15 to 45 minutes. Admin-level users can set the duration up to a maximum of 43200 minutes

Redirect Target
redirect_target string

Determines whether to open the redirect URI in a new tab in the browser or in the same tab after the signing session. Possible values: 'In the new tab' – opens the link in a new tab, 'In the same tab' - opens the link in the same tab

Returns

Name Path Type Description
Url
url string

The link to the embedded document sending

Create Document from Template

Generate a document from a selected template

Parameters

Name Key Required Type Description
Document Template
doc_id True string

Select a template from the list

Document Name
document_name string

Enter new file name for the document

Returns

Name Path Type Description
Document ID
id DocumentId

Unique document ID

Create Document Group Embedded Invite

This action creates an embedded signing invite for a document group. Once the invite is created, generate an embedded signing link

Parameters

Name Key Required Type Description
Document Group ID
id True string

Document group ID

Order
order True integer

Signing order step. All signers assigned to a specific order step (e.g., order: 1) receive the invite email simultaneously. Emails for the next order step (e.g., order: 2) are sent only after all actions in the previous order step are completed

Email
email True string

Recipient email address

Document Id
id True string

ID of the document

Role
role string

Recipient role in the document. Roles should not be specified for the 'view' action

Action
action True string

The action required from the recipient in the document. Allowed values: 'sign', 'view'

Order
order True string

Signing order step

Email
email True string

Recipient email address

Language
language string

Specifies the language of the signing session and notification emails for the signer. Possible values: En for English, Es for Spanish, and Fr for French. If not set, the language is determined by the language of your SignNow account

First Name
first_name string

Recipient first name

Last Name
last_name string

Recipient last name

Required Preset Signature Name
required_preset_signature_name string

Pre-filled text for the signature field, locked for editing by the recipient

Redirect Uri
redirect_uri string

The link that opens after the signing session has been completed

Decline Redirect Uri
decline_redirect_uri string

The link that opens after the recipient declines to sign the document

Close Redirect Uri
close_redirect_uri string

The link that opens when the recipient clicks Save Progress and Finish Later during a signing session or Close in view mode

Redirect Target
redirect_target string

Determines whether to open the redirect URI in a new tab in the browser or in the same tab after the signing session. Possible values: 'In the new tab' – opens the link in a new tab, 'In the same tab' - opens the link in the same tab

Delivery Type
delivery_type string

Defines how the invite is sent

Link Expiration
link_expiration integer

In how many minutes the email invite expires. Can be used only if 'Delivery type=email'. Valid range: 15–43200 minutes

Session Expiration
session_expiration integer

In how many minutes the signing session expires. If a link is generated for this invite, the session expiration resets. Applicable only when 'Delivery type=email' and for 'sign' actions. Valid range: 15–1440 minutes

Authentication Type
authentication_type string

Authentication type used for recipient authentication during the signing session. Allowed values: 'Password', 'Phone call', and 'Sms'

Authentication Password
authentication_password string

Password set for the signer's authentication. Required for the 'Password' authentication type

Authentication Phone
authentication_phone string

Phone number used to authenticate the signer. Required for the 'Phone call' and 'Sms' authentication type. Example: +1XXXXXXXXX

Authentication Sms Message
authentication_sms_message string

Custom sms message sent to the signer, containing the {password} placeholder. Used with the 'Sms' authentication type. Without this parameter, the signer receives a default sms with an autogenerated password (unlock code) - 'SignNow document invite unlock code: 123456'. Example: Enter the password {password} to unlock your document

QES Signature
signature string

Type of QES. Possible values: 'Eideasy', 'Nom151'. Used to request QES signatures from signers. All signers in the invite must use the same signature type. To create an invite with QES, the user must belong to an organization with QES enabled

Returns

Name Path Type Description
Invite ID
id string

ID of the created embedded invite

This action generates an embedded sending link for a specific document group, allowing third-party users to prepare and send the document group for signature

Parameters

Name Key Required Type Description
Document Group ID
id True string

Document group ID

Type
type string

Specifies the sending step at which the embedded link should open: 'manage' — opens the link on the Add documents to document group page; 'edit': opens the link in the editor; 'send-invite': opens the link on the Send Invite page

Redirect Uri
redirect_uri string

The page that opens after embedded sending has been set up. Required if 'Redirect target' is added

Link Expiration
link_expiration integer

Specifies how many minutes the link will remain active. The allowed range: 15 to 45 minutes. Admin-level users can set the duration up to a maximum of 43200 minutes

Redirect Target
redirect_target string

Determines whether to open the redirect URI in a new tab in the browser or in the same tab after the signing session. Possible values: 'In the new tab' – opens the link in a new tab, 'In the same tab' - opens the link in the same tab

Returns

Name Path Type Description
Url
url string

The link to the embedded document group sending

Create Document Group from Multiple Files

Create a document group by uploading multiple files as base64-encoded strings

Parameters

Name Key Required Type Description
Document Group Name
group_name True string

Enter a name for the document group

Document Name
name True string

Document name with extension: Report.pdf, Letter.docx etc

File Content
content True string

Base64-encoded string representing content of the document

Returns

Create Document Group from the Group Template

Create the document group from a selected group template

Parameters

Name Key Required Type Description
Group Template
doc_group_id True string

Select the group template from the list

Document Group Name
group_name string

Enter new name for the document group

Returns

Name Path Type Description
Document Group ID
id DocumentGroupId

Unique Document Group ID

Generate a link to the document and share it to have the document signed

Parameters

Name Key Required Type Description
Document ID
doc_id True string

Specify a unique document ID or select a document from the list

fields
fields dynamic

Returns

Name Path Type Description
URL
url_no_signup string

Signing Link

Delete Document

Delete a document from SignNow

Parameters

Name Key Required Type Description
Document ID
doc_id True string

Specify a unique document ID

Returns

Name Path Type Description
Status
status string

Document removal status

Delete Document Embedded Invite

This action deletes an embedded invite for a document

Parameters

Name Key Required Type Description
Document ID
id True string

Document ID

Delete Document Group Embedded Invite

This action deletes an embedded invite for a specific document group

Parameters

Name Key Required Type Description
Document Group ID
id True string

Document group ID

Deprecated - Advanced Document Invite

The action is deprecated. Invite request with manually defined schema. It allows to setup invite for a document that will be generated in the future

Parameters

Name Key Required Type Description
Document ID
doc_id True string

Provide a document ID

Name
role string

Role name of signer

E-mail
email email

Specify e-mail for signer

Phone Number (Invite via SMS)
phone_invite string

Specify +XXXXXXXXXXXX recipient's phone number. Required for Invite via SMS.

Order
order integer

Set the order of signing for multiple signers

Personalized Subject
subject string

Add Personalized Subject for Signer

Personalized Message
message string

Add Personalized message for Signer

Authentication type
authentication_type string

Verify user identity via password, SMS, or phone call

Password
password string

Set the password for Authentication type Password

Phone
phone string

Specify +XXXXXXXXXXXX phone number for Authentication type Phone or SMS

Days Until Expiration
expiration_days integer

Get signer be notified in how many days the invite expires

Send Reminder in
reminder integer

The number of days after sending the invite to automatically follow up with an email reminder

Send Reminder every X Days
remind_repeat integer

The recipient will get a reminder email every set amount of days.

Allow Forwarding
reassign boolean

Allow signer to delegate the signing to someone else

Show Decline on Signature
decline_by_signature boolean

Stamp a signature field as Decline to Sign if the recipient refused to sign the document

CC
cc string

A comma-separated emails that will be Carbon Copied in the invite

Subject
subject string

Type your subject

Message
message string

Type your message

Email all parties on completion
on_complete string

All parties receive a notification email when the document is signed

Returns

response
object

Deprecated - Invite to sign

The action is deprecated. Invite others to fill out and sign the document

Parameters

Name Key Required Type Description
Template
template True boolean

Specify if documents or templates should be retrieved

Document
template_id True string

Select a template from the list

body
body True dynamic

Returns

response
object

Deprecated - Invite to sign the Document Group

The action is deprecated. Invite others to fill out and sign the document group

Parameters

Name Key Required Type Description
Template
template True boolean

Specify if document groups or group templates should be retrieved

Document Group
template_group_id True string

Select the document group from the list

body
body True dynamic

Returns

response
object

Download Document

Download a document from SignNow

Parameters

Name Key Required Type Description
Document ID
doc_id True string

Specify a unique document ID or select a document from the list

Format
mode string

Select a document format for downloading

Returns

response
binary

This action generates a link for the document embedded invite

Parameters

Name Key Required Type Description
Document ID
id True string

Document ID

Field Invite ID
field_invite_id True string

Embedded invite ID from 'Create Document Embedded Invite' action

Link Expiration
link_expiration integer

Specifies how many minutes the link will remain active. Valid range:15-45 minutes

Session Expiration
session_expiration integer

Specifies how many minutes the signing session will remain active. Valid range:15-1440 minutes

Returns

Name Path Type Description
Link
data.link string

Generated embedded invite link for the document

This action generates a link for the document group embedded invite

Parameters

Name Key Required Type Description
Document Group ID
id True string

Document group ID

Document Group Embedded Invite ID
invite_id True string

ID of the document group embedded invite from 'Create Document Group Embedded Invite' action

Email
email True email

Recipient email address

Link Expiration
link_expiration integer

Specifies how many minutes the link will remain active. Valid range:15-45 minutes

Session Expiration
session_expiration integer

Specifies how many minutes the signing session will remain active. Valid range:15-1440 minutes

Returns

Name Path Type Description
Embedded Invite Link
link string

The link for document group embedded invite

Get Document Fields

Retrieve values from the fillable fields in the document

Parameters

Name Key Required Type Description
Template
template_id True string

Specify a document template to get fields from

Document ID
doc_id True string

Specify a unique document ID

Returns

The outputs of this operation are dynamic.

Get Document Fields [DEPRECATED]

This action has been deprecated. Please use Get Document Fields instead.

Get document field values.

Parameters

Name Key Required Type Description
Template
template_id True string

Specify a document template to get fields from

Document ID
doc_id True string

Specify a unique document ID

Returns

The outputs of this operation are dynamic.

Get Document Group

Retrieve a list of user's document groups

Parameters

Name Key Required Type Description
Group Template
doc_group_id True string

Select the group template from the list

Template
template True boolean

Specify if document group or group template should be retrieved

Returns

Get Document Group Invite Status

This action retrieves information about a document group invite, including the status of each step and action

Parameters

Name Key Required Type Description
Document Group ID
id True string

Document group ID

Returns

Name Path Type Description
Document Group Invite Id
document_group_invite_id string

Invite ID of the document group

Document Group Status
status string

Document group signing status. Possible values: 'created', 'pending', 'fulfilled', 'canceled'

Owner Email
owner_email string

Email address of the document group owner

Document Group Declined
is_document_declined boolean

Returns 'true' if any document in the group is declined by a signer or approver; otherwise, returns 'false'

steps
steps array of object

Steps

Step ID
steps.step_id string

Step ID from the document group invite

Signing Order
steps.signing_order integer

Order of signing

Document Id
steps.document_id string

Document id

Document Name
steps.document_name string

Document name

Signer Email
steps.signer_email string

Recipient email address

Role Name
steps.role_name string

Recipient role name

Action Type
steps.action_type string

The action required from the recipient in the document. Possible values: 'Sign', 'View', 'Approve', or 'FreeFormSign'

Step Invite ID
steps.invite_id string

ID of the invite step

Status
steps.status string

The signing status of the step

Declined
steps.declined boolean

True if the recipient in this step declined the document

Decline Reason
steps.decline_reason string

Message provided by the recipient when declining the document

Created
steps.created integer

Date when the step was created

Updated
steps.updated integer

Date when the step status was last updated

Get Document Groups

Retrieve a list of user's document groups

Parameters

Name Key Required Type Description
Template
template True boolean

Specify if document groups or group templates should be retrieved

Limit
limit integer

Total number of items returned (between 1 and 50)

Offset
offset integer

The (zero-based) offset of the first item in the collection to return

Returns

Get Document Information

Get document properties like name, id, create/update dates etc.

Parameters

Name Key Required Type Description
Template
template True boolean

Specify if documents or templates should be retrieved

Document ID
doc_id True string

Specify a unique document ID or select a document from the list

Returns

Get Document Invite Status

This action retrieves information about a document invite, including the status of each step and action

Parameters

Name Key Required Type Description
Document ID
id True string

Document ID

Returns

Name Path Type Description
Document Declined
is_document_declined boolean

True if the document was declined by the signer or approver, false otherwise

steps
steps array of object

Steps

Signing Order
steps.signing_order integer

Order of signing

Recipient Email
steps.signer_email string

Recipient email address

Role Name
steps.role_name string

Recipient role name

Action Type
steps.action_type string

The action required from the recipient in the document. Possible values: 'Sign', 'View', 'Approve', or 'FreeFormSign'

Invite ID
steps.invite_id string

Invite ID

Status
steps.status string

Signing status. Possible values: 'created', 'pending', 'fulfilled', 'canceled', 'skipped'

Declined
steps.declined boolean

Returns 'true' if the recipient of this step declined the document

Decline Reason
steps.decline_reason string

Message provided by the recipient when declining the document

Created
steps.created integer

Date when the step was created

Updated
steps.updated integer

Date when the step status was last updated

Get Document List

Retrieve a list of user's documents

Parameters

Name Key Required Type Description
Template
template boolean

Specify if documents or templates should be retrieved

Include Default Template
includeDefaultTemplate boolean

Specify if default template should be added to templates list

Returns

Get document schema [DEPRECATED]

This action has been deprecated. Please use Get document schema instead.

Get OpenAPI document schema

Parameters

Name Key Required Type Description
Document ID
doc_id string

Specify a unique document ID

Field type filter
select string

Separate with a comma what field types you'd like to retrieve

Returns

Name Path Type Description
properties
properties object

Invite to Sign Document

This action creates and sends a field invite for a document to be signed

Parameters

Name Key Required Type Description
Document ID
id True string

Document ID

Email
email string

Recipient email address

Email Group
email_group string

A group of users that should receive the invite. When one of the users signs the document, it is considered completed. Must be used with the 'email groups' advanced parameter. Required if 'Email' or 'Phone Invite' is not added, but cannot be used at the same time with either of these parameters

Phone Invite
phone_invite string

Recipient phone number. Required for Invite via SMS

Role
role True string

Recipient role name. e.g. Signer 1, Signer 2

Order
order True integer

Order of signing. The signing order defines the sequence in which recipients must sign or fill a document. Once all recipients in an order step complete signing, the document proceeds to the next order step (e.g., 2, 3). Multiple recipients can share the same signing order

Role
role True string

Recipient role name, used for mapping advanced parameteres

Prefill Signature Name
prefill_signature_name string

Pre-filled text in the signature field, available for editing by signer

Required Preset Signature Name
required_preset_signature_name string

Pre-filled text for the signature field, locked for editing by the recipient. Cannot be used with 'Prefill signature name' or 'Require new signature'

Require New Signature
force_new_signature boolean

Defines whether the signer can use a saved signature. False – signer can use a saved signature; True – signer must create a new signature

Allow Forwarding
reassign boolean

Defines whether the recipient can forward the invite to another email address. 'true': recipient can forward the invite; 'false': recipient cannot forward the invite

Allow Decline by Signature
decline_by_signature boolean

Defines whether to show the Decline to Sign option on signature fields. True – show the decline option; false – hide the decline option

Send Reminder in X Days
remind_after integer

X days after the invite, a recepient gets a reminder email (from 1 to 179 days). Must be less than 'Days until expiration'

Send Reminder in X Days Before Expiration
remind_before integer

X days before expiration, a recepient gets a reminder email (from 1 to 179 days). Must be less than 'Days until expiration'

Send Reminder Every X Days
remind_repeat integer

A recepient gets a reminder email each x days after the invite is sent (from 1 to 7 days)

Days Until Expiration
expiration_days integer

In X days, the invite expires (from 3 to 180 days)

Authentication Type
authentication_type string

Authentication type used for recipient authentication during the signing session. Allowed values: 'Password', 'Phone call', and 'Sms'

Authentication Password
password string

Password set for the signer authentication. Required for the 'Password' authentication type

Authentication Phone
phone string

Phone number used to authenticate the signer. Required for the 'Phone call' and 'Sms' authentication type. Example: +1XXXXXXXXX

Authentication Sms Message
authentication_sms_message string

Custom sms message sent to the signer, containing the {password} placeholder. Used with the 'Sms' authentication type. Without this parameter, the signer receives a default sms with an autogenerated password (unlock code) - 'SignNow document invite unlock code: 123456'. Example: Enter the password {password} to unlock your document

Subject
subject string

Custom email subject for the recipient

Message
message string

Custom email message for the recipient

Redirect Uri
redirect_uri string

When all the requested fields are completed and signed, the signer is redirected to this URI

Redirect Target
redirect_target string

Determines whether to open the redirect URI in a new tab in the browser or in the same tab after the signing session. Possible values: 'In the new tab' – opens the link in a new tab, 'In the same tab' - opens the link in the same tab

Decline Redirect Uri
decline_redirect_uri string

The link that opens after the document has been declined by the recipient

Close Redirect Uri
close_redirect_uri string

The link that opens when the recipient clicks Save Progress and Finish Later during a signing session or Close in view mode

Is Finish Redirect Canceled
is_finish_redirect_canceled boolean

Specifies whether the completion redirect setting is canceled for the organization. True – the redirect is canceled; False – the redirect remains active

Is Close Redirect Canceled
is_close_redirect_canceled boolean

Specifies whether the save progress redirect setting is canceled for the organization. True – the redirect is canceled; False – the redirect remains active

Is Decline Redirect Canceled
is_decline_redirect_canceled boolean

Specifies whether the decline redirect setting is canceled for the organization. True – the redirect is canceled; False – the redirect remains active

Language
language string

Specifies the language of the signing session and notification emails for the signer. Possible values: En for English, Es for Spanish, and Fr for French. If not set, the language is determined by the language of your SignNow account

Email
email True string

Viewer email address

Role
role True string

Viewer role name

Order
order True integer

Integer: the order of sending, starting from 1

Role
role True string

Viewer role name. Used for mapping advanced parameters

Subject
subject string

Custom email subject for the viewer

Message
message string

Custom email message for the viewer

Email
email True string

Approver email address

Role
role True string

Approver role name

Order
order True integer

The order of receiving the approval request

Role
role True string

Approver role name. Used for mapping advanced parameters

Expiration Days
expiration_days integer

Number of days before the invite expires

Message
message string

Custom email message for the approver

Subject
subject string

Custom email subject for the approver

Authentication Type
authentication_type string

Authentication type used for recipient authentication during the signing session. Allowed values: 'Password', 'Phone call', and 'Sms'

Password
password string

Password set for the signer authentication. Required for the 'Password' authentication type

Phone
phone string

Phone number used to authenticate the signer. Required for the 'Phone call' and 'Sms' authentication type. Example: +1XXXXXXXXX

Authentication Sms Message
authentication_sms_message string

Custom sms message sent to the signer, containing the {password} placeholder. Used with the 'Sms' authentication type. Without this parameter, the signer receives a default sms with an autogenerated password (unlock code) - 'SignNow document invite unlock code: 123456'. Example: Enter the password {password} to unlock your document

Redirect Uri
redirect_uri string

The URL that opens after the approver approves the document

Redirect Target
redirect_target string

Determines whether to open the redirect URI in a new tab in the browser or in the same tab after the signing session. Possible values: 'In the new tab' – opens the link in a new tab, 'In the same tab' - opens the link in the same tab

From
from string

Sender email address. Only the email associated with your SignNow account (login email) can be used. If left blank, it is set automatically

ID
id string

ID of an email group. A unique 40-character identifier that must be created beforehand

Name
name string

A name of the group. Use it in the Signers > Email Group field

Email
email string

Email address that should receive an invite

Email
email string

Email address that should receive an invite

Name
name string

Name of the step

Email
email string

CC recipient email address

Step
step integer

The order of sending, starting from 1

Subject
subject string

Email subject for all recipients

Message
message string

Email message for all recipients

CC Subject
cc_subject string

CC email subject for all CC recipients

CC Message
cc_message string

CC email message for all CC recipients

QES Signature
signature string

Type of QES. Possible values: 'Eideasy', 'Nom151'. Used to request QES signatures from signers. All signers in the invite must use the same signature type. To create an invite with QES, the user must belong to an organization with QES enabled

Returns

Name Path Type Description
Status
status string

Status

Invite to Sign Document Group

This action creates an invite for signing a document group. You can configure a multistep workflow, where different recipients act on the document group at different stages

Parameters

Name Key Required Type Description
Document Group ID
id True string

Document group ID

Order
order True integer

Order of signing step: 1 - the recipient(s) sign the document group first, then the document group is sent to 2,3 etc. Several recipients can hold the same order of signing

Email
email string

Recipient email address

Email Group
email_group string

A contact group of recipients

Role Name
role_name True string

Recipient role name in the document (can be used to identify fields in the document assigned to this particular recipient)

Action
action True string

Allowed action with a document. Possible values: View, Sign, Approve

Document ID
document_id True string

ID of the document on which actions are required from this recipient

Required Preset Signature Name
required_preset_signature_name string

Pre-filled text for the signature field, locked for editing by the recipient

Allow Forwarding
allow_reassign boolean

Defines whether the recipient can forward the invite to another email address. 'true': recipient can forward the invite; 'false': recipient cannot forward the invite

Allow Decline by Signature
decline_by_signature boolean

Defines whether to show the Decline to Sign option on signature fields. True: show the decline option; False: hide the decline option

Authentication Type
type string

Authentication type used for recipient authentication during the signing session. Allowed values: 'Password', 'Phone call', and 'Sms'

Password
value string

Password set for the signer authentication. Required for the 'Password' authentication type

Phone
phone string

Phone number used to authenticate the signer. Required for the 'Phone call' and 'Sms' authentication type. Example: +1XXXXXXXXX

Message
message string

Custom sms message sent to the signer, containing the {password} placeholder. Used with the 'Sms' authentication type. Without this parameter, the signer receives a default sms with an autogenerated password (unlock code) - 'SignNow document invite unlock code: 123456'

MerchantId
merchant_id string

The ID of the merchant account added to your Organization

Currency
currency string

The payment currency requested

Amount
amount string

The payment amount requested

Uri
redirect_uri string

When all the requested fields are completed and signed, the signer is redirected to this URI

Redirect Target
redirect_target string

Determines whether to open the redirect URI in a new tab in the browser or in the same tab after the signing session. Possible values: 'In the new tab' – opens the link in a new tab, 'In the same tab' - opens the link in the same tab

Decline Redirect Uri
decline_redirect_uri string

The link that opens after the document has been declined by the recipient

Close Redirect Uri
close_redirect_uri string

The link that opens when a signer clicks Save Progress and Finish Later during a signing session or Close in view mode

Is Finish Redirect Canceled
is_finish_redirect_canceled boolean

Specifies whether the completion redirect setting is canceled for the organization. True – the redirect is canceled; False – the redirect remains active

Is Close Redirect Canceled
is_close_redirect_canceled boolean

Specifies whether the save progress redirect setting is canceled for the organization. True – the redirect is canceled; False – the redirect remains active

Is Decline Redirect Canceled
is_decline_redirect_canceled boolean

Specifies whether the decline redirect setting is canceled for the organization. True – the redirect is canceled; False – the redirect remains active

Language
language string

Specifies the language of the signing session and notification emails for the signer. Possible values: En for English, Es for Spanish, and Fr for French. If not set, the language is determined by the language of your SignNow account

Order
order True integer

Order of signing step: 1 - the recipient(s) sign the document group first, then the document group is sent to 2,3 etc. Several recipients can hold the same order of signing

Email
email True string

Recipient's email address

Email Group
email_group string

A contact group of recipients

Subject
subject string

Custom email subject for the recipient

Message
message string

Custom email message for the recipient

Days Until Expiration
expiration_days integer

In x days, the invite expires (from 3 to 180 days)

Send Reminder in X Days
remind_after integer

X days after the invite, a recepient gets a reminder email (from 1 to 179 days). Must be less than Expiration Days

Send Reminder in X Days before Expiration
remind_before integer

X days before expiration, a recepient gets a reminder email (from 1 to 179 days). Must be less than Expiration Days

Send Reminder every X Days
remind_repeat integer

A recepient gets a reminder email each x days after the invite is sent (from 1 to 7 days)

Id
id string

ID of an email group. A unique 40-character identifier that must be created beforehand

Name
name string

A name of the group. Use it in the 'Invite Steps > Email Group'

Email
email string

Email address that should receive an invite

Email
email string

Email address of the recipient who will receive the completion email

Disable Document Attachment
disable_document_attachment boolean

Whether to disable sending document attachments with the completion email. Possible values: False - enable document attachment, True - disable document attachment

Subject
subject string

Custom subject for the completion email

Message
message string

Custom message for the completion email

Sign As Merged
sign_as_merged boolean

If true, allows API user to send an invite which opens as merged document group in a single document

Client Timestamp
client_timestamp integer

The timestamp of the document group invite

Email
email string

Email address that should receive an invite

QES Signature
signature string

Type of QES. Possible values: 'Eideasy', 'Nom151'. Used to request QES signatures from signers. All signers in the invite must use the same signature type. To create an invite with QES, the user must belong to an organization with QES enabled

Returns

Name Path Type Description
Id
id string

Document group invite ID

Pending Invite Link
pending_invite_link string

Pending invite link

Prefill Document Field Values

Automatically populate fillable fields in the document with specific values

Parameters

Name Key Required Type Description
Template
template_id True string

Specify a document template to get fields from

Document ID
doc_id True string

Specify a unique document ID

fields
fields dynamic

Returns

Name Path Type Description
Document ID
id DocumentId

Unique document ID

Prefill Document Field Values [DEPRECATED]

This action has been deprecated. Please use Prefill Document Field Values instead.

Prefill field values and properties.

Parameters

Name Key Required Type Description
Template
template_id True string

Specify a document template to get fields from

Document ID
doc_id True string

Specify a unique document ID

fields
fields dynamic

Returns

Name Path Type Description
Document ID
id DocumentId

Unique document ID

Prefill Document Group Field Values

Automatically populate fillable fields in the documents with specific values

Parameters

Name Key Required Type Description
Template
template_group_id True string

Specify a document group template to get fields from

Document Group ID
doc_group_id True string

Specify a unique document group ID

fields
fields dynamic

Returns

Name Path Type Description
Document Group ID
id DocumentGroupId

Unique Document Group ID

Prefill Document Group Smart Field Values

Automatically populate smart fields in the documents with specific values

Parameters

Name Key Required Type Description
Template
template_group_id True string

Specify a document group template to get fields from

Document Group ID
doc_group_id True string

Specify a unique document group ID

fields
fields dynamic

Returns

Name Path Type Description
Document Group ID
id DocumentGroupId

Unique Document Group ID

Prefill Smart Field Values

Prefill Smart Field values for the specified document

Parameters

Name Key Required Type Description
Template
template_id True string

Specify a document template to get fields from

Document ID
doc_id True string

Specify a unique document ID

fields
fields dynamic

Replace Recipients In Document Group Invite

This action replaces recipients in a document group invite by its invite ID. You can also set an invite expiration, reminders, reassign permissions, and decline options for each document

Parameters

Name Key Required Type Description
Document Group ID
id True string

Document group ID

Invite ID
invite_id True string

Document group invite ID

Step ID
step_id string

ID of the invite step from the document group invite

Recipient to Replace
recipient_to_update string

Email of the recipient to replace

New Recipient
new_recipient string

Email of the new recipient

Expiration Days
expiration_days integer

In how many days the invite expires; 30 days max

Reminder
reminder integer

In how many days to send a reminder to the signer; 30 days max

Document ID
document_id True string

Document ID from document group

Allow Forwarding
allow_forwarding boolean

Whether or not to allow recipients reassign this invite to another email address. Possible values: False - not allowed. True - allowed.

Allow Decline by Signature
decline_by_signature boolean

Defines whether to show the Decline to Sign option on signature fields. True: show the decline option; False: hide the decline option

Returns

Name Path Type Description
Status
status string

Status of recipients replacement

Replace Recipients in Document Invite

This action replaces recipients in the document invite based on their roles. It also allows updating invite settings such as authentication type, expiration days, and other advanced parameters for each role

Parameters

Name Key Required Type Description
Document ID
id True string

Document ID

Role
role True string

Role name of the recipient to be replaced

New Email
email True string

New recipient email

Role
role True string

Role name that requires additional invite parameters

Expiration Days
expiration_days integer

In how many days the invite expires. 30 days max

Allow Decline by Signature
decline_by_signature boolean

Defines whether to show the Decline to Sign option on signature fields. True: show the decline option; False: hide the decline option

Reminder
reminder integer

In how many days to send a reminder to the recipient. 30 days max

Authentication Type
authentication_type string

Authentication type used for recipient authentication during the signing session. Allowed values: 'Password', 'Phone call', and 'Sms'

Authentication Password
authentication_password string

Password set for the signer authentication. Required for the 'Password' authentication type

Authentication Phone
authentication_phone string

Phone number used to authenticate the signer. Required for the 'Phone call' and 'Sms' authentication type. Example: +1XXXXXXXXX

Authentication Sms Message
authentication_sms_message string

Custom sms message sent to the signer, containing the {password} placeholder. Used with the 'Sms' authentication type. Without this parameter, the signer receives a default sms with an autogenerated password (unlock code) - 'SignNow document invite unlock code: 123456'. Example: Enter the password {password} to unlock your document

Returns

Name Path Type Description
replacements
replacements array of object

Details of the new recipients

New Invite ID
replacements.new_invite_id string

The new field invite ID

Role
replacements.role string

Role name of the recipient that was replaced

New Email
replacements.new_email string

New recipient email

Upload Document

Upload a document to SignNow

Parameters

Name Key Required Type Description
File
file True file

File to upload

Returns

Name Path Type Description
Document ID
id DocumentId

Unique document ID

Triggers

Start flow on document event

Select the event to trigger on: the new or updated signature invite; when someone creates, updates, completes, or deletes a document

Start flow on document event [DEPRECATED]

This action has been deprecated. Please use Start flow on document event instead.

You can create trigger for one of this event: document create, document update, document delete, document complete, invite create, invite update

Start flow on document event

Select the event to trigger on: the new or updated signature invite; when someone creates, updates, completes, or deletes a document

Parameters

Name Key Required Type Description
Event
event True string

Select event which should trigger the Flow

Returns

Name Path Type Description
Event
meta.event string

Document event that caused the trigger.

Document ID
content.document_id string

Unique ID of target document which caused the event.

Document Name
content.document_name string

Target document file name without extension

Start flow on document event [DEPRECATED]

This action has been deprecated. Please use Start flow on document event instead.

You can create trigger for one of this event: document create, document update, document delete, document complete, invite create, invite update

Parameters

Name Key Required Type Description
Event
event True string

Select event which should trigger the Flow.

Returns

Name Path Type Description
Timestamp
meta.timestamp integer

Date and time when the event occured (Unix timestamp format).

Event
meta.event string

Document event that caused the trigger.

Document ID
content.document_id string

Unique ID of target document which caused the event.

Document Name
content.document_name string

Target document file name without extension

Definitions

DocumentProperties

Name Path Type Description
Document ID
id DocumentId

Unique document ID

Document Name
document_name string

Document file name without extension

Page count
page_count integer

Number of pages in the document

Created
created integer

Date and time the document was created in Unix Timestamp format

Updated
updated integer

The date and time the document was updated in Unix Timestamp format

Template name
original_filename string

Template file name with extension (if any)

Template ID
origin_document_id string

Template document ID (if any)

Is template
template boolean

true if document is template.

Document Status
status string

Document Status

DocumentGroupsResponse

Name Path Type Description
document_groups
document_groups array of DocumentGroupProperties
Document Groups Total Count
document_group_total_count integer

The total number of Document Groups in the SignNow account

DocumentGroupProperties

Name Path Type Description
Document Group ID
group_id DocumentGroupId

Unique Document Group ID

Document Group Name
group_name string

Document Group Name

Documents
documents array of DocumentGroupDocumentProperties

Documents

DocumentGroupDocumentProperties

Name Path Type Description
Document ID
id DocumentId

Unique document ID

Document Name
document_name string

Document file name without extension

Template ID
origin_document_id string

Template document ID (if any)

CreateDocumentGroupFromFilesResponse

Name Path Type Description
Document Group Name
group_name string

Document group name

Document Group Id
group_id string

Document group id

documents
documents array of object
Document ID
documents.id DocumentId

Unique document ID

Document Name
documents.name string

Document name

DocumentId

Unique document ID

Unique document ID

Document ID
string

DocumentGroupId

Unique Document Group ID

Unique Document Group ID

Document Group ID
string

object

This is the type 'object'.

binary

This is the basic data type 'binary'.