SigningHub (Preview)

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

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Contact
Email support@ascertia.com
Connector Metadata
Publisher Ascertia
Website https://www.signinghub.com
Privacy policy https://www.signinghub.com/privacy-policy/

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

About SigningHub

Get the SigningHub instance details

Add recipient

Add a recipient into existing workflow

Apply template

Apply a provided template on the document workflow

Approve a document

Recipient can approve the workflow on this turn

Complete the workflow (Terminate in the middle)

Workflow owner can complete workflow at any stage to terminate it

Create a workflow

Create a new workflow inside the SigningHub

Decline a document

Recipient can decline the workflow on his turn

Delete a workflow

Delete existing workflow by the workflow owner

Delete recipient from a workflow

Delete a particular recipient from an existing workflow

Download a particular document from a workflow

Download a particular document from an existing workflow

Download all documents of a workflow

Download all the documents in extracted/zipped format of an existing workflow from SigningHub

Get contects

Get a list of contacts related to the logged-in user from SigningHub

Get recipients

Get a list of recipients of an existing workflow

Get templates

Get a list of all enterprise templates from SigningHub

Get workflow details

Get the workflow details

Get workflows

Get a list of workflows from SigningHub for the Logged-in user

Share a document workflow

Share a document workflow to the recipient

Sign document

Signs a document by logged-in-user

Upload a document into workflow

Upload a document into existing workflow

About SigningHub

Get the SigningHub instance details

Returns

Name Path Type Description
Build
aboutSigningHub.build string

Build of SigningHub instance

Copyright
aboutSigningHub.copyright string

Copyright of SigningHub

Installation name
aboutSigningHub.installation_name string

Installation name of SigningHub instance

US Patent No.
aboutSigningHub.patents.us_patent_no string

US Patent No. of SigningHub

Version
aboutSigningHub.version string

Version of SigningHub instance

Add recipient

Add a recipient into existing workflow

Parameters

Name Key Required Type Description
Workflow ID
packageId True integer

The ID of the existing workflow

Add signature field
addSignatureField True boolean

Add a signature field into the workflow

Document ID
documentId integer

The ID of the document

Email Notification
emailNotification True boolean

Email notification

Only me
onlyMe boolean

The type of recipient as only me

Page No.
pageNo integer

The number of the document page

Page position
pagePosition True string

the position on the page

Page X
pageX integer

The horizontal position on the document page

Page Y
pageY integer

The vertical position on the document page

Role
role True string

The role of the recipient

Signing order
signingOrder True integer

The order of the signing of the recipient

User email
userEmail True string

The email of the recipient

User name
userName True string

The name of the recipient

Returns

Name Path Type Description
Recipient added
recipientAdded boolean

Recipient added response

Apply template

Apply a provided template on the document workflow

Parameters

Name Key Required Type Description
Workflow ID
packageId True integer

The ID of the workflow

Document ID
documentId True integer

The ID of the document

Apply to all
applyToAll True boolean

Apply to all documents

Template name
templateName True string

The name of the applied template

Returns

Name Path Type Description
Certify enabled
applyTemplate.certify.enabled boolean

The certify enabled value

Certify permission
applyTemplate.certify.permission string

The certify permission value

Document height
applyTemplate.document_height integer

The height of the document

Document ID
applyTemplate.document_id integer

The ID of the document

Document name
applyTemplate.document_name string

The name of the document

Document order
applyTemplate.document_order integer

The order of the document in workflow

Document pages
applyTemplate.document_pages integer

Total pages of the document

Document source
applyTemplate.document_source string

The source of the document

Document type
applyTemplate.document_type string

The type of the document

Document width
applyTemplate.document_width integer

The width of the document

Form fields
applyTemplate.form_fields boolean

The form fields availability in the document

Lock form fields
applyTemplate.lock_form_fields boolean

The lock form fields enabled value

Modified on
applyTemplate.modified_on string

The date of the modified

Read only
applyTemplate.template.read_only boolean

The ready only type of the template

Template name
applyTemplate.template.template_name string

The name of the applied template

Uploaded on
applyTemplate.uploaded_on string

The date of the uploaded on

Approve a document

Recipient can approve the workflow on this turn

Parameters

Name Key Required Type Description
Workflow ID
packageId True integer

The ID of the workflow

Approve reason
approveReason string

The reason to approve the document

Returns

Name Path Type Description
Document approved
documentApproved boolean

The status of the document approved

Complete the workflow (Terminate in the middle)

Workflow owner can complete workflow at any stage to terminate it

Parameters

Name Key Required Type Description
Workflow ID
packageId True string

The ID of the workflow

Returns

Name Path Type Description
Workflow completed
workflowCompleted boolean

The status of the workflow completed

Create a workflow

Create a new workflow inside the SigningHub

Parameters

Name Key Required Type Description
Document content
documentContent True string

The content of the document in base64

Workflow Name
documentName True string

Create a new workflow inside the SigningHub

Returns

Name Path Type Description
Document ID
documentId integer

The ID of the document

Package ID
packageId integer

The ID of the workflow

Decline a document

Recipient can decline the workflow on his turn

Parameters

Name Key Required Type Description
Workflow ID
packageId True integer

The ID of the workflow

Decline reason
declineReason True string

The reason to decline the document

Returns

Name Path Type Description
Document declined
documentDeclined boolean

The status of the document declined

Delete a workflow

Delete existing workflow by the workflow owner

Parameters

Name Key Required Type Description
Workflow ID
packageId True integer

The ID of the workflow

Returns

Name Path Type Description
Workflow deleted
packageDeleted boolean

The workflow deleted response

Delete recipient from a workflow

Delete a particular recipient from an existing workflow

Parameters

Name Key Required Type Description
Workflow ID
packageId True integer

The ID of the workflow

Order
order True integer

The order of the deleted recipient

Returns

Name Path Type Description
Recipient deleted
recipientDeleted boolean

The recipient deleted status

Download a particular document from a workflow

Download a particular document from an existing workflow

Parameters

Name Key Required Type Description
Workflow ID
packageId True integer

The ID of the workflow

Document ID
documentId True integer

The ID of the document

Returns

Name Path Type Description
Document content
documentContent byte

The content of the document in base64 string

Document type
documentType string

The type of the document

Download all documents of a workflow

Download all the documents in extracted/zipped format of an existing workflow from SigningHub

Parameters

Name Key Required Type Description
Workflow ID
packageId True integer

The ID of the workflow

Returns

Name Path Type Description
Workflow content
packageContent byte

The content of the workflow in base64 string

Workflow type
packageType string

The type of the workflow content

Get contects

Get a list of contacts related to the logged-in user from SigningHub

Parameters

Name Key Required Type Description
Enterprise
enterprise boolean

The enterprise contacts list

Page No.
pageNo True integer

The number of the page

Records per page
recordsPerPage True integer

The number of records per page

Search text
searchText string

The searching text to filter out the list

Returns

Name Path Type Description
array of object
User email
user_email string

The email of the user

User name
user_name string

The name of the user

User national ID
user_national_id string

The national ID of the user

Get recipients

Get a list of recipients of an existing workflow

Parameters

Name Key Required Type Description
Workflow ID
packageId True integer

The ID of the workflow

Returns

Name Path Type Description
recipients
recipients array of object

recipients

Delegatee
recipients.delegatee string

The email of the delegatee

Delegatee name
recipients.delegatee_name string

The name of the delegatee

Group name
recipients.group_name string

The name of the group

Order
recipients.order integer

The order of the recipient

Placeholder
recipients.placeholder string

The placeholder value

Process status
recipients.process_status string

The status of the placeholder

Processed as
recipients.processed_as string

The processed as value

Processed by
recipients.processed_by string

The email of the processed by

Processed on
recipients.processed_on string

The date of the processed

Reason
recipients.reason string

The reason if any

Role
recipients.role string

The role of the recipient

Signing order
recipients.signing_order integer

The order of the signing

User email
recipients.user_email string

The email of the user

User name
recipients.user_name string

The name of the user

User national ID
recipients.user_national_id string

The national ID of the user

Get templates

Get a list of all enterprise templates from SigningHub

Returns

Name Path Type Description
templatesCollection
templatesCollection array of object

templatesCollection

templatesCollection.read_only boolean

read_only

template_id
templatesCollection.template_id integer

template_id

template_name
templatesCollection.template_name string

template_name

template_public
templatesCollection.template_public boolean

template_public

Get workflow details

Get the workflow details

Parameters

Name Key Required Type Description
Workflow ID
packageId True integer

The ID of the workflow

Returns

Name Path Type Description
array of object
documents
documents array of object

documents

allowed_permissions
documents.certify.allowed_permissions array of string

allowed_permissions

default_permission
documents.certify.default_permission string

default_permission

enabled
documents.certify.enabled boolean

enabled

created_on
documents.created_on string

created_on

document_height
documents.document_height integer

document_height

document_id
documents.document_id integer

document_id

document_name
documents.document_name string

document_name

document_order
documents.document_order integer

document_order

document_pages
documents.document_pages integer

document_pages

document_source
documents.document_source string

document_source

document_type
documents.document_type string

document_type

document_width
documents.document_width integer

document_width

form_fields
documents.form_fields boolean

form_fields

lock_form_fields
documents.lock_form_fields boolean

lock_form_fields

modified_on
documents.modified_on string

modified_on

template
documents.template string

template

Folder
folder string

The folder type

Modified on
modified_on string

The date of modified

Next signer
next_signer string

The email of the next signer

next_signer_email
next_signer_email array of

next_signer_email

Owner name
owner_name string

The display name of owner

Workflow ID
package_id integer

The ID of the workflow

Workflow name
package_name string

The name of the workflow

Workflow owner
package_owner string

The owner of the workflow

Package status
package_status string

The current status of the workflow

Uploaded on
uploaded_on string

The date of the workflow uploaded

users
users array of

users

Continue on decline
workflow.continue_on_decline boolean

Continue on decline of the workflow

contacts
workflow.post_process.contacts array of

contacts

Dropbox
workflow.post_process.dropbox boolean

The Dropbox enabled value

Google drive
workflow.post_process.google_drive boolean

The Google drive enabled value

Workflow recipients
workflow.post_process.workflow_recipients boolean

The workflow recipients value

Read only
workflow.read_only boolean

The workflow read only value

Workflow mode
workflow.workflow_mode string

The mode of the workflow

Workflow status
workflow.workflow_status string

The status of the workflow

Workflow type
workflow.workflow_type string

The type of the workflow

Get workflows

Get a list of workflows from SigningHub for the Logged-in user

Parameters

Name Key Required Type Description
Document status
documentStatus True string

The status of the document

Folder
folder True string

The folder of the user's workflow

Page No.
pageNo True integer

The number of the document page

Records per page
recordsPerPage integer

The number of records per page

Search text
searchText string

The search text to filter out the list

Returns

Name Path Type Description
array of object
Folder
folder string

The folder of the user's workflow

Modified on
modified_on string

The date of the modified

Next signer
next_signer string

The next signer of the workflow

next_signer_email
next_signer_email array of object

next_signer_email

user_email
next_signer_email.user_email string

user_email

user_name
next_signer_email.user_name string

user_name

Owner name
owner_name string

The name of the workflow owner

Workflow ID
package_id integer

The ID of the workflow

Workflow name
package_name string

The name of the workflow

Workflow owner
package_owner string

The email of the workflow owner

Workflow status
package_status string

The status of the workflow

Unread
unread boolean

Unread type

Uploaded on
uploaded_on string

The date of the workflow uploaded

Share a document workflow

Share a document workflow to the recipient

Parameters

Name Key Required Type Description
Workflow ID
packageId True integer

The ID of the workflow

Returns

Name Path Type Description
array of object
Workflow ID
packageID integer

The ID of shared workflow

Sign document

Signs a document by logged-in-user

Parameters

Name Key Required Type Description
Workflow ID
packageId True integer

The ID of the workflow

Document ID
documentId True integer

The ID of the document

Page No.
pageNo True integer

The number of the document page

Page position
pagePosition True string

The position on the document page

Page X
pageX integer

The horizontal position on document page

Page Y
pageY integer

The vertical position on document page

Returns

Name Path Type Description
Document name
documentName string

The name of signed document

Field name
fieldName string

The name of signed field

Status
status string

The status of the signed document

Upload a document into workflow

Upload a document into existing workflow

Parameters

Name Key Required Type Description
Workflow ID
packageId True integer

The ID of the existing workflow

Document content
documentContent True byte

The content of the added document in base64

Document name with extension
documentName True string

The name of the added document with extension

Returns

Name Path Type Description
Document ID
documentId string

The ID of the uploaded document