SigningHub is a complete solution for document approval workflows, advanced digital signatures and document status tracking. It is designed to quickly optimize the way businesses deliver, review, approve and sign their business documents
Status: Preview |
Tier: Premium |
Version: 1.0 |
Name |
Summary |
About SigningHub |
|
CreateWorkflow ([Optional]CreateWorkflowParameterCreateWorkflowRequest CreateWorkflowRequest) |
Create a workflow |
GetWorkflows ([Optional]GetWorkflowsParameterGetWorkflowsRequest GetWorkflowsRequest) |
Get workflows |
Delete a workflow |
|
Approve a document |
|
Download all documents of a workflow |
|
Complete the workflow (Terminate in the middle) |
|
Decline a document |
|
Upload a document into workflow |
|
Download a particular document from a workflow |
|
Sign document |
|
Apply template |
|
Share a document workflow |
|
Get workflow details |
|
Get recipients |
|
Add recipient |
|
Delete recipient from a workflow |
|
GetContects ([Optional]GetContectsParameterGetContactsRequest GetContactsRequest) |
Get contects |
Get templates |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: About SigningHub
Description: Get the SigningHub instance details
Syntax:
SigningHub.AboutSigningHub ()
Returns:
Summary: Create a workflow
Description: Create a new workflow inside the SigningHub
Syntax:
SigningHub.CreateWorkflow ([Optional]CreateWorkflowParameterCreateWorkflowRequest CreateWorkflowRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
CreateWorkflowRequest |
CreateWorkflowParameterCreateWorkflowRequest
|
|
False |
Returns:
Summary: Get workflows
Description: Get a list of workflows from SigningHub for the Logged-in user
Syntax:
SigningHub.GetWorkflows ([Optional]GetWorkflowsParameterGetWorkflowsRequest GetWorkflowsRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
GetWorkflowsRequest |
GetWorkflowsParameterGetWorkflowsRequest
|
|
False |
Returns:
Type:array of (GetWorkflowsResponseItem)
Summary: Delete a workflow
Description: Delete existing workflow by the workflow owner
Syntax:
SigningHub.DeleteWorkflow (integer packageId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
packageId |
integer(int64) (Workflow ID) |
The ID of the workflow |
True |
Returns:
Summary: Approve a document
Description: Recipient can approve the workflow on this turn
Syntax:
SigningHub.ApproveDocument (integer packageId, [Optional]ApproveDocumentParameterApproveDocumentRequest ApproveDocumentRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
packageId |
integer(int64) (Workflow ID) |
The ID of the workflow |
True |
|
ApproveDocumentRequest |
ApproveDocumentParameterApproveDocumentRequest
|
|
False |
Returns:
Summary: Download all documents of a workflow
Description: Download all the documents in extracted/zipped format of an existing workflow from SigningHub
Syntax:
SigningHub.DownloadWorkflow (integer packageId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
packageId |
integer(int64) (Workflow ID) |
The ID of the workflow |
True |
Returns:
Summary: Complete the workflow (Terminate in the middle)
Description: Workflow owner can complete workflow at any stage to terminate it
Syntax:
SigningHub.CompleteWorkflow (string packageId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
packageId |
string (Workflow ID) |
The ID of the workflow |
True |
Returns:
Summary: Decline a document
Description: Recipient can decline the workflow on his turn
Syntax:
SigningHub.DeclineDocument (integer packageId, [Optional]DeclineDocumentParameterDeclineDocumentRequest DeclineDocumentRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
packageId |
integer(int64) (Workflow ID) |
The ID of the workflow |
True |
|
DeclineDocumentRequest |
DeclineDocumentParameterDeclineDocumentRequest
|
|
False |
Returns:
Summary: Upload a document into workflow
Description: Upload a document into existing workflow
Syntax:
SigningHub.UploadDocument (integer packageId, [Optional]UploadDocumentParameterUploadDocumentRequest UploadDocumentRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
packageId |
integer(int64) (Workflow ID) |
The ID of the existing workflow |
True |
|
UploadDocumentRequest |
UploadDocumentParameterUploadDocumentRequest
|
|
False |
Returns:
Summary: Download a particular document from a workflow
Description: Download a particular document from an existing workflow
Syntax:
SigningHub.DownloadDocument (integer packageId, integer documentId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
packageId |
integer(int64) (Workflow ID) |
The ID of the workflow |
True |
|
documentId |
integer(int64) (Document ID) |
The ID of the document |
True |
Returns:
Summary: Sign document
Description: Signs a document by logged-in-user
Syntax:
SigningHub.SignDocument (integer packageId, integer documentId, [Optional]SignDocumentParameterSignDocumentRequest SignDocumentRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
packageId |
integer(int64) (Workflow ID) |
The ID of the workflow |
True |
|
documentId |
integer(int64) (Document ID) |
The ID of the document |
True |
|
SignDocumentRequest |
SignDocumentParameterSignDocumentRequest
|
|
False |
Returns:
Type:SignDocumentResponse
Summary: Apply template
Description: Apply a provided template on the document workflow
Syntax:
SigningHub.ApplyTemplate (integer packageId, integer documentId, [Optional]ApplyTemplateParameterApplyTemplateRequest ApplyTemplateRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
packageId |
integer(int64) (Workflow ID) |
The ID of the workflow |
True |
|
documentId |
integer(int64) (Document ID) |
The ID of the document |
True |
|
ApplyTemplateRequest |
ApplyTemplateParameterApplyTemplateRequest
|
|
False |
Returns:
Summary: Share a document workflow
Description: Share a document workflow to the recipient
Syntax:
SigningHub.ShareWorkflow (integer packageId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
packageId |
integer(int64) (Workflow ID) |
The ID of the workflow |
True |
Returns:
Type:array of (ShareWorkflowResponseItem)
Summary: Get workflow details
Description: Get the workflow details
Syntax:
SigningHub.GetWorkflowDetails (integer packageId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
packageId |
integer(int64) (Workflow ID) |
The ID of the workflow |
True |
Returns:
Type:array of (GetWorkflowDetailsResponseItem)
Summary: Get recipients
Description: Get a list of recipients of an existing workflow
Syntax:
SigningHub.GetRecipients (integer packageId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
packageId |
integer(int64) (Workflow ID) |
The ID of the workflow |
True |
Returns:
Summary: Add recipient
Description: Add a recipient into existing workflow
Syntax:
SigningHub.AddRecipient (integer packageId, [Optional]AddRecipientParameterAddRecipientRequest AddRecipientRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
packageId |
integer(int64) (Workflow ID) |
The ID of the existing workflow |
True |
|
AddRecipientRequest |
AddRecipientParameterAddRecipientRequest
|
|
False |
Returns:
Type:AddRecipientResponse
Summary: Delete recipient from a workflow
Description: Delete a particular recipient from an existing workflow
Syntax:
SigningHub.DeleteRecipient (integer packageId, integer order)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
packageId |
integer(int64) (Workflow ID) |
The ID of the workflow |
True |
|
order |
integer(int32) (Order) |
The order of the deleted recipient |
True |
Returns:
Summary: Get contects
Description: Get a list of contacts related to the logged-in user from SigningHub
Syntax:
SigningHub.GetContects ([Optional]GetContectsParameterGetContactsRequest GetContactsRequest)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
GetContactsRequest |
GetContectsParameterGetContactsRequest
|
|
False |
Returns:
Type:array of (GetContectsResponseItem)
Summary: Get templates
Description: Get a list of all enterprise templates from SigningHub
Syntax:
SigningHub.GetTemplates ()
Returns:
Type:GetTemplatesResponse
Summary:
Description:
Properties:
Name |
Type |
Summary |
aboutSigningHub |
|
aboutSigningHub |
Summary:
Description: aboutSigningHub
Properties:
Name |
Type |
Summary |
build |
string
|
Build of SigningHub instance |
copyright |
string
|
Copyright of SigningHub |
installation_name |
string
|
Installation name of SigningHub instance |
patents |
|
patents |
version |
string
|
Version of SigningHub instance |
Summary:
Description: patents
Properties:
Name |
Type |
Summary |
us_patent_no |
string
|
US Patent No. of SigningHub |
Summary:
Description:
Properties:
Name |
Type |
Summary |
addSignatureField |
boolean
|
Add a signature field into the workflow Values: [, ] |
documentId |
integer(int64)
|
The ID of the document |
emailNotification |
boolean
|
Email notification Values: [, ] |
onlyMe |
boolean
|
The type of recipient as only me Values: [, ] |
pageNo |
integer(int32)
|
The number of the document page |
pagePosition |
string
|
the position on the page Values: [Top Left, Top Right, Bottom Left, Bottom Right, Center] |
pageX |
integer(int32)
|
The horizontal position on the document page |
pageY |
integer(int32)
|
The vertical position on the document page |
role |
string
|
The role of the recipient Values: [SIGNER, REVIEWER, EDITOR, CARBON_COPY, INPERSON_HOST] |
signingOrder |
integer(int32)
|
The order of the signing of the recipient |
userEmail |
string
|
The email of the recipient |
userName |
string
|
The name of the recipient |
Summary:
Description:
Properties:
Name |
Type |
Summary |
recipientAdded |
boolean
|
Recipient added response Values: [, ] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
applyToAll |
boolean
|
Apply to all documents Values: [, ] |
templateName |
string
|
The name of the applied template |
Summary:
Description:
Properties:
Name |
Type |
Summary |
applyTemplate |
|
applyTemplate |
Summary:
Description: applyTemplate
Properties:
Name |
Type |
Summary |
certify |
|
certify |
document_height |
integer(int32)
|
The height of the document |
document_id |
integer(int32)
|
The ID of the document |
document_name |
string
|
The name of the document |
document_order |
integer(int32)
|
The order of the document in workflow |
document_pages |
integer(int32)
|
Total pages of the document |
document_source |
string
|
The source of the document |
document_type |
string
|
The type of the document |
document_width |
integer(int32)
|
The width of the document |
form_fields |
boolean
|
The form fields availability in the document Values: [, ] |
lock_form_fields |
boolean
|
The lock form fields enabled value Values: [, ] |
modified_on |
string
|
The date of the modified |
template |
|
template |
uploaded_on |
string
|
The date of the uploaded on |
Summary:
Description: certify
Properties:
Name |
Type |
Summary |
enabled |
boolean
|
The certify enabled value Values: [, ] |
permission |
string
|
The certify permission value |
Summary:
Description: template
Properties:
Name |
Type |
Summary |
read_only |
boolean
|
The ready only type of the template Values: [, ] |
template_name |
string
|
The name of the applied template |
Summary:
Description:
Properties:
Name |
Type |
Summary |
approveReason |
string
|
The reason to approve the document |
Summary:
Description:
Properties:
Name |
Type |
Summary |
documentApproved |
boolean
|
The status of the document approved Values: [, ] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
workflowCompleted |
boolean
|
The status of the workflow completed Values: [, ] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
documentContent |
string
|
The content of the document in base64 |
documentName |
string
|
Create a new workflow inside the SigningHub |
Summary:
Description:
Properties:
Name |
Type |
Summary |
documentId |
integer(int32)
|
The ID of the document |
packageId |
integer(int32)
|
The ID of the workflow |
Summary:
Description:
Properties:
Name |
Type |
Summary |
declineReason |
string
|
The reason to decline the document |
Summary:
Description:
Properties:
Name |
Type |
Summary |
documentDeclined |
boolean
|
The status of the document declined Values: [, ] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
recipientDeleted |
boolean
|
The recipient deleted status Values: [, ] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
packageDeleted |
boolean
|
The workflow deleted response Values: [, ] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
documentContent |
string(byte)
|
The content of the document in base64 string |
documentType |
string
|
The type of the document |
Summary:
Description:
Properties:
Name |
Type |
Summary |
packageContent |
string(byte)
|
The content of the workflow in base64 string |
packageType |
string
|
The type of the workflow content |
Summary:
Description:
Properties:
Name |
Type |
Summary |
enterprise |
boolean
|
The enterprise contacts list Values: [, ] |
pageNo |
integer(int32)
|
The number of the page |
recordsPerPage |
integer(int32)
|
The number of records per page |
searchText |
string
|
The searching text to filter out the list |
Summary:
Description:
Properties:
Name |
Type |
Summary |
user_email |
string
|
The email of the user |
user_name |
string
|
The name of the user |
user_national_id |
string
|
The national ID of the user |
Summary:
Description:
Properties:
Name |
Type |
Summary |
recipients |
array of (RecipientsItem)
|
recipients |
Summary:
Description:
Properties:
Name |
Type |
Summary |
delegatee |
string
|
The email of the delegatee |
delegatee_name |
string
|
The name of the delegatee |
group_members |
string
|
The members of the group |
group_name |
string
|
The name of the group |
order |
integer(int32)
|
The order of the recipient |
placeholder |
string
|
The placeholder value |
process_status |
string
|
The status of the placeholder |
processed_as |
string
|
The processed as value |
processed_by |
string
|
The email of the processed by |
processed_on |
string
|
The date of the processed |
reason |
string
|
The reason if any |
role |
string
|
The role of the recipient |
signing_order |
integer(int32)
|
The order of the signing |
user_email |
string
|
The email of the user |
user_name |
string
|
The name of the user |
user_national_id |
string
|
The national ID of the user |
Summary:
Description:
Properties:
Name |
Type |
Summary |
templatesCollection |
array of (TemplatesCollectionItem)
|
templatesCollection |
Summary:
Description:
Properties:
Name |
Type |
Summary |
read_only |
boolean
|
read_only Values: [, ] |
template_id |
integer(int32)
|
template_id |
template_name |
string
|
template_name |
template_public |
boolean
|
template_public |
Summary:
Description:
Properties:
Name |
Type |
Summary |
documents |
array of (DocumentsItem)
|
documents |
folder |
string
|
The folder type |
modified_on |
string
|
The date of modified |
next_signer |
string
|
The email of the next signer |
next_signer_email |
array of (Next_signer_emailItem)
|
next_signer_email |
owner_name |
string
|
The display name of owner |
package_id |
integer(int64)
|
The ID of the workflow |
package_name |
string
|
The name of the workflow |
package_owner |
string
|
The owner of the workflow |
package_status |
string
|
The current status of the workflow |
uploaded_on |
string
|
The date of the workflow uploaded |
users |
array of (UsersItem)
|
users |
workflow |
|
workflow |
Summary:
Description:
Properties:
Name |
Type |
Summary |
certify |
|
certify |
created_on |
string
|
created_on |
document_height |
integer(int32)
|
document_height |
document_id |
integer(int32)
|
document_id |
document_name |
string
|
document_name |
document_order |
integer(int32)
|
document_order |
document_pages |
integer(int32)
|
document_pages |
document_source |
string
|
document_source |
document_type |
string
|
document_type |
document_width |
integer(int32)
|
document_width |
form_fields |
boolean
|
form_fields |
lock_form_fields |
boolean
|
lock_form_fields |
modified_on |
string
|
modified_on |
template |
string
|
template |
Summary:
Description: certify
Properties:
Name |
Type |
Summary |
allowed_permissions |
array of (string)
|
allowed_permissions |
default_permission |
string
|
default_permission |
enabled |
boolean
|
enabled |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description: workflow
Properties:
Name |
Type |
Summary |
continue_on_decline |
boolean
|
Continue on decline of the workflow Values: [, ] |
message |
string
|
The message if any |
post_process |
|
post_process |
read_only |
boolean
|
The workflow read only value Values: [, ] |
workflow_mode |
string
|
The mode of the workflow |
workflow_status |
string
|
The status of the workflow |
workflow_type |
string
|
The type of the workflow |
Summary:
Description: post_process
Properties:
Name |
Type |
Summary |
contacts |
array of (ContactsItem)
|
contacts |
dropbox |
boolean
|
The Dropbox enabled value Values: [, ] |
enabled |
boolean
|
Enabled status Values: [, ] |
google_drive |
boolean
|
The Google drive enabled value Values: [, ] |
message |
string
|
The message if any |
recipients |
string
|
The recipients value |
workflow_recipients |
boolean
|
The workflow recipients value Values: [, ] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
documentStatus |
string
|
The status of the document Values: [ALL, DRAFT, PENDING, SIGNED, DECLINED, INPROGRESS, COMPLETED] |
folder |
string
|
The folder of the user's workflow Values: [INBOX, ARCHIVE] |
pageNo |
integer(int32)
|
The number of the document page |
recordsPerPage |
integer(int32)
|
The number of records per page |
searchText |
string
|
The search text to filter out the list |
Summary:
Description:
Properties:
Name |
Type |
Summary |
folder |
string
|
The folder of the user's workflow |
modified_on |
string
|
The date of the modified |
next_signer |
string
|
The next signer of the workflow |
next_signer_email |
array of (Next_signer_emailItem)
|
next_signer_email |
owner_name |
string
|
The name of the workflow owner |
package_id |
integer(int32)
|
The ID of the workflow |
package_name |
string
|
The name of the workflow |
package_owner |
string
|
The email of the workflow owner |
package_status |
string
|
The status of the workflow |
unread |
boolean
|
Unread type Values: [, ] |
uploaded_on |
string
|
The date of the workflow uploaded |
Summary:
Description:
Properties:
Name |
Type |
Summary |
user_email |
string
|
user_email |
user_name |
string
|
user_name |
Summary:
Description:
Properties:
Name |
Type |
Summary |
packageID |
integer(int64)
|
The ID of shared workflow |
Summary:
Description:
Properties:
Name |
Type |
Summary |
pageNo |
integer(int32)
|
The number of the document page |
pagePosition |
string
|
The position on the document page Values: [Top Left, Top Right, Bottom Left, Bottom Right, Center] |
pageX |
integer(int32)
|
The horizontal position on document page |
pageY |
integer(int32)
|
The vertical position on document page |
Summary:
Description:
Properties:
Name |
Type |
Summary |
documentName |
string
|
The name of signed document |
fieldName |
string
|
The name of signed field |
status |
string
|
The status of the signed document |
Summary:
Description:
Properties:
Name |
Type |
Summary |
documentContent |
string(byte)
|
The content of the added document in base64 |
documentName |
string
|
The name of the added document with extension |
Summary:
Description:
Properties:
Name |
Type |
Summary |
documentId |
string
|
The ID of the uploaded document |