SigningHub (Preview)

SigningHub by Ascertia delivers a comprehensive suite for high-trust digital signatures and document workflow automation. This connector enables businesses to securely authenticate users, initiate document signing requests, and manage end-to-end approval cycles. Designed to meet rigorous global security standards, it ensures that your automated workflows remain legally enforceable, transparent, and highly secure across your entire organisation.

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) - 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 Government regions - Azure China regions - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - 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) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	Support
URL	https://www.signinghub.com/contact-us/
Email	support@ascertia.com

Connector Metadata
Publisher	Ascertia Limited.
Publisher	Ascertia
StackOwner	SigningHub
BrandColor	#1C1C1C
IconBrandColor	#1C1C1C
Website	https://signinghub.com
Privacy policy	https://www.signinghub.com/privacy-policy
Categories	Content and Files;Productivity

SigningHub Connector

SigningHub provides a comprehensive REST API that enables organisations to automate and manage digital document signing workflows. Using this connector, you can integrate SigningHub with Power Automate to streamline document approval processes and automate signing actions within custom workflows.

This connector enables the automation of document signing and other SigningHub actions directly within Power Automate flows, helping organisations build efficient and secure document workflows.

Publisher: Ascertia

Prerequisites

To use this connector, you must have:

An active SigningHub account (https://www.signinghub.com).
A valid Integration defined in SigningHub.

How to get credentials

Fill the Login Form fields with the following values:

Email: The SigningHub account email.
Password: The SigningHub account password.
API Client ID: Ascertia or your company administrator will provide the API Client ID to use the connector.
API Client Secret: Ascertia or your company administrator will provide the API Client Secret to use the connector.
API URL: The SigningHub API URL, by default https://api.signinghub.com

Supported Operations

This connector provides some coverage of the SigningHub REST API. For a list of supported actions and their parameters, please refer to SigningHub API Guide.

Support & Links

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add CheckBox Field	Business applications can use this service API to add a checkbox to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users. If width and height parameters are not provided, a default size of 10x10 will be assigned. If either width or height (or both) is provided, the system will compare these provided values with each other. The larger value between width and height will be assigned to both dimensions.
Add Digital Signature Field	Business applications can use this service API to add a digital signature field to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information.Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.
Add Groups to Workflow	Business applications can use this service API to add groups as a recipient to a workflow. A SigningHub group means any member of the group can perform the action, i.e. sign, on behalf of all members of the group. Note the group will be added as the last user/group in the workflow.Hence further work may be required to remove a current user/group, already present in the workflow. While XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"
Add In-person Field	Business applications can use this service API to an add in-person signature field to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users. In order to host an in-person meeting a SigningHub user must be part of the workflow.They must either be added with Role "INPERSON_HOST" or "SIGNER". For the host option they do not require a signature or input field on the document, and the in-person signature field can be signed by the non-SigningHub registered user. Note this is a special workflow scenario whereby it is expected that the SigningHub user and recipient would be in the same location.This type of signature is not intended for use whereby a document is shared with recipients over email link in the normal loose integration method.
Add Initial Field	Business applications can use this service API to add an initials field to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.
Add or Update Document from Library	Business applications can use this service API to add a document from the user’s library to a package. Package ID is provided in the URL, the ID of the document should also be provided as “document_id” in the resource URL to identify the library document to be copied. Note a package must already exist before you can add a document using this call.
Add Package	This service API is used to add/create a document package to hold one or more documents. This package can then be used to add documents and recipients in order to start a new workflow. As previously stated, this call is mandatory if you wish to work with documents. A package must exist before you can upload or add documents to SigningHub.. Even a single document is a part of a package: a package containing one document. Note: A package can be renamed if required once created.
Add Placeholder to Workflow	Business applications can use this service API to add placeholder to a workflow in a package. A place holder is required when you do not know the identity of the intended recipient in a workflow. Note the placeholder will be added as the last user in the workflow.Hence further work may be required to remove a current user/group, already present in the workflow. Adding a place holder allows you to proceed and add signature and/or input fields to the document, which can then be assigned to individual users at a later stage. While XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"
Add QR Code	Business applications can use this service API to add a QR Code to a document in a package.
Add RadioBox Field	Business applications can use this service API to add a checkbox to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users. If width and height parameters are not provided, a default size of 10x10 will be assigned. If either width or height (or both) is provided, the system will compare these provided values with each other. The larger value between width and height will be assigned to both dimensions.
Add TextBox Field	Business applications can use this service API to add a text input field to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.
Add Users to Workflow	Business applications can use this service API to add recipients to a workflow. This call will only add a recipient to the workflow. That is, no fields currently on the document will be automatically assigned to the new recipient(s), nor will this create any new fields. Note the recipient(s) will be added as the last person in the workflow.Hence further work may be required to remove a current recipient(s) already present in the workflow. At least one user must exist in a workflow before fields (input and signature) can be added to the document. Note the input accepts one or more users in a single call. In this specific call the user is a known natural person. However, the same rules apply to Groups and Placeholders. In either of these cases the recipient becomes a Group of users whereby any member of the group can sign the document, or a Placeholder.The latter case is used when you do not know the identity of the intended signatory. Note SigningHub workflow signing order starts at "1". Hence, adding a user to workflow with no current recipient(s) begins a new signing order count.The "signing_order" parameter is mandatory if the workflow type is "custom". Important, using this API call may affect the workflow type.If there are current recipients in a sequential workflow and a new one is added with the same signing order as a current recipient, then that part of the workflow changes automatically from sequential to parallel.Hence, the workflow overall is now of type custom as opposed to purely sequential. Adding a recipient with the same signing order as two or parallel recipients does not change the workflow.There are merely, three or more recipients at that particular point of the workflow; all in parallel order. Note, while XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"
Apply Workflow Template	Business applications can use this service API to apply a workflow template to a document. The document ID on which template has to be applied is provided in the resource URL. When document ID is set to 0 then template will be applied to to all of the doucments in a pacakge. While applying the template it is important to remember these two important points: Point 1 - If the template being applied is created using a PDF which already contained form fields then ensure that the document on which this template is now being applied must contain these form fields in advance and SigningHub will NOT create those form fields via the template rather only apply the form data and assign to the respective users. Point 2 - If the template being applied is created where form fields are manually added (hence not present in the PDF originally) via SigningHub e.g. signature field, initial, in-person signature, check boxes, radio buttons, text fields etc. then on applying such a template, these form fields will be created on the target document even if these form fields were already present in the document.
Approve Document	Business applications can use this service API to approve a document by a specified user in the order.
Assign Document Field	Business applications can use this service API to assign users to input fields, e.g. signature fields, and hence define the signing order. The fields must already be present in the document and the users must be present in the workflow. The ID of the workflow document is provided in the resource URL, along with the package identifier. When recipients are in a workflow they are numbered, beginning at one and counting up for each extra one.Therefore, if there are three users in a workflow they are numbered "1", "2", and "3" respectfully.This API call allows you to assign a user by their workflow order number, to an input field on the document.
AutoPlace Fields	Business applications can call this API to add signature or user defined form fields to a document based upon the search criterion supplied. The placement options are: to the left, to the right, top and bottom. The document is search and all instances of the search criteria met are processed. This allows you to add multiple fields with one call. For example, upload a document and automatically place a signature field to the right of all instances of the word "Sign here:". This saves time and ensures no signatures are missed from the workflow. The API call supports all types of fields; namely electronic, digital, in-person, initials, and text field etc. In addition, the API call supports the "order" variable.This means you can assign a set of signature fields automatically to a single user.Hence, the call can be repeated to place and assign signature fields to more than one user in the workflow. At least one user must exist in a workflow before signature fields can be added to the document in this way.The order number corresponds to the recipient in the workflow. Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. This API call can be used multiple times on the same document.The reason for doing so is to cater for multiple signatories on a document.The recipient or signatory is identified by the "order" variable passed in the call. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.
Bulk Sign Packages	Business applications can use this API to sign/share/sign and share multiple documents (both electronic and digital) without displaying the documents to the end user. This API needs information from the business application about document packages and the details of signatures, in-person and initials fields. On the successful completion of bulk signing transaction, the API will return the statuses and transaction ids of the document packages. Unlike the Sign Document API, this API not only signs a document package but also marks it as approved and reviewed based on whether the recipient is a Signer, Editor or Reviewer. Any document package for which the status returns as COMPLETED has been signed, approved or reviewed by this API. Bulk Signing works with all the signing-time authentication methods. If SIGN is passed as bulk_action and package is in Draft state, Sign and Share will be performed automatically. You must call this API after the Pre Bulk Sign Documents API. In case you need to make changes in any of the document before signing, the Fill Form Fields API should be called before calling the Pre Bulk Sign Document API. Remember, any mandatory input fields on a document require completing before this API will successfully complete; whereas, the auto-populated fields (like Name, Email, Date, Job Title, etc.) will be automatically filled. The signatory is identified by the access token presented in the call. Therefore, authentication of the signatory is required prior to making this call. You cannot authenticate as an Enterprise Admin with the scope variable, and sign a document on behalf of a user. The access token must be issued to the signatory as a result of direct authentication. Once document is signed, the verification response can be seen from the Bulk Signing Status API. First or Second Factor OTP Usage for Authentication In case OTP authentication is turned on for the server side signing operation, the client applications will need to generate an OTP for the mobile number using the Bulk Sign Authentication via OTP API call. Respective business applications must retrieve the OTP from the use and submit it when making the API call. This is done using the "x-otp" header in the request.
Bulk Signing Status	Business applications can use this API to get the status of a specific bulk signing transaction along with the details of document packages that were processed by the Bulk Signing Packages API. You must call this API after the Bulk Signing Packages API. The signatory is identified by the access token presented in the call. Therefore, authentication of the signatory is required prior to making this call. You cannot authenticate as an Enterprise Admin with the scope variable, and sign a document on behalf of a user. The access token must be issued to the signatory as a result of direct authentication. For RAS signing, the ACTION property will be REMOTE_AUTHORIZATION_REQURIED and the STATUS property will be PENDING, indicating that the request needs to be authorized using the mobile device. If the signing process fails in some document due to different levels of assurance configured and the user wants to re-initiate the signing process to complete the signing process on failed documents, the ACTION property will be REINITIATE_SIGNING_PROCESS, and the STATUS property will be PENDING.
Complete Workflow in the Middle (Terminate Workflow)	Business applications can mark the workflow completed even in the middle of the workflow. Use this service API to change the status of the workflow to completed. If there are recipients who have not signed the document yet. Their signature will not be required any more and they will not be able to see the document in their inbox any further. Bearer token should belong to document owner or enterprise admin can use scope variable to get the access token on behalf of document owner to perform this action.
Decline Document	Business applications can use this service API to decline a document by a specified user in the order.
Delete Attachment	Business applications can use this service API to delete the attachment of a document.
Delete Document	Business applications can use this service API to delete a document in a package.
Delete Document Field	Business applications can use this service API to delete a field of document in a package.
Delete Package	Business applications can use this service API to delete a document from the user inbox. The package ID is provided in the resource URL as "{package_id}". If the document status is PENDING, then it is automatically declined as result of delete operation. If the document status is SHARED, then the document is automatically recalled and workflow is stopped before the document is deleted.
Delete Shared Space	Business applications can use this service API to delete shared space. The availability of deleting shared spaces is subject to the assigned enterprise user role. To allow this provision Enterprise Admin will enable the ‘Manage Shared Space’ option in Roles>Document Settings.
Delete Workflow User	Business applications can use this service API to delete workflow recipient.
Download Attachment	Business applications can use this service API to download the attachment of a document.
Download Document	Business applications can use this service API to download the document bytes. The package ID and document ID is provided in the resource URL.
Download Package	Business applications can use this service API to download the document package in binary format. The package ID is provided in the resource URL. If the package contains only one document, the download is the binary PDF document. Alternatively, if the package has more than one document, the download is the binary zip file of all documents. The x-password and x-otp headers are optional. They are required if the document owner set them during the workflow creation phase.
Fill Form Fields	Business applications can use this service API to fill one or more form fields in a document by a specified user in the order.
Fill Initials	Business applications can use this service API to fill an initials field in a document by a specified user in the order.
Finish Processing	Business applications can use this service API to finish the document processing after signing all the signature fields. This method is primarily used by native SigningHub mobile apps for iOS and Android, and mobile web use cases. General business applications employing tight integration into their respective portal do not need to call this method. However, when using the Sign Document API (and hence the user is not presented with a visual representation of the document they are requested to sign) calling this API is required in order to ensure the respective workflow continues or completes. For example, once all signatures have been applied using the "blind" Sign Document API call the document will not show as status "Completed" to the owner until this API is invoked. The document owner will see a status of "In Progress" until this API is called. Within native SigningHub mobile apps and mobile web use cases, this call is necessary to ensure that each user completes their respective actions with respect to SigningHub.For example, after a signatory has signed a document in SigningHub App, this method is invoked by the application to ensure the workflow continues to process and the next signatory is notified, and the document status is available via the configured call-back URL.
Gatekeeper Approve Document	Business applications can use this service API to gatekeeper approve a document by a specified user in the order.
Gatekeeper Decline Document	Business applications can use this service API to gatekeeper decline a document by a specified user in the order.
Get Attachments	Business applications can use this service API to get the attachments of a document.
Get Certify Policy for a document	Business applications can use this service API to get certify signature settings of a document in a package.
Get Contacts	Business applications can use this service API to retieve contacts from both personal and enterprise contacts for the current user. It is possible to search based upon the criterion supplied under the "x-search-text" header.Furthermore, it is possible to search a user's specific contacts or that of the enterprise to which the user belongs. The search response information contains the user email address and respective user name.
Get Document Details	Business applications can use this service API to get the document details. The document ID is provided in the URL as “{document_id}”.
Get Document Fields	Business applications can use this service API to get document fields i.e., initials, in-persons, signature fields or form fields.
Get Enterprise Templates	Business applications can use this service API to get list of enterprise templates of the current user. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request. It is possible to search based upon the criterion supplied under the "x-search-text" header.
Get Package Details	Business applications can use this service API to get the details of an package. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
Get Packages	Business applications can use this service API to get a list of documents filtered by different statuses. Users can divide the records into pages by providing a number of records per page.
Get Process Evidence Report	Business applications can use this service API to download the workflow process evidence report of a document.
Get Shared Space	Business applications can use this service API to get a specific shared space. This API returns information about shared space, its owner and collaborator.
Get Templates	Business applications can use this service API to get list of templates for the current user. It is possible to search based upon the criterion supplied under the "x-search-text" header.Furthermore, it is possible to search a user's personal templates or the enterprise templates as allowed against their user role by their enterprise admin.
Get Workflow Details	Business applications can use this service API to get workflow details for the package.
Get Workflow History	Business applications can utilize this service API to retrieve the list of actions performed on a document. The package ID is provided in the resource URL. The search field (x-search-text header) is intended for email, document name, action, infokey, and infovalue.
Get Workflow Reminder	Business applications can use this service API to update the reminders for the recipients that has already been added to a workflow. Normally this call is useful after a template has been applied to a document and business applications want to override the reminders settings within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow recipient is identified by the order at which it is added to the workflow.
Get Workflow User Authentication (Document Opening) of Enterprise Package	Business applications can use this service API to get the access security settings enabled for the package. Recipients for whom the security is configured are identified by the order in the URL. Package ID is also identified in the request URL. Recipients will not be able to access document package outside the scope of this duration if the access security is enabled. Document owner can also configure authentication based security of the package for a recipient.
Get Workflow User Permissions	Business applications can use this service API to get document permissions for a recipient. Recipient is identified by the order in the workflow. The ID of the package is provided in the resource URL.
Get Workflow Users	Business applications can use this service API to get workflow details for the package.
Move Package to Custom or Shared Space folder	Business applications can use this service API to move the document package to a shared space or user's custom folder.
Recall Document	Business applications can use this service API to stop a workflow in progress. The document ID is provided in the resource URL. After recall the document status automatically changes to “DRAFT”.
Rename Document	Business applications can use this service API to rename a document in a package.
Rename Package	This service API is used to rename a document package. The document package is identified by its unique identifier in the URL of the call.
Share Document Package	Business applications can use this service API to share a document package with the signers and start a new workflow. The document should already have been prepared by applying a template and optionally updating the users and actions defined in template. The package ID to be shared is provided in the resource URL.
Sign Document	Business applications can use this service API to sign a document (both electronic and digital) without displaying the document to the end user using SigningHub. For example, a business application may have another method to display the document to the user, and only the signing functionality of SigningHub is required, or for bulk operations it may be justified to sign without requiring the user to view and approve every document individually. If there are changes to be saved in the document before signing, Fill Form Fields API should be called before calling the Sign Document API. Note any mandatory input fields on a document require completing before this API will successfully complete. The signatory is identified by the access token presented in the call.Therefore, authentication of the signatory is required prior to making this call.You cannot authenticate as an Enterprise Admin with the scope variable, and sign a document on behalf of a user.The access token must be issued to the signatory as a result of direct authentication. When this call completes it is important that if the signatory was the last signer for a document that the Finish Document API call is invoked.The reason is because without calling that API the document will remain in a status of "In Progress" to the document owner. Once the API has been called, the status will change to "Completed" for the document owner. Once document is signed, the verification response can be seen from Get Document Verification API. First or Second Factor OTP Usage for Authentication If OTP authentication is turned on for the server side signing operation, client applications will need to generate a OTP for the mobile number using Signer Authentication via OTP API call. Respective business applications must retrieve the OTP from the use and submit it when making the API call. This is done using the "x-otp" header in the request.
Submit Document	One of the SigningHub roles is called "Editor". This allows a recipient to edit input fields on a document, but does not require a signature. Once completed the recipient submits their changes. The button used in the GUI is called "Submit". This is the equivalent operation for an editor to submit their changes via an API call. Click SigningHub Roles for a description of all available workflow recipient roles.
Update Certify Policy for a document	Business applications can use this service API to update certify signature settings for a document in a package.
Update CheckBox Field	Business applications can use this service API to update a checkbox field of a document in a package. Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface. It's width and height cannot be updated. They will remain the same as when they were added.
Update Digital Signature Field	Business applications can use this service API to update a digital signature field of a document in a package. Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface.
Update In-person Field	Business applications can use this service API to update an in-person signature field of a document in a package. Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface.
Update Initial Field	Business applications can use this service API to update an initials field of a document in a package. Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged. You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface.
Update Placeholder	Business applications can use this service API to update a placeholder in the workflow. Normally this call is useful after a template has been applied to a document and business applications wants to override the details of a specific place holder within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow place holder is identified by the order at which it is added to the workflow. While XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"
Update Post Processing	Business applications can use this service API to add placeholder to a workflow a document in a package.
Update QR Code	Business applications can use this service API to update a QR Code of a document in a package.
Update RadioBox Field	Business applications can use this service API to update a radio button of a document in a package. Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface. It's width and height cannot be updated. They will remain the same as when they were added.
Update Shared Space	Business applications can use this service API to update shared space. The availability of updating shared spaces is subject to the assigned enterprise user role. To allow this provision Enterprise Admin will enable the ‘Manage Shared Space’ option in Roles>Document Settings.
Update TextBox Field	Business applications can use this service API to update a text box of a document in a package. Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged. You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields. The latter can be used when a template was applied or the document was created using the GUI interface.
Update Workflow Details	Business applications can use this service API to update the workflow details. Normally this call is useful after a template has been applied to a document, but business applications wants to override the certify permission or post processing details. The package ID is provided in the resource URL.
Update Workflow Reminders	Business applications can use this service API to update the workflow reminders for a recipient that has already been added to a workflow. Normally this call is useful after a template has been applied to a document and business applications want to override the reminders settings within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow recipient is identified by the order at which it is added to the workflow.
Update Workflow User	Business applications can use this service API to update the details of a recipient, group or place holder who has already been added to a workflow. Normally this call is useful after a template has been applied to a document and business applications wants to override the details of a specific user within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow recipient is identified by the order at which it is added to the workflow. Note, while XML type document preparation, only supports role types "SIGNER", "REVIEWER" and "CARBON_COPY".
Update Workflow User Authentication (Document Opening) of Enterprise Package	Business applications can use this service API to update the package authentications and access duration for the recipients. This API can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request
Update Workflow User Permissions	Business applications can use this service API to update the workflow permissions for a user that has already been added to a workflow. Normally this call is useful after a template has been applied to a document and business applications want to override the permissions within the workflow. The ID of the document package is provided in the resource URL, and the workflow user is identified by the order at which it is added to the workflow.
Update Workflow Users Order	Business applications can use this service API to update order of the recipient in the workflow.
Upload Attachment	Business applications can use this service API to upload a attachment in a document.
Upload Document	Business applications can use this service API to add a document to a document package linked to an enterprise user’s account. The document information is sent in the HTTP request header and document bytes are sent in the HTTP request body. Note SigningHub will convert supported document formats to PDF if the header "x-convert-document" is set to a value of "true". The only case supported where this value is set to "false" is to retain Word format and XML documents. SigningHub supports a wide variety of document formats, each of which can be converted to PDF format upon upload.Click here for the full list. Note PDF documents are not altered upon upload to the system. Note a package must already exist before you can add a document using this call.

Add CheckBox Field

Operation ID:: V4_Checkbox_AddCheckBox

Business applications can use this service API to add a checkbox to a document in a package.

At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow.

See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

If width and height parameters are not provided, a default size of 10x10 will be assigned. If either width or height (or both) is provided, the system will compare these provided values with each other. The larger value between width and height will be assigned to both dimensions.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID to which the document is added.
Document ID	documentId	True	integer	The document ID for which the action is to be taken.
order	order	True	integer	The order of the user in workflow for which the field is being added.
page_no	page_no	True	integer	Page number on which the field is to be created.
field_name	field_name		string	Name of the provided field that is to be added. If not provided, system will assign an unique auto generated name to the field.
value	value		string	Value of the field. Possible values are "true" or "false"
x	x	True	double	Left location of the field in pixel.
y	y	True	double	Top location of the field in pixel.
width	width	True	double	Width of the field in pixel.
height	height	True	double	Height of the field in pixel.
validation_rule	validation_rule		string	One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".

Returns

Body: AddFieldResponse

Add Digital Signature Field

Operation ID:: V4_Signature_AddSignature

Business applications can use this service API to add a digital signature field to a document in a package.

See Add Users to Workflow for more information.Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The package ID for which workflow details need to be updated.
Document ID	documentId	True	integer	The document ID where the field is to be added.
order	order	True	integer	Order of the recipient for which the field is being created.
page_no	page_no	True	integer	Page number at which the field is about to be created.
field_name	field_name		string	Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.
level_of_assurance	level_of_assurance		array of string	Level Of Assurance to be added. Possible Values are "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
x	x	True	double	Left location of the field in pixel.
y	y	True	double	Top location of the field in pixel.
width	width	True	double	Width of the field in pixel.
height	height	True	double	Height of the field in pixel.
display	display		string	Visibility of the field that is to be added, possible values are "VISIBLE" and "INVISIBLE"
authentication_signing	authentication_signing			Field Authentication

Returns

Body: SignatureFieldResponse

Add Groups to Workflow

Operation ID:: V4_Workflow_WorkflowAddGroup

Business applications can use this service API to add groups as a recipient to a workflow. A SigningHub group means any member of the group can perform the action, i.e. sign, on behalf of all members of the group.

Note the group will be added as the last user/group in the workflow.Hence further work may be required to remove a current user/group, already present in the workflow. While XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	ID of the package for which the group is to be added.
group_name	group_name		string	The name of the new group to be added in workflow.
email_notification	email_notification	True	boolean	Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn. If no value is provided, default value of "true" will be set.
role	role	True		Role of the group as a recipient in the workflow. Possible value are "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" and "INPERSON_HOST". However, while XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"
signing_order	signing_order		integer	Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".

Returns

response: array of CollaboratorGroupResponse

Add In-person Field

Operation ID:: V4_InPerson_AddInPerson

Business applications can use this service API to an add in-person signature field to a document in a package.

See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

In order to host an in-person meeting a SigningHub user must be part of the workflow.They must either be added with Role "INPERSON_HOST" or "SIGNER". For the host option they do not require a signature or input field on the document, and the in-person signature field can be signed by the non-SigningHub registered user.

Note this is a special workflow scenario whereby it is expected that the SigningHub user and recipient would be in the same location.This type of signature is not intended for use whereby a document is shared with recipients over email link in the normal loose integration method.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID to which the document is added.
Document ID	documentId	True	integer	The document ID for which the action is to be taken.
order	order	True	integer	The order of the user in workflow for which the field is being added.
page_no	page_no	True	integer	Page number on which the field is to be created.
field_name	field_name		string	Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.
placeholder	placeholder	True	string	String identifier for the inperson field, it can be Customer, Jack, CEO etc.
x	x	True	double	Left location of the field in pixel.
y	y	True	double	Top location of the field in pixel.
width	width	True	double	Width of the field in pixel.
height	height	True	double	Height of the field in pixel.
display	display		string	Visibility of the field that is to be added, possible values are "VISIBLE" and "INVISIBLE"
level_of_assurance	level_of_assurance		array of string	Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE"
authentication_signing	authentication_signing			Field Authentication

Returns

Body: AddFieldResponse

Add Initial Field

Operation ID:: V4_Initials_AddInitial

Business applications can use this service API to add an initials field to a document in a package.

See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID to which the document is added.
Document ID	documentId	True	integer	The document ID for which the action is to be taken.
order	order	True	integer	The order of the user in workflow for which the field is being added.
page_no	page_no	True	integer	Page number on which the field is to be created.
field_name	field_name		string	Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.
x	x	True	double	Left location of the field in pixel.
y	y	True	double	Top location of the field in pixel.
width	width	True	double	Width of the field in pixel.
height	height	True	double	Height of the field in pixel.

Returns

Body: AddFieldResponse

Add or Update Document from Library

Operation ID:: V4_Documents_UploadFromLibrary

Business applications can use this service API to add a document from the user’s library to a package. Package ID is provided in the URL, the ID of the document should also be provided as “document_id” in the resource URL to identify the library document to be copied.

Note a package must already exist before you can add a document using this call.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The Package ID of the package to which the document is being added.
Document ID	documentId	True	integer	The library document ID that need to add/updated
Old Document ID	x-document-id		string	Id of the old document of current package that need to be updated

Returns

Body: UploadDocumentLibraryResponse

Add Package

Operation ID:: V4_Package_AddPackage

This service API is used to add/create a document package to hold one or more documents. This package can then be used to add documents and recipients in order to start a new workflow.

As previously stated, this call is mandatory if you wish to work with documents. A package must exist before you can upload or add documents to SigningHub..

Even a single document is a part of a package: a package containing one document.

Note: A package can be renamed if required once created.

Parameters

Name	Key	Required	Type	Description
package_name	package_name		string	The name of the package. Default package name is always "Untitled" if the package_name is not provided.
workflow_mode	workflow_mode	True		Mode of the workflow, there are three types of workflow modes supported in application. Possible values are "ONLY_ME", "ME_AND_OTHERS" and "ONLY_OTHERS"
folder_name	folder_name		string	The name of the folder. It will be used to upload package in any folder of the user, either it is a custom folder or a shared folder.

Returns

Body: AddPackageResponse

Add Placeholder to Workflow

Operation ID:: V4_Workflow_WorkflowAddPlaceholder

Business applications can use this service API to add placeholder to a workflow in a package. A place holder is required when you do not know the identity of the intended recipient in a workflow.

Note the placeholder will be added as the last user in the workflow.Hence further work may be required to remove a current user/group, already present in the workflow.

Adding a place holder allows you to proceed and add signature and/or input fields to the document, which can then be assigned to individual users at a later stage. While XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	ID of the package for which the placeholder is to be added.
placeholder	placeholder		string	The name of the new placeholder to be added in workflow.
email_notification	email_notification	True	boolean	Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn.
role	role	True		Role of the group as a recipient in the workflow. Possible value are "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" and "INPERSON_HOST". However, while XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"
signing_order	signing_order		integer	Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".

Returns

response: array of CollaboratorPlaceholderResponse

Add QR Code

Operation ID:: V4_QR_AddQRCode

Business applications can use this service API to add a QR Code to a document in a package.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID to which the document is added.
Document ID	documentId	True	integer	The document ID for which the action is to be taken.
page_no	page_no	True	integer	Page number on which the field is to be created.
field_name	field_name		string	Name of the provided field that is to be added. If not provided, system will assign an unique auto generated name to the field.
dimensions	dimensions	True		Field dimensions
data	data		string	The plain text data to be encoded in the QR code. Default is URL generated to access the related document. e.g. {base_url}/document/{document_unique_id}
options	options			Settings regarding options
color	color			Settings regarding color
logo	logo			Settings regarding logo

Returns

Body: AddQrCodeResponse

Add RadioBox Field

Operation ID:: V4_Radio_AddRadioBox

Business applications can use this service API to add a checkbox to a document in a package.

See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID to which the document is added.
Document ID	documentId	True	integer	The document ID for which the action is to be taken.
order	order	True	integer	The order of the user in workflow for which the field is being added.
page_no	page_no	True	integer	Page number on which the field is to be created.
field_name	field_name		string	Name of the provided field that is to be added. If not provided, system will assign an unique auto generated name to the field.
value	value		string	Value of the field. Possible values are "true" or "false"
validation_rule	validation_rule	True		One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".
radio_group_name	radio_group_name	True	string
x	x	True	double	Left location of the field in pixel.
y	y	True	double	Top location of the field in pixel.
width	width	True	double	Width of the field in pixel.
height	height	True	double	Height of the field in pixel.

Returns

Body: AddFieldResponse

Add TextBox Field

Operation ID:: V4_TextBox_AddTextBox

Business applications can use this service API to add a text input field to a document in a package.

See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID to which the document is added.
Document ID	documentId	True	integer	The document ID for which the action is to be taken.
order	order	True	integer	The order of the user in workflow for which the field is being added.
page_no	page_no	True	integer	Page number on which the field is to be created.
type	type	True		Type of the field, possible values are "TEXT", "NAME", "EMAIL", "COMPANY", "JOBTITLE", "DATE". All text fields other then TEXT are auto filled in pending mode with the attributes/data of the recipient.
value	value		string	Value of the field. For type = DATE, the value is expected to follow ISO 8601 format.Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00. If value is not in proper format an error will be returned.
placeholder	placeholder		string	Placeholder text for the text field. For name, email, company, job title and date, placeholder value can be "NAME", "EMAIL", "COMPANY", "JOBTITLE", "DATE". Developers can send their own placeholders to overwrite the default values. For "TEXT" developers can provide a their own placeholder texts. These placeholders appear in the text fields while viewing the document in viewer.
max_length	max_length	True	integer	Maximum length of the value allowed in the field. Must between 1 - 9999
format	format		string	Text format of the field. Used for the date type field only. Possible values are m/d m/d/yy m/d/yyyy mm/dd/yy mm/dd/yyyy mm/yy mm/yyyy d-mmm d-mmm-yy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd yyyy-mm-dd mmm-yy mmm-yyyy mmmm-yy mmmm-yyyy mmmm d, yyyy dd/mm/yy ddmmmyyyy
field_name	field_name		string	Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.
field_locale	field_locale		string	Field local. Possible values are ar-AE \| en-US. Optional and default will be en-US. This value matters for type "DATE".
field_type	field_type	True		Field type with respect to accepting the type of values, possible values are "NUMBER" or "TEXT".
validation_rule	validation_rule	True		One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".
validation	validation			Validations
font	font	True		Font of the fields text
x	x	True	double	Left location of the field in pixel.
y	y	True	double	Top location of the field in pixel.
width	width	True	double	Width of the field in pixel.
height	height	True	double	Height of the field in pixel.
multiline	multiline	True	boolean	If set to true, text area field would be created

Returns

Body: AddFieldResponse

Add Users to Workflow

Operation ID:: V4_Workflow_WorkflowAddUser

Business applications can use this service API to add recipients to a workflow. This call will only add a recipient to the workflow. That is, no fields currently on the document will be automatically assigned to the new recipient(s), nor will this create any new fields.

Note the recipient(s) will be added as the last person in the workflow.Hence further work may be required to remove a current recipient(s) already present in the workflow.

At least one user must exist in a workflow before fields (input and signature) can be added to the document.

Note the input accepts one or more users in a single call.

In this specific call the user is a known natural person. However, the same rules apply to Groups and Placeholders. In either of these cases the recipient becomes a Group of users whereby any member of the group can sign the document, or a Placeholder.The latter case is used when you do not know the identity of the intended signatory.

Note SigningHub workflow signing order starts at "1". Hence, adding a user to workflow with no current recipient(s) begins a new signing order count.The "signing_order" parameter is mandatory if the workflow type is "custom".

Important, using this API call may affect the workflow type.If there are current recipients in a sequential workflow and a new one is added with the same signing order as a current recipient, then that part of the workflow changes automatically from sequential to parallel.Hence, the workflow overall is now of type custom as opposed to purely sequential. Adding a recipient with the same signing order as two or parallel recipients does not change the workflow.There are merely, three or more recipients at that particular point of the workflow; all in parallel order.

Note, while XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	SigningHub package ID, which the recipients are to be added to.
user_email	user_email		string	Email address of the user to be added in the workflow.
user_name	user_name	True	string	Name of the recipient to be added in the workflow.
user_national_id	user_national_id		string	User national id of the recipient
email_notification	email_notification	True	boolean	If set as true, SigningHub will send notifications to the user via email as per the document owner and user notification settings. A value of false means no notifications will be sent to user throughout the workflow.
role	role	True		Role of the recipient in the workflow. Possible values are "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" or "INPERSON_HOST". However, while XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"
signing_order	signing_order		integer	Order of the recipient in the workflow. This signing order is mandatory when workflow type is "CUSTOM".
delivery_method	delivery_method	True		Delivery method of the recipient in the workflow. Possible values are "EMAIL", "SMS", or "EMAIL_AND_SMS". Default value would be EMAIL
mobile_number	mobile_number		string	Mobile Number

Returns

response: array of CollaboratorResponse

Apply Workflow Template

Operation ID:: V4_Workflow_ApplyTemplate

Business applications can use this service API to apply a workflow template to a document. The document ID on which template has to be applied is provided in the resource URL. When document ID is set to 0 then template will be applied to to all of the doucments in a pacakge.

While applying the template it is important to remember these two important points:

Point 1 - If the template being applied is created using a PDF which already contained form fields then ensure that the document on which this template is now being applied must contain these form fields in advance and SigningHub will NOT create those form fields via the template rather only apply the form data and assign to the respective users.

Point 2 - If the template being applied is created where form fields are manually added (hence not present in the PDF originally) via SigningHub e.g. signature field, initial, in-person signature, check boxes, radio buttons, text fields etc. then on applying such a template, these form fields will be created on the target document even if these form fields were already present in the document.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The Package ID of the package to which the template needs to be applied.
Document ID	documentId	True	integer	The document ID on which the template needs to be applied. If the value is set to 0, if template is to be applied on all the documents in the package.
template_name	template_name	True	string	Name of template to be applied on the document.
apply_to_all	apply_to_all	True	boolean	True, if template is to be applied on all the documents in the package.

Returns

Body: DocumentDetailsResponse

Approve Document

Operation ID:: V4_Package_Approve

Business applications can use this service API to approve a document by a specified user in the order.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The ID of the package to be approved.
reason	reason		string	The reason for approving a package.
Document Access Password	x-password		string	The password set by the document owner for accessing the document, if any. If the password has not been set, then the value shall be null.
Document One-Time Password	x-otp		string	The One-Time Password (OTP) set by the document owner for accessing the document, if any. If the OTP has not been set, then the value shall be null.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: object

Assign Document Field

Operation ID:: V4_Fields_AutoAssignField

Business applications can use this service API to assign users to input fields, e.g. signature fields, and hence define the signing order. The fields must already be present in the document and the users must be present in the workflow. The ID of the workflow document is provided in the resource URL, along with the package identifier.

When recipients are in a workflow they are numbered, beginning at one and counting up for each extra one.Therefore, if there are three users in a workflow they are numbered "1", "2", and "3" respectfully.This API call allows you to assign a user by their workflow order number, to an input field on the document.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID to which the document is added.
Document ID	documentId	True	integer	The document ID for which workflow user needs to be updated.
field_name	field_name	True	string	Name of the signature field that is to be assigned.
radio_group_name	radio_group_name		string	provide group name for radio box
order	order	True	integer	The order of the user in workflow, to which the field is being assigned.
level_of_assurance	level_of_assurance		array of string	Level Of Assurance to be added. Possible Values are "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"

Returns

response: object

AutoPlace Fields

Operation ID:: V4_Fields_AutoPlace

Business applications can call this API to add signature or user defined form fields to a document based upon the search criterion supplied. The placement options are: to the left, to the right, top and bottom. The document is search and all instances of the search criteria met are processed. This allows you to add multiple fields with one call. For example, upload a document and automatically place a signature field to the right of all instances of the word "Sign here:". This saves time and ensures no signatures are missed from the workflow.

The API call supports all types of fields; namely electronic, digital, in-person, initials, and text field etc.

In addition, the API call supports the "order" variable.This means you can assign a set of signature fields automatically to a single user.Hence, the call can be repeated to place and assign signature fields to more than one user in the workflow.

At least one user must exist in a workflow before signature fields can be added to the document in this way.The order number corresponds to the recipient in the workflow. Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow.

This API call can be used multiple times on the same document.The reason for doing so is to cater for multiple signatories on a document.The recipient or signatory is identified by the "order" variable passed in the call.

See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The ID of the package to which the document is added.
Document ID	documentId	True	integer	The ID of the document for which the fields are requested.
search_text	search_text		string	Word that needs to be searched in the document.
order	order	True	integer	Order of the user to which the fields will be assigned automatically. Workflow in SigningHub orders recipients. This list begins with “1” for the first designated signer.
placement	placement		string	If the text is found, fields are to be placed in the document. Placement of the field can be mentioned in this attribute. Possible values of placement of a field are LEFT, RIGHT, TOP, BOTTOM. If no value is provided the default value will be LEFT.
field_type	field_type		string	Type of field to be created in the document. Possible values are "SIGNATURE", "IN_PERSON_SIGNATURE", "INITIALS", "TEXT", "NUMBER" ,"NAME", "EMAIL", "COMPANY", "JOBTITLE", "RADIOBOX", "CHECKBOX", "DATE", "ATTACHMENT"
level_of_assurance	level_of_assurance		array of string	Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
dimensions	dimensions			Dimensions of a field to be created in the document. X and Y location is calculated automatically. API can only configure width and height for the field. If dimensions are not provided default dimensions will be followed. that is 200 x 80 in pixels.
placeholder	placeholder		string	Provide note in the case of Mandatory Attachment
radio_group_name	radio_group_name		string	The group name required only when adding a Radio Box type field to group multiple Radio boxes together.
format	format		string	Text format of the field. Used for the date type field only. Possible values are m/d m/d/yy m/d/yyyy mm/dd/yy mm/dd/yyyy mm/yy mm/yyyy d-mmm d-mmm-yy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd yyyy-mm-dd mmm-yy mmm-yyyy mmmm-yy mmmm-yyyy mmmm d, yyyy dd/mm/yy ddmmmyyyy
value	value		string	Value that user want to show in the field.
max_length	max_length	True	integer	Maximum length of the value allowed in the field. Must between 1 - 9999
validation_rule	validation_rule		string	One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".
validation	validation			Validations
font	font			Font of the fields text
multiline	multiline	True	boolean	This belongs to Text Area field type and If set to true, text area field would be created with multi line option.

Returns

response: array of AutoPlaceFieldsResponse

Bulk Sign Packages

Operation ID:: V4_Signing_BulkSignDocuments

Business applications can use this API to sign/share/sign and share multiple documents (both electronic and digital) without displaying the documents to the end user. This API needs information from the business application about document packages and the details of signatures, in-person and initials fields. On the successful completion of bulk signing transaction, the API will return the statuses and transaction ids of the document packages.

Unlike the Sign Document API, this API not only signs a document package but also marks it as approved and reviewed based on whether the recipient is a Signer, Editor or Reviewer. Any document package for which the status returns as COMPLETED has been signed, approved or reviewed by this API.

Bulk Signing works with all the signing-time authentication methods.

If SIGN is passed as bulk_action and package is in Draft state, Sign and Share will be performed automatically.

You must call this API after the Pre Bulk Sign Documents API.

In case you need to make changes in any of the document before signing, the Fill Form Fields API should be called before calling the Pre Bulk Sign Document API. Remember, any mandatory input fields on a document require completing before this API will successfully complete; whereas, the auto-populated fields (like Name, Email, Date, Job Title, etc.) will be automatically filled.

The signatory is identified by the access token presented in the call. Therefore, authentication of the signatory is required prior to making this call. You cannot authenticate as an Enterprise Admin with the scope variable, and sign a document on behalf of a user. The access token must be issued to the signatory as a result of direct authentication.

Once document is signed, the verification response can be seen from the Bulk Signing Status API.

First or Second Factor OTP Usage for Authentication

In case OTP authentication is turned on for the server side signing operation, the client applications will need to generate an OTP for the mobile number using the Bulk Sign Authentication via OTP API call. Respective business applications must retrieve the OTP from the use and submit it when making the API call. This is done using the "x-otp" header in the request.

Parameters

Name	Key	Required	Type	Description
ids	ids		array of integer	An array of the document package ids that are selected for bulk signing.
hand_signature_initials_image	hand_signature_initials_image		string	Base64 image used for the filling of the initials
hand_signature_initials_method	hand_signature_initials_method		integer	0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE
hand_signature_image	hand_signature_image		string	Base64 encoded string image of the visible signature appearance
hand_signature_method	hand_signature_method			Name of the hand signature method by user for signing. In case no hand signature method is provided then default will be DRAW. possible values DRAW,TEXT,UPLOAD,SIGNATURE_PAD
signing_reason	signing_reason		string	Reason of signing provided by the recipient.
signing_location	signing_location		string	Locale of the signer provided by the recipient
contact_information	contact_information		string	Contact information of the signer provided by the recipient
appearance_design	appearance_design		string	Name of the signature appearance provided by user for signing. In case no appearance name is provided then default selected appearance would be used. Possible values are "COMPANY_LOGO", "DETAILED_SIGNATURE", "HAND_SIGNATURE"
signing_server	signing_server		string	Name of signing server using which the document is to be signed
signing_capacity	signing_capacity		string	Name of certification profile/signing capacity using which the document is to be signed
authentication	authentication			Authentication object is an optional, it contains authentication releated options
transaction_id	transaction_id		string	re-initiated signing process transaction id
Package ID	packageId_bulkAction	True	string	Bulk action to be performed. Possible values are: SIGN \| SHARE
Signing OTP	x-otp		string	OTP/TOTP used as a second factor/document signing authentication for the signing operation.
Document Access Password	x-open-password		string	The password set by the document owner for accessing the document, if any. If the password has not been set, then the value shall be null.
Document One-Time Password	x-open-otp		string	The One-Time Password (OTP) set by the document owner for accessing the document, if any. If the OTP has not been set, then the value shall be null.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.
Mobile Originator	x-mobile		string	Define the originator(Web/Mobile) of the request/action

Returns

Body: BulkSignResponse

Bulk Signing Status

Operation ID:: V4_Signing_BulkSignStatus

Business applications can use this API to get the status of a specific bulk signing transaction along with the details of document packages that were processed by the Bulk Signing Packages API.

You must call this API after the Bulk Signing Packages API.

For RAS signing, the ACTION property will be REMOTE_AUTHORIZATION_REQURIED and the STATUS property will be PENDING, indicating that the request needs to be authorized using the mobile device. If the signing process fails in some document due to different levels of assurance configured and the user wants to re-initiate the signing process to complete the signing process on failed documents, the ACTION property will be REINITIATE_SIGNING_PROCESS, and the STATUS property will be PENDING.

Parameters

Name	Key	Required	Type	Description
transaction_id	transaction_id		string	The identification number of the bulk signing transaction
Bulk Action	bulk_action	True	string	Bulk action to be performed. Possible values are: SIGN \| SHARE

Returns

Body: BulkSignStatusResponse

Complete Workflow in the Middle (Terminate Workflow)

Operation ID:: V4_Workflow_MarkWorkflowCompleted

Business applications can mark the workflow completed even in the middle of the workflow. Use this service API to change the status of the workflow to completed. If there are recipients who have not signed the document yet. Their signature will not be required any more and they will not be able to see the document in their inbox any further. Bearer token should belong to document owner or enterprise admin can use scope variable to get the access token on behalf of document owner to perform this action.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The package ID from which the recipient is to be deleted.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: object

Decline Document

Operation ID:: V4_Package_Decline

Business applications can use this service API to decline a document by a specified user in the order.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The ID of the package to be declined.
reason	reason		string	Reason provided by the user for declining.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: object

Delete Attachment

Operation ID:: V4_Attachment_DeleteAttachment

Business applications can use this service API to delete the attachment of a document.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID of the package to which the document is added.
Document ID	documentId	True	integer	ID of the document to which the attachment is added.
Attachment ID	attachment_id	True	integer	ID of the attachment.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: object

Delete Document

Operation ID:: V4_Documents_DeleteDocument

Business applications can use this service API to delete a document in a package.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID of the package to which the document is added.
Document ID	documentId	True	integer	ID of the document to be deleted.

Returns

Body: DocumentResponse

Delete Document Field

Operation ID:: V4_Fields_DeleteDocumentField

Business applications can use this service API to delete a field of document in a package.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID to which the document is added.
Document ID	documentId	True	integer	The document ID for which the action is to be taken.
field_name	field_name	True	string	Name of the field to be deleted.

Returns

response: object

Delete Package

Operation ID:: V4_Package_DeletePackage

Business applications can use this service API to delete a document from the user inbox. The package ID is provided in the resource URL as "{package_id}". If the document status is PENDING, then it is automatically declined as result of delete operation. If the document status is SHARED, then the document is automatically recalled and workflow is stopped before the document is deleted.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId_bulkAction	True	integer	Package ID of the package which contains the document.

Returns

response: object

Delete Shared Space

Operation ID:: V4_WorkSpace_DeleteSharedSpace

Business applications can use this service API to delete shared space. The availability of deleting shared spaces is subject to the assigned enterprise user role. To allow this provision Enterprise Admin will enable the ‘Manage Shared Space’ option in Roles>Document Settings.

Parameters

Name	Key	Required	Type	Description
Shared Space ID	id	True	integer	Id of shared space that you want to delete

Returns

response: object

Delete Workflow User

Operation ID:: V4_Workflow_WorkflowDeleteUser

Business applications can use this service API to delete workflow recipient.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The package ID from which the recipient is to be deleted.
Order	order	True	integer	Order of the recipient in the workflow which is to be deleted.

Returns

response: object

Download Attachment

Operation ID:: V4_Attachment_DownloadAttachment

Business applications can use this service API to download the attachment of a document.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID of the package to which the document is added.
Document ID	documentId	True	integer	ID of the document to which the attachment is added.
Attachment ID	attachment_id	True	integer	ID of the attachment.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: object

Download Document

Operation ID:: V4_Documents_DownloadDocumentBytes

Business applications can use this service API to download the document bytes. The package ID and document ID is provided in the resource URL.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID of the package to which the document is added.
Document ID	documentId	True	integer	The ID of the document to be downloaded.
Document Password	x-password		string	The password set by the document owner for accessing the document, if any. If the password has not been set, then the value shall be null.
One-Time Password (OTP)	x-otp		string	The One-Time Password (OTP) set by the document owner for accessing the document, if any. If the OTP has not been set, then the value shall be null.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: object

Download Package

Operation ID:: V4_Package_DownloadPackageBytes

Business applications can use this service API to download the document package in binary format.

The package ID is provided in the resource URL.

If the package contains only one document, the download is the binary PDF document.

Alternatively, if the package has more than one document, the download is the binary zip file of all documents.

The x-password and x-otp headers are optional. They are required if the document owner set them during the workflow creation phase.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId_bulkAction	True	integer	The package ID to be downloaded.
Document IDs	document-ids		array	The Document IDs parameter is optional. If x-combine-files is set to true, the documents will be merged based on the mentioned documents of the package.
Document Access Password	x-password		string	The password set by the document owner for accessing the document, if any. If the password has not been set, then the value shall be null.
Document One-Time Password	x-otp		string	The One-Time Password (OTP) set by the document owner for accessing the document, if any. If the OTP has not been set, then the value shall be null.
Combine Files	x-combine-files		string	The default value is false, Set to "true" to combine the entire document package into a single PDF file.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: object

Fill Form Fields

Operation ID:: V4_Fields_FillFormFields

Business applications can use this service API to fill one or more form fields in a document by a specified user in the order.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID to which the document is added.
Document ID	documentId	True	integer	The ID of the document.
auto_save	auto_save	True	boolean	Default value is false. True, if the form fields are being saved without user intervention e.g., while closing the document or pressing back. For Signing, Initials, In-persons, Reviewing, Submit actions the value is false.
field_name	field_name	True	string	Unique identifier of the field in the document.
value	value		string	Value of the field to be saved in the document.
field_name	field_name	True	string	Unique identifier of the field in the document.
radio_group_name	radio_group_name		string	Group name to which the radio button belongs.
value	value	True	boolean	Value of the field to be saved in the document.
field_name	field_name	True	string	Unique identifier of the field in the document.
value	value	True	boolean	Value of the field to be saved in the document.
field_name	field_name	True	string	Unique identifier of the field in the document.
value	value		string	Value of the field to be saved in the document.
field_name	field_name	True	string	Unique identifier of the field in the document.
value	value		string	Value of the field to be saved in the document.
Document Password	x-password		string	The password set by the document owner for accessing the document, if any. If the password has not been set, then the value shall be null.
One-Time Password (OTP)	x-otp		string	The One-Time Password (OTP) set by the document owner for accessing the document, if any. If the OTP has not been set, then the value shall be null.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: object

Fill Initials

Operation ID:: V4_Initials_Fill

Business applications can use this service API to fill an initials field in a document by a specified user in the order.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID to which the document is added.
Document ID	documentId	True	integer	The ID of the document.
field_name	field_name	True	string	Unique identifier of the field in the document.
image	image	True	string	Base64 image used for the filling of the initials.
method	method			Name of the hand signature method by user for signing. In case no hand signature method is provided then default will be DRAW. possible values DRAW,TEXT,UPLOAD,SIGNATURE_PAD
apply_to_all	apply_to_all	True	boolean	True if all initials are to be filled.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: object

Finish Processing

Operation ID:: V4_Package_Finish

Business applications can use this service API to finish the document processing after signing all the signature fields. This method is primarily used by native SigningHub mobile apps for iOS and Android, and mobile web use cases. General business applications employing tight integration into their respective portal do not need to call this method. However, when using the Sign Document API (and hence the user is not presented with a visual representation of the document they are requested to sign) calling this API is required in order to ensure the respective workflow continues or completes. For example, once all signatures have been applied using the "blind" Sign Document API call the document will not show as status "Completed" to the owner until this API is invoked. The document owner will see a status of "In Progress" until this API is called.

Within native SigningHub mobile apps and mobile web use cases, this call is necessary to ensure that each user completes their respective actions with respect to SigningHub.For example, after a signatory has signed a document in SigningHub App, this method is invoked by the application to ensure the workflow continues to process and the next signatory is notified, and the document status is available via the configured call-back URL.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The ID of the package to be finished.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: object

Gatekeeper Approve Document

Operation ID:: V4_Package_GatekeeperApprove

Business applications can use this service API to gatekeeper approve a document by a specified user in the order.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The ID of the package to be approved.
reason	reason		string	The reason for approving a package.
Document Access Password	x-password		string	The password set by the document owner for accessing the document, if any. If the password has not been set, then the value shall be null.
Document One-Time Password	x-otp		string	The One-Time Password (OTP) set by the document owner for accessing the document, if any. If the OTP has not been set, then the value shall be null.

Returns

response: object

Gatekeeper Decline Document

Operation ID:: V4_Package_GatekeeperDecline

Business applications can use this service API to gatekeeper decline a document by a specified user in the order.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The ID of the package to be declined.
reason	reason		string	Reason provided by the user for declining.

Returns

response: object

Get Attachments

Operation ID:: V4_Attachment_GetAttachments

Business applications can use this service API to get the attachments of a document.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID of the package to which the document is added.
Document ID	documentId	True	integer	ID of the document to which the attachment is added.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: array of GetAttachmentResponse

Get Certify Policy for a document

Operation ID:: V4_Documents_GetCertifyPolicy

Business applications can use this service API to get certify signature settings of a document in a package.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID of the package to which the document is added.
Document ID	documentId	True	integer	The ID of the document to be downloaded.

Returns

Body: CertifyPolicyResponse

Get Contacts

Operation ID:: V4_Contacts_Get

Business applications can use this service API to retieve contacts from both personal and enterprise contacts for the current user.

It is possible to search based upon the criterion supplied under the "x-search-text" header.Furthermore, it is possible to search a user's specific contacts or that of the enterprise to which the user belongs.

The search response information contains the user email address and respective user name.

Parameters

Name	Key	Required	Type	Description
Records Per Page	recordPerPage	True	integer	Total number of records to be retrieved in a page.
Page Number	pageNo	True	integer	Page number to be retrieved.
Sort By	sort-by		string	Sort the result by possible values are mentioned above.
Ascending	asc		boolean	Order the result set by ascending or descending.
Search Text	x-search-text		string	Search text if required. This is optional and without it the entire list is returned. Furthermore, recommended value for search text parameter is in Base64 encoded format.
Enterprise Contacts Only	x-enterprise		string	When set as "true" only enterprise contacts list will be returned. In case of "false"only the user's contacts list will be returned.If you do not set the header, then both enterprise and user's contacts lists will be returned.
Total Records	x-total-records		string	The total number of records found with the provided search criteria.

Returns

response: array of ContactResponse

Get Document Details

Operation ID:: V4_Documents_GetDocumentDetails

Business applications can use this service API to get the document details. The document ID is provided in the URL as “{document_id}”.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The Package ID of the package to which the document is added.
Document ID	documentId	True	integer	The document ID for which the document details are requested.
Document Password	x-password		string	The password set by the document owner for accessing the document, if any. If the password has not been set, then the value shall be null.
One-Time Password (OTP)	x-otp		string	The One-Time Password (OTP) set by the document owner for accessing the document, if any. If the OTP has not been set, then the value shall be null.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

Body: DocumentDetailsResponse

Get Document Fields

Operation ID:: V4_Fields_GetAllDocumentFields

Business applications can use this service API to get document fields i.e., initials, in-persons, signature fields or form fields.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The ID of the package to which the document is added.
Document ID	documentId	True	integer	The ID of the document for which the fields are requested.
Page No	pageNo	True	integer	Page no of the document for which the fields are requested. If page number is not provided fields of whole document are returned.
Originator	x-mobile		string	Define the originator(Web/Mobile) of the request/action

Returns

Body: FieldsResponse

Get Enterprise Templates

Operation ID:: V4_Template_GetEnterpriseTemplates

Business applications can use this service API to get list of enterprise templates of the current user. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.

It is possible to search based upon the criterion supplied under the "x-search-text" header.

Parameters

Name	Key	Required	Type	Description
Number of records per page	recordPerPage	True	integer	Total number of records to be retrieved in a page.
Page number to be retrieved	pageNo	True	integer	Page number to be retrieved.
Sort by column	sort-by		string	Sort the result by possible values are mentioned above.
Order the result set	asc		boolean	Order the result set by ascending or descending.
Filter by template ids	id		array	Search by template ids.
Search text	x-search-text		string	Search text if required. This is optional and without it the entire list is returned. Furthermore, recommended value for search text parameter is in Base64 encoded format.
Total number of records	x-total-records		string	The total number of records found with the provided search criteria.

Returns

response: array of EnterpriseTemplateResponse

Get Package Details

Operation ID:: V4_Package_GetPackageDetails

Business applications can use this service API to get the details of an package. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID of the document package.

Returns

Body: GetPackageDetailsResponse

Get Packages

Operation ID:: V4_Package_GetAllPackages

Business applications can use this service API to get a list of documents filtered by different statuses. Users can divide the records into pages by providing a number of records per page.

Parameters

Name	Key	Required	Type	Description
Document Status	document_status	True	string	Filter by document status possible values are ALL, DRAFT, PENDING, SIGNED, DECLINED, INPROGRESS, EDITED, REVIEWED, COMPLETED, EXPIRING_IN_SEVEN_DAYS.
Page Number	pageNo	True	integer	Page number, according the division of records per page.
Records Per Page	recordPerPage	True	integer	Number of records that are needed to be fetched in one request.
Package Name	package-name		string	Package Name
Package ID	package-id		integer	Package Id
From	recipient-from		string	From
To	recipient-to		string	To
Document ID	document-id		integer	Document Id
Expiry (Days)	expiry		integer	Expiry (Days)
From Modified Date	modified-from		date-time	From Modified Date
To Modified Date	modified-to		date-time	To Modified Date
From Size (KB)	size-from		integer	From Size (KB)
To Size (KB)	size-to		integer	To Size (KB)
Certified Documents	certified-documents		boolean	Only certified signed documents
Form Fields	form-fields		boolean	Only documents that have form fields
Attachments	attachments		boolean	Only documents that have attachments
Document Type	document-type		string	Document Type like XML, PDF, DOCX etc
Sort By	sort-by		string	Sort the resultant records as per your choice
Ascending Order	asc		boolean	Sorted the resultant records by ascending or descending order
Document Statuses	document-statuses		array	Document Type
Owned By	owned-by		string	Owned By filter possible values are ME_OTHERS, ME, OTHERS.
Smart Form Name	smart-form		string	Smart form name
Folder Name	x-folder		string	Folder name from where the documents are to be fetched. Possible values are INBOX and ARCHIVE. Furthermore, recommended value for x-folder parameter is in Base64 encoded format.
Search Text	x-search-text		string	Search text sent in headers for further filtration of the documents. Package id, name and document owner can be searched. Furthermore, recommended value for search text parameter is in Base64 encoded format.
Total Records	x-total-records		string	The total number of records found with the provided search criteria.
Source	x-source		string	This is the identification of the source of the document from where the document is uploaded, e.g. "My App".
Recipient Details	x-recipient-details		string	If "true" is passed recipient details regarding Document Access Duration will be provided along decline information

Returns

response: array of GetPackagesResponse

Get Process Evidence Report

Operation ID:: V4_WorkflowEvidenceReport_DownloadBytes

Business applications can use this service API to download the workflow process evidence report of a document.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The ID of the document.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: object

Get Shared Space

Operation ID:: V4_WorkSpace_GetSharedSpace

Business applications can use this service API to get a specific shared space. This API returns information about shared space, its owner and collaborator.

Parameters

Name	Key	Required	Type	Description
Shared Space ID	id	True	integer	Id of shared space that you want to get

Returns

Body: WorkSpaceResponse

Get Templates

Operation ID:: V4_Settings_GetTemplates

Business applications can use this service API to get list of templates for the current user.

It is possible to search based upon the criterion supplied under the "x-search-text" header.Furthermore, it is possible to search a user's personal templates or the enterprise templates as allowed against their user role by their enterprise admin.

Parameters

Name	Key	Required	Type	Description
Number of records per page	recordPerPage	True	integer	Total number of records to be retrieved in a page.
Page number to be retrieved	pageNo	True	integer	Page number to be retrieved.
Sort by column	sort-by		string	Sort by column. Possible Values are CREATED_ON and NAME. Default is sort by CREATED_ON
Asc	asc		boolean	The resulting list order. Default resulting list will be descending
Search text	x-search-text		string	Search text if required. This is optional and without it the entire list is returned. Furthermore, recommended value for search text parameter is in Base64 encoded format.
Enterprise templates only	x-enterprise		string	When set as "true" only enterprise templates list will be returned. In case of "false"only the user's templates list will be returned.If you do not set the header, then both enterprise and user's templates lists will be returned.
Total number of records	x-total-records		string	The total number of records found with the provided search criteria.

Returns

response: array of TemplateResponse

Get Workflow Details

Operation ID:: V4_Workflow_GetWorkflowDetail

Business applications can use this service API to get workflow details for the package.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The ID of the package to be downloaded.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

Body: WorkflowDetailsResponse

Get Workflow History

Operation ID:: V4_Workflow_GetWorkflowHistory

Business applications can utilize this service API to retrieve the list of actions performed on a document. The package ID is provided in the resource URL. The search field (x-search-text header) is intended for email, document name, action, infokey, and infovalue.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The ID of the document for which the log is required.
Page Number	pageNo	True	integer	Page number to be retrieved.
Records Per Page	recordsPerPage	True	integer	Total number of records to be retrieved in a page.
Search Text	x-search-text		string	The search field (x-search-text header) is intended for email, document name, action, infokey, and infovalue.

Returns

Body: WorkflowHistoryResponse

Get Workflow Reminder

Operation ID:: V4_Workflow_GetWorkflowReminder

Business applications can use this service API to update the reminders for the recipients that has already been added to a workflow. Normally this call is useful after a template has been applied to a document and business applications want to override the reminders settings within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow recipient is identified by the order at which it is added to the workflow.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The package ID for which workflow reminders to be updated.
Order	order	True	integer	The order of the user for which the workflow reminders to be updated.

Returns

Body: ReminderResponse

Get Workflow User Authentication (Document Opening) of Enterprise Package

Operation ID:: V4_EnterpriseDocuments_GetEnterpriseWorkflowAccess

Business applications can use this service API to get the access security settings enabled for the package. Recipients for whom the security is configured are identified by the order in the URL. Package ID is also identified in the request URL. Recipients will not be able to access document package outside the scope of this duration if the access security is enabled. Document owner can also configure authentication based security of the package for a recipient.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The package ID for which workflow access security and authentication is to be updated.
Recipient Order	order	True	integer	Order of the recipient in the workflow for which the access security and authentication is to be updated.

Returns

Body: EnterpriseAccessResponse

Get Workflow User Permissions

Operation ID:: V4_WorkflowPermission_GetWorkflowPermissions

Business applications can use this service API to get document permissions for a recipient. Recipient is identified by the order in the workflow. The ID of the package is provided in the resource URL.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The document ID for which workflow user needs to be updated.
Order	order	True	integer	The order of the user in workflow for which the permissions are requested. By providing the value 0 in order, service would return the permissions of most recently added collaborator in the workflow.

Returns

Body: WorkflowPermissionResponse

Get Workflow Users

Operation ID:: V4_Workflow_GetWorkflowUsers

Business applications can use this service API to get workflow details for the package.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The ID of the package to be downloaded.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: array of WorkflowRecipient

Move Package to Custom or Shared Space folder

Operation ID:: V4_Folder_MovePackage

Business applications can use this service API to move the document package to a shared space or user's custom folder.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package id that need to move to folder
folder_name	folder_name	True	string	Target folder name in which package need to move

Returns

response: object

Recall Document

Operation ID:: V4_Workflow_RecallWorkflow

Business applications can use this service API to stop a workflow in progress. The document ID is provided in the resource URL. After recall the document status automatically changes to “DRAFT”.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The ID of the package to be recalled.

Returns

response: object

Rename Document

Operation ID:: V4_Documents_RenameDocument

Business applications can use this service API to rename a document in a package.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID of the package to which the document is added.
Document ID	documentId	True	integer	The ID of the document to on which the action is to be performed.
document_name	document_name	True	string	New name of the document.

Returns

Body: DocumentResponse

Rename Package

Operation ID:: V4_Package_RenamePackage

This service API is used to rename a document package.

The document package is identified by its unique identifier in the URL of the call.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId_bulkAction	True	integer	Package ID to change the name of.
package_name	package_name	True	string	New name of the document package.

Returns

response: object

Operation ID:: V4_Workflow_StartWorkflow

Business applications can use this service API to share a document package with the signers and start a new workflow. The document should already have been prepared by applying a template and optionally updating the users and actions defined in template. The package ID to be shared is provided in the resource URL.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The document package to be shared.

Returns

response: array of StartWorkflowResponse

Sign Document

Operation ID:: V4_Signing_SignDocument

Business applications can use this service API to sign a document (both electronic and digital) without displaying the document to the end user using SigningHub. For example, a business application may have another method to display the document to the user, and only the signing functionality of SigningHub is required, or for bulk operations it may be justified to sign without requiring the user to view and approve every document individually. If there are changes to be saved in the document before signing, Fill Form Fields API should be called before calling the Sign Document API. Note any mandatory input fields on a document require completing before this API will successfully complete.

The signatory is identified by the access token presented in the call.Therefore, authentication of the signatory is required prior to making this call.You cannot authenticate as an Enterprise Admin with the scope variable, and sign a document on behalf of a user.The access token must be issued to the signatory as a result of direct authentication.

When this call completes it is important that if the signatory was the last signer for a document that the Finish Document API call is invoked.The reason is because without calling that API the document will remain in a status of "In Progress" to the document owner. Once the API has been called, the status will change to "Completed" for the document owner.

Once document is signed, the verification response can be seen from Get Document Verification API.

First or Second Factor OTP Usage for Authentication

If OTP authentication is turned on for the server side signing operation, client applications will need to generate a OTP for the mobile number using Signer Authentication via OTP API call. Respective business applications must retrieve the OTP from the use and submit it when making the API call. This is done using the "x-otp" header in the request.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The identifier of the package that contains the document for signature.
Document ID	documentId	True	integer	Identifier of the document to be signed.
field_name	field_name	True	string	Unique identifier of the signature field in the document.
hand_signature_image	hand_signature_image		string	Base64 encoded string image of the visible signature appearance, which is placed onto the document. Note this can be retrieved from the user's personal settings using this call. (The response is binary, so the business application must then Base64 encode it before submitting in this API call.)
hand_signature_method	hand_signature_method			Name of the hand signature method by user for signing. In case no hand signature method is provided then default will be DRAW.
signing_reason	signing_reason		string	Reason of signing provided by the recipient. Note: Commitment type indication for XML documents
signing_location	signing_location		string	Locale of the signer provided by the recipient.
contact_information	contact_information		string	Contact information of the signer provided by the recipient.
user_name	user_name		string	Name of the signer provided by the recipient. Note this applies to in-person signing operations only.
user_password	user_password		string	Password provided by the user subject to user's signature settings.
appearance_design	appearance_design		string	Name of the signature appearance provided by user for signing. In case no appearance name is provided then default selected appearance would be used. Possible values are "COMPANY_LOGO","DETAILED_SIGNATURE","HAND_SIGNATURE"
signing_capacity	signing_capacity		string	Name of certification profile/signing capacity using which the document is to be signed. If not provided the default capacity will be used to sign. Provided name must be exactly same as of the actual profile due to case sensitivity.
skip_verification	skip_verification	True	boolean	No signature verification returns in response body when it is set as true. Default value for this parameter set to false.
signing_server	signing_server		string	Name of signing server using which the document is to be signed.
authentication	authentication			Authentication object is an optional, it contains authentication releated options
One-Time Password (OTP)	x-otp		string	OTP used as a second factor authentication for the signing operation.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.
Mobile Originator	x-mobile		string	Define the originator(Web/Mobile) of the request/action

Returns

Body: SignDocumentResponse

Submit Document

Operation ID:: V4_Package_Submit

One of the SigningHub roles is called "Editor". This allows a recipient to edit input fields on a document, but does not require a signature. Once completed the recipient submits their changes. The button used in the GUI is called "Submit".

This is the equivalent operation for an editor to submit their changes via an API call.

Click SigningHub Roles for a description of all available workflow recipient roles.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The SigningHub package ID that contains the document to be submitted.
Document Access Password	x-password		string	The password set by the document owner for accessing the document, if any. If the password has not been set, then the value shall be null.
Document One-Time Password	x-otp		string	The One-Time Password (OTP) set by the document owner for accessing the document, if any. If the OTP has not been set, then the value shall be null.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: object

Update Certify Policy for a document

Operation ID:: V4_Documents_UpdateCertifyPolicy

Business applications can use this service API to update certify signature settings for a document in a package.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID of the package to which the document is added.
Document ID	documentId	True	integer	The ID of the document on which the action is to be performed.
certify	certify			Certify settings object for the document.
lock_form_fields	lock_form_fields	True	boolean	True if form fields are to be locked after the last signature on the current document.

Returns

response: object

Update CheckBox Field

Operation ID:: V4_Checkbox_UpdateCheckBox

Business applications can use this service API to update a checkbox field of a document in a package.

Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface.

It's width and height cannot be updated. They will remain the same as when they were added.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID to which the document is added.
Document ID	documentId	True	integer	The document ID for which the action is to be taken.
field_name	field_name	True	string	Current name of the field, that is to be updated.
renamed_as	renamed_as		string	Updated name of the field if renaming is intended.
page_no	page_no	True	integer	Page number on which the field is to be created.
value	value		string	Value of the field. Possible values are "true" or "false"
x	x	True	double	Left location of the field in pixel.
y	y	True	double	Top location of the field in pixel.
width	width	True	double	Width of the field in pixel.
height	height	True	double	Height of the field in pixel.
validation_rule	validation_rule		string	One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: object

Update Digital Signature Field

Operation ID:: V4_Signature_UpdateSignature

Business applications can use this service API to update a digital signature field of a document in a package.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID to which the document is added.
Document ID	documentId	True	integer	The document ID for which the action is to be taken.
field_name	field_name	True	string	Current name of the field, which is to be updated.
level_of_assurance	level_of_assurance		array of string	Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
renamed_as	renamed_as		string	Updated name of the field if renaming of the field is intended.
page_no	page_no	True	integer	Page number on which the field is to be created.
x	x	True	double	Left location of the field in pixel.
y	y	True	double	Top location of the field in pixel.
width	width	True	double	Width of the field in pixel.
height	height	True	double	Height of the field in pixel.
display	display		string	Visibility of the field that is to be updated, possible values are "VISIBLE" and "INVISIBLE"
authentication_signing	authentication_signing			Field Authentication
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: object

Update In-person Field

Operation ID:: V4_InPerson_UpdateInPerson

Business applications can use this service API to update an in-person signature field of a document in a package.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID to which the document is added.
Document ID	documentId	True	integer	The document ID for which the action is to be taken.
field_name	field_name	True	string	Current name of the field, that is to be updated.
renamed_as	renamed_as		string	updated name of the field, if renaming is intended.
page_no	page_no	True	integer	Page number on which the field is to be created.
placeholder	placeholder		string	String identifier for the in-person field, it can be Customer, Jack, CEO etc.
x	x	True	double	Left location of the field in pixel.
y	y	True	double	Top location of the field in pixel.
width	width	True	double	Width of the field in pixel.
height	height	True	double	Height of the field in pixel.
display	display		string	Visibility of the field that is to be updated, possible values are "VISIBLE" and "INVISIBLE"
level_of_assurance	level_of_assurance		array of string	Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE"
authentication_signing	authentication_signing			Field Authentication
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: object

Update Initial Field

Operation ID:: V4_Initials_UpdateInitial

Business applications can use this service API to update an initials field of a document in a package.

Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.

You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID to which the document is added.
Document ID	documentId	True	integer	The document ID for which the action is to be taken.
field_name	field_name	True	string	Current name of the field, that is to be updated.
renamed_as	renamed_as		string	Updated name of the field if renaming is intended.
page_no	page_no	True	integer	Page number on which the field is to be created.
x	x	True	double	Left location of the field in pixel.
y	y	True	double	Top location of the field in pixel.
width	width	True	double	Width of the field in pixel.
height	height	True	double	Height of the field in pixel.

Returns

response: object

Update Placeholder

Operation ID:: V4_Workflow_WorkflowUpdatePlaceholder

Business applications can use this service API to update a placeholder in the workflow. Normally this call is useful after a template has been applied to a document and business applications wants to override the details of a specific place holder within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow place holder is identified by the order at which it is added to the workflow. While XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	ID of the package for which the placeholder is to be added.
Order	order	True	integer	Order of the recipient in the workflow.
placeholder	placeholder		string	The name of the new placeholder to be added in workflow. If no value is provided, old value will be retained.
email_notification	email_notification		boolean	Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn. If no value is provided, old value will be retained.
role	role	True		Role of the group as a recipient in the workflow. Possible value are "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" and "INPERSON_HOST". If no value is provided, old value will be retained. However, while XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"
signing_order	signing_order		integer	Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".

Returns

response: object

Update Post Processing

Operation ID:: V4_Workflow_UpdateWorkflowPostProcess

Business applications can use this service API to add placeholder to a workflow a document in a package.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	ID of the document package for which the post processing is being updated.
enabled	enabled	True	boolean	True, if post processing is turned on for the package.
contacts	contacts		array of string
name	name	True	string
email	email	True	string
message	message		string	A custom string message for all the contacts. Message becomes part of the email sent to the contacts.
google_drive	google_drive		boolean	True, if document is to be uploaded to the provided google account after the workflow completion.
dropbox	dropbox		boolean	True, if document is to be uploaded to the provided dropbox account after the workflow completion.
onedrive	onedrive		boolean	True, if document is to be uploaded to the provided oneDrive account after the workflow completion.
workflow_recipients	workflow_recipients	True	boolean	True, if workflow completion report is to be sent to all recipients of the workflow when post processing is executed. Default value is false.
document_processing_report	document_processing_report	True	boolean	True, if Send the document processing report (XML) is to be enabled to for the workflow

Returns

response: object

Update QR Code

Operation ID:: V4_QR_UpdateQRCode

Business applications can use this service API to update a QR Code of a document in a package.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID to which the document is added.
Document ID	documentId	True	integer	The document ID for which the action is to be taken.
field_name	field_name	True	string	Current name of the field, that is to be updated.
renamed_as	renamed_as		string	Updated name of the field if renaming is intended.
page_no	page_no	True	integer	Page number for which field is need to be updated
dimensions	dimensions	True		Field dimensions
data	data		string	The plain text data to be encoded in the QR code. Default is URL generated to access the related document. e.g. {base_url}/document/{document_unique_id}
options	options			Settings regarding options
color	color			Settings regarding color
logo	logo			Settings regarding logo

Returns

Body: UpdateQrCodeResponse

Update RadioBox Field

Operation ID:: V4_Radio_UpdateRadioBox

Business applications can use this service API to update a radio button of a document in a package.

It's width and height cannot be updated. They will remain the same as when they were added.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID to which the document is added.
Document ID	documentId	True	integer	The document ID for which the action is to be taken.
field_name	field_name	True	string	Current name of the field, that is to be updated.
renamed_as	renamed_as		string	Updated name of the field if renaming is intended.
page_no	page_no	True	integer	Page number on which the field is to be created.
value	value		string	Value of the field. Possible values are "true" or "false"
validation_rule	validation_rule	True		One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".
radio_group_name	radio_group_name	True	string	The group name to which the field belongs.
x	x	True	double	Left location of the field in pixel.
y	y	True	double	Top location of the field in pixel.
width	width	True	double	Width of the field in pixel.
height	height	True	double	Height of the field in pixel.

Returns

response: object

Update Shared Space

Operation ID:: V4_WorkSpace_UpdateSharedSpace

Business applications can use this service API to update shared space. The availability of updating shared spaces is subject to the assigned enterprise user role. To allow this provision Enterprise Admin will enable the ‘Manage Shared Space’ option in Roles>Document Settings.

Parameters

Name	Key	Required	Type	Description
Shared Space ID	id	True	integer	Id of shared space that you want to update
name	name		string	Name of shared space
name	name	True	string	Name of work space member
email	email	True	string	Email Address of work space member

Returns

response: object

Update TextBox Field

Operation ID:: V4_TextBox_UpdateTextBox

Business applications can use this service API to update a text box of a document in a package.

Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged. You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields. The latter can be used when a template was applied or the document was created using the GUI interface.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID to which the document is added.
Document ID	documentId	True	integer	The document ID for which the action is to be taken.
field_name	field_name	True	string	Current name of the field, that is to be updated.
field_locale	field_locale		string	Field local. Possible values are ar-AE \| en-US. Optional and default will be en-US. This value matters for type "DATE".
renamed_as	renamed_as		string	Updated name of the field if renaming is intended.
page_no	page_no	True	integer	Page number on which the field is to be created.
value	value		string	Value of the field. For type = DATE, the value is expected to follow ISO 8601 format.Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00. If value is not in proper format an error will be returned.
max_length	max_length	True	integer	Maximum length of the value allowed in the field. Must between 1 - 9999
field_type	field_type	True		Field type with respect to accepting the type of values, possible values are "NUMBER" or "TEXT".
validation_rule	validation_rule	True		One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".
font	font			Font of the fields text
x	x	True	double	Left location of the field in pixel.
y	y	True	double	Top location of the field in pixel.
width	width	True	double	Width of the field in pixel.
height	height	True	double	Height of the field in pixel.
placeholder	placeholder		string	Developers can provide a their own placeholder texts. These placeholders appear in the text fields while viewing the document in viewer.
format	format		string	Text format of the field. Used for the date type field only. Possible values are m/d m/d/yy m/d/yyyy mm/dd/yy mm/dd/yyyy mm/yy mm/yyyy d-mmm d-mmm-yy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd yyyy-mm-dd mmm-yy mmm-yyyy mmmm-yy mmmm-yyyy mmmm d, yyyy dd/mm/yy ddmmmyyyy
validation	validation			Validations

Returns

response: object

Update Workflow Details

Operation ID:: V4_Workflow_UpdateWorkflow

Business applications can use this service API to update the workflow details. Normally this call is useful after a template has been applied to a document, but business applications wants to override the certify permission or post processing details. The package ID is provided in the resource URL.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The package ID for which workflow details need to be updated.
workflow_type	workflow_type			Workflow type for the package e.g (SERIAL,PARALLEL,INDIVIDUAL,CUSTOM). If no value is provided, old value will be retained.
workflow_mode	workflow_mode			Workflow mode of the package e.g (ONLY_ME, ME_AND_OTHERS, ONLY_OTHERS). If workflow mode is set to ONLY_ME then no collaborator can be added to package other then authenticated user itself
continue_on_decline	continue_on_decline		boolean	True, if workflow needs to continue even if any recipient declines the document. If no value is provided, old value will be retained.
message	message		string	A custom string message from the document owner to every recipient, this message appears in the sharing email as well as on the screen. If no value is provided, old value will be retained.
comments	comments		boolean	Allow comments

Returns

response: object

Update Workflow Reminders

Operation ID:: V4_Workflow_UpdateWorkflowReminder

Business applications can use this service API to update the workflow reminders for a recipient that has already been added to a workflow. Normally this call is useful after a template has been applied to a document and business applications want to override the reminders settings within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow recipient is identified by the order at which it is added to the workflow.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The package ID for which workflow reminders to be updated.
Order	order	True	integer	The order of the user for which the workflow reminders to be updated.
apply_to_all	apply_to_all	True	boolean	True, if reminder settings are to be applied on all the recipients in the workflow.
enabled	enabled	True	boolean	True, if reminder settings are to be enabled.
frequency	frequency		string	Reminder Frequency. Possible Values are DAYS \| HOURS.
remind_after	remind_after	True	integer	Required, in case of enabled property will true. The number of days after which the first reminder would be sent to workflow user.
repeat	repeat			The reminders would be sent to user repeatedly.

Returns

response: object

Update Workflow User

Operation ID:: V4_Workflow_WorkflowUserUpdate

Business applications can use this service API to update the details of a recipient, group or place holder who has already been added to a workflow. Normally this call is useful after a template has been applied to a document and business applications wants to override the details of a specific user within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow recipient is identified by the order at which it is added to the workflow. Note, while XML type document preparation, only supports role types "SIGNER", "REVIEWER" and "CARBON_COPY".

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The package ID for which workflow user needs to be updated.
Order	order	True	integer	The order of the user in workflow.
user_email	user_email		string	The email address of the new user to be updated in workflow. If no value is provided, old value will be retained.
user_name	user_name		string	Name of the recipient to be updated. If no value is provided, old value will be retained.
email_notification	email_notification		boolean	Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn. If no value is provided, old value will be retained.
mobile_number	mobile_number		string	Mobile number. If no value is provided, old value will be retained.
role	role	True		Role of the recipient to be updated. Possible values are "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" or "INPERSON_HOST". If no value is provided, old value will be retained. However, while XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"
signing_order	signing_order		integer	Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".
email_language_code	email_language_code		string	email language code
delivery_method	delivery_method	True		Delivery method of the recipient in the workflow. Possible values are "EMAIL", "SMS", or "EMAIL_AND_SMS". Default value would be EMAIL
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

Body: UpdateCollaboratorResponse

Update Workflow User Authentication (Document Opening) of Enterprise Package

Operation ID:: V4_EnterpriseDocuments_UpdateEnterpriseWorkflowAccess

Business applications can use this service API to update the package authentications and access duration for the recipients. This API can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The package ID for which workflow access security and authentication is to be updated.
Recipient Order	order	True	integer	Order of the recipient in the workflow for which the access security and authentication is to be updated.
apply_to_all	apply_to_all	True	boolean	True, if the access security or authentications are to be applied on all the recipients in the workflow.
authentication	authentication	True		It has the access aauthentication data
authentication_signing	authentication_signing			It has the signing authentication data
access_duration	access_duration	True		It has the access duration of the workflow

Returns

response: object

Update Workflow User Permissions

Operation ID:: V4_WorkflowPermission_UpdateWorkflowPermissions

Business applications can use this service API to update the workflow permissions for a user that has already been added to a workflow. Normally this call is useful after a template has been applied to a document and business applications want to override the permissions within the workflow. The ID of the document package is provided in the resource URL, and the workflow user is identified by the order at which it is added to the workflow.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	The package ID for which workflow permissions to be updated.
Order	order	True	integer	The order of the recipient for which the workflow permissions to be updated.
apply_to_all	apply_to_all	True	boolean	True, if the permissions are to be applied on all the recipients in the workflow.
permissions	permissions	True		It has all the permissions to be allowed in the workflow
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

response: object

Update Workflow Users Order

Operation ID:: V4_Workflow_WorkflowUserUpdateOrder

Business applications can use this service API to update order of the recipient in the workflow.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	ID of the package to which the recipients are to be added.
Order	order	True	integer	Existing order of the recipient which is to be updated.
order	order	True	integer	The order of the recipient which is to be updated.

Returns

response: object

Upload Attachment

Operation ID:: V4_Attachment_UploadAttachment

Business applications can use this service API to upload a attachment in a document.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID of the package to which the document is added.
Document ID	documentId	True	integer	ID of the document to which the attachment needs to be add.
Attachment File	file (binary Stream)		binary	This is the document in the raw binary format.
Field Name	x-field-name		string	Field name if required. This is optional and with field name attachment field is processed. Furthermore, recommended value for field name parameter is in Base64 encoded format.
File Name	x-file-name	True	string	It's the name of file with extension.
Document Password	x-password		string	The password set by the document owner for accessing the document, if any. If the password has not been set, then the value shall be null.
One-Time Password	x-otp		string	The One-Time Password (OTP) set by the document owner for accessing the document, if any. If the OTP has not been set, then the value shall be null.
Folder ID	x-folder-id		string	Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

Returns

Body: AddAttachmentResponse

Upload Document

Operation ID:: V4_Documents_UploadStream

Business applications can use this service API to add a document to a document package linked to an enterprise user’s account. The document information is sent in the HTTP request header and document bytes are sent in the HTTP request body. Note SigningHub will convert supported document formats to PDF if the header "x-convert-document" is set to a value of "true". The only case supported where this value is set to "false" is to retain Word format and XML documents.

SigningHub supports a wide variety of document formats, each of which can be converted to PDF format upon upload.Click here for the full list.

Note PDF documents are not altered upon upload to the system.

Note a package must already exist before you can add a document using this call.

Parameters

Name	Key	Required	Type	Description
Package ID	packageId	True	integer	Package ID of the package to which the document is being added.
Document (binary Stream)	file (binary Stream)		binary	This is the document in the raw binary format.
File Name	x-file-name		string	It's the name of file with extension.
Convert Document	x-convert-document		string	This identifies whether to convert the document to a PDF or if it should be retained in its original format. Note the only original format supported is currently Word & XML. All other document types will result in an error if this header value is set to "false". If uploading a PDF document this Header can be omitted.
Source	x-source		string	This is the identification of the source of the document from where the document is uploaded, e.g. "My App".

Returns

Body: UploadDocument

Definitions

ElectronicSealRecipient

Name	Path	Type	Description
name	name	string
level_of_assurance	level_of_assurance	string

ReminderResponse

Name	Path	Type	Description
enabled	enabled	boolean	True, if reminders are enabled for the recipient
frequency	frequency	string	Reminder Frequency. Possible Values are DAYS \| HOURS.
remind_after	remind_after	integer	The number of days after which the first reminder would be sent to workflow user.
repeat	repeat		Repeat object with the details of reminder being repeated or not.

AddQrCodeResponse

Name	Path	Type	Description
data	data	string	QR Code generated data
field_name	field_name	string	Name of the field created in the document.
value	value	string	Value will be the base64 of QrCode image

AddFieldResponse

Name	Path	Type	Description
field_name	field_name	string	Name of the field created in the document.
created_on	created_on	string	Date and time of field creation.

SignatureFieldResponse

Name	Path	Type	Description
field_name	field_name	string	Name of the field created in the document.
created_on	created_on	string	Date and time of field creation.

UpdateQrCodeResponse

Name	Path	Type	Description
value	value	string	Value will be the base64 of QrCode image

CertifyResponse

Name	Path	Type	Description
enabled	enabled	boolean	True, if certify signature settings are enabled for the document.
allowed_permissions	allowed_permissions	array of string	Certify permission level set for the document with certify signature settings.
default_permission	default_permission	string

GroupMemberResponse

Name	Path	Type	Description
user_email	user_email	string	Email address of the group member
user_name	user_name	string	User name of the group member

CollaboratorResponse

Name	Path	Type	Description
user_email	user_email	string	User email
signing_order	signing_order	integer	Signing order
guest_user	guest_user	boolean	Is guest user
email_language_code	email_language_code	string	Email language code
permission	permission		Permissions for the recipient in the document package
reminder	reminder		Reminder settings of the recipient.

WorkflowPermissionResponse

Name	Path	Type	Description
print	print	boolean	True, if printing is allowed for this recipient.
download	download	boolean	True, if download is allowed.
add_text	add_text	boolean	True, if add text annotation on the document is allowed.
change_recipients	change_recipients	boolean	True, if the recipient on the current order can change other recipients in the workflow after workflow is shared.
add_attachment	add_attachment	boolean	True, if attachments and merging of PDF documents is allowed.
legal_notice	legal_notice		Legal notice set by the owner for the recipient.
attachment	attachment		Attachments

EnterpriseTemplateResponse

Name	Path	Type	Description
id	id	integer	Id of the template
name	name	string	Name of the template.
public	public	boolean	Response is "true" if enterprise template is marked as public. Otherwise "false" would be returned
read_only	read_only	boolean	Response of "true" if the template is read only, and user cannot make any changes to the workflow after applying this template. Otherwise "false".
description	description	string	Description of the template
created_on	created_on	string	Date and time when the template was created
roles	roles	array of EnterpriseTemplateRole
documents	documents	array of TemplateDocumentResponse

EnterpriseTemplateRole

Name	Path	Type	Description
name	name	string	Name of the enterprise role assigned to the user.
id	id	integer	Id of the enterprise role assigned to the user.

TemplateDocumentResponse

Name	Path	Type	Description
id	id	integer	Id of the template document
name	name	string	Name of the template document.

Next_signer_email

Name	Path	Type	Description
user_email	user_email	string	Email address of the next signer.
user_name	user_name	string	Name of the next signer.

WorkflowRecipient

Name	Path	Type	Description
order	order	integer	Order of the recipient in the workflow.
user_email	user_email	string	Email address of the recipient if user is not a group.
user_name	user_name	string	Name of the recipient if user is not a group.
mobile_number	mobile_number	string	Mobile number
delivery_method	delivery_method	string	Delivery method of recipient Possible values: EMAIL, SMS, or EMAIL_AND_SMS
user_photo_url	user_photo_url	string	API endpoint to access the resource, This will be provided only for main signers. e.g it will be null for group/delegator/gatekeeper etc. This URL does not make sure that signer image is exist. If image exist it will be provided by hitting the defined url otherwise it will be an empty string.
group_name	group_name	string	Group name of the recipient if recipient is a group.
group_members	group_members	array of GroupMemberResponse	A list of email addresses of the group members if recipient is a group.
delegatee	delegatee	string	Delegatee email address, if recipient is not a group.
delegatee_name	delegatee_name	string	Name of the delegatee user, if recipient is not a group.
role	role	string	Workflow role in which the recipient was added. This role is not the enterprise role. Possible values are "SIGNER", "REVIEWER","CARBON_COPY" and "EDITOR".
reason	reason	string	Reason provided by the user when declining, approving or submitting a document.
process_status	process_status	string	Document processing status for the recipient. Possible values are "UN_PROCESSED", "IN_PROGRESS", "SIGNED", "REVIEWED", "DECLINED", "EDITED" or "INVALID".
processed_on	processed_on	string	Date and time on which the document was processed.
processed_as	processed_as	string	User may processed the field as COLLABORATOR , DELEGATOR, GROUP_MEMBER or OWNER.
processed_by	processed_by	string	Email address of the user who processed the document.
placeholder	placeholder	string	Placeholder text if the recipient is a placeholder
signing_order	signing_order	integer	Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".
user_national_id	user_national_id	string	National identity number of the user. This helps to identify user in the workflow
guest_user	guest_user	boolean	Gest user
email_language_code	email_language_code	string	email language code
electronic_seal	electronic_seal	ElectronicSealRecipient
gatekeepers	gatekeepers		Gatekeepers

EnterpriseAccessResponse

Name	Path	Description
authentication	authentication	Authentication object with the details of authentication methods applied on the document for the recipient.
authentication_signing	authentication_signing	Authentication Signing for the package
access_duration	access_duration	Access duration object with the details of access securities for the recipient.

GetPackageDetailsResponse

Name	Path	Type	Description
name	name	string	Name of the document package.
owner	owner	DocumentOwner
read_only	read_only	boolean	True if the applied template is read only. User will not be able to make any changes if a read only template is applied.
document_status	document_status	string	Document status for the current logged in user. Possible values are "DRAFT", "INPROGRESS", "PENDING", "DECLINED", or "COMPLETED".
documents	documents	array of DocumentDetails

DocumentOwner

Name	Path	Type	Description
name	name	string	Name of the document package owner.
email	email	string	Email of the document package owner.

DocumentDetails

Name	Path	Type	Description
id	id	integer	ID of the newly created document.
name	name	string	The name of the document.
uploaded_on	uploaded_on	string	Date and time when the document was uploaded.
modified_on	modified_on	string	Date and time when the document was last modified.
size	size	integer	Size of the document in bytes.
type	type	string	Type of the document e.g. "PDF".
source	source	string	Identifies where the document was uploaded e.g. "My App".

TemplateResponse

Name	Path	Type	Description
template_id	template_id	integer	Id of the template is returned here
template_name	template_name	string	Name of the template.
template_public	template_public	boolean	Response is "true" if enterprise template is marked as public. Otherwise "false" would be returned
read_only	read_only	boolean	Response of "true" if the template is read only, and user cannot make any changes to the workflow after applying this template. Otherwise "false".
created_on	created_on	string	Date and time when the template was created
description	description	string	Description of the template
enterprise	enterprise	boolean	True, if user belong to an enterprise.
documents	documents	array of TemplateDocumentResponse
smart_form	smart_form		Smart form

StartWorkflowResponse

Name	Path	Type	Description
package_id	package_id	integer	Package ID of the package just shared. Incase of individual sharing, more then one packages are created and shared with the recipients. API returns an array of packages along with IDs of newly created documents.
documents	documents	array of integer	Array of document IDs which were part of the package before sharing.

WorkflowDetailsResponse

Name	Path	Type	Description
package_id	package_id	integer	Package ID of the document package.
package_name	package_name	string	Name of the document package.
shared_package	shared_package	boolean	shared package
package_owner	package_owner	string	Email address of the document package owner.
owner_name	owner_name	string	Name of the document package owner.
package_status	package_status	string	Document status for the current logged in user. Possible values are "DRAFT", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" or "COMPLETED".
folder	folder	string	Name of the folder which contains the document package.
folder_id	folder_id	integer	ID of the folder which contains the document package.
gatekeeper	gatekeeper	boolean
next_signer	next_signer	string	The name of the next signer if the document is in shared state.
next_signer_email	next_signer_email	array of Next_signer_email	An object containing next signers username and email address. In case of group signer it will have a list of email addresses of all the group members.
uploaded_on	uploaded_on	string	Date and time when the document was uploaded.
modified_on	modified_on	string	Date and time when the document was last modified.
workflow	workflow		Workflow object with the workflow details.
documents	documents	array of WorkflowDocumentsResponse	List of documents that are uploaded in the package.
users	users	array of WorkflowUserResponse	Recipients list for the workflow.

WorkflowDocumentsResponse

Name	Path	Type	Description
document_id	document_id	integer	ID of the document.
document_name	document_name	string	Name of the document.
document_type	document_type	string	Original document extension when the document was uploaded before conversion to the PDF.
document_order	document_order	integer	Order of the document in the document package.
document_source	document_source	string	Source of the document from where the document was uploaded.
update_required	update_required	boolean	True if document is required to update
document_height	document_height	integer	Height of the PDF document.
document_width	document_width	integer	Width of the PDF document.
document_pages	document_pages	integer	Total number of pages in the document.
created_on	created_on	string	The date and time on which the document was uploaded.
modified_on	modified_on	string	The date and time on which the document was last modified.
form_fields	form_fields	boolean	True, if document has form fields.
template	template		Template object which is applied on the document along with the template details.
certify	certify	CertifyResponse
lock_form_fields	lock_form_fields	boolean	True, if document is set to lock the form fields with the last digital signature on the document.
locked	locked	boolean
has_signed_signature_fields	has_signed_signature_fields	boolean	Pdf document meta info: true if pdf document have signed signature fields
attachments	attachments	boolean	True, if document has attachments.
conformance_level	conformance_level	string	Document conformance level
document_size	document_size	integer	Size of document.
formatted	formatted	boolean	This property is for XML document, that either its formatted or not

WorkflowUserResponse

Name	Path	Type	Description
order	order	integer	Order of the recipient in the workflow.
user_name	user_name	string	Name of the recipient if recipient is not a group. If recipient is a placeholder it will contain the name of the placeholder.
user_email	user_email	string	Email address of the recipient if recipient is not a group or placeholder.
mobile_number	mobile_number	string	Mobile number
delivery_method	delivery_method	string	Delivery method of recipient Possible values: EMAIL, SMS, or EMAIL_AND_SMS
user_photo_url	user_photo_url	string	API endpoint to access the resource, This will be provided only for main signers. e.g it will be null for group/delegator/gatekeeper etc. This URL does not make sure that signer image is exist. If image exist it will be provided by hitting the defined url otherwise it will be an empty string.
group_name	group_name	string	Name of the group if recipient is a group.
group_members	group_members	array of string	List of all the email addresses and names of the users.
delegator	delegator	string	Email address of the user who is delegator to this recipient.
gatekeeper	gatekeeper	string	Email address of the user who is gatekeeper to this recipient.
gatekeepers	gatekeepers		Gatekeepers
role	role	string	Role of the recipient i.e., "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" or "INPERSON_HOST".
process_status	process_status	string	Document processing status for the recipient. Possible values are "UN_PROCESSED", "IN_PROGRESS", "SIGNED", "REVIEWED", "DECLINED", "EDITED" or "INVALID".
processed_on	processed_on	string	Date and time on which the document was processed.
processed_as	processed_as	string	User may processed the field as COLLABORATOR, DELEGATOR, GROUP_MEMBER or OWNER.
processed_by	processed_by	string	Email address of the user who processed the document.
reason	reason	string	Reason provided by the user when declining, approving or submitting a document.
placeholder	placeholder	string	Placeholder text if the recipient is a placeholder.
permission	permission		Permissions for the recipient set by the owner of the document package.
authentications	authentications		Authentications object with the details of any authentications and access securities configured for the recipient.
reminder	reminder		Reminder object with the details of reminder settings.
signing_order	signing_order	integer	Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".
user_national_id	user_national_id	string	National identity number of the user. This helps to identify user in the workflow
guest_user	guest_user	boolean	Gest user
email_language_code	email_language_code	string	Email language code
electronic_seal	electronic_seal		electronic seal

DocumentDetailsResponse

Name	Path	Type	Description
document_id	document_id	integer	ID of the newly created document.
document_name	document_name	string	The name of the document.
document_order	document_order	integer
document_type	document_type	string	Type of the document e.g. "PDF".
document_width	document_width	integer	Width of the document in PDF format.
document_height	document_height	integer	Height of the document in PDF format.
document_source	document_source	string	Identifies where the document was uploaded e.g. "My App".
document_pages	document_pages	integer	Total pages of the document.
form_fields	form_fields	boolean	True if document has form fields.
lock_form_fields	lock_form_fields	boolean	True if locking of form fields with the last signature is enabled.
uploaded_on	uploaded_on	string	The date and time when the document was uploaded.
modified_on	modified_on	string	The date and time when the document was last modified.
certify	certify		Certified signature settings for the document.
template	template		Template details, if the template is applied on the document.

AddAttachmentResponse

Name	Path	Type	Description
attachment_id	attachment_id	integer	Attachment id

GetAttachmentResponse

Name	Path	Type	Description
attachment_id	attachment_id	integer	Attachment id
attachment_name	attachment_name	string	Attachment name

AddPackageResponse

Name	Path	Type	Description
package_id	package_id	integer	The package ID to be used later to share, download and get status of the document.
workflow_mode	workflow_mode	string	The workflow mode that is set while adding package.
workflow_type	workflow_type	string	Type of the workflow. Possible values are "SERIAL", "PARALLEL", "INDIVIDUAL" and "CUSTOM".

GetPackagesResponse

Name	Path	Type	Description
package_id	package_id	integer	Package ID of the document package.
package_name	package_name	string	Name of the document package.
package_owner	package_owner	string	Email address of the document package owner.
owner_name	owner_name	string	Name of the document package owner.
shared_package	shared_package	boolean	Shared Package
gatekeeper_package	gatekeeper_package	boolean	Gatekeeper Package
package_status	package_status	string	Document status for the current logged in user. Possible values are "DRAFT", "INPROGRESS", "PENDING", "DECLINED", or "COMPLETED".
extension	extension	string	Document Package extension
workflow_mode	workflow_mode	string	Workflow Mode
folder	folder	string	Name of the folder which contains the document package.
folder_id	folder_id	integer	Id of the folder which contains the document package.
unread	unread	boolean	True, if the document is not read by the recipient yet.
next_signer	next_signer	string	The name of the next signer if the document is in shared state.
next_signer_email	next_signer_email	array of Next_signer_email	An object containing next signers username and email address. In case of group signer it will have a list of email addresses of all the group members.
uploaded_on	uploaded_on	string	Date and time when the document was uploaded.
modified_on	modified_on	string	Date and time when the document was last modified.
access_duration	access_duration		Specify start and end date/time for a recipient to access the document. The recipient will not be able to access the document beyond this duration. If the document is not processed within the specified time, the document will be considered declined.. This will be provided if "x-recipient-details" is passed as true in the header
decline	decline		Document decline details if its either manually declined or auto via Core. This will be provided if "x-recipient-details" is passed as true in the header
size	size	integer	Size of the document in bytes.

DocumentResponse

Name	Path	Type	Description
package_name	package_name	string	Document Package name

UploadDocument

Name	Path	Type	Description
documentId	documentId	integer	This property is retained for backward compatibility and will be removed in later versions. Use document_id instead.
documentid	documentid	integer	The document ID to be used later to share, download and get status of the document. will be removed later document_id will be used
document_id	document_id	integer	The document ID to be used later to share, download and get status of the document.
document_name	document_name	string	The name of the document.
document_order	document_order	integer	Document order in package
document_type	document_type	string	Type of the document e.g. "PDF".
document_source	document_source	string	Identifies where the document was uploaded e.g. "My App".
document_width	document_width	integer	Width of the document in PDF format.
document_height	document_height	integer	Height of the document in PDF format.
document_pages	document_pages	integer	Total pages of the document.
uploaded_on	uploaded_on	date-time	The date and time when the document was uploaded.
modified_on	modified_on	date-time	The date and time when the document was last modified.
lock_form_fields	lock_form_fields	boolean	True if locking of form fields with the last signature is enabled.
certify	certify		Certified signature settings for the document.
document_size	document_size	integer	Uploaded document size in bytes
metadata	metadata		Uploaded document pdf meta information
package_name	package_name	string	The document package name

CertifyPolicyResponse

Name	Path	Type	Description
certify	certify		Certify signature settings for the document.
lock_form_fields	lock_form_fields	boolean	True if forms fields are to be locked in the PDF after the last digital signature on the current document.

BulkSignResponse

Name	Path	Type	Description
status	status	string
transaction_id	transaction_id	string

BulkSignStatusResponse

Name	Path	Type	Description
status	status	string
packages	packages	array of BulkSignPackagesStatus

BulkSignPackagesStatus

Name	Path	Type	Description
id	id	integer
name	name	string
status	status	string
action	action	string	Required action key if any
error	error	string
percentage	percentage	integer
documents	documents	array of BulkSignActionDocumentModel	Documents in the current package

BulkSignActionDocumentModel

Name	Path	Type	Description
id	id	integer
fields	fields	array of BulkSignActionFieldModel

BulkSignActionFieldModel

Name	Path	Type
name	name	string
hash	hash	string
hashing_algo	hashing_algo	string

SignDocumentResponse

Name	Path	Type	Description
field_name	field_name	string	Name of the field for which the verification was requested.
status	status	string	Returns the status of signature field. Values are SIGNED, PENDING. Status helps in eIDAS enabled remote authorized signing. If sign request is sent to mobile the status is pending.
transaction_id	transaction_id	string	This parameter is used while RAS signing
verification	verification		Signature Verification
authentication_access_token	authentication_access_token	string	It will contain the OIDC id_token when user is authenticated via OIDC

AutoPlaceFieldsResponse

Name	Path	Type	Description
field_name	field_name	string	Name of the field that was auto generated by the API.

ContactResponse

Name	Path	Type	Description
id	id	integer	id of the contact.
user_name	user_name	string	User name of the contact.
user_email	user_email	string	Email address of the contact.
mobile_number	mobile_number	string	Mobile number of the contact.
enterprise	enterprise	boolean	True, if contact is enterprise.
user_national_id	user_national_id	string	National identity number of the contact
created_on	created_on	string	DateTime when contact is added.

WorkSpaceMembers

Name	Path	Type	Description
name	name	string	Name of work space member
email	email	string	Email Address of work space member

WorkSpaceResponse

Name	Path	Type	Description
id	id	integer	Id of shared space
name	name	string	Name of shared space
owner	owner		Owner of shared space
members	members	array of WorkSpaceMembers	Members of shared space

UploadDocumentLibraryResponse

Name	Path	Type	Description
document_id	document_id	integer	ID of the newly created document.
document_name	document_name	string	The name of the document.
document_size	document_size	integer	Uploaded document size in bytes
document_order	document_order	integer	Order of the document
document_type	document_type	string	Type of the document e.g. "PDF".
document_source	document_source	string	Identifies where the document was uploaded e.g. "My App".
document_width	document_width	integer	Width of the document in PDF format.
document_height	document_height	integer	Height of the document in PDF format.
document_pages	document_pages	integer	Total pages of the document.
uploaded_on	uploaded_on	date-time	The date and time when the document was uploaded.
modified_on	modified_on	date-time	The date and time when the document was last modified.
form_fields	form_fields	boolean	True if document has form fields.
lock_form_fields	lock_form_fields	boolean	True if locking of form fields with the last signature is enabled.
certify	certify		Certified signature settings for the document.
template	template		Template details, if the template is applied on the document.
package_name	package_name	string	Package name
metadata	metadata		Uploaded document pdf meta information

WorkflowHistoryResponse

Name	Path	Type	Description
package_id	package_id	integer	ID of the package for which the workflow history is requested.
package_name	package_name	string
package_owner	package_owner	string	Email address of the package owner.
owner_name	owner_name	string	Name of the package owner.
package_status	package_status	string	Status of the package/document with the current logged in user. Possible values are "DRAFT", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" or "COMPLETED".
next_signer	next_signer	string	Name of the next recipient.
next_signer_email	next_signer_email	array of Next_signer_email	Object having name and email address of the next recipient.
documents	documents	array of WorkflowDocumentsResponse
actions	actions	array of DocumentLogsActions

DocumentLogsActions

Name	Path	Type	Description
log_id	log_id	integer	ID of an action performed on the document.
date_time	date_time	string	Date and time when the action was performed.
action_type	action_type	string
user_email	user_email	string	Email of the user who performed the action.
user_name	user_name	string	Name of the user who performed the action.
enterprise_name	enterprise_name	string	The name of Enterprise to which the user belongs. If the user doesn't belong to an enterprise, then this element is not present.
information	information	DocumentLogsActionsInformation

DocumentLogsActionsInformation

Name	Path	Type	Description
type	type	string	The type of extra information about the action e.g. "SIGNING_METHOD" which means what signing method user used to sign the document.
value	value	string	The value of the extra information about the action e.g. "LOCAL" which means user signed the document using locally held credentials.

UpdateCollaboratorResponse

Name	Path	Type	Description
user_email	user_email	string	User email
signing_order	signing_order	integer	Signing order
guest_user	guest_user	boolean	Is guest user
email_language_code	email_language_code	string	Email language code

CollaboratorGroupResponse

Name	Path	Type	Description
permission	permission		Permissions for the recipient in the document package
reminder	reminder		Reminder settings of the recipient.
signing_order	signing_order	integer	Signing order

CollaboratorPlaceholderResponse

Name	Path	Type	Description
permission	permission		Permissions for the recipient in the document package
reminder	reminder		Reminder settings of the recipient.
signing_order	signing_order	integer	Signing order

FieldsResponse

Name	Path	Type	Description
signature	signature	array of DigitalSignatureFieldResponse	A list of all digital signatures in the document.
hand_signature	hand_signature	array of HandSignatureFieldResponse
electronic_signature	electronic_signature	array of ElectronicSignatureFieldResponse
initials	initials	array of InitialFieldResponse
in_person_signature	in_person_signature	array of object
items	in_person_signature	object
text	text	array of TextFieldResponse
radio	radio	array of RadioFieldResponse
checkbox	checkbox	array of CheckboxFieldResponse
dropdown	dropdown	array of DropdownFieldResponse
listbox	listbox	array of ListBoxFieldResponse
qrcode	qrcode	array of QrCodeResponse
attachment	attachment	array of AttachmentFieldResponse
comment	comment	array of CommentFieldResponse
unique_identifier	unique_identifier	array of UniqueIdentifierFieldResponse

DigitalSignatureFieldResponse

Name	Path	Type	Description
order	order	integer	Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.
display_order	display_order	integer	Display order according to the SigningHub viewer.
field_name	field_name	string	Unique identifier of the field.
page_no	page_no	integer	Page number of the document on which the field exists.
embedded	embedded	boolean	True, if field is part of the PDF document.
type	type	string	If field is assigned or not, possible values are ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN and PLACEHOLDER.
process_status	process_status	string	Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Date time on which the document is processed.
processed_as	processed_as	string	User who processed the field as COLLABORATOR, DELEGATEE, GROUP_MEMBER or OWNER.
created_on	created_on	string	Date time on which the field is added
processed_by	processed_by	string	Email address of the user who processed the field.
dimensions	dimensions	FieldDimenssionResponse
verification	verification		Returns the verification response of signature field. In case of no verification, null is returned.
nid	nid	string
display	display	string	Returns the visibility value of the digital signature field, possible values are "VISIBLE" and "INVISIBLE".
level_of_assurance	level_of_assurance	array of string
authentication	authentication		Authentication

FieldDimenssionResponse

Name	Path	Type	Description
field	field	FieldResponse
page	page	PageResponse

FieldResponse

Name	Path	Type	Description
x	x	double	Left location of the field in pixel.
y	y	double	Top location of the field in pixel.
width	width	double	Width of the field in pixel.
height	height	double	Height of the field in pixel.

PageResponse

Name	Path	Type	Description
width	width	float	Width of the page where field is placed in the PDF.
height	height	float	Height of the page where field is placed in the PDF.

HandSignatureFieldResponse

Name	Path	Type	Description
order	order	integer	Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.
display_order	display_order	integer	Display order according to the SigningHub viewer.
field_name	field_name	string	Unique identifier of the field.
page_no	page_no	integer	Page number of the document on which the field exists.
embedded	embedded	boolean	True, if field is part of the PDF document.
type	type	string	If field is assigned or not, possible values are ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN and PLACEHOLDER.
process_status	process_status	string	Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Date time on which the document is processed.
processed_as	processed_as	string	User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER.
processed_by	processed_by	string	Email address of the user who processed the field.
dimensions	dimensions	FieldDimenssionResponse
nid	nid	string

ElectronicSignatureFieldResponse

Name	Path	Type	Description
order	order	integer	Email address of the user who processed the field.
display_order	display_order	integer	Display order according to the SigningHub viewer.
field_name	field_name	string	Unique identifier of the field.
page_no	page_no	integer	Page number of the document on which the field exists.
embedded	embedded	boolean	True, if field is part of the PDF document.
type	type	string	If field is assigned or not, possible values are ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN and PLACEHOLDER.
process_status	process_status	string	Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Date time on which the document is processed.
processed_as	processed_as	string	User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER.
processed_by	processed_by	string	Email address of the user who processed the field.
dimensions	dimensions	FieldDimenssionResponse
signature_sub_type	signature_sub_type	string	The signature sub-type can be a WITNESS signature. If witness signatures are enabled in service plan, E-Signature fields are signed with a common certificate shared by all the users in the service plan. Possible values are WITNESS or NONE.
authentication	authentication		Authentication
verification	verification		Returns the verification response of the field. In case of no verification, null is returned.
nid	nid	string
display	display	string	Returns the visibility value of the electronic signature field, possible values are "VISIBLE" and "INVISIBLE".

InitialFieldResponse

Name	Path	Type	Description
order	order	integer	Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.
display_order	display_order	integer	Display order according to the SigningHub viewer.
field_name	field_name	string	Unique identifier of the field.
page_no	page_no	integer	Page number of the document on which the field exists.
process_status	process_status	string	Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Date time on which the document is processed.
processed_as	processed_as	string	User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER.
processed_by	processed_by	string	Email address of the user who processed the field.
dimensions	dimensions	FieldDimenssionResponse
embedded	embedded	boolean	True, if field is part of the PDF document.

TextFieldResponse

Name	Path	Type	Description
field_locale	field_locale	string	Field local. Possible values are ar-AE \| en-US. Optional and default will be en-US. This value matters for type "DATE".
required	required	boolean	True if field required in pdf
order	order	integer	Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.
tab_order	tab_order	integer	Tab order in the PDF document
display_order	display_order	integer	Display order according to the SigningHub viewer.
field_name	field_name	string	Unique identifier of the field.
page_no	page_no	integer	Page number of the document on which the field exists.
embedded	embedded	boolean	True, if field is part of the PDF document.
type	type	string	Type of the text field, possible values are "TEXT", "NAME", "COMPANY", "JOBTITLE", "EMAIL", "DATE".
value	value	string	Value of the field. For type = DATE or format_type = DATE, the value is expected to follow ISO 8601 format.Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00. If value is not in proper format an error will be returned.
read_only	read_only	boolean	True, if the field is marked read only in the PDF document.
validation_rule	validation_rule	string	One or more rules for validation of the fields, possible values are "MANDATORY" or "OPTIONAL".
validation	validation		This object is for required Value to be passed
visible	visible	boolean	True, if the field is not hidden in the PDF document.
multiline	multiline	boolean	True, if the field is multi line in the PDF document.
font	font	FontResponse
max_length	max_length	integer	Maximum content length allowed to be filled in the field.
format_type	format_type	string	If field is a textbox it can follow different input types. Possible values are ALPHANUMERIC, NUMBER, TEXT, EMAIL, TIME or DATE.
placeholder	placeholder	string	Placeholder text for the textbox field.
format	format	string	Text format of the field. Used for the date type field only. Possible values are m/d m/d/yy m/d/yyyy mm/dd/yy mm/dd/yyyy mm/yy mm/yyyy d-mmm d-mmm-yy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd yyyy-mm-dd mmm-yy mmm-yyyy mmmm-yy mmmm-yyyy mmmm d, yyyy dd/mm/yy ddmmmyyyy
color	color	string	Color of the text in the form fields.
border_color	border_color	string	Border color of the form field.
tooltip	tooltip	string	tooltip of the form field.
field_rotation	field_rotation	integer	Field Rotation
align	align	string	Text alignment for the form field. Possible values are "RIGHT", "LEFT", "CENTER" or "JUSTIFY"
dimensions	dimensions	FieldDimenssionResponse

RadioFieldResponse

Name	Path	Type	Description
required	required	boolean	True if field required in pdf
order	order	integer	Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.
tab_order	tab_order	integer	Tab order in the PDF document.
display_order	display_order	integer	Display order according to the SigningHub viewer.
field_name	field_name	string	Unique identifier of the field.
page_no	page_no	integer	Page number of the document on which the field exists.
embedded	embedded	boolean	True, if field is part of the PDF document.
type	type	string
value	value	boolean	Value of the field.
read_only	read_only	boolean	True, if the field is marked readonly in the PDF document.
validation_rule	validation_rule	string	One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".
radio_group_name	radio_group_name	string	The group name to which the field belongs.
checked	checked	boolean	True, if the field is selected
visible	visible	boolean	True if the field is not hidden in the PDF document.
dimensions	dimensions	FieldDimenssionResponse
color	color	string	Color of the text in the form fields.
border_color	border_color	string	Border color of the form field.
tooltip	tooltip	string	tooltip of the form field.
field_rotation	field_rotation	integer	Field Rotation

CheckboxFieldResponse

Name	Path	Type	Description
required	required	boolean	True if field required in pdf
order	order	integer	Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.
tab_order	tab_order	integer	Tab order in the PDF document
display_order	display_order	integer	Display order according to the SigningHub viewer.
field_name	field_name	string	Unique identifier of the field.
page_no	page_no	integer	Page number of the document on which the field exists.
embedded	embedded	boolean	True, if field is part of the PDF document.
type	type	string
value	value	boolean	Value of the field.
read_only	read_only	boolean	True, if the field is marked read only in the PDF document.
checked	checked	boolean	True if the field is selected.
visible	visible	boolean	True if the field is not hidden in the PDF document.
validation_rule	validation_rule	string	One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".
dimensions	dimensions	FieldDimenssionResponse
color	color	string	Color of the text in the form fields.
border_color	border_color	string	Border color of the form field.
tooltip	tooltip	string	tooltip of the form field.
field_rotation	field_rotation	integer	Field Rotation

DropdownFieldResponse

Name	Path	Type	Description
required	required	boolean	True if field required in pdf
order	order	integer	Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.
tab_order	tab_order	integer	Tab order in the PDF document.
display_order	display_order	integer	Display order according to the SigningHub viewer.
field_name	field_name	string	Unique identifier of the field.
page_no	page_no	integer	Page number of the document on which the field exists.
embedded	embedded	boolean	True, if field is part of the PDF document.
validation_rule	validation_rule	string	One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".
read_only	read_only	boolean	True, if the field is marked read only in the PDF document.
value	value	string	Value of the field .
choices	choices	array of string	Choices available for the dropdown to choose a value from.
visible	visible	boolean	True, if the field is not hidden in the PDF document.
dimensions	dimensions	FieldDimenssionResponse
font	font	FontResponse
color	color	string	Color of the text in the form fields.
border_color	border_color	string	Border color of the form field.
tooltip	tooltip	string	tooltip of the form field.
field_rotation	field_rotation	integer	Field Rotation

ListBoxFieldResponse

Name	Path	Type	Description
order	order	integer	Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.
tab_order	tab_order	integer	Tab order in the PDF document.
display_order	display_order	integer	Display order according to the SigningHub viewer.
field_name	field_name	string	Unique identifier of the field.
page_no	page_no	integer	Page number of the document on which the field exists.
embedded	embedded	boolean	True, if field is part of the PDF document.
validation_rule	validation_rule	string	One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".
read_only	read_only	boolean	True, if the field is marked read only in the PDF document.
value	value	string	Value of the field.
choices	choices	array of string	Choices available for the dropdown to choose a value from.
visible	visible	boolean	True, if the field is not hidden in the PDF document.
dimensions	dimensions	FieldDimenssionResponse
font	font	FontResponse
color	color	string	Color of the text in the form fields.
border_color	border_color	string	Border color of the form field.
tooltip	tooltip	string	tooltip of the form field.
field_rotation	field_rotation	integer	Field Rotation

FontResponse

Name	Path	Type	Description
name	name	string	Font name for the text field. For user defined fields SigningHub only support "COURIER", "HELVETICA". In case of existing fields in a PDF file, font value can be anything that is set in the PDF.
size	size	integer	Font size for the text field.
embedded_size	embedded_size	double	Size of the font in the original PDF document.

QrCodeResponse

Name	Path	Type	Description
field_name	field_name	string	Unique identifier of the field.
type	type	string	Field Type PDF_FIELD_TYPE like QR
page_no	page_no	integer	Page number of the document on which the field exists.
value	value	string	QrCode generated base64 will be provided inly in draft mode
dimensions	dimensions	FieldDimenssionResponse
data	data	string	The plain text data to be encoded in the QR code. Default is URL generated to access the related document. e.g. {base_url}/document/{document_unique_id}
options	options		Settings regarding options
color	color		Settings regarding color
logo	logo		Settings regarding logo

AttachmentFieldResponse

Name	Path	Type	Description
order	order	integer	Order of the recipient to whom this field is assigned.
display_order	display_order	integer	Display order according to the SigningHub viewer.
field_name	field_name	string	Unique identifier of the field.
page_no	page_no	integer	Page number of the document on which the field exists.
process_status	process_status	string	Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Date time on which the document is processed.
processed_as	processed_as	string	User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER.
processed_by	processed_by	string	Email address of the user who processed the field.
attachmentRefId	attachmentRefId	integer	Attachmet ref id
note	note	string	Attachmet note Only in case of "MANDATORY" attachment rule
validation_rule	validation_rule		One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".
dimensions	dimensions		Dimentions

CommentFieldResponse

Name	Path	Type	Description
id	id	integer	Comment field id
page_no	page_no	integer	Page number of the document on which the field exists.
unread_count	unread_count	integer	Unread comments
private	private	boolean	Private
recipients	recipients	array of CommentFieldRecipientResponse	Recipients
dimensions	dimensions		Dimensions

UniqueIdentifierFieldResponse

Name	Path	Type	Description
field_name	field_name	string	Unique identifier of the field.
value	value	string	Value of the field.
page_no	page_no	integer	Page number of the document on which the field exists.
font	font	FontResponse
dimensions	dimensions	FieldDimenssionResponse

CommentFieldRecipientResponse

Name	Path	Type	Description
user_name	user_name	string	User name
user_email	user_email	string	User email

object

This is the type 'object'.