SignNow makes it easy to sign, send, and manage documents anywhere on any device with a simple and secure electronic signature solution.
Status: Preview |
Tier: Premium |
Version: 1.2.1 |
Name |
Summary |
Get Document List |
|
Upload Document |
|
Get Document Information |
|
Delete Document |
|
CreateFromTemplate (string doc_id, [Optional]CreateFromTemplateParameterBody body) |
Create Document from Template |
Get invite request body schema |
|
Create Signing Link |
|
SendInvite (boolean template, string template_id, SendInviteParameterBody body) |
Invite to sign |
DownloadDocument (string doc_id, [advanced][Optional]string mode) |
Download Document |
Get Document Fields |
|
Prefill Document Field Values |
|
Get Document Fields |
|
Prefill Document Field Values |
|
GetDocSchema ([Optional]string doc_id, [Optional]string select) |
Get document schema |
GetDocSchema_V2 ([Optional]string doc_id, [Optional]string select) |
Get document schema |
Get Enum Values |
|
Delete Event Subscription |
|
Get Event Subscription |
|
Delete Event Subscription |
Name |
Summary |
Start flow on document event |
|
Start flow on document event |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
File |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get Document List
Description: Retrieve a list of user's documents
Syntax:
SignNow.GetListDoc ([advanced][Optional]boolean template, [advanced][Optional]boolean includeDefaultTemplate)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
template |
boolean (Template) |
Specify if documents or templates should be retrieved |
False |
|
includeDefaultTemplate |
boolean (Include Default Template) |
Specify if default template should be added to templates list |
False |
Returns:
Type:array of (DocumentProperties)
Summary: Upload Document
Description: Upload a document to SignNow
Syntax:
SignNow.UploadDocument (file file)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
file |
(File) |
File to upload |
True |
Returns:
Summary: Get Document Information
Description: Get document properties like name, id, create/update dates etc.
Syntax:
SignNow.GetDoc (boolean template, string doc_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
template |
boolean (Template) |
Specify if documents or templates should be retrieved |
True |
|
doc_id |
string (Document ID) |
Specify a unique document ID or select a document from the list |
True |
Returns:
Type:DocumentProperties
Summary: Delete Document
Description: Delete a document from SignNow
Syntax:
SignNow.DeleteDoc (string doc_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
doc_id |
string (Document ID) |
Specify a unique document ID |
True |
Returns:
Type:DeleteDocResponse
Summary: Create Document from Template
Description: Generate a document from a selected template
Syntax:
SignNow.CreateFromTemplate (string doc_id, [Optional]CreateFromTemplateParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
doc_id |
string (Document Template) |
Select a template from the list |
True |
|
body |
CreateFromTemplateParameterBody
|
|
False |
Returns:
Type:CreateFromTemplateResponse
Summary: Get invite request body schema
Description: Retrieve the OpenAPI request body schema for the invite to sign the document
Syntax:
SignNow.GetInviteSchema ([Optional]string doc_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
doc_id |
string (Document ID) |
Specify a unique document ID |
False |
Returns:
Summary: Create Signing Link
Description: Generate a link to the document and share it to have the document signed
Syntax:
SignNow.CreateSigningLink (string doc_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
doc_id |
string (Document ID) |
Specify a unique document ID or select a document from the list |
True |
Returns:
Type:CreateSigningLinkResponse
Summary: Invite to sign
Description: Invite others to fill out and sign the document
Syntax:
SignNow.SendInvite (boolean template, string template_id, SendInviteParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
template |
boolean (Template) |
Specify if documents or templates should be retrieved |
True |
|
template_id |
string (Document) |
Select a template from the list |
True |
|
body |
|
|
True |
Returns:
Type:SendInviteResponse
Summary: Download Document
Description: Download a document from SignNow
Syntax:
SignNow.DownloadDocument (string doc_id, [advanced][Optional]string mode)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
doc_id |
string (Document ID) |
Specify a unique document ID or select a document from the list |
True |
|
mode |
string (Format) |
Select a document format for downloading |
False |
Returns:
Type:string(binary)
Summary: Get Document Fields
Description: Get document field values.
Syntax:
SignNow.GetDocFields (string template_id, string doc_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
template_id |
string (Template) |
Specify a document template to get fields from |
True |
|
doc_id |
string (Document ID) |
Specify a unique document ID |
True |
Returns:
Type:DocumentFields
Summary: Prefill Document Field Values
Description: Prefill field values and properties.
Syntax:
SignNow.UpdateFieldValues (string template_id, string doc_id, [Optional]UpdateFieldValuesParameterFields fields)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
template_id |
string (Template) |
Specify a document template to get fields from |
True |
|
doc_id |
string (Document ID) |
Specify a unique document ID |
True |
|
fields |
UpdateFieldValuesParameterFields
|
|
False |
Returns:
Type:UpdateFieldValuesResponse
Summary: Get Document Fields
Description: Retrieve values from the fillable fields in the document
Syntax:
SignNow.GetDocFields_V2 (string template_id, string doc_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
template_id |
string (Template) |
Specify a document template to get fields from |
True |
|
doc_id |
string (Document ID) |
Specify a unique document ID |
True |
Returns:
Type:DocumentFields_V2
Summary: Prefill Document Field Values
Description: Automatically populate fillable fields in the document with specific values
Syntax:
SignNow.UpdateFieldValues_V2 (string template_id, string doc_id, [Optional]UpdateFieldValues_V2ParameterFields fields)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
template_id |
string (Template) |
Specify a document template to get fields from |
True |
|
doc_id |
string (Document ID) |
Specify a unique document ID |
True |
|
fields |
UpdateFieldValues_V2ParameterFields
|
|
False |
Returns:
Type:UpdateFieldValues_V2Response
Summary: Get document schema
Description: Get OpenAPI document schema
Syntax:
SignNow.GetDocSchema ([Optional]string doc_id, [Optional]string select)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
doc_id |
string (Document ID) |
Specify a unique document ID |
False |
|
select |
string (Field type filter) |
Separate with a comma what field types you'd like to retrieve |
False |
Returns:
Type:GetDocSchemaResponse
Summary: Get document schema
Description: Retrieve the OpenAPI document schema
Syntax:
SignNow.GetDocSchema_V2 ([Optional]string doc_id, [Optional]string select)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
doc_id |
string (Document ID) |
Specify a unique document ID |
False |
|
select |
string (Field type filter) |
Separate with a comma what field types you'd like to retrieve |
False |
Returns:
Summary: Get Enum Values
Description: Retrieve available enums for dynamic values
Syntax:
SignNow.GetEnumValues (string definitionKey)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
definitionKey |
string
|
Enum definition name. Complete list of definitions can be found calling /enum endpoint |
True |
Returns:
Type:array of (GetEnumValuesResponseItem)
Summary: Delete Event Subscription
Description: Remove the user's subscription for a particular event
Syntax:
SignNow.DeleteEvent (string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string
|
ID of the event subscription being deleted |
True |
Returns:
Type:DeleteEventResponse
Summary: Get Event Subscription
Description: Retrieve the event subscriptions for a particular user
Syntax:
SignNow.GetEvent ()
Returns:
Type:GetEventResponse
Summary: Delete Event Subscription
Description: Remove the user's subscription for a particular event
Syntax:
SignNow.DeleteEvent_V2 (string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string
|
ID of the event subscription being deleted |
True |
Returns:
Summary: Start flow on document event
Description: You can create trigger for one of this event: document create, document update, document delete, document complete, invite create, invite update
Syntax:
SignNow.Triggers (TriggersParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Type:TriggersResponse
Summary: Start flow on document event
Description: Select the event to trigger on: the new or updated signature invite; when someone creates, updates, completes, or deletes a document
Syntax:
SignNow.Triggers_V2 (Triggers_V2ParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Type:Triggers_V2Response
Summary:
Description:
Properties:
Name |
Type |
Summary |
document_name |
string Document Name |
Enter new file name for the document |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string Document ID |
Unique document ID |
Summary:
Description:
Properties:
Name |
Type |
Summary |
url_no_signup |
string URL |
Signing Link |
Summary:
Description:
Properties:
Name |
Type |
Summary |
status |
string Status |
Document removal status |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string id |
id |
status |
string status |
status |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string id |
id |
status |
string status |
status |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string Document ID |
Unique document ID |
document_name |
string Document Name |
Document file name without extension |
page_count |
integer(int32) Page count |
Number of pages in the document |
created |
integer(int32) Created |
Date and time the document was created in Unix Timestamp format |
updated |
integer(int32) Updated |
The date and time the document was updated in Unix Timestamp format |
original_filename |
string Template name |
Template file name with extension (if any) |
origin_document_id |
string Template ID |
Template document ID (if any) |
template |
boolean Is template |
true if document is template. |
roles |
array of (RolesItem) Roles |
Document signers settings. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
unique_id |
string
|
Unique Role ID |
signing_order |
string
|
Preset order of signing for multiple signers |
name |
string
|
Unique role name in the document |
Summary: File
Description: File to upload
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
properties |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
properties |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
name |
value |
string
|
value |
Summary:
Description:
Properties:
Name |
Type |
Summary |
subscriptions |
array of (SubscriptionsItem) subscriptions |
subscriptions |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string id |
id |
event |
string event |
event |
created |
string created |
created |
Summary:
Description:
Properties:
Name |
Type |
Summary |
properties |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
event |
string Event |
Select event which should trigger the Flow. |
callback_url |
string callback_url |
callback_url |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string id |
id |
created |
string created |
created |
updated |
string updated |
updated |
Summary:
Description:
Properties:
Name |
Type |
Summary |
event |
string Event |
Select event which should trigger the Flow |
entity_id |
string
|
entity_id |
action |
string
|
action |
attributes |
|
attributes |
Summary:
Description: attributes
Properties:
Name |
Type |
Summary |
callback |
string
|
callback |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string id |
id |
created |
string created |
created |
updated |
string updated |
updated |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string Document ID |
Unique document ID |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string Document ID |
Unique document ID |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string Document ID |
Unique document ID |