SigningHub API Guide
Download OpenAPI specification:Download
Browse through the API content by selecting the relevant pages from the left panel. To quickly find specific web service information, enter search criteria in the search box on top left.
.More about SigningHub
To know more about SigningHub, explore the following links:
- Go to SigningHub Knowledge Base to view all the relevant information of SigningHub.
-
Contact
SigningHub support staff through the
Live Chat provision
.
Our
support staff may be occupied with other priority tasks so live chat is offered on
an "as available" basis.
This guide is intended for developers who will integrate SigningHub into their respective web web applications using the RESTful web services, and user interface offered by SigningHub. It is assumed that the reader has a basic knowledge of REST, Java, C#, HTML, JavaScript, HTTP and TLS/SSL. There is no Software Developers Kit (SDK) for the integration, instead the integration uses HTML Forms and JSON so that integration is simple from any language including .Net, Java, PHP etc.
Most Popular Pages
Authentication
Account Management
Add Package
Upload Document
Get Workflow Details
Sign Document
-
Create an Enterprise Admin account
– the business application has to connect to this account and makes JSON requests to control the signing users/recipients. The SigningHub cloud service can be used for testing and you can create a free Enterprise Admin. Once you have created the account, contact Ascertia support (support@ascertia.com) and provide the name of your enterprise to have the standard restrictions removed from your account, to allow you to fully test the web services integration option. This restriction is for number of signatures, workflows, and templates. .
-
Create an API Key
– set an Application Name, Call-back URL and generate an API Key in SigningHub, using the Enterprise Settings menu > Integrations screen. Note the Application Name and API Key. See details, how to configure an API key.
- Create workflow templates (Optional) – the workflow template defines the location of each signature field and the user that is expected to sign the document. It also defines other document and workflow control options including PDF permissions, the ability to download or print document for example. Templates may increase efficiency, especially when a standard contract or agreement is used many times. SigningHub also supports dynamic creation of signature fields for use cases where documents are created and uploaded in real time where templates may not be appropriate. .
Supported Tokens
This section provides information of supported tokens by SigningHub.
- Client Credentials Token - The Client Credentials grant type is used by clients to obtain an access token outside of the context of a user. This is typically used by clients to access resources about themselves rather than to access a user's resources. The business application should use client credentials token to authenticate themselves and to manage an enterprise or use scope token API to perform actions on behalf of the user. Click here for more details
- User Credentials Token - The Password grant type is a way to exchange a user's credentials for an access token. This is typically used to access users' resources like upload, share, etc. Enterprise Actions should be allowed in the user's role to manage them. Click here for more details
- Scope Token - The business application uses scope API to create a token that then allows the business application to perform actions on behalf of the users. This will require a business application to be authenticated first.Click here for more details
Below is the list of APIs that provdes information of which api is allowed to be used by token.
shows that API is supported- (-) shows that API is not supported
This section provides a quick "Do this and it works" guide for developers to understand how they can integrate SigningHub features within their business applications.
Overview
SigningHub exposes an external communication channel that allows external business applications to authenticate themselves, send requests and receive responses. This integration can be done with an on-premise instance (or private cloud instance) or the public cloud service running here www.signinghub.com.
The business application uses a secure HTTPS session to pass the document and its workflow control data to SigningHub. Using this approach, SigningHub can quickly and easily integrate with business applications to provide users with document review and digital signature approval functionality.
There is no Software Development Kit (SDK) for the integration, instead, SigningHub provides REST APIs that simplify the integration and can be used with any language including .Net, Java, PHP, etc.
Integration Scenarios
There are two ways to integrate SigningHub within a business application:
- Tight Integration - The business application uses SigningHub to provide document review and digital signature functionality. Users interact with the business web application and when they get to the point where a document requires approval SigningHub is invoked to display it within an iframe. The user is unaware that SigningHub functionality is used. The user can review the entire document and sign in their defined location. Tight integration is suitable for ECM, CRM, and ERP web applications or portals where a known user already interacts in a defined way. The user login information can be used by the business application to create and connect the user to their respective SigningHub account.
-
Loose Integration - The business application sends a document to SigningHub together with control information. SigningHub creates and manages the workflow and emails each user in turn prompting them to log in, review and sign the document. Users log in and see the document within the SigningHub view and sign screen. They can review the entire document and sign in their defined location. This mode is most suitable for integration with a back-office application that has no exposed public-interface
This Quick Guide summarises how to use tight integration. The SigningHub software includes an example tight integration demo website built in .NET to help developers with web application/portal integration.
- SmartForm Integration – This integration enables seamless in-app signing experiences by embedding SmartForms directly into your web application using the SigningHub API. Users can view, fill, and sign forms without login or registration, while your system handles all notifications, routing, and status tracking. Structured fields and predefined workflows are supported, and the signing interface is securely loaded via iframe, keeping the entire process within your application.
Tight Integration
The following diagram summarizes the process for tight integration:
In this mode of integration, users interact with the business web application. At some point, there is a need to view and sign a document. For ease of use, the user does not need to register or login in order to view and sign the document. In tight integration, the web application uses iframe technology to embed the SigningHub view and sign page within an existing webpage.
The user’s signing field is highlighted for them, and clicking on such enables them to create their digital signature. All of these web service interactions are performed in a way that ensures the user has a seamless experience fully consistent with the existing business application.
When using tight integration, users do not login directly to the SigningHub and no email is generated by SigningHub. It is the business application’s responsibility to manage the workflow and keep the user informed.
The process is:
- (Manual Step) - an Enterprise Account must be created
- (Manual Step) - an Enterprise Client ID, Client Secret and Call back URL must be configured
- (Manual Optional Step) - the Enterprise Admin creates a workflow template
- (Manual Optional Step) - the Enterprise Admin uploads a document to Enterprise Library which will be later sent to your user to sign
- (Coding) - the business application gets a client credential access token which is then used to get scope token
- (Optional coding) - the business application registers a new Enterprise User
- (Coding) - the business application gets a scope token using client credentials access token which is used for subsequent API calls
- (Coding) - the business application uploads a new package to the Enterprise User (used as Scope) account
- (Coding) - the business application applies a template or dynamically adds fields to the document
- (Coding) - the business application starts the document workflow
- (Coding) - the document is shown to the Enterprise User (used as Scope) within an iframe
- (Manual) - the enterprise user review and signs the document within an iframe
- (Optional coding) - the business application downloads the package/document
These steps are explained in more detail here:
- Step 1 - Create an Enterprise Admin Account (Manual) - the business application has to register for an enteprise account. The SigningHub cloud service www.signinghub.com can be used for testing and you can create a free Enterprise Admin account by clicking the FREE TRIAL button.
- Step 2 - Generate the API Key (Manual) - Click here for instructions
- Step 3 - Create a Workflow Template (Manual, Optional) - Click here for instructions. If template can't be used and you want to dynamically add fields then skip this step
- Step 4 - Add a Document to the Library (Manual, optional) - If a standard document or contract is used you can avoid uploading the document programmatically for every use case. All you need is to maintain your document in your enterprise library and use the ID of the document as a reference in your application. Click here for more information about managing documents in an enterprise library
- Step 5 - Get client credential token via the API (Coding) - this call authenticates the business application access to SigningHub. This requires the Enterprise Client Secret and Client Id that in return sends the access token. For authentication, the business application needs to send an HTTP POST request to SigningHub. The following is an example request/response:
Header Parameters
application/x-www-form-urlencoded
application/json
REQUEST BODY SCHEMA
"client_credentials"
Define the OAuth 2.0 grant type.
non-empty
Application Name that is configured in your Enterprise Account when configuring the integration options.
non-empty
API Key that that is generated in your Enterprise Account when configuring the integration options.
Request Body
grant_type=client_credentials&
client_id= CLIENT_ID&
client_secret= CLIENT_SECRET&
Sample Response
- Step 6 - Register an Enterprise User via the API (Coding, Optional) - this represents the user account that will be used to upload the document and will be shared to sign the signature field. An account for the signer must exist, if it does not then to create a signer, the business application needs to send the following example request only once. To learn more about each parameter used consult the developer manuals here.
Header Parameters
application/json
application/json
Bearer {access_token}
Access token obtained after a successful authentication. This service requires the access token to be obtained using the client credentials.
REQUEST BODY SCHEMA
The email address of the user account to be registered.
The name of the user to be registered.
Job title of user.
Company name of user.
Mobile number of user.
The password of the user account. This is optional if you want your users to authenticate externally e.g. via SAML, Salesforce, Office 365 etc. rather than using a SigningHub ID (email/password). If password is provided, application expects the security question and answer as mandatory fields.
Security question used to reset password if user forgets his password. This is mandatory if you wish to allow the user to sign without manually, via an email link, completing the registration process. If security question is provided, application expects password and security answer as mandatory fields.
Security answer used to reset the password if user forgets his password. This is mandatory if you wish to allow the user to sign without manually, via an email link, completing the registration process. If security answer is provided, application expects password and security question as mandatory fields.
The enterprise role to be assigned to this user - these are managed within the Enterprise account.
This defines whether enterprise user would get an email notification about the account creation. Default value is 'false'.
Request Body
Sample Response
- Step 7 - Authenticate Enterprise User (Coding) - this authenticates access to SigningHub and requires the Enterprise User email address and client credentials access token. An OAuth 2.0 access token is returned. For authentication, the business application needs to send an HTTP POST request to SigningHub. The received access token is then used to upload, prepare and share the document. Following is an example request/response:
Header Parameters
application/json
application/json
Bearer {access_token}
This service requires the access token to be obtained using the client credentials.
REQUEST BODY SCHEMA
non-empty
Email of a registered enterprise user
Request Body
Sample Response
- Step 8 - Add Package (Coding) - 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.
Header Parameters
application/json
application/json
Bearer {access_token_scope}
Access token returned in Scope API call
REQUEST BODY SCHEMA
non-empty
The name of the package.
ONLY_OTHERS
Enum: "ME_AND_OTHERS" "ONLY_OTHERS" "ONLY_ME"
Inbox
The name of the folder. It will be used to upload package in any folder of the user, either its a custom folder or a shared folder.
Request Body
Sample Response
-
Step 8.1 - Add Document or dynamically add fields (Coding) - Business applications can use this service API to add a document from the user’s library to a package. The
package_idis provided in the URL which should be the same as found in the previous call. The document ID must be provided asdocument_idin the resource URL to identify the library document to be copied.
Path Parameters
The ID of the package to which the document is being added.
The ID of the document that will be fetched from libary and added to the package
Header Parameters
application/json
application/json
Bearer {access_token_scope}
Access token returned in Scope API call
In the case where the business application creates the document dynamically then you can upload the document using the Upload Document API call explained here , as opposed to using a document from your respective library
Sample Response
-
Step 9 - Apply Template or dynamically add fields (Coding) - 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. In this call the
package_idshould be same as used in step 9 and thedocument_idis the one the user got in the response of step 8.
Path Parameters
The ID of the package.
The ID of the document on which the template will be applied.
Header Parameters
application/json
application/json
Bearer {access_token_user}
Access token returned in Scope API call
REQUEST BODY SCHEMA
Name of template to be applied on the document.
false
True, if template has to be applied on all the documents in the package.
In the case where the template contains a placeholder or a user that you wish to change then you can use the Update Workflow User API call as explained here.
Alternatively if due to the dynamic nature of the document you cannot apply a template and want to add different fields, e.g. text field, checkbox, initials, signature fields etc., then you can add them dynamically by providing the X, Y, Width, Height coordinates, package ID, document ID, page number and assign to a user. Click here to learn more.
Request Body
Sample Response
- Step 10 - Share Package (Coding) - Business applications can use this service API to share a document with the designated signatories and start a new workflow. The document should already have been prepared by optinally 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. In this call the package_id should be same as used in step 8.
Path Parameters
The ID of the package that has to be shared.
Header Parameters
application/json
application/json
Bearer {access_token_scope}
Access token returned in Scope API call
Sample Response
- Step 11 - Generate Integration URL for Encrypted Data (Coding) - Business applications can use this service API to generate an encrypted URL to access a document and to perform signing operation on that document. The returned URL in response will be an encrypted URL which contains all the information which was provided in request body. See sample request below.
Header Parameters
application/json
application/json
Bearer {access_token_scope}
REQUEST BODY SCHEMA
The ID of the package that has been shared in step 10.
The ID of the Document that has been shared.
""
Language code in which application is required be shown to end user. if no value is provided then system defined language will be used.
""
user_email is required when a Guest user has to process the document.
""
URL, where user will be redirected after completing the required actions. if no value is provided then system will follow what's been configured in Enterprise Settings > Integration.
"false"
True, will hide the panels in the IFrame mode. if no value is provided then it will follow what's been set in Integration options.
"false"
False, if you do not want to have a user automatically redirected to the call-back URL. After the user has performed their task, they will stay on the document viewer screen and will not be redirected unless they press the "Close" button.
""
Indicating response should be encoded or plan.Possible values are ENCODED, PLAIN
The user custom certificate Id.
Section wise integration, if not provided Default value : VIEWER
Possible values are
|
Note: If the section is VIEWER or WORKFLOW, SigningHub will redirect you to the Viewer; otherwise, it will navigate to the specified SigningHub section. |
Request Body
Sample Response
- Step 12 - Review Document in Iframe (Coding) - Client web applications create an iframe with the source of the iframe that is being returned in step 11 as follows:
Iframe view in browser
-
Step 13 - Handle Call-back (Coding) - Once the user has signed, declined or reviewed and approved the document within the SigningHub document viewer, the user can close the document and return to the web application. When the user closes the document, SigningHub immediately returns control to the web application using the configured URL for that specific integration. This is the 'call-back' parameter, configured under the Application Integration settings.
Control is returned to the web application as soon as the user navigates away from the document viewer window. For cases such as signature operations this occurs when the user completes the signing process and clicks on 'Finish' button. Browser navigation (back button) is another way of navigating away from the document viewer and will also result in control passing back to the web application, and invoke the call-back URL.
When control returns to the web application, SigningHub appends the following parameters to the call-back URL to inform the web application of the action status. Response type can be encoded or plain depending on the value response_type sent in the request
Respose Details
| Response Type | Description |
|---|---|
| ENCODED | [callback_url]?lang=en_USpackage_id%3D1017545%26action%3Dnone |
| Plain | [callback_url]?lang=en_US&package_id=1017545&action=signed |
Parameters Details
| Name | Description |
|---|---|
| package_id | The ID of the package that was shown to the user. |
| action |
Provides information about the action the user performed on the document. The possible values are:
|
- Step 13.1 - Check Workflow Status (Coding) - Once the document has been shared and the workflow is in progress, the document owner may want to see the current status of the workflow. The status of workflow at any time can be checked by using the Get Workflow Details API. Click here for details.
- Step 15 - Download Package/Document (Coding)
SmartForm Integration
The following diagram summarizes the process for Smart Form integration:
In this integration model, users interact solely with the business web application, which triggers the signing process at a specific point—such as after completing a form, application, or survey. The SmartForm document, along with control metadata, is sent to SigningHub. This metadata defines structured fields like checkboxes, dropdowns, text areas, and rating scales, which are embedded directly into the document.
To ensure a smooth user experience, no registration or login is required. The business application embeds the SigningHub signing interface directly into its web page using iframe technology. The required signing fields are clearly highlighted, allowing users to fill out the form and apply their digital signature in a guided and intuitive manner.
All web service interactions are handled behind the scenes, ensuring the experience remains fully integrated within the business application. Users never interact with SigningHub directly, and no emails are triggered by SigningHub. It is the sole responsibility of the business application to manage the workflow, notify users, and ensure completion of the signing process.
The process is:
- (Manual Step) Create an Enterprise Account
- (Manual Step) Generate Enterprise Client ID and Client Secret
- (Manual Step) - Obtain an access token using the enterprise API credentials
- (Manual Step) - Create a SmartForm
- (Coding) - Retrieve the SmartForm integration URL using the SmartForm ID
These steps are explained in more detail below:
- Step 1 – Create an Enterprise Account (Manual) - The business application must register for an Enterprise account. For testing purposes, you can use the SigningHub cloud service at www.signinghub.com and create a free account by clicking the FREE TRIAL button.
- Step 2 – Generate API Credentials (Manual) - Follow the steps here to generate the Client ID and Client Secret from the SigningHub Web interface.
- Step 3 – Obtain Access Token (Coding) - Use your enterprise credentials (Client ID and Secret) to request an access token from SigningHub’s authentication endpoint.
- Step 4 – Create a SmartForm (Manual) - Design and publish your SmartForm via the SigningHub Web interface, defining required fields and workflow routing.
- Step 5 – Retrieve SmartForm Integration URL (Coding) - Make an authenticated HTTP GET request to SigningHub using the SmartForm ID and access token. This returns the SmartForm integration URL, which the business application can embed via iframe. Example request/response:
Path Parameters
The ID of the smart form.
Header Parameters
application/json
application/json
Bearer {access_token}
Access token returned in Authenticate API call
Sample Response
10.0 | Following are the APIs that have been affected by the changes:
- New APIs
-
Updates in existing APIs
-
Document Package
- Upload Document
- Upload Document Base64
- Get Document Image
- Get Document Image (Base64)
- Upload Attachment
- Get Attachments
- Delete Attachment
- Download Attachment
- Download Attachment (base64)
- Close Document Package
- Download Package
- Download Package (Base64)
- Get Package Verification
- Open Document Package
- Download Document
- Download Document (Base64)
- Get Document Details
- Get Document Verification
- Get Packages
- Bulk Delete Document Package
- Bulk Move Packages to Custom/Shared Space folder
-
Document Workflow
- Update Electronic Seal to Workflow
- Update Workflow User Permissions
- Update Workflow User Authentication (Document Opening)
- Update Placeholder
- Update Workflow User
- Update Workflow Group
- Get Workflow History Details
- Get Certificate Saved In Workflow History
- Complete Workflow in the Middle (Terminate Workflow)
- Get Process Evidence Report
- Authenticate via OTP
- Document Preparation
-
Document Processing
- Approve Document
- Decline Document
- Finish Processing
- Bulk Sign Packages
- Bulk Signing Status
- Submit Document
- Sign Document
- Bulk Action Pre Validation
- Get Document Hash
- Embed Signature
- Sign Document via RSSP Directly
- Fill Form Fields
- Fill Initials
- Bulk OTP Signing Authentication
- Bulk Signing Pre Validation
- Enterprise Management
- Account Management
- General
-
Document Package
New APIs
| Document Package | |
|---|---|
| Document Workflow | |
| Enterprise Management |
Reset Enterprise User Two Factor Authentication Import Enterprise Users Template Import Enterprise Invitations Template |
| Account Management | |
| Document Preparation | |
| Document Processing | |
| Authentications | |
| Personal Settings | |
| Template |
Bulk Delete Document Field (Template) Update DropDown Field (Template) Replicate Initial Fields (Template) |
Updates in existing APIs
Document Package
Below are the APIs that are affected by the change.
Upload Document
| 8.6.8 (Upload Document) | 10.0 (Upload Document) |
|---|---|
 |
 |
| From 10.0, SigningHub has introduced the multiple response parameters to provide detailed information about the uploaded document. | |
Upload Document Base64
| 8.6.8 (Upload Document Base64) | 10.0 (Upload Document Base64) |
|---|---|
 |
 |
| From 10.0, SigningHub has introduced the multiple response parameters to provide detailed information about the uploaded document. | |
Get Document Image
| 8.6.8 (Get Document Image) | 10.0 (Get Document Image) |
|---|---|
| From 10.0, SigningHub has introduced the x-formatted and x-folder-id header parameters to support xml formatted view and shared space folder access. | |
|
New header parameters added
|
|
Get Document Image (Base64)
| 8.6.8 (Get Document Image (Base64)) | 10.0 (Get Document Image (Base64)) |
|---|---|
| From 10.0, SigningHub has introduced the x-formatted and x-folder-id header parameters to support xml formatted view and shared space folder access. | |
|
New header parameters added
|
|
Upload Attachment
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Get Attachments
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Delete Attachment
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Download Attachment
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Download Attachment (base64)
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Close Document Package
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Download Package
| From 10.0, SigningHub has introduced the x-folder-id header parameter to support shared space folder access as well as the document-ids query parameter for downloading the documents within the package. | |
|
New parameters added
|
|
Download Package (Base64)
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access well as the document-ids query parameter for downloading the documents within the package. | |
|
New parameter added
|
|
Get Package Verification
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Open Document Package
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Download Document
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Download Document (Base64)
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Get Document Details
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Get Document Verification
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Get Packages
| From 10.0, SigningHub has introduced the package-name, package-id, recipient-from, recipient-to , document-id, expiry, modified-from, modified-to, size-from, size-to , certified-documents, form-fields, attachments, document-type, document-statuses, and owned-by query parameters to support advanced search. | |
|
New parameter added
|
|
Bulk Delete Document Package
| From 10.0, SigningHub has introduced the document-status, package-name, recipient-from, recipient-to , document-id, expiry, modified-from, modified-to, size-from, size-to , certified-documents, form-fields, attachments, document-type, document-statuses, and owned-by request body parameters to support advanced search. | |
|
New parameters added
|
|
Bulk Move Packages to Custom/Shared Space folder
| From 10.0, SigningHub has introduced the document-status, package-name, recipient-from, recipient-to , document-id, expiry, modified-from, modified-to, size-from, size-to , certified-documents, form-fields, attachments, document-type, document-statuses, and owned-by request body parameters to support advanced search. | |
|
New parameters added
|
|
Document Workflow
Below are the APIs that are affected by the change.
Update Electronic Seal to Workflow
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Update Workflow User Permissions
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Update Workflow User Authentication (Document Opening)
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Update Placeholder
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Update Workflow User
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Update Workflow Group
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Get Workflow History Details
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Get Certificate Saved In Workflow History
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Complete Workflow in the Middle (Terminate Workflow)
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Get Process Evidence Report
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Authenticate via OTP
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Document Preparation
Below are the APIs that are affected by the change.
Update In-person Field
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Update Digital Signature Field
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Update CheckBox Field
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Get Document Fields
| From 10.0, SigningHub has introduced the tooltip, border_color, and field_rotation in the response body to provide the information for form fields. | |
|
New parameters added
|
|
Document Processing
Below are the APIs that are affected by the change.
Approve Document
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Decline Document
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Finish Processing
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Bulk Sign Packages
| From 10.0, SigningHub has introduced the x-folder-id, and x-mobile header parameters to support shared space folder access and originator(Web/Mobile) support. Additionally, a new URL parameter, bulk_action added to facilitate bulk sharing of packages, and the hand_signature_method request parameter to set the hand signature mode. | |
|
New parameter added
|
|
Bulk Signing Status
| From 10.0, SigningHub has introduced the URL parameter bulk_action is added to support share package feature in bulk. | |
|
New parameter added
|
|
Submit Document
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Sign Document
| From 10.0, SigningHub has introduced the x-folder-id, and x-mobile header parameters to support shared space folder access and originator(Web/Mobile). Along this new request parameter hand_signature_method is to set the hand signature mode. | |
|
New parameter added
|
|
Bulk Action Pre Validation
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. Along this new URL parameter bulk_action is added to support share package feature in bulk. | |
|
New parameter added
|
|
Get Document Hash
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access, as well as hand_signature_method request parameter to set the hand signature mode. | |
|
New parameter added
|
|
Embed Signature
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Sign Document via RSSP Directly
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access as well as the hand_signature_method request parameter to set the hand signature mode. | |
|
New parameter added
|
|
Fill Form Fields
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Fill Initials
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
Bulk OTP Signing Authentication
| 8.6.8 (Bulk OTP Signing Authentication) | 10.0 (Bulk OTP Signing Authentication) |
|---|---|
| From 10.0, SigningHub has introduced the x-folder-id header parameter and packageId request parameter to support document signing authentication and shared space folder access. | |
|
New parameters added
|
|
Bulk Signing Pre Validation
| 8.6.8 (Bulk Signing Pre Validation) | 10.0 (Bulk Signing Pre Validation) |
|---|---|
| From 10.0, SigningHub has introduced the x-otp and x-password header parameters to support document access authentication. Additionally, a new response parameter signing_authentication, indicates the type of one-time authentication enabled, such as OTP or TOTP. | |
|
New parameters added
|
|
Enterprise Management
Below are the APIs that are affected by the change.
Get Enterprise Users
| 8.6.8 (Get Enterprise Users) | 10.0 (Get Enterprise Users) |
|---|---|
 |
 |
| From 10.0, SigningHub has introduced the two_factor_authentication to provide two factor authentication is enabled or not, certificate_dn to provide certificate dn with signing certificate. | |
|
New parameter added
|
|
Register Enterprise User
| 8.6.8 (Register Enterprise User) | 10.0 (Register Enterprise User) |
|---|---|
 |
 |
| From 10.0, SigningHub has introduced the created_on in response body. | |
|
New parameter added
|
|
Get Role Users
| 8.6.8 (Get Role Users) | 10.0 (Get Role Users) |
|---|---|
 |
 |
| From 10.0, SigningHub has introduced the created_on and status in response body to provide more detail of user. | |
|
New parameter added
|
|
Get Enterprise Package Timeline
| 8.6.8 (Get Enterprise Package Timeline) | 10.0 (Get Enterprise Package Timeline) |
|---|---|
 |
 |
| From 10.0, SigningHub has update the timeline_details property of the response. | |
Get Enterprise Logs
| 8.6.8 (Get Enterprise Logs) | 10.0 (Get Enterprise Logs) |
|---|---|
| From 10.0, SigningHub has added the new QUERY PARAMETERS -> module option's ADVANCED_REPORTS to support search of Advanced Reports. | |
Get Enterprise Integrations
| 8.6.8 (Get Enterprise Integrations) | 10.0 (Get Enterprise Integrations) |
|---|---|
| From 10.0, SigningHub has added the new reponse parameter client_secret and external_users_count. | |
|
New parameter added
|
|
Get Enterprise Branding
| 8.6.8 (Get Enterprise Branding) | 10.0 (Get Enterprise Branding) |
|---|---|
| From 10.0, SigningHub has added the new reponse parameters level_14 and level_15 to provide information about sidebar menus and the color of error validation text. | |
|
New parameter added
|
|
Reset Enterprise Branding
| 8.6.8 (Reset Enterprise Branding) | 10.0 (Reset Enterprise Branding) |
|---|---|
| From 10.0, SigningHub has added the new reponse parameters level_14 and level_15 to provide information about sidebar menus and the color of error validation text. | |
|
New parameter added
|
|
Update Enterprise Branding
| 8.6.8 (Update Enterprise Branding) | 10.0 (Update Enterprise Branding) |
|---|---|
| From 10.0, SigningHub has added the new request parameters level_14 and level_15 to provide information about sidebar menus and the color of error validation text. | |
|
New parameter added
|
|
Get Enterprise Branding and Authentication Profile
| 8.6.8 (Get Enterprise Branding and Authentication Profile) | 10.0 (Get Enterprise Branding and Authentication Profile) |
|---|---|
| From 10.0, SigningHub has added the new reponse parameters level_14 and level_15 to provide information about sidebar menus and the color of error validation text. | |
|
New parameter added
|
|
Account Management
Below are the APIs that are affected by the change.
Get Notifications
| 8.6.8 (Get Notifications) | 10.0 (Get Notifications) |
|---|---|
| From 10.0, SigningHub has introduced the type query param to filter notifications. | |
|
New query parameters added
|
|
Register User Account
| 8.6.8 (Register User (Free Trial)) | 10.0 (Register User Account) |
|---|---|
| From version 10.0, SigningHub's process depends on the service plan. For online plans, a billing response is mandatory. | |
|
New parameters added
|
|
Documents Statistics
| From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. | |
|
New parameter added
|
|
General
Below are the APIs that are affected by the change.
Get System Branding
| 8.6.8 (Get System Branding) | 10.0 (Get System Branding) |
|---|---|
| From 10.0, SigningHub has added the new response parameters level_14 and level_15 to provide information about sidebar menus and the color of error validation text. | |
|
New parameter added
|
|
10.0.1 | Following are the APIs that have been affected by the changes:
New APIs
| Personal Settings |
|---|
Updates in existing APIs
Document Workflow
Below are the APIs that are affected by the change.
Generate Integration URL for Encrypted Data (Coding)
| 10.0 (Generate Integration URL for Encrypted Data (Coding)) | 10.0.1 (Generate Integration URL for Encrypted Data (Coding)) |
|---|---|
| From 10.0.1, SigningHub has introduced the section header parameters to support section wise access. | |
|
New parameter added
|
|
Personal Settings
Below are the APIs that are affected by the change.
Get Signature Settings
| 10.0 (Get Signature Settings) | 10.0.1 (Get Signature Settings) |
|---|---|
| From 10.0.1, SigningHub has introduced the environment in the response body to provide the environment of EID Easy signing server. | |
|
New parameter added
|
|
Get Templates
| 10.0 (Get Templates) | 10.0.1 (Get Templates) |
|---|---|
| From 10.0.1, SigningHub has introduced the smart_form in the response parameter to provide information about Smart forms | |
|
New parameter added
|
|
Account Management
Below are the APIs that are affected by the change.
Get Account
| From 10.0.1, SigningHub has introduced a new feature in the service_plan > features > SMART_FORM if allowed in the service plan | |
|
New data added
|
|
Get User Role
| From 10.0.1, SigningHub has introduced a new response parameter smart-form under user settings | |
|
New parameter added
|
|
Document Package
Below are the APIs that are affected by the change.
Get Packages
| From 10.0.1, SigningHub has introduced a new query parameter smart-form to search by name | |
|
New parameter added
|
|
Export Packages
| From 10.0.1, SigningHub has introduced a new query parameter smart-form to search by name | |
|
New parameter added
|
|
Enterprise Management
Below are the APIs that are affected by the change.
Get Role by ID
| From 10.0.1, SigningHub has introduced a new response parameter smart-form under user settings | |
|
New parameter added
|
|
Add Role
| From 10.0.1, SigningHub has introduced a new request parameter smart-form under user settings | |
|
New parameter added
|
|
Clone Role
| From 10.0.1, SigningHub has introduced a new response parameter smart-form under user settings | |
|
New parameter added
|
|
Update Role
| From 10.0.1, SigningHub has introduced a new request parameter smart-form under user settings | |
|
New parameter added
|
|
SigningHub Admin APIs
Below are the APIs that are affected by the change.
Add Service Plan
| From 10.0.1, SigningHub has introduced a new parameter to add ALLOW_SMART_FORM in the features | |
|
New parameter added
|
|
Update Service Plan
| From 10.0.1, SigningHub has introduced a new parameter to add ALLOW_SMART_FORM in the features | |
|
New parameter added
|
|
Get Service Plan by ID
| From 10.0.1, SigningHub has introduced a new response parameter to provide Smart form feature information | |
|
New parameter added
|
|
Authentication
Below are the APIs that are affected by the change.
Single Sign On Authentication
| 10.0 (Single Sign On Authentication) | 10.0.1 (Single Sign On Authentication) |
|---|---|
| From 10.0.1, SigningHub has changed error Status Code for guest user from 401 to 404. | |
|
Status Code
|
Status Code
|
10.0.2 | Following are the APIs that have been affected by the changes:
New APIs
| User Provisioning Via SCIM |
|---|
Updates in existing APIs
General
Below are the APIs that are affected by the change.
System Settings
| From 10.0.2, SigningHub returns trusted device authentication response data for configuration and display. | |
|
Response
|
|
General
Below are the APIs that are affected by the change.
Password Authentication
| From 10.0.2, SigningHub returns the "x-device"="required" if the administrator/enterprise setting are requiring to trust the device, and the user must have to provide the device information in the request header. | |
|
If the administrator/enterprise setting is requiring the device information then this header is returned. |
Response Header
|
|
If the administrator/enterprise setting are requiring the device information then use the below-format with your own device informations Example: JSON Serilize of { DeviceId = "DeviceId", Name = "Chrome", Version = "120.0.0.0", Type = "Browser", Vendor = "Google", Model = "Desktop", OS = "Windows", OSVersion = "10.0.19045", Cpu = "x64", UserAgent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36" } then Base64 |
Request Header
|
Single Sign On Authentication
| From 10.0.2, SigningHub returns the "x-device"="required" if the administrator/enterprise setting are requiring to trust the device, and the user must have to provide the device information in the request header. | |
|
If the administrator/enterprise setting is requiring the device information then this header is returned. |
Response Header
|
|
If the administrator/enterprise setting are requiring the device information then use the below-format with your own device informations Example: JSON Serilize of { DeviceId = "DeviceId", Name = "Chrome", Version = "120.0.0.0", Type = "Browser", Vendor = "Google", Model = "Desktop", OS = "Windows", OSVersion = "10.0.19045", Cpu = "x64", UserAgent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36" } then Base64 |
Request Header
|
Client Credentials Authentication
| From 10.0.2, SigningHub has introduced new request header x-scim to support SCIM protocol. | |
|
New Request Header Parameter
|
|
Account Management
Below are the APIs that are affected by the change.
Configure Two-Factor Authentication
| From 10.0.2, SigningHub returns two-factor authentication response data for configuration and display. | |
|
Response
|
|
Get Notifications
| 10.0.1 (Get Notifications) | 10.0.2 (Get Notifications) |
|---|---|
| From 10.0.2, SigningHub has introduced the new response parameter information_details which provide information details list. | |
|
New response parameter added
|
|
Get Account
| 10.0.1 (Get Account) | 10.0.2 (Get Account) |
|---|---|
| From 10.0.2, SigningHub has introduced the new response parameter service_plan > deprecated which provide the service plan deprecated information and display_plan_upgrade_banner to display banner in the application. | |
|
New response parameter added
|
|
Get User Role
| 10.0.1 (Get User Role) | 10.0.2 (Get User Role) |
|---|---|
| From 10.0.2, SigningHub has introduced the new response parameter user_setting > require_document_access_authentication_apply_to, require_document_sign_authentication_apply_to which provide service plan start and end date. SigningHub has also introduced the new response parameter user_setting.readonly_user_fields which provide information for restricted user fields. | |
|
New response parameter added
|
|
Enterprise Management
Below are the APIs that are affected by the change.
Get Role by ID
| 10-0-1 (Get Role by ID) | 10-0-2 (Get Role by ID) |
|---|---|
| From 10-0-2, SigningHub has introduced the new response parameter document_settings > owner_settings > access_authentication_all_recipient > apply_to, document_settings > owner_settings > signing_authentication_all_recipient > apply_to and post_processing_all_recipient to provide the recipient authentication information and the post_processing_all_recipient information at document_settings > owner_settings object which provide information for post processing. SigningHub has also introduced the new response parameter document_settings.miscellaneous_settings.readonly_user_fields which provide information for restricted user fields. | |
|
New response parameter added
|
|
Add Role
| 10-0-1 (Add Role) | 10-0-2 (Add Role) |
|---|---|
| From 10-0-2, SigningHub has introduced the new response parameter document_settings > owner_settings > access_authentication_all_recipient > apply_to, document_settings > owner_settings > signing_authentication_all_recipient > apply_to and post_processing_all_recipient to provide the recipient authentication information and the post_processing_all_recipient information at document_settings > owner_settings object which provide information for post processing. SigningHub has also introduced the new response parameter document_settings.miscellaneous_settings.readonly_user_fields which provide information for restricted user fields. | |
|
New response parameter added
|
|
Clone Role
| 10-0-1 (Clone Role) | 10-0-2 (Clone Role) |
|---|---|
| From 10-0-2, SigningHub has introduced the new response parameter document_settings > owner_settings > access_authentication_all_recipient > apply_to, document_settings > owner_settings > signing_authentication_all_recipient > apply_to and post_processing_all_recipient to provide the recipient authentication information and the post_processing_all_recipient information at document_settings > owner_settings object which provide information for post processing. SigningHub has also introduced the new response parameter document_settings.miscellaneous_settings.readonly_user_fields which provide information for restricted user fields. | |
|
New response parameter added
|
|
Update Role
| 10-0-1 (Update Role) | 10-0-2 (Update Role) |
|---|---|
| From 10-0-2, SigningHub has introduced the new request parameter document_settings > owner_settings > access_authentication_all_recipient > apply_to, document_settings > owner_settings > signing_authentication_all_recipient > apply_to and post_processing_all_recipient to provide the recipient authentication information and the post_processing_all_recipient information at document_settings > owner_settings object which provide information for post processing. SigningHub has also introduced the new request parameter document_settings.miscellaneous_settings.readonly_user_fields which set configurations for restricted user fields. | |
|
New request parameter added
|
|
Get Enterprise Default Settings
| 10-0-1 (Get Enterprise Default Settings) | 10-0-2 (Get Enterprise Default Settings) |
|---|---|
| From 10-0-2, SigningHub has introduced the new response parameter post_processing and login > "trusted_device_authentication": { "enabled" : true} object which provide information for post processing and the trusted device information. | |
|
New response parameter added
|
|
Update Enterprise Default Settings
| 10-0-1 (Update Enterprise Default Settings) | 10-0-2 (Update Enterprise Default Settings) |
|---|---|
| From 10-0-2, SigningHub has introduced the new request parameter post_processing and login > "trusted_device_authentication": { "enabled" : true} object which provide information for post processing and the trusted device information. | |
|
New request parameter added
|
|
Get Auto Provision Settings
| From 10.0.2, SigningHub added new response parameter scim to provide the SCIM configurations. | |
|
Response
|
|
Update Auto Provision Settings
| From 10.0.2, SigningHub added new request parameter scim to enable/disable the SCIM configurations. | |
|
Request
|
|
SigningHub Admin APIs
Below are the APIs that are affected by the change.
Get Service Plans
| From 10-0-2, SigningHub has introduced the new response parameter deprecated object which provide information for deprecation status to display. | |
|
Response
|
|
Get Service Plan by ID
| From 10-0-2, SigningHub has introduced the new response parameter deprecated object which provide information for deprecation status to display. | |
|
Response
|
|
Update Service Plan
| From 10-0-2, SigningHub has introduced the new request parameter deprecated object to update the deprecation status. | |
|
Request
|
|
Clone Service Plan
| From 10-0-2, SigningHub has introduced the new request parameter deprecated object to update the Deprecated status. | |
|
Request
|
|
10.0.3 | Following are the APIs that have been affected by the changes:
New APIs
| Account Management |
|---|
Updates in existing APIs
General
Below are the APIs that are affected by the change.
About SigningHub
| 10.0.2 (About SigningHub) | 10.0.3 (About SigningHub) |
|---|---|
| From 10.0.3, "About SigningHub" API will be accessible via Client Credentials token. | |
Enterprise Management
Below are the APIs that are affected by the change.
Get Enterprise Branding
| 10.0.2 (Get Enterprise Branding) | 10.0.3 (Get Enterprise Branding) |
|---|---|
| From 10.0.3, SigningHub has added the new reponse parameters background_image and slider_items to provide information about background image and slider items. | |
|
New parameter added
|
|
Update Enterprise Branding
| 10.0.2 (Update Enterprise Branding) | 10.0.3 (Update Enterprise Branding) |
|---|---|
| From 10.0.3, SigningHub has added the new request parameters background_image and slider_items to provide information about background image and slider items. | |
|
New parameter added
|
|
| From 10.0.3, SigningHub has added the new response parameters id, content, order and web to provide information about slider items. | |
|
New parameter added
|
|
Reset Enterprise Branding
| 10.0.2 (Reset Enterprise Branding) | 10.0.3 (Reset Enterprise Branding) |
|---|---|
| From 10.0.3, SigningHub has added the new response parameters background_image and slider_items to provide information about background image and slider items. | |
|
New parameter added
|
|
Document Preparation
Below are the APIs that are affected by the change.
Add Textbox Field
| 10.0.2 (Add Textbox Field) | 10.0.3 (Add Textbox Field) |
|---|---|
| From 10.0.3, SigningHub has added the new request parameter field_locale to support Arabic for Date field. | |
|
New parameter added
|
|
Update Textbox Field
| 10.0.2 (Update Textbox Field) | 10.0.3 (Update Textbox Field) |
|---|---|
| From 10.0.3, SigningHub has added the new request parameter field_locale to support Arabic for Date field. | |
|
New parameter added
|
|
Get Document Fields
| 10.0.2 (Get Document Fields) | 10.0.3 (Get Document Fields) |
|---|---|
| From 10.0.3, SigningHub has added the new response parameters field_locale to support Arabic for Date field. | |
|
New parameter added
|
|
10.0.4 | Following are the APIs that have been affected by the changes:
- New APIs
-
Updates in existing APIs
-
Enterprise Management
- Export Enterprise Users
- Export Enterprise Invitations
- Get Role by ID
- Add Role
- Clone Role
- Update Role
- Get Enterprise User Consumed Statistics
- Update Enterprise User Consumed Statistics
- Get Enterprise Notification Settings
- Update Enterprise Notifications Settings
- Get Enterprise Default Settings
- Update Enterprise Default Settings
- Get Workflow User Permissions of Enterprise Package
- Update Workflow User Permissions of Enterprise Package
- Get Enterprise Branding
- Update Enterprise Branding
- Reset Enterprise Branding
- Get Enterprise Branding and Authentication Profile
- Account Management
- Personal Settings
- Document Workflow
- Template
- General
-
Enterprise Management
New APIs
| Enterprise Management | |
|---|---|
| Artificial Intelligence | |
| Template | |
| Document Processing |
Updates in existing APIs
Authentication
Below are the APIs that are affected by the change.
Signle Sign On Authentication
| 10.0.3 (Single Sign On Authentication) | 10.0.4 (Single Sign On Authentication) |
|---|---|
| From 10.0.4, SigningHub has added a new authentication mechanism Pass Key to provide login option using pass key. | |
|
New mechanism added
|
|
Document Package
Below are the APIs that are affected by the change.
Sign Document Package
| 10.0.3 (Sign Document Package) | 10.0.4 (Sign Document Package) |
|---|---|
| From 10.0.4, SigningHub has added a new authentication mechanism Pass Key to provide signing option using pass key. | |
|
New mechanism added
|
|
Bulk Document Sign
| 10.0.3 (Bulk Document Sign) | 10.0.4 (Bulk Document Sign) |
|---|---|
| From 10.0.4, SigningHub has added a new authentication mechanism Pass Key to provide bulk signing option using pass key. | |
|
New mechanism added
|
|
Reports
Below are the APIs that are affected by the change.
Signature Statistics
| 10.0.3 (Signature Statistics) | 10.0.4 (Signature Statistics) |
|---|---|
| From 10.0.4, SigningHub has added a new option parameter in request signing-server to provide signing profile id against which data is required. | |
|
New parameter added
|
|
Export Signature Statistics
| 10.0.3 (Export Signature Statistics) | 10.0.4 (Export Signature Statistics) |
|---|---|
| From 10.0.4, SigningHub has added a new option parameter in request signing-server to provide signing profile id against which data is required. | |
|
New parameter added
|
|
Enterprise Management
Below are the APIs that are affected by the change.
Export Enterprise Users
| 10.0.3 (Export Enterprise Users) | 10.0.4 (Export Enterprise Users) |
|---|---|
| From 10.0.4, SigningHub has added the new request parameters ids as nullable to export registered users specific to the provided IDs. | |
|
New parameter added
|
|
Export Enterprise Invitations
| 10.0.3 (Export Enterprise Invitations) | 10.0.4 (Export Enterprise Invitations) |
|---|---|
| From 10.0.4, SigningHub has added the new request parameters ids as nullable to export invitation users specific to the provided IDs. | |
|
New parameter added
|
|
Get Role by ID
| From 10.0.4, SigningHub has introduced a new response parameter artificial_intelligence under document_settings | |
|
New parameter added
|
|
Add Role
| From 10.0.4, SigningHub has introduced a new response parameter artificial_intelligence under document_settings | |
|
New parameter added
|
|
Clone Role
| From 10.0.4, SigningHub has introduced a new response parameter artificial_intelligence under document_settings | |
|
New parameter added
|
|
Update Role
| From 10.0.4, SigningHub has introduced a new request parameter artificial_intelligence under document_settings | |
|
New parameter added
|
|
Get Enterprise User Consumed Statistics
| From 10.0.4, SigningHub has introduced a new request parameter artificial_intelligence | |
|
New parameter added
|
|
Update Enterprise User Consumed Statistics
| From 10.0.4, SigningHub has introduced a new request parameter artificial_intelligence | |
|
New parameter added
|
|
Get Enterprise Notification Settings
| From 10.0.4, SigningHub has introduced a new request parameter artificial_intelligence_tokens_limit_reached under notification_setting | |
|
New parameter added
|
|
Update Enterprise Notifications Settings
| From 10.0.4, SigningHub has introduced a new request parameter artificial_intelligence_tokens_limit_reached under notification_setting | |
|
New parameter added
|
|
Get Enterprise Default Settings
| From 10.0.4, SigningHub has introduced two new response parameters allow_artificial_intelligence and allow_attachment_preview under recipient_permissions | |
|
New parameter added
|
|
|
New parameter added
|
|
Update Enterprise Default Settings
| From 10.0.4, SigningHub has introduced two new request parameters allow_artificial_intelligence and allow_attachment_preview under recipient_permissions | |
|
New parameter added
|
|
|
New parameter added
|
|
Get Workflow User Permissions of Enterprise Package
| From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview | |
|
New parameter added
|
|
|
New parameter added
|
|
Update Workflow User Permissions of Enterprise Package
| From 10.0.4, SigningHub has introduced two new request parameters artificial_intelligence and attachment_preview under permissions | |
|
New parameter added
|
|
|
New parameter added
|
|
Get Enterprise Branding
| 10.0.3 (Get Enterprise Branding) | 10.0.4 (Get Enterprise Branding) |
|---|---|
| From 10.0.4, SigningHub has added the new response parameter status which indicates whether the slider is active or inactive. | |
|
New parameter added
|
|
Update Enterprise Branding
| 10.0.3 (Update Enterprise Branding) | 10.0.4 (Update Enterprise Branding) |
|---|---|
| From 10.0.4, SigningHub has added the new request and response parameter status which indicates whether the slider is active or inactive. | |
|
New parameter added
|
|
Reset Enterprise Branding
| 10.0.3 (Reset Enterprise Branding) | 10.0.4 (Reset Enterprise Branding) |
|---|---|
| From 10.0.4, SigningHub has added the new response parameter status which indicates whether the slider is active or inactive. | |
|
New parameter added
|
|
Get Enterprise Branding and Authentication Profile
| 10.0.3 (Get Enterprise Branding and Authentication Profile) | 10.0.4 (Get Enterprise Branding and Authentication Profile) |
|---|---|
| From 10.0.4, SigningHub has added the new response parameter status which indicates whether the slider is active or inactive. | |
|
New parameter added
|
|
Document Processing
Below are the APIs that are affected by the change.
Bulk Signing Pre Validation
| 10.0.3 (Bulk Signing Pre Validation) | 10.0.4 (Bulk Signing Pre Validation) |
|---|---|
| From 10.0.4, SigningHub has added the new request object search_criteria to provide the advanced search criteria for the API. | |
|
New object added
|
|
Account Management
Below are the APIs that are affected by the change.
Get Account
| From 10.0.4, SigningHub has introduced a new parameter in the service_plan > artificial_intelligence and service_plan > constraints > artificial_intelligence_tokens | |
|
New data added
|
|
Get User Role
| From 10.0.4, SigningHub has introduced a new response parameter allow_artificial_intelligence under user_setting | |
|
New parameter added
|
|
Account Usage Statistics
| From 10.0.4, SigningHub has introduced a new response parameter artificial_intelligence | |
|
New parameter added
|
|
Personal Settings
Below are the APIs that are affected by the change.
Get Notification Settings
| From 10.0.4, SigningHub has introduced a new response parameter in the artificial_intelligence_tokens_limit_reached | |
|
New data added
|
|
Update Notifications Settings
| From 10.0.4, SigningHub has introduced a new request parameter artificial_intelligence_tokens_limit_reached under notification_setting | |
|
New parameter added
|
|
Document Workflow
Below are the APIs that are affected by the change.
Get Workflow User Permissions
| From 10.0.4, SigningHub has introduced two new response parameters in the artificial_intelligence and attachment_preview | |
|
New data added
|
|
|
New data added
|
|
Update Workflow User Permissions
| From 10.0.4, SigningHub has introduced two new request parameters artificial_intelligence and attachment_preview under permissions | |
|
New parameter added
|
|
|
New parameter added
|
|
Get Workflow Details
| From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under users > permission | |
|
New parameter added
|
|
|
New parameter added
|
|
Add Users to Workflow
| From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under permission | |
|
New parameter added
|
|
|
New parameter added
|
|
Add Groups to Workflow
| From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under permission | |
|
New parameter added
|
|
|
New parameter added
|
|
Add Placeholder to Workflow
| From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under permission | |
|
New parameter added
|
|
|
New parameter added
|
|
Replicate Workflow
| From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under users > permission | |
|
New parameter added
|
|
|
New parameter added
|
|
Template
Below are the APIs that are affected by the change.
Get Workflow User Permission (Template)
| From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under permissions | |
|
New data added
|
|
|
New data added
|
|
Update Workflow User Permission (Template)
| From 10.0.4, SigningHub has introduced two new request parameters artificial_intelligence and attachment_preview under permissions | |
|
New parameter added
|
|
|
New data added
|
|
Get Workflow Details (Template)
| From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under users > permission | |
|
New parameter added
|
|
|
New parameter added
|
|
Add Users to Workflow (Template)
| From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under users > permission | |
|
New parameter added
|
|
|
New parameter added
|
|
Add Placeholder to Workflow (Template)
| From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under users > permission | |
|
New parameter added
|
|
|
New parameter added
|
|
Add Groups to Workflow (Template)
| From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under users > permission | |
|
New parameter added
|
|
|
New parameter added
|
|
Template
| From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under users > permission | |
|
New parameter added
|
|
|
New parameter added
|
|
Get System Branding
| From 10.0.4, SigningHub has introduced a new response parameter status which indicates whether the slider is active or inactive. | |
|
New parameter added
|
|
For such operations, for example in tight integration, the intended recipient credentials must be used as opposed to enterprise admin. The Authenticate API call returns an access token in the response which must be saved by the business client and must be provided with each subsequent API call as a bearer token for authorisation. Note this token is used in tight integration scenarios for both digital and electronic signatures.
When invoking the refresh token option this will generate both a new access token for use, and refresh token for a subsequent refresh operation. The refresh token operation means the correct grant type must be used, i.e. refresh_token, and the client_id and client_secret parameters are required. User name, password and scope are not required.
Second Factor Authentication as OTP
If a user has OTP configured as a second factor authentication, this API will throw an error 403 with a JSON response of error and error_description. It will also send two response headers.- x-otp
- x-mobile-number
If phone number is empty, application should ask for the phone number from the end user to send the OTP on the given number. For sending OTP, use OTP Login Authentication API call.
Once OTP is received, client application will again call the following authenticate API to authenticate the user with two factors, i.e., Password and OTP. To submit the OTP request in the authenticate API a new request header is expected.
- x-otp
This request header will contain the OTP that was received on the mobile. Server side will authenticate the user based on user email, password and also verify the OTP. Once everything is verified end user will receive the access token details.
Terms & Services
After implementation of GDPR, SigningHub will enforce the end users to agree with new terms and services, every time there is a change in it. Calling authentication API end point will check if the user has provided proper authentication information. Once validated, it will also check if the user has agreed to the latest terms and services or not. If user has already agreed to the terms everything will work in the previous fashion. If new terms and services are found that are not agreed by the user the API will send following response header as false, along with access token details.
- x-terms-agreed
Note: Agreement to terms of use is required if this feature is enabled in "system settings" to meet the GDPR requirements.
Enforce Password Reset
If enterprise has set the policy to reset password on first login for newly register users or on password expiration then in that cases this API call won't return the authentication token for users. Instead, 403 with a JSON response of error and error_description would be returned. It will also send a response header.- x-change-password
Client Credentials Authentication
Authenticate using client_id and client_secret with grant_type = client_credentials and retrieve access_token
header Parameters
| Content-Type required | string Default: application/x-www-form-urlencoded |
| Accept required | string Default: application/json |
| x-scim | string Default: false Set to True if the generated access token should be SCIM supported |
Request Body schema: application/x-www-form-urlencoded
| grant_type required | string Default: "client_credentials" Grant type client_credentials is used when operations are performed on behalf of the application. |
| client_id required | string Default: "ACMapAppId" Application Name that you have configured in your Enterprise Account when configuring the integration options. |
| client_secret required | string Default: "jr67gj0h76gr83nf8734nj59g4he895jh87nr" API Key that you generated in your Enterprise Account when configuring the integration options. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "access_token": "string",
- "token_type": "string",
- "expires_in": 0,
- "refresh_token": "string"
}Password Authentication
Authenticate using client_id and client_secret and retrieve an Jwt access_token
header Parameters
| Content-Type required | string Default: application/x-www-form-urlencoded |
| Accept required | string Default: application/json |
Request Body schema: application/x-www-form-urlencoded
| grant_type required | string Default: "password" Define the OAuth 2.0 grant type. It can be set to "password", "client_credentials", "refresh_token" or "active_directory". Note for most operations "password" is sufficient. Active Directory is used when the authentication required is the user's AD credentials. Client_credentials is reserved for internal use at this stage. |
| client_id required | string Default: "ACMEapp" Application Name that you have configured in your Enterprise Account when configuring the integration options. |
| client_secret required | string Default: "jr67gj0h76gr83nf8734nj59g4he895jh87nr" API Key that you generated in your Enterprise Account when configuring the integration options. |
| username | string Default: "admin@ascertia.com" SigningHub email address identifying the target user account - this can be an Enterprise Admin or an Enterprise User account. Note an enterprise user can use an API Key created for the enterprise by an enterprise administrator. |
| password | string Default: "Password@12" Password for the account defined in the 'username' parameter. |
| scope | string Default: "john@ascertia.com" Used when the Enterprise Admin user is identified in 'username' and you wish to identify an Enterprise User as the target. That is, set an enterprise user as the current user for operations. For example, to update the general profile settings of an enterprise user then the "scope" variable can be used. |
| refresh_token | string Default: "rtfgdsxtrgefds543wedsx" If access_token is expired, refresh token is used along with grant type refresh_token. If refresh token is provided, username, password and scope attributes can be treated as optional. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "access_token": "string",
- "token_type": "string",
- "expires_in": 0,
- "refresh_token": "string"
}Scope Authentication
Business applications can call this API to get the scope access token on behalf of an enterprise user and perform any action other than document signing.
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
Scope request model
| user_email required | string <email> non-empty Scope user email address |
Responses
Request samples
- Payload
{- "user_email": "user@example.com"
}Response samples
- 200
- 401
- 403
- 500
{- "access_token": "string",
- "token_type": "string",
- "expires_in": 0,
- "refresh_token": "string"
}Kerberos Authentication
SigningHub uses OAuth 2.0 to authorize client requests. This API endpoint will present a Kerberos authentication challenge if the API is called in a browser that supports Kerberos authentication.
To get the Windows Kerberos dialog for authentication, use "withCredentials" in jQuery AJAX calls.Or on server side language like c# HttpClient object you can use "UseDefaultCredentials" with HTTP(S) requests.
header Parameters
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
Kerbose request model
| profile_name | string or null SSL Authenticate Profile Name |
Responses
Request samples
- Payload
{- "profile_name": "string"
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "access_token": "string",
- "token_type": "string",
- "expires_in": 0,
- "refresh_token": "string"
}Single Sign On Authentication
SigningHub uses OAuth 2.0 to authorize client requests. Business application can call this API to get the access token of user by requesting third party, based on provided method and token. Currently supported third parties are Office 365, Azure Active Directory, OAuth2 and OIDC.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| token | string or null Token obtained from 3rd party e.g Office 365, Azure Active Directory, OAuth 2, OIDC |
| code | string or null Code obtained from OAuth2, OIDC (authorize response), Base64 encoded PassKey assertion response from authenticator |
| method required | string non-empty Supported method type Possible values are "OFFICE_365", "AZURE_ACTIVE_DIRECTORY", "OAUTH2", "OIDC", "PassKey" |
| profile_name | string or null Authentication profile name, required for "OAUTH2" and "OIDC". It's an alternative to profile_id, so this can be skipped if profile_id is provided. It's become mandatory for "OFFICE_365" and "AZURE_ACTIVE_DIRECTORY" too if code is provided and token is not provided in the request body. |
| profile_id | integer <int32> Authentication profile id, required for "OAUTH2", "OIDC", "PassKey". It's an alternative to profile_name, so this can be skipped if profile_name is provided. It's become mandatory for "OFFICE_365" and "AZURE_ACTIVE_DIRECTORY" too if code is provided and token is not provided in the request body. |
| redirect_uri | string or null Redirect URL |
| code_verifier | string or null Code Verifier if PKCE is enabled for the client. |
| nonce | string or null Nonce value if it is enabled for the client. |
Responses
Request samples
- Payload
{- "token": "string",
- "code": "string",
- "method": "string",
- "profile_name": "string",
- "profile_id": 0,
- "redirect_uri": "string",
- "code_verifier": "string",
- "nonce": "string"
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "access_token": "string",
- "token_type": "string",
- "expires_in": 0,
- "refresh_token": "string",
- "authentication_access_token": "string"
}OTP Login Authentication
SigningHub supports second factor authentication using One Time Password at login time via the web site GUI. Note this is different to OTP via SMS used in electronic signatures at the point of signing. This specifically refers to using the second factor authentication for SigningHub system access.
To enable One Time Password second factor authentication see here.It is an option in the Enterprise Role settings.
At least one SMS provider must be configured in SigningHub administration in order to use this functionality.
This API call is used to allow business applications to request an One Time Password to the user's mobile device for subsequent use in second factor authentication in the GUI.
Note the mobile number is an optional field.If not supplied, SigningHub will attempt to send the OTP to the mobile number stored in the user's Profile settings. If a mobile number is supplied in the call, then the OTP will be sent to this number, and any stored one under Profile settings will be ignored.
In the event that no mobile number is supplied, nor found under the user's Profile settings, an error will be returned.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| mobile_number | string or null Mobile number of the user in case user do not have a mobile number already in his profile. SigningHub application will update the new phone number in the profile automatically. |
| method | string or null Method Possible values are "EMAIL", "SMS" |
Responses
Request samples
- Payload
{- "mobile_number": "string",
- "method": "string"
}Response samples
- 200
- 400
- 401
- 500
{ }Pre Login Authentication
Business application can use this API to get the authentication method for the user, based on the configurations set in enterprise role
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| username required | string non-empty Email address of the user for which authentication method is te be retrieved. |
Responses
Request samples
- Payload
{- "username": "string"
}Response samples
- 200
- 403
- 500
{- "profile_id": 0,
- "profile_name": "string",
- "provider": "string",
- "method": "string",
- "app_id": "string",
- "tenant_id": "string",
- "private_profiles_count": 0,
- "logo_url": "string",
- "url": "string",
- "logout_url": "string",
- "scope": "string",
- "resource": "string",
- "oidc_advance_settings": {
- "pkce": true,
- "state": true,
- "nonce": true,
- "language": true,
- "display": true,
- "display_value": "string",
- "prompt": true,
- "prompt_value": "string",
- "max_age": true,
- "max_age_value": "string",
- "login_hint": true,
- "login_hint_value": "string",
- "acr": true,
- "acr_values": "string"
}, - "allow_public_profile": true
}Get Service Agreements
Business applications can use this service API to get terms of services and privacy policy that are configured in SigningHub Admin console.
For details how to configure this content in SigningHub follow this link.Note the content applies across the system.
A successful response is only possible if the content is set of course.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 400
- 500
{- "version_number": 0,
- "name": "string",
- "description": "string",
- "terms_of_service": "string",
- "terms_of_service_url": "string",
- "privacy_policy": "string",
- "privacy_policy_url": "string"
}Get Public Authentication Profiles
Business application can use this API to get all the public authentications configured in the SigningHub.
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 403
- 500
[- {
- "profile_id": 0,
- "profile_name": "string",
- "provider": "string",
- "method": "string",
- "app_id": "string",
- "tenant_id": "string",
- "private_profiles_count": 0,
- "logo_url": "string",
- "url": "string",
- "logout_url": "string",
- "scope": "string",
- "resource": "string",
- "oidc_advance_settings": {
- "pkce": true,
- "state": true,
- "nonce": true,
- "language": true,
- "display": true,
- "display_value": "string",
- "prompt": true,
- "prompt_value": "string",
- "max_age": true,
- "max_age_value": "string",
- "login_hint": true,
- "login_hint_value": "string",
- "acr": true,
- "acr_values": "string"
}, - "allow_public_profile": true
}
]Revoke Refresh Tokens
Business application can call this API to revoke the refresh tokens generated for a user. The refresh token is generated and sent when a successful authentication request is made.
header Parameters
| Authorization required | string Default: Bearer {access_token} Users access token |
| Content-Type required | string Default: application/x-www-form-urlencoded |
| Accept required | string Default: application/json |
Request Body schema: application/x-www-form-urlencoded
| refresh_token required | string Default: "45ghiukldjahdnhzdauz" OAuth refresh access token to revoke. |
| token_type_hint required | string Default: "refresh_token" Type of token. Currently only refresh_token is supported. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{ }Logout/Device De-Registration
Applications can call this API when a user logout from the application. This API call will update the user activity.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-expired | string Default: false The values must be "true" | "false" and when no header is provided default value will be false. |
Request Body schema:
| device_token | string or null Push notification token that needs to be removed from the server in case of logout. |
Responses
Request samples
- Payload
{- "device_token": "string"
}Response samples
- 200
- 401
- 404
- 500
{ }SSL Authentication
User can authenticate using his certificate. The browser will prompt to select the certificate.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
Ssl request model
| profile_name | string or null SSL Authenticate Profile Name |
Responses
Request samples
- Payload
{- "profile_name": "string"
}Response samples
- 200
- 400
- 401
- 403
{- "access_token": "string",
- "token_type": "string",
- "expires_in": 0,
- "refresh_token": "string"
}SAML Authentication
This API can be used to authenticate to SigningHub User using SAML supported IDP.
The profilename is mandatory parameter and required to be passed from caller application.
The callback URL is optional and can be set by the caller application if required.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| profile_name required | string non-empty SAML Profile Name |
| callback_url | string or null Callback URL to get the response |
Responses
Request samples
- Payload
{- "profile_name": "string",
- "callback_url": "string"
}Response samples
- 200
- 403
{- "url": "string",
- "request_body": "string",
- "type": "string"
}SAML Authentication Logout
This API can be used to logout SigningHub User using SAML supported IDP.
The profilename is mandatory parameter and required to be passed from caller application.
The callback URL is optional and can be set by the caller application if required.
query Parameters
| profile_name | string SAML Profile Name. |
| session_index | string Session Index created at the time of log-in. |
string Logged in user email address. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 403
{- "url": "string",
- "body": "string",
- "type": "string"
}Get OIDC Authentication URL
Business application can use this API to get oidc authentication url.
query Parameters
| profileId | string |
string |
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 403
- 500
"string"This section entails the web services for the Document Package related operations i.e. Add, Delete, Download, and Share.
Upload Attachment
Business applications can use this service API to upload a attachment in a document.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is added. |
| documentId required | integer <int64> ID of the document to which the attachment needs to be add. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/octet-stream |
| Accept required | string Default: application/json |
| x-field-name | string Example: U0hfQVRUQUNITUVOVF8xMjg5NDY= Field name if required. This is optional and with field name attachment field is processed. |
| x-file-name required | string Example: Test file.pdf It's the name of file with extension. |
| x-password | string Example: pincode123 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. |
| x-otp | string Example: 123456 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. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema: multipart/form-data
| file (binary Stream) required | string <binary> Default: "" This is the document in the raw binary format. |
Responses
Response samples
- 201
- 400
- 403
- 500
{- "attachment_id": 0
}Get Attachments
Business applications can use this service API to get the attachments of a document.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is added. |
| documentId required | integer <int64> ID of the document to which the attachment is added. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 400
- 403
- 500
[- {
- "attachment_id": 0,
- "attachment_name": "string"
}
]Delete Attachment
Business applications can use this service API to delete the attachment of a document.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is added. |
| documentId required | integer <int64> ID of the document to which the attachment is added. |
| attachment_id required | integer <int32> ID of the attachment. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 400
- 403
- 500
{ }Download Attachment
Business applications can use this service API to download the attachment of a document.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is added. |
| documentId required | integer <int64> ID of the document to which the attachment is added. |
| attachment_id required | integer <int32> ID of the attachment. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 400
- 403
- 500
"string"Download Attachment (base64)
Business applications can use this service API to download the attachment base64 of a document.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is added. |
| documentId required | integer <int64> ID of the document to which the attachment is added. |
| attachment_id required | integer <int32> ID of the attachment. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 400
- 403
- 500
{- "base64": "string"
}Update Document Properties
Business applications can use this service API to choose which properties (i.e., Signatures, Attachments, and PDF/A Compliance) they want to retain in a document.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is added |
| documentId required | integer <int64> ID of the document to be updated. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| signed_signature_fields | boolean or null Keep signed signatures. Default value for this parameter set to true. |
| attachments | boolean or null Keep attachments. Default value for this parameter set to true. |
| conformance_level | boolean or null Keep conformance level. Default value for this parameter set to true. |
Responses
Request samples
- Payload
{- "signed_signature_fields": true,
- "attachments": true,
- "conformance_level": true
}Response samples
- 200
- 400
- 403
- 404
- 500
{ }Delete Document
Business applications can use this service API to delete a document in a package.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is added. |
| documentId required | integer <int64> ID of the document to be deleted. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 403
- 500
{- "package_name": "string"
}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.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is added. |
| documentId required | integer <int64> The ID of the document to be downloaded. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
"string"Rename Document
Business applications can use this service API to rename a document in a package.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is added. |
| documentId required | integer <int64> The ID of the document to on which the action is to be performed. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| document_name required | string non-empty New name of the document. |
Responses
Request samples
- Payload
{- "document_name": "string"
}Response samples
- 200
- 403
- 500
{- "package_name": "string"
}Upload XML StyleSheet (.XSLT)
Business applications can use this service API to upload an XSLT StyleSheet to transform an XML document into HTML formatted PDF document on SigningHub viewer. This API is support client credential scope too to upload XSLT StyleSheet and it will restrict to upload XSLT StyleSheet if document is signed and target document is not XML
path Parameters
| packageId required | integer <int64> Package ID of the package to which the XML document is belonged. |
| documentId required | integer <int64> Document ID of the XML document that need to formatted. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/octet-stream |
| Accept required | string Default: application/json |
| x-file-name | string Default: Test file.pdf It's the name of file with extension. |
Request Body schema: multipart/form-data
| file (binary Stream) required | string <binary> Default: "" This is the document in the raw binary format. |
Responses
Response samples
- 201
- 400
- 401
- 403
- 500
{- "documentId": 0,
- "document_id": 0,
- "document_name": "string",
- "document_order": 0,
- "document_type": "string",
- "document_source": "string",
- "document_width": 0,
- "document_height": 0,
- "document_pages": 0,
- "uploaded_on": "2019-08-24T14:15:22Z",
- "modified_on": "2019-08-24T14:15:22Z",
- "lock_form_fields": true,
- "certify": {
- "enabled": true,
- "allowed_permissions": [
- "string"
], - "default_permission": "string"
}, - "document_size": 0,
- "metadata": {
- "attachments": true,
- "form_fields": true,
- "blank_signatures": true,
- "signed_signatures": true,
- "conformance": "string",
- "locked": true,
- "certify": "string",
- "qr_code": true
}, - "package_name": "string",
- "property1": null,
- "property2": null
}Download Document (Base64)
Business applications can use this service API to download the document in base64 string format. The package and document ID is provided in the resource URL.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is added. |
| documentId required | integer <int64> The ID of the document to be downloaded. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
"string"Upload XML StyleSheet (.XSLT) Base64
Business applications can use this service API to upload an XSLT StyleSheet (base64) to transform an XML document into HTML formatted PDF document on SigningHub viewer. This API is support client credential scope too to upload XSLT StyleSheet (base64) and it will restrict to upload XSLT StyleSheet if document is signed and target document is not XML
path Parameters
| packageId required | integer <int64> Package ID of the package to which the XML document is belonged. |
| documentId required | integer <int64> Document ID of the XML document that need to formatted. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-file-name | string Default: Test file.pdf It's the name of file with extension. |
| x-base64 required | string Default: true True mean uploaded document is in base64 format. |
Request Body schema:
| document required | string non-empty Base64 converted string of XML Beautifier file (.XSLT) need to upload |
Responses
Request samples
- Payload
{- "document": "string"
}Response samples
- 201
- 400
- 401
- 403
- 500
{- "documentId": 0,
- "document_id": 0,
- "document_name": "string",
- "document_order": 0,
- "document_type": "string",
- "document_source": "string",
- "document_width": 0,
- "document_height": 0,
- "document_pages": 0,
- "uploaded_on": "2019-08-24T14:15:22Z",
- "modified_on": "2019-08-24T14:15:22Z",
- "lock_form_fields": true,
- "certify": {
- "enabled": true,
- "allowed_permissions": [
- "string"
], - "default_permission": "string"
}, - "document_size": 0,
- "metadata": {
- "attachments": true,
- "form_fields": true,
- "blank_signatures": true,
- "signed_signatures": true,
- "conformance": "string",
- "locked": true,
- "certify": "string",
- "qr_code": true
}, - "package_name": "string",
- "property1": null,
- "property2": null
}Upload Document Base64
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is being added. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-file-name | string Default: Test file.pdf It's the name of file with extension. |
| x-convert-document | string Default: true 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. |
| x-source | string Default: API This is the identification of the source of the document from where the document is uploaded, e.g. "My App". |
| x-base64 required | string Default: true True mean uploaded document is in base64 format. |
Request Body schema:
| document required | string non-empty Base64 converted string of document need to upload |
Responses
Request samples
- Payload
{- "document": "string"
}Response samples
- 201
- 400
- 401
- 403
- 500
{- "documentId": 0,
- "document_id": 0,
- "document_name": "string",
- "document_order": 0,
- "document_type": "string",
- "document_source": "string",
- "document_width": 0,
- "document_height": 0,
- "document_pages": 0,
- "uploaded_on": "2019-08-24T14:15:22Z",
- "modified_on": "2019-08-24T14:15:22Z",
- "lock_form_fields": true,
- "certify": {
- "enabled": true,
- "allowed_permissions": [
- "string"
], - "default_permission": "string"
}, - "document_size": 0,
- "metadata": {
- "attachments": true,
- "form_fields": true,
- "blank_signatures": true,
- "signed_signatures": true,
- "conformance": "string",
- "locked": true,
- "certify": "string",
- "qr_code": true
}, - "package_name": "string",
- "property1": null,
- "property2": null
}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.
path Parameters
| packageId required | integer <int64> The Package ID of the package to which the document is being added. |
| documentId required | integer <int64> The library document ID that need to add/updated |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-document-id | string Default: 0 Id of the old document of current package that need to be updated |
Responses
Response samples
- 201
- 401
- 403
- 404
- 500
{- "document_id": 0,
- "document_name": "string",
- "document_size": 0,
- "document_order": 0,
- "document_type": "string",
- "document_source": "string",
- "document_width": 0,
- "document_height": 0,
- "document_pages": 0,
- "uploaded_on": "2019-08-24T14:15:22Z",
- "modified_on": "2019-08-24T14:15:22Z",
- "form_fields": true,
- "lock_form_fields": true,
- "certify": {
- "enabled": true,
- "allowed_permissions": [
- "string"
], - "default_permission": "string",
- "permission": "string"
}, - "template": {
- "template_name": "string",
- "read_only": true
}, - "package_name": "string",
- "metadata": {
- "attachments": true,
- "form_fields": true,
- "blank_signatures": true,
- "signed_signatures": true,
- "conformance": "string",
- "locked": true,
- "certify": "string",
- "qr_code": true
}
}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.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is being added. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/octet-stream |
| Accept required | string Default: application/json |
| x-file-name | string Default: Test file.pdf It's the name of file with extension. |
| x-convert-document | string Default: true 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. |
| x-source | string Default: API This is the identification of the source of the document from where the document is uploaded, e.g. "My App". |
Request Body schema: multipart/form-data
| file (binary Stream) required | string <binary> Default: "" This is the document in the raw binary format. |
Responses
Response samples
- 201
- 400
- 401
- 403
- 500
{- "documentId": 0,
- "document_id": 0,
- "document_name": "string",
- "document_order": 0,
- "document_type": "string",
- "document_source": "string",
- "document_width": 0,
- "document_height": 0,
- "document_pages": 0,
- "uploaded_on": "2019-08-24T14:15:22Z",
- "modified_on": "2019-08-24T14:15:22Z",
- "lock_form_fields": true,
- "certify": {
- "enabled": true,
- "allowed_permissions": [
- "string"
], - "default_permission": "string"
}, - "document_size": 0,
- "metadata": {
- "attachments": true,
- "form_fields": true,
- "blank_signatures": true,
- "signed_signatures": true,
- "conformance": "string",
- "locked": true,
- "certify": "string",
- "qr_code": true
}, - "package_name": "string",
- "property1": null,
- "property2": null
}Multipart Document Upload
Business applications can use this service API to upload a document in parts to a document package linked to an enterprise user’s account. Client application could divide document in any size. e.g. 1MB chunk.
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.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is being added. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/octet-stream |
| Accept required | string Default: application/json |
| x-file-name required | string Example: Test file.pdf It's the name of file with extension. |
| x-convert-document | string Default: true 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. |
| x-source required | string Example: FILE_SYSTEM | LIBRARY | SHAREPOINT | SALES_FORCE | DROPBOX | MS_OFFICE | GOOGLE_DRIVE | ONEDRIVE | API This is the identification of the source of the document from where the document is uploaded, e.g. "My App". |
| x-file-part-no required | string Example: 1 File part number being send to API in request. Started from 1 |
| x-total-parts required | string Example: 10 Total number of parts in which file is divided. Minimum value is 1 |
Request Body schema: application/json
This is the document in the raw binary format.
Responses
Request samples
- Payload
""Response samples
- 200
- 201
- 400
- 401
- 403
- 500
{ }Multipart Document Update
Business applications can use this service API to update a document in parts to a document package. Client application could divide document in any size. e.g. 1MB chunk.
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.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is being added. |
| documentId required | integer <int64> Id of the document that need to be updated. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-file-name required | string Example: Test file.pdf It's the name of file with extension. |
| x-convert-document | string Default: true 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. |
| x-source required | string Example: FILE_SYSTEM | LIBRARY | SHAREPOINT | SALES_FORCE | DROPBOX | MS_OFFICE | GOOGLE_DRIVE | ONEDRIVE | API This is the identification of the source of the document from where the document is uploaded, e.g. "My App". |
| x-file-part-no required | string Example: 1 File part number being send to API in request. Started from 1 |
| x-total-parts required | string Example: 10 Total number of parts in which file is divided. Minimum value is 1 |
Request Body schema: application/json
This is the document in the raw binary format.
Responses
Request samples
- Payload
""Response samples
- 200
- 400
- 401
- 403
- 500
{- "documentId": 0,
- "document_id": 0,
- "document_name": "string",
- "document_order": 0,
- "document_type": "string",
- "document_source": "string",
- "document_width": 0,
- "document_height": 0,
- "document_pages": 0,
- "uploaded_on": "2019-08-24T14:15:22Z",
- "modified_on": "2019-08-24T14:15:22Z",
- "lock_form_fields": true,
- "certify": {
- "enabled": true,
- "allowed_permissions": [
- "string"
], - "default_permission": "string"
}, - "document_size": 0,
- "metadata": {
- "attachments": true,
- "form_fields": true,
- "blank_signatures": true,
- "signed_signatures": true,
- "conformance": "string",
- "locked": true,
- "certify": "string",
- "qr_code": true
}, - "package_name": "string",
- "property1": null,
- "property2": null
}Update Document
Business applications can use this service API to update a document of a document package. The document information is sent in the HTTP request header and document bytes are sent in the HTTP request body.
SigningHub supports a wide variety of document formats, each of which can be converted to PDF format upon upload.
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.
Note this feature is supported only for PDF documents.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is belong. |
| documentId required | integer <int64> Id of the document that need to be updated. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/octet-stream |
| Accept required | string Default: application/json |
| x-file-name | string Default: Test file.pdf It's the name of file with extension. |
| x-source | string Default: API This is the identification of the source of the document from where the document is uploaded, e.g. "My App". |
Request Body schema: multipart/form-data
| file (binary Stream) required | string <binary> Default: "" This is the document in the raw binary format. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "documentId": 0,
- "document_id": 0,
- "document_name": "string",
- "document_order": 0,
- "document_type": "string",
- "document_source": "string",
- "document_width": 0,
- "document_height": 0,
- "document_pages": 0,
- "uploaded_on": "2019-08-24T14:15:22Z",
- "modified_on": "2019-08-24T14:15:22Z",
- "lock_form_fields": true,
- "certify": {
- "enabled": true,
- "allowed_permissions": [
- "string"
], - "default_permission": "string"
}, - "document_size": 0,
- "metadata": {
- "attachments": true,
- "form_fields": true,
- "blank_signatures": true,
- "signed_signatures": true,
- "conformance": "string",
- "locked": true,
- "certify": "string",
- "qr_code": true
}, - "package_name": "string",
- "property1": null,
- "property2": null
}Get Certify Policy for a Document
Business applications can use this service API to get certify signature settings of a document in a package.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is added. |
| documentId required | integer <int64> The ID of the document to be downloaded. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 403
- 500
{- "certify": {
- "enabled": true,
- "allowed_permissions": [
- "string"
], - "default_permission": "string"
}, - "lock_form_fields": true
}Update Certify Policy for a document
Business applications can use this service API to update certify signature settings for a document in a package.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is added. |
| documentId required | integer <int64> The ID of the document on which the action is to be performed. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
object (SigningHub.Web.API.Models.CertifyPolicyRequest) CertifyPolicyRequest | |
| lock_form_fields | boolean True if form fields are to be locked after the last signature on the current document. |
Responses
Request samples
- Payload
{- "certify": {
- "enabled": true,
- "permission": "NO_CHANGES_ALLOWED"
}, - "lock_form_fields": true
}Response samples
- 200
- 400
- 403
- 500
{ }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}”.
path Parameters
| packageId required | integer <int64> The Package ID of the package to which the document is added. |
| documentId required | integer <int64> The document ID for which the document details are requested. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "document_id": 0,
- "document_name": "string",
- "document_order": 0,
- "document_type": "string",
- "document_width": 0,
- "document_height": 0,
- "document_source": "string",
- "document_pages": 0,
- "form_fields": true,
- "lock_form_fields": true,
- "uploaded_on": "string",
- "modified_on": "string",
- "certify": {
- "enabled": true,
- "permission": "string"
}, - "template": {
- "template_name": "string",
- "read_only": true
}
}Get Document Image
Business applications can use this service API to get an image of a particular page as identified by the pageNo. 800x600 can be replaced by any given resolution to match the device displaying resolution.
path Parameters
| packageId required | integer <int64> Package ID of the package of which the document is part of. |
| documentId required | integer <int64> The ID of the document for which the image is to be requested. |
| pageNo required | integer <int32> Page number in the document for which the image is requested. |
| widthHeight required | string Dimensions are provided in the URL in the form of width x height. This width height can be any value desired by the client application. Width and height are calculated in pixels. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-page-width | string Default: 600 Width of the image returned in response. |
| x-page-height | string Default: 800 Height of the image returned in response. |
| x-formatted | string Default: TRUE XML document viewer indication.Possible values are TRUE | FALSE |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
"string"Get Document Image (Base64)
Business applications can use this service API to get an image of a particular page as identified by the pageNo. 800x600 can be replaced by any given resolution to match the device displaying resolution.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document belongs. |
| documentId required | integer <int64> The ID of the document for which the image is to be requested. |
| pageNo required | integer <int32> Page number in the document for which the image is requested. |
| widthHeight required | string Dimensions are provided in the URL in the form of width x height. This width height can be any value desired by the client application. Width and height are calculated in pixels. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-page-width | string Default: 600 Width of the image returned in response. |
| x-page-height | string Default: 800 Height of the image returned in response. |
| x-formatted | string Default: TRUE XML document viewer indication.Possible values are TRUE | FALSE |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
"string"Get Document Thumbnail
Business applications can use this service API to get a thumbnail of a particular page as identified by the pageNo.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document belongs. |
| documentId required | integer <int64> The ID of the document for which the thumbnails is to be requested. |
| pageNo required | integer <int32> Default: 1 Page number in the document for which the thumbnails is requested.Its optional, default value is 1 |
| pageWidth required | integer <int32> Default: 133 Width of the viewing area of the page. Maximum with can be passed as 512, recommended is 133 |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-page-width | string Default: 600 Width of the image returned in response. |
| x-page-height | string Default: 800 Height of the image returned in response. |
| x-formatted | string Default: TRUE XML document viewer indication.Possible values are TRUE | FALSE |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
"string"Get Document Thumbnails (Base64)
Business applications can use this service API to get list of thumbnails of a particular pages as identified by the fromPage and toPage.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document belongs. |
| documentId required | integer <int64> The ID of the document for which the thumbnails is to be requested. |
| fromPage required | integer <int32> Start page number in the document for which the thumbnails is requested. It must be smaller than toPage value |
| toPage required | integer <int32> End page number in the document for which the thumbnails is requested. |
| pageWidth required | integer <int32> Width of the viewing area of the page. Maximum with can be passed as 512, recommended is 133 |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-formatted | string Default: TRUE XML document viewer indication.Possible values are TRUE | FALSE |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
[- {
- "page_no": 0,
- "image_base64": "string"
}
]Get Document Verification
Business applications can use this service API to get verification results for all the digital signature fields of a document in a package.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is added. |
| documentId required | integer <int64> The ID of the document to be downloaded. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-base64 required | string Default: true True if response should have images in base64 format. False will only return the resource URLs in response. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 403
- 500
[- {
- "field_name": "string",
- "signer_name": "string",
- "signer_photo": "string",
- "signer_photo_url": "string",
- "signature_status": "string",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "signing_time": "string",
- "ltv": true,
- "qualified": true,
- "certified": true,
- "certify_permission": "string",
- "timestamp_at": "string",
- "timestamp_authority": "string",
- "subject_dn": "string",
- "issuer_dn": "string",
- "cert_valid_from": "string",
- "cert_valid_to": "string",
- "signature_type": "string",
- "signature_application": "string",
- "signature_policy_id": 0,
- "signature_policy_uri": "string",
- "signature_algorithm": "string",
- "signed_hash": "string",
- "display": "string",
- "page_number": 0,
- "lei_number": "string",
- "lei_role": "string",
- "error_message": "string"
}
]Change Document Order
Business applications can use this service API to change the order of a document in a package.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is added. |
| documentId required | integer <int64> The ID of the document to on which the action is to be performed. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| order | integer <int32> New order of the document in the package. |
Responses
Request samples
- Payload
{- "order": 0
}Response samples
- 200
- 403
- 500
{- "package_name": "string"
}Merge All Documents
Business applications can use this service API to merge all documents in a package document.
path Parameters
| packageId required | integer <int64> Package ID of the target document to which the document belongs. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "size": 0
}Merge Document
Business applications can use this service API to merge document at any location (TOP | BOTTOM) of the target document in a package.
path Parameters
| packageId required | integer <int64> Package ID of the target document to which the document belongs. |
| documentId required | integer <int64> The ID of the target document which need to be merged with source document. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/octet-stream |
| Accept required | string Default: application/json |
| x-file-name required | string Example: Test file.pdf It's the name of file with extension. |
| x-password | string Example: 123 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. |
| x-otp | string Example: 123 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. |
| x-location | string Default: BOTTOM Source document location. Possible values are TOP | BOTTOM |
| x-remove-signatures | string Default: false Specify to retain signatures in source document.Possible values are TRUE | FALSE |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema: application/json
This is the document in the raw binary format.
Responses
Request samples
- Payload
""Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }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.
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| package_name | string or null The name of the package. Default package name is always "Untitled" if the package_name is not provided. |
| workflow_mode | string (SigningHub.Infrastructure.Core.Enumerations.WorkflowMode) Enum: "ME_AND_OTHERS" "ONLY_OTHERS" "ONLY_ME" |
| folder_name | string or null 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. |
Responses
Request samples
- Payload
{- "package_name": "string",
- "workflow_mode": "ME_AND_OTHERS",
- "folder_name": "string"
}Response samples
- 200
- 400
- 403
- 404
- 500
{- "package_id": 0,
- "workflow_mode": "string",
- "workflow_type": "string"
}Change Document Package Owner
Business applications can use this service API to change the owner of a document package. The new owner must be part of the same Enterprise as the current owner, and must be in an active state.
The document package must be in either In-Progress or Completed state.
The document package ID is supplied in the URL.
Only the current document owner or an Enterprise Admin can use this method.If an Enterprise Admin is using this call then the access token must be obtained using the scope parameter of the current document owner.
path Parameters
| packageId required | integer <int64> The ID of the document package to change. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| owner required | string non-empty Email address of the new owner. |
Responses
Request samples
- Payload
{- "owner": "string"
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }Close Document Package
Applications can call this API when a document package is closed by a recipient in the application. This API call will update the document reading status as well as create necessary logs.
path Parameters
| packageId required | integer <int64> Package ID of the package which contains the document. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{ }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.
path Parameters
| packageId required | integer <int64> Package ID of the package which contains the document. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{ }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.
path Parameters
| packageId required | integer <int64> The package ID to be downloaded. |
query Parameters
| document-ids | Array of integers <int64> [ items <int64 > ] 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. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-combine-files | string Default: false The default value is false, Set to "true" to combine the entire document package into a single PDF file. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
"string"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.
path Parameters
| packageId required | integer <int64> Package ID to change the name of. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| package_name required | string non-empty New name of the document package. |
Responses
Request samples
- Payload
{- "package_name": "string"
}Response samples
- 200
- 403
- 500
{ }Bulk Delete Document Package
Business applications can use this service API to delete a documents from the user inbox. 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.
The folder ID is provided in the header as x-folder-id for retrieving folder items.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
| x-source | string Example: Library This is the identification of the source of the document from where the document is uploaded, e.g. "My App". |
| x-search-text | string Example: c2FsZXMgY29udHJhY3QgMTA1 Search text sent in headers for further filtration of the documents. Package id, name and document owner can be searched. |
| x-folder | string Example: SU5CT1g= Folder name from where the documents are to be fetched. Possible values are INBOX and ARCHIVE. |
Request Body schema:
| package_ids | Array of integers or null <int64> Ids of the document package. |
| document_status | string (SigningHub.Infrastructure.Core.Enumerations.DocumentPackageStatus) Enum: "ALL" "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" |
| package_name | string or null The name of the package. |
| recipient_from | string or null The sender who shared the document package. |
| recipient_to | string or null The recipient to whom the document package is sent. |
| document_id | integer or null <int64> Ids of the document. |
| expiry | integer or null <int32> Expiry (Days). |
| modified_from | string or null <date-time> From Modified Date. |
| modified_to | string or null <date-time> To Modified Date |
| size_from | integer or null <int32> From Size (KB) |
| size_to | integer or null <int32> To Size (KB) |
| certified_documents | boolean or null Certified signed documents |
| form_fields | boolean or null Documents that have form fields |
| attachments | boolean or null Documents that have attachments |
| document_type | string (SigningHub.Web.API.Helper.DocumentType) Enum: "ALL" "PDF" "DOCX" "XML" |
| document_statuses | Array of strings or null (SigningHub.Web.API.Helper.AllowedDocumentPackageStatus) Enum: "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" Document statuses possible values are mentioned above |
| owned_by | string (SigningHub.Infrastructure.Core.Enumerations.DocumentOwnedBy) Enum: "ME_OTHERS" "ME" "OTHERS" |
Responses
Request samples
- Payload
{- "package_ids": [
- 0
], - "document_status": "ALL",
- "package_name": "string",
- "recipient_from": "string",
- "recipient_to": "string",
- "document_id": 0,
- "expiry": 0,
- "modified_from": "2019-08-24T14:15:22Z",
- "modified_to": "2019-08-24T14:15:22Z",
- "size_from": 0,
- "size_to": 0,
- "certified_documents": true,
- "form_fields": true,
- "attachments": true,
- "document_type": "ALL",
- "document_statuses": [
- "DRAFT"
], - "owned_by": "ME_OTHERS"
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }Bulk Download Packages
Business applications can use this service API to download the bulk document packages 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.
In the response headers, you'll find the x-file-name header, which provides the name of the file. You can determine the file type by inspecting its extension.
query Parameters
| ids | Array of integers <int64> [ items <int64 > ] List of package ids |
| document-status | string (SigningHub.Infrastructure.Core.Enumerations.DocumentPackageStatus) Enum: "ALL" "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" Filter by document status possible values are mentioned above. |
| package-name | string Package Name |
| recipient-from | string From |
| recipient-to | string To |
| document-id | integer <int64> Document Id |
| expiry | integer <int32> Expiry (Days) |
| modified-from | string <date-time> From Modified Date |
| modified-to | string <date-time> To Modified Date |
| size-from | integer <int32> From Size (KB) |
| size-to | integer <int32> To Size (KB) |
| certified-documents | boolean Only certified signed documents |
| form-fields | boolean Only documents that have form fields |
| attachments | boolean Only documents that have attachments |
| document-type | string (SigningHub.Web.API.Helper.DocumentType) Enum: "ALL" "PDF" "DOCX" "XML" Filter by document type possible values are mentioned above |
| document-statuses | Array of strings (SigningHub.Web.API.Helper.AllowedDocumentPackageStatus) Items Enum: "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" Filter by document statuses possible values are mentioned above |
| owned-by | string (SigningHub.Infrastructure.Core.Enumerations.DocumentOwnedBy) Enum: "ME_OTHERS" "ME" "OTHERS" |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
| x-file-name | string Default: Test file.pdf It's the name of file with extension. It will be return in response header |
| x-source | string Example: Library This is the identification of the source of the document from where the document is uploaded, e.g. "My App". |
| x-search-text | string Example: c2FsZXMgY29udHJhY3QgMTA1 Search text sent in headers for further filtration of the documents. Package id, name and document owner can be searched. |
| x-folder | string Example: SU5CT1g= Folder name from where the documents are to be fetched. Possible values are INBOX and ARCHIVE. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
"string"Download Package (Base64)
Business applications can use this service API to download the document in Base64 encoded byte format.
The package ID is provided in the resource URL.
If the package contains only one document, the download is the Base64 encoded PDF document.
Alternatively, if the package has more than one document, the download is the Base64 encoded 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.
path Parameters
| packageId required | integer <int64> The package ID to be downloaded. |
query Parameters
| document-ids | Array of integers <int64> [ items <int64 > ] 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. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-combine-files | string Default: false The default value is false, Set to "true" to combine the entire document package into a single PDF file. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
"string"Get Package Verification
Business applications can use this service API to get verification results for all the digital signature fields of all documents in a single package.
path Parameters
| packageId required | integer <int64> Package ID of the package to which the document is added. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-base64 required | string Default: false True if response should have images in base64 format. False will only return the resource URLs in response. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 403
- 500
[- {
- "document_id": 0,
- "fields": [
- {
- "field_name": "string",
- "signer_name": "string",
- "signer_photo": "string",
- "signer_photo_url": "string",
- "signature_status": "string",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "signing_time": "string",
- "ltv": true,
- "qualified": true,
- "certified": true,
- "certify_permission": "string",
- "timestamp_at": "string",
- "timestamp_authority": "string",
- "subject_dn": "string",
- "issuer_dn": "string",
- "cert_valid_from": "string",
- "cert_valid_to": "string",
- "signature_type": "string",
- "signature_application": "string",
- "signature_policy_id": 0,
- "signature_policy_uri": "string",
- "signature_algorithm": "string",
- "signed_hash": "string",
- "display": "string",
- "page_number": 0,
- "lei_number": "string",
- "lei_role": "string",
- "error_message": "string"
}
]
}
]Open Document Package
Applications can call this API when a document package is opened by a recipient in the application. This API call will update the document reading status as well as create necessary logs.
path Parameters
| packageId required | integer <int64> Package ID of the package which contains the document. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
"string"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.
path Parameters
| document_status required | string (SigningHub.Infrastructure.Core.Enumerations.DocumentPackageStatus) Enum: "ALL" "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" Filter by document status possible values are ALL, DRAFT, PENDING, SIGNED, DECLINED, INPROGRESS, EDITED, REVIEWED, COMPLETED, EXPIRING_IN_SEVEN_DAYS. |
| pageNo required | integer <int32> Page number, according the division of records per page. |
| recordPerPage required | integer <int32> Number of records that are needed to be fetched in one request. |
query Parameters
| package-name | string Package Name |
| package-id | integer <int64> Package Id |
| recipient-from | string From |
| recipient-to | string To |
| document-id | integer <int64> Document Id |
| expiry | integer <int32> Expiry (Days) |
| modified-from | string <date-time> From Modified Date |
| modified-to | string <date-time> To Modified Date |
| size-from | integer <int32> From Size (KB) |
| size-to | integer <int32> To Size (KB) |
| certified-documents | boolean Only certified signed documents |
| form-fields | boolean Only documents that have form fields |
| attachments | boolean Only documents that have attachments |
| document-type | string (SigningHub.Web.API.Helper.DocumentType) Enum: "ALL" "PDF" "DOCX" "XML" Document Type like XML, PDF, DOCX etc |
| sort-by | string (SigningHub.Infrastructure.Core.Enumerations.FolderItemSortBy) Enum: "TITLE" "WORKFLOW_TYPE" "DATE_CREATED" "LAST_MODIFIED" "OWNER" "LOCATION" "STATUS" Sort the resultant records as per your choice |
| asc | boolean Default: false Sorted the resultant records by ascending or descending order |
| document-statuses | Array of strings (SigningHub.Web.API.Helper.AllowedDocumentPackageStatus) Items Enum: "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" Document Type |
| owned-by | string (SigningHub.Infrastructure.Core.Enumerations.DocumentOwnedBy) Enum: "ME_OTHERS" "ME" "OTHERS" |
| smart-form | string Smart form name |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder | string Example: SU5CT1g= Folder name from where the documents are to be fetched. Possible values are INBOX and ARCHIVE. |
| x-search-text | string Example: c2FsZXMgY29udHJhY3QgMTA1 Search text sent in headers for further filtration of the documents. Package id, name and document owner can be searched. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
| x-source | string Example: Library This is the identification of the source of the document from where the document is uploaded, e.g. "My App". |
| x-recipient-details | string Example: true If "true" is passed recipient details regarding Document Access Duration will be provided along decline information |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
[- {
- "package_id": 0,
- "package_name": "string",
- "package_owner": "string",
- "owner_name": "string",
- "shared_package": true,
- "gatekeeper_package": true,
- "package_status": "string",
- "extension": "string",
- "workflow_mode": "string",
- "folder": "string",
- "folder_id": 0,
- "unread": true,
- "next_signer": "string",
- "next_signer_email": [
- {
- "user_email": "string",
- "user_name": "string"
}
], - "uploaded_on": "string",
- "modified_on": "string",
- "access_duration": {
- "date_from": "string",
- "date_to": "string"
}, - "decline": {
- "reason": "string",
- "auto_decline": true,
- "declined_by": {
- "user_name": "string",
- "user_email": "string"
}
}, - "size": 0
}
]Export Packages
Business applications can use this service API to export list of documents filtered by different statuses. Users can divide the records into pages by providing a number of records per page.
path Parameters
| document_status required | string (SigningHub.Infrastructure.Core.Enumerations.DocumentPackageStatus) Enum: "ALL" "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" Filter by document status possible values are ALL, DRAFT, PENDING, SIGNED, DECLINED, INPROGRESS, EDITED, REVIEWED, COMPLETED, EXPIRING_IN_SEVEN_DAYS. |
| pageNo required | integer <int32> Page number, according the division of records per page. |
| recordPerPage required | integer <int32> Number of records that are needed to be fetched in one request. |
query Parameters
| package-name | string Package Name |
| package-id | integer <int64> Package Id |
| recipient-from | string From |
| recipient-to | string To |
| document-id | integer <int64> Document Id |
| expiry | integer <int32> Expiry (Days) |
| modified-from | string <date-time> From Modified Date |
| modified-to | string <date-time> To Modified Date |
| size-from | integer <int32> From Size (KB) |
| size-to | integer <int32> To Size (KB) |
| certified-documents | boolean Only certified signed documents |
| form-fields | boolean Only documents that have form fields |
| attachments | boolean Only documents that have attachments |
| document-type | string (SigningHub.Web.API.Helper.DocumentType) Enum: "ALL" "PDF" "DOCX" "XML" Document Type like XML, PDF, DOCX etc |
| sort-by | string (SigningHub.Infrastructure.Core.Enumerations.FolderItemSortBy) Enum: "TITLE" "WORKFLOW_TYPE" "DATE_CREATED" "LAST_MODIFIED" "OWNER" "LOCATION" "STATUS" Sort the resultant records as per your choice |
| asc | boolean Default: false Sorted the resultant records by ascending or descending order |
| document-statuses | Array of strings (SigningHub.Web.API.Helper.AllowedDocumentPackageStatus) Items Enum: "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" Document Type |
| owned-by | string (SigningHub.Infrastructure.Core.Enumerations.DocumentOwnedBy) Enum: "ME_OTHERS" "ME" "OTHERS" |
| ids | Array of integers <int64> [ items <int64 > ] Selected package Ids |
| smart-form | string Smart form name |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder | string Example: SU5CT1g= Folder name from where the documents are to be fetched. Possible values are INBOX and ARCHIVE. |
| x-search-text | string Example: c2FsZXMgY29udHJhY3QgMTA1 Search text sent in headers for further filtration of the documents. Package id, name and document owner can be searched. |
| x-source | string Example: Library This is the identification of the source of the document from where the document is uploaded, e.g. "My App". |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
"string"Get Package Timeline
Business applications can use this service API to get an package timeline details. However, in the following cases, the API will not return document timeline in response:
If the document is in "Draft" mode.
If the workflow type was set to "Only Me".
If in the workflow the recipient's role is configured as "Send a Copy".
path Parameters
| packageId required | integer <int64> Package ID of the document package. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "package_name": "string",
- "process_status": "string",
- "shared_on": "string",
- "processed_on": "string",
- "time_taken": {
- "years": 0,
- "months": 0,
- "days": 0,
- "hours": 0,
- "minutes": 0,
- "seconds": 0,
- "milliseconds": 0
}, - "timeline_details": [
- {
- "user_name": "string",
- "user_email": "string",
- "recipient_id": 0,
- "recipient_type": "string",
- "recipient_signing_order": 0,
- "recipient_picture_url": "string",
- "recipient_process_status": "string",
- "group_recipient": true,
- "delegator": {
- "user_name": "string",
- "user_email": "string"
}, - "gatekeepers": [
- {
- "user_name": "string",
- "user_email": "string",
- "picture_url": "string",
- "process_status": "string",
- "shared_on": "string",
- "processed_on": "string",
- "processed_by_email": "string",
- "processed_by_name": "string",
- "time_taken": {
- "years": 0,
- "months": 0,
- "days": 0,
- "hours": 0,
- "minutes": 0,
- "seconds": 0,
- "milliseconds": 0
}
}
], - "shared_on": "string",
- "processed_on": "string",
- "processed_by_email": "string",
- "processed_by_name": "string",
- "recalled": true,
- "time_taken": {
- "years": 0,
- "months": 0,
- "days": 0,
- "hours": 0,
- "minutes": 0,
- "seconds": 0,
- "milliseconds": 0
}
}
]
}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".
path Parameters
| packageId required | integer <int64> Package ID of the document package. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "name": "string",
- "owner": {
- "name": "string",
- "email": "string"
}, - "read_only": true,
- "document_status": "string",
- "documents": [
- {
- "id": 0,
- "name": "string",
- "uploaded_on": "string",
- "modified_on": "string",
- "size": 0,
- "type": "string",
- "source": "string"
}
]
}Export Package Timeline
Business applications can use this service API to export a package timeline details.
path Parameters
| packageId required | integer <int64> Package ID of the document package. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
"string"On Page Comments
Business applications can use this service API for adding comments onto a documents within workflows
path Parameters
| packageId required | integer <int64> The package ID of the document package. |
| documentId required | integer <int64> The ID of the document to get the document. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
object (SigningHub.Web.API.Models.Dimensions) Dimensions | |
| font_size required | number <float> The default font Size is 9.55010395010395 |
| page_no required | integer <int32> The page Number |
| image required | string non-empty The Base64 string image |
Responses
Request samples
- Payload
{- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "font_size": 0,
- "page_no": 0,
- "image": "string"
}Response samples
- 401
- 403
- 404
- 500
{- "Message": "string"
}Print Document
Business application can use this service API to print a document package using the package ID.
path Parameters
| package_id required | integer <int64> The package ID of the document package. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
[- {
- "document_id": 0,
- "document_name": "string",
- "pages": 0
}
]Start New Workflow From Existing Document Package
path Parameters
| packageId required | integer <int64> Package id of the existing document package. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 201
- 401
- 403
- 404
- 500
{- "package_id": 0,
- "package_name": "string",
- "shared_package": true,
- "package_owner": "string",
- "owner_name": "string",
- "package_status": "string",
- "folder": "string",
- "folder_id": 0,
- "gatekeeper": true,
- "next_signer": "string",
- "next_signer_email": [
- {
- "user_email": "string",
- "user_name": "string"
}
], - "uploaded_on": "string",
- "modified_on": "string",
- "workflow": {
- "workflow_type": "string",
- "continue_on_decline": true,
- "workflow_status": "string",
- "workflow_mode": "string",
- "message": "string",
- "read_only": true,
- "post_process": {
- "enabled": true,
- "contacts": [
- "string"
], - "recipients": [
- {
- "name": "string",
- "email": "string"
}
], - "message": "string",
- "google_drive": true,
- "one_drive": true,
- "dropbox": true,
- "workflow_recipients": true,
- "document_processing_report": true
}, - "comments": true
}, - "documents": [
- {
- "document_id": 0,
- "document_name": "string",
- "document_type": "string",
- "document_order": 0,
- "document_source": "string",
- "update_required": true,
- "document_height": 0,
- "document_width": 0,
- "document_pages": 0,
- "created_on": "string",
- "modified_on": "string",
- "form_fields": true,
- "template": {
- "template_id": 0,
- "template_name": "string",
- "read_only": true
}, - "certify": {
- "enabled": true,
- "allowed_permissions": [
- "string"
], - "default_permission": "string"
}, - "lock_form_fields": true,
- "locked": true,
- "has_signed_signature_fields": true,
- "attachments": true,
- "conformance_level": "string",
- "document_size": 0,
- "formatted": true
}
], - "users": [
- {
- "order": 0,
- "user_name": "string",
- "user_email": "string",
- "mobile_number": "string",
- "delivery_method": "string",
- "user_photo_url": "string",
- "group_name": "string",
- "group_members": [
- "string"
], - "delegator": "string",
- "gatekeeper": "string",
- "gatekeepers": {
- "emails": [
- {
- "user_email": "string"
}
]
}, - "role": "string",
- "process_status": "string",
- "processed_on": "string",
- "processed_as": "string",
- "processed_by": "string",
- "reason": "string",
- "placeholder": "string",
- "permission": {
- "print": true,
- "download": true,
- "add_text": true,
- "change_recipients": true,
- "add_attachment": true,
- "legal_notice": {
- "enabled": true,
- "allowed_notices": [
- {
- "legal_notice_id": 0,
- "legal_notice_name": "string",
- "legal_notice_html": "string"
}
], - "default_notice": {
- "legal_notice_id": 0,
- "legal_notice_name": "string",
- "legal_notice_html": "string"
}
}, - "attachment": {
- "enabled": true
}, - "artificial_intelligence": {
- "enabled": true
}, - "attachment_preview": {
- "enabled": true
}
}, - "authentications": {
- "authentication": {
- "enabled": true,
- "password": {
- "enabled": true,
- "user_password": "string"
}, - "sms_otp": {
- "enabled": true,
- "otp_length": 0,
- "retry_duration": 0,
- "mobile_number": "string",
- "methods": [
- "string"
]
}, - "totp": {
- "enabled": true
}
}, - "authentication_signing": {
- "enabled": true,
- "sms_otp": {
- "otp_length": 0,
- "retry_duration": 0,
- "mobile_number": "string",
- "methods": [
- "string"
]
}, - "totp": {
- "enabled": true
}
}, - "access_duration": {
- "enabled": true,
- "duration_by_date": {
- "enabled": true,
- "accessible": true,
- "duration": {
- "start_date_time": "string",
- "end_date_time": "string"
}
}, - "duration_by_days": {
- "enabled": true,
- "accessible": true,
- "duration": {
- "total_days": 0
}
}
}
}, - "reminder": {
- "enabled": true,
- "frequency": "string",
- "remind_after": 0,
- "repeat": {
- "enabled": true,
- "frequency": "string",
- "keep_reminding_after": 0,
- "total_reminders": 0
}
}, - "signing_order": 0,
- "user_national_id": "string",
- "guest_user": true,
- "email_language_code": "string",
- "electronic_seal": {
- "name": "string",
- "level_of_assurance": "string"
}
}
]
}Unlock Documents
Business applications can use this service API to unlock document which is locked while signing.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
The IDs of the package for which the password is submitted.
Responses
Request samples
- Payload
[- 0
]Response samples
- 201
- 401
- 403
- 404
- 500
{ }Send Email on Finish Document
Business applications can use this service API to send email on finish document
path Parameters
| packageId required | integer <int64> Package ID of the document package. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
required | Array of objects (SigningHub.Web.API.Models.SendEmailOnFinishDocumentRecipient) The recipients to whom the email has to be sent. |
| message | string or null <= 255 characters Email message |
Responses
Request samples
- Payload
{- "recipients": [
- {
- "name": "string",
- "email": "string"
}
], - "message": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }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.
path Parameters
| packageId required | integer <int64> The document package to be shared. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
[- {
- "package_id": 0,
- "documents": [
- 0
]
}
]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.
path Parameters
| packageId required | integer <int64> The Package ID of the package to which the template needs to be applied. |
| documentId required | integer <int64> 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. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| template_name required | string non-empty Name of template to be applied on the document. |
| apply_to_all required | boolean True, if template is to be applied on all the documents in the package. |
Responses
Request samples
- Payload
{- "template_name": "string",
- "apply_to_all": true
}Response samples
- 200
- 401
- 403
- 404
- 500
{- "document_id": 0,
- "document_name": "string",
- "document_order": 0,
- "document_type": "string",
- "document_width": 0,
- "document_height": 0,
- "document_source": "string",
- "document_pages": 0,
- "form_fields": true,
- "lock_form_fields": true,
- "uploaded_on": "string",
- "modified_on": "string",
- "certify": {
- "enabled": true,
- "permission": "string"
}, - "template": {
- "template_name": "string",
- "read_only": true
}
}This section entails the web services for the Document Workflow related operations i.e. Get Details, Add/Update Users, and Permissions.
Open Document via Password
Business applications can use this service API to submit a password from a particular recipient, specified by the order.
path Parameters
| packageId required | integer <int64> The ID of the package for which the password is submitted. |
| order required | integer <int32> The order of the user for which the password is to be submitted. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| password required | string non-empty String password for the document package for verification and opening the package. |
Responses
Request samples
- Payload
{- "password": "string"
}Response samples
- 200
- 401
- 403
- 404
- 500
{- "Message": "string"
}Unlock Document
Business applications can use this service API to unlock document which is locked while signing.
path Parameters
| packageId required | integer <int64> The ID of the package for which the password is submitted. |
| documentId required | integer <int64> The document ID for which workflow user needs to be updated. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{ }Pre EID Easy Signing
Business applications can use this API to get all the configured signing methods from EID Easy Server for preparing document for signing.
path Parameters
| packageId required | integer <int64> The identifier of the package that contains the document for signature. |
| documentId required | integer <int64> Identifier of the document to be signed. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
| field_name required | string non-empty Unique identifier of the signature field in the document. |
| hand_signature_image | string or null Base64 encoded string image of the visible signature appearance |
| hand_signature_method | string (SigningHub.Infrastructure.Core.Enumerations.HandSignature) Enum: "DRAW" "TEXT" "UPLOAD" "SIGNATURE_PAD" "NONE" |
| signing_reason | string or null Reason of signing provided by the recipient. |
| signing_location | string or null Locale of the signer provided by the recipient. |
| contact_information | string or null Contact information of the signer provided by the recipient. |
| appearance_design | string or null 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 required | string non-empty Name of signing server using which the document is to be signed |
Responses
Request samples
- Payload
{- "field_name": "string",
- "hand_signature_image": "string",
- "hand_signature_method": "DRAW",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "appearance_design": "string",
- "signing_server": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "doc_id": "string",
- "status": "string",
- "available_methods": [
- "string"
]
}EID Easy Webhook
This endpoint will be consumed by EID Easy server when configured in Custom CAdES digest webhook.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| signer_name | string or null |
| signer_idcode | string or null |
| signing_method | string or null |
| host | string or null |
| signing_time | integer <int64> |
| doc_id | string or null |
| notification_state | string or null |
Responses
Request samples
- Payload
{- "signer_name": "string",
- "signer_idcode": "string",
- "signing_method": "string",
- "host": "string",
- "signing_time": 0,
- "doc_id": "string",
- "notification_state": "string"
}Response samples
- 200
"string"Post EID Easy Signing
Business applications can use this service API to perform signature assembly and signature embedding process.
path Parameters
| packageId required | integer <int64> The identifier of the package that contains the document for signature. |
| documentId required | integer <int64> Identifier of the document to be signed. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| doc_id required | string non-empty The unique identification of document from eid easy server |
| skip_verification | boolean or null No signature verification returns in response body when it is set as true. Default value for this parameter set to false. |
Responses
Request samples
- Payload
{- "doc_id": "string",
- "skip_verification": true
}Response samples
- 200
- 400
- 401
- 404
- 500
{- "field_name": "string",
- "status": "string",
- "transaction_id": "string",
- "verification": {
- "field_name": "string",
- "signer_name": "string",
- "signature_status": "string",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "signing_time": "string",
- "ltv": true,
- "qualified": true,
- "certified": true,
- "certify_permission": "string",
- "timestamp_at": "string",
- "timestamp_authority": "string",
- "subject_dn": "string",
- "issuer_dn": "string",
- "cert_valid_from": "string",
- "cert_valid_to": "string",
- "signature_type": "string",
- "signature_algorithm": "string",
- "signature_application": "string",
- "signature_policy_id": 0,
- "signature_policy_uri": "string",
- "signer_photo": "string",
- "signer_photo_url": "string",
- "signed_hash": "string",
- "display": "string",
- "page_number": 0,
- "lei_number": "string",
- "lei_role": "string",
- "error_message": "string"
}
}Add Electronic Seal to Workflow
Business applications can use this service API to add an Electronic Seal recipient 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 Electronic Seal recipient(s), nor will this create any new fields. Note the Electronic Seal recipient(s) will be added as the last person in the workflow. Hence further work may be required to remove a current Electronic Seal recipient(s) already present in the workflow. At least one recipient must exist in a workflow before fields can be added to the document. Note: the input accepts one or more Electronic Seal recipient(s) in a single call. Note: only PDF type document is supported.
path Parameters
| packageId required | integer <int64> SigningHub package ID, which the eseal recipients are to be added to. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| name required | string [ 1 .. 255 ] characters The name of the new user to be added/updated in workflow. If no value is provided, old value will be retained. |
| signing_order | integer or null <int32> Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM". |
Responses
Request samples
- Payload
[- {
- "name": "string",
- "signing_order": 0
}
]Response samples
- 200
- 400
- 401
- 403
- 404
- 500
[- {
- "name": "string",
- "signing_order": 0,
- "level_of_assurance": "string"
}
]Update Electronic Seal to Workflow
Business applications can use this service API to update the details of an Electronic Seal recipient 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 Electronic Seal recipient 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: only PDF type document is supported
path Parameters
| packageId required | integer <int64> The package ID for which workflow eSeal recipient needs to be updated. |
| order required | integer <int32> The order of the eseal recipient in workflow. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
| name required | string [ 1 .. 255 ] characters The name of the new user to be added/updated in workflow. If no value is provided, old value will be retained. |
| signing_order | integer or null <int32> Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM". |
Responses
Request samples
- Payload
{- "name": "string",
- "signing_order": 0
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "name": "string",
- "signing_order": 0,
- "level_of_assurance": "string"
}Bulk Move Packages to Custom/Shared Space folder
Business applications can use this service API to move the document packages to a shared space or user's custom folder.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-source | string Example: Library This is the identification of the source of the document from where the document is uploaded, e.g. "My App". |
| x-search-text | string Example: c2FsZXMgY29udHJhY3QgMTA1 Search text sent in headers for further filtration of the documents. Package id, name and document owner can be searched. |
| x-folder | string Example: SU5CT1g= Folder name from where the documents are to be fetched. Possible values are INBOX and ARCHIVE. |
Request Body schema:
| package_ids | Array of integers or null <int64> Packages ids |
| folder_name required | string [ 1 .. 255 ] characters Target folder name in which packages need to move |
| document_status | string (SigningHub.Infrastructure.Core.Enumerations.DocumentPackageStatus) Enum: "ALL" "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" |
| package_name | string or null The name of the package. |
| recipient_from | string or null The sender who shared the document package. |
| recipient_to | string or null The recipient to whom the document package is sent. |
| document_id | integer or null <int64> Ids of the document. |
| expiry | integer or null <int32> Expiry (Days). |
| modified_from | string or null <date-time> From Modified Date. |
| modified_to | string or null <date-time> To Modified Date |
| size_from | integer or null <int32> From Size (KB) |
| size_to | integer or null <int32> To Size (KB) |
| certified_documents | boolean or null Certified signed documents |
| form_fields | boolean or null Documents that have form fields |
| attachments | boolean or null Documents that have attachments |
| document_type | string (SigningHub.Web.API.Helper.DocumentType) Enum: "ALL" "PDF" "DOCX" "XML" |
| document_statuses | Array of strings or null (SigningHub.Web.API.Helper.AllowedDocumentPackageStatus) Enum: "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" Document statuses possible values are mentioned above |
| owned_by | string (SigningHub.Infrastructure.Core.Enumerations.DocumentOwnedBy) Enum: "ME_OTHERS" "ME" "OTHERS" |
Responses
Request samples
- Payload
{- "package_ids": [
- 0
], - "folder_name": "string",
- "document_status": "ALL",
- "package_name": "string",
- "recipient_from": "string",
- "recipient_to": "string",
- "document_id": 0,
- "expiry": 0,
- "modified_from": "2019-08-24T14:15:22Z",
- "modified_to": "2019-08-24T14:15:22Z",
- "size_from": 0,
- "size_to": 0,
- "certified_documents": true,
- "form_fields": true,
- "attachments": true,
- "document_type": "ALL",
- "document_statuses": [
- "DRAFT"
], - "owned_by": "ME_OTHERS"
}Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Move Package to Custom/Shared Space folder
Business applications can use this service API to move the document package to a shared space or user's custom folder.
path Parameters
| packageId required | integer <int64> Package id that need to move to folder |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
Target folder name
| folder_name required | string [ 1 .. 255 ] characters Target folder name in which package need to move |
Responses
Request samples
- Payload
{- "folder_name": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Load Applet
Business applications can use this service API to get go-sign applet and embed into HTML element.
query Parameters
| signing-server | string |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
"string"Get Jwt Token
Business applications can use this service API to get jwt token from T1C server for authorization.
query Parameters
| signing-server | string |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 400
- 401
- 500
"string"Pre Local Signing
Business applications can use this service API to get D2S (data to be signed) and transaction id.
path Parameters
| packageId required | integer <int64> The identifier of the package that contains the document for signature. |
| documentId required | integer <int64> Identifier of the document to be signed. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
| field_name required | string non-empty Unique identifier of the signature field in the document. |
| hand_signature_image | string or null Base64 encoded string image of the visible signature appearance. |
| hand_signature_method | string (SigningHub.Infrastructure.Core.Enumerations.HandSignature) Enum: "DRAW" "TEXT" "UPLOAD" "SIGNATURE_PAD" "NONE" |
| signing_reason | string or null Reason of signing provided by the recipient. |
| signing_location | string or null Locale of the signer provided by the recipient. |
| contact_information | string or null Contact information of the signer provided by the recipient. |
| appearance_design | string or null 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" |
required | object (SigningHub.Web.API.Models.SignerCertificateRequestModel) SignerCertificateRequestModel |
| signing_server required | string non-empty Name of signing server using which the document is to be signed |
| transaction_id | string or null The identification number of the signing transaction |
Responses
Request samples
- Payload
{- "field_name": "string",
- "hand_signature_image": "string",
- "hand_signature_method": "DRAW",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "appearance_design": "string",
- "signer_certificate": {
- "signer": "string",
- "intermediate": "string"
}, - "signing_server": "string",
- "transaction_id": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "transaction_id": "string",
- "d2s": "string"
}Post Local Signing
Business applications can use this service API to perform signature assembly and signature embedding process.
path Parameters
| packageId required | integer <int64> The identifier of the package that contains the document for signature. |
| documentId required | integer <int64> Identifier of the document to be signed. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
| raw_signature | string or null Provide only in case of T1C not Go-Sign |
| transaction_id required | string non-empty The identification number of the signing transaction |
| skip_verification | boolean or null No signature verification returns in response body when it is set as true. Default value for this parameter set to false. |
Responses
Request samples
- Payload
{- "raw_signature": "string",
- "transaction_id": "string",
- "skip_verification": true
}Response samples
- 200
- 400
- 401
- 404
- 500
{- "field_name": "string",
- "status": "string",
- "transaction_id": "string",
- "verification": {
- "field_name": "string",
- "signer_name": "string",
- "signature_status": "string",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "signing_time": "string",
- "ltv": true,
- "qualified": true,
- "certified": true,
- "certify_permission": "string",
- "timestamp_at": "string",
- "timestamp_authority": "string",
- "subject_dn": "string",
- "issuer_dn": "string",
- "cert_valid_from": "string",
- "cert_valid_to": "string",
- "signature_type": "string",
- "signature_algorithm": "string",
- "signature_application": "string",
- "signature_policy_id": 0,
- "signature_policy_uri": "string",
- "signer_photo": "string",
- "signer_photo_url": "string",
- "signed_hash": "string",
- "display": "string",
- "page_number": 0,
- "lei_number": "string",
- "lei_role": "string",
- "error_message": "string"
}
}Get Certificates Detail
Business applications can use this service API to fetch common names from the provided base64 encoded certificates.
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| base64 required | string non-empty Base64 of certificate |
Responses
Request samples
- Payload
[- {
- "base64": "string"
}
]Response samples
- 200
- 401
- 500
[- {
- "base64": "string",
- "CN": "string"
}
]Send Reminder
Business applications can use this service API to send reminder to workflow user. The recipient is identified by the order in the workflow. The ID of the package is provided in the resource URL.
path Parameters
| packageId required | integer <int64> The package ID for which the reminder needs to be sent. |
| order required | integer <int32> The order of the user in workflow. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Bulk Send Reminder
Business applications can use this service API to bulk send reminder to workflow user.
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
| x-source | string Default: Library This is the identification of the source of the document from where the document is uploaded, e.g. "My App". |
| x-search-text | string Example: c2FsZXMgY29udHJhY3QgMTA1 Search text sent in headers for further filtration of the documents. Package id, name and document owner can be searched. |
| x-folder | string Example: SU5CT1g= Folder name from where the documents are to be fetched. Possible values are INBOX and ARCHIVE. |
Request Body schema:
| package_ids | Array of integers or null <int64> Ids of the document package. |
| document_status | string (SigningHub.Infrastructure.Core.Enumerations.DocumentPackageStatus) Enum: "ALL" "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" |
| package_name | string or null The name of the package. |
| recipient_from | string or null The sender who shared the document package. |
| recipient_to | string or null The recipient to whom the document package is sent. |
| document_id | integer or null <int64> Ids of the document. |
| expiry | integer or null <int32> Expiry (Days). |
| modified_from | string or null <date-time> From Modified Date. |
| modified_to | string or null <date-time> To Modified Date |
| size_from | integer or null <int32> From Size (KB) |
| size_to | integer or null <int32> To Size (KB) |
| certified_documents | boolean or null Certified signed documents |
| form_fields | boolean or null Documents that have form fields |
| attachments | boolean or null Documents that have attachments |
| document_type | string (SigningHub.Web.API.Helper.DocumentType) Enum: "ALL" "PDF" "DOCX" "XML" |
| document_statuses | Array of strings or null (SigningHub.Web.API.Helper.AllowedDocumentPackageStatus) Enum: "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" Document statuses possible values are mentioned above |
| owned_by | string (SigningHub.Infrastructure.Core.Enumerations.DocumentOwnedBy) Enum: "ME_OTHERS" "ME" "OTHERS" |
Responses
Request samples
- Payload
{- "package_ids": [
- 0
], - "document_status": "ALL",
- "package_name": "string",
- "recipient_from": "string",
- "recipient_to": "string",
- "document_id": 0,
- "expiry": 0,
- "modified_from": "2019-08-24T14:15:22Z",
- "modified_to": "2019-08-24T14:15:22Z",
- "size_from": 0,
- "size_to": 0,
- "certified_documents": true,
- "form_fields": true,
- "attachments": true,
- "document_type": "ALL",
- "document_statuses": [
- "DRAFT"
], - "owned_by": "ME_OTHERS"
}Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Open Document via OTP (Generate)
Business applications can use this service API to generate an OTP for a particular recipient, specified by the order.
path Parameters
| packageId required | integer <int64> The ID of the package for which the OTP is to be generated. |
| order required | integer <int32> The order of the recipient for whom the OTP is to be generated. If the order is passed as 0, the system will select the current collaborator by packageId. This is useful when signing a single package during bulk signing. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
The OTP method.
| method | string or null Method Possible values are "EMAIL", "SMS" |
Responses
Request samples
- Payload
{- "method": "string"
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }Generate Integration URL for Encrypted Data (Coding)
Business applications can use this service API to generate an encrypted URL to access a document and to perform signing operation on that document. The returned URL in response will be an encrypted URL which contains all the information which was provided in request body.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| document_id | integer or null <int64> The ID of the Document that has been shared. |
| package_id | integer or null <int64> The ID of the package that has been shared. |
| language required | string non-empty Language code in which application is required be shown to end user. if no value is provided then system defined language will be used. |
| response_type | string or null Indicating response should be encoded or plan.Possible values are ENCODED, PLAIN |
| callback_url | string or null URL, where user will be redirected after completing the required actions. if no value is provided then system will follow what's been configured in Enterprise Settings > Integration. |
| user_email | string or null It is required when a Guest user has to process the document. |
| collapse_panels | string or null True, will hide the panels in the IFrame mode. if no value is provided then it will follow what's been set in Integration options. |
| redirect_callback_url | string or null False, if you do not want to have a user automatically redirected to the call-back URL. After the user has performed their task, they will stay on the document viewer screen and will not be redirected unless they press the "Close" button. |
| usercertificate_id | integer or null <int64> The user custom certificate Id. |
| section | string (SigningHub.Web.API.Helper.IntegrationSection) Enum: "VIEWER" "DASHBOARD" "WORKFLOW" "DOCUMENTS" "ACTIVITY" "NOTIFICATIONS" "PERSONAL_INFORMATION" "AUTHORISED_DEVICES" "TWO_FACTOR_AUTHENTICATION" "SECURITY" "PERSONAL_CONTACTS" "PERSONAL_GROUPS" "PERSONAL_LIBRARY" "PERSONAL_TEMPLATES" "PERSONAL_LEGAL_NOTICES" "SIGNATURES_SETTINGS" "CLOUD_DRIVE_SETTINGS" "DELEGATION_SETTINGS" "PERSONAL_NOTIFICATION_SETTINGS" "ENTERPRISE_INFORMATION" "ENTERPRISE_LOGS" "ENTERPRISE_CONTACTS" "ENTERPRISE_GROUPS" "ENTERPRISE_USERS" "ENTERPRISE_ROLES" "ENTERPRISE_DOCUMENTS" "ENTERPRISE_LIBRARY" "ENTERPRISE_TEMPLATES" "ENTERPRISE_LEGAL_NOTICES" "ENTERPRISE_ELECTRONIC_SEALS" "ENTERPRISE_DOCUMENTS_REPORTS" "ENTERPRISE_SIGNATURES_REPORTS" "ENTERPRISE_ELECTRONIC_SEALS_REPORTS" "ENTERPRISE_ADVANCED_REPORTS" "ENTERPRISE_BRANDING" "ENTERPRISE_INTEGRATIONS" "ENTERPRISE_CERTIFICATE_FILTERS" "ENTERPRISE_NOTIFICATIONS" "ENTERPRISE_ADVNACED_SETTINGS" "SMART_FORM" "PASSWORDLESS_LOGIN" Integration sections |
Responses
Request samples
- Payload
{- "document_id": 0,
- "package_id": 0,
- "language": "string",
- "response_type": "string",
- "callback_url": "string",
- "user_email": "string",
- "collapse_panels": "string",
- "redirect_callback_url": "string",
- "usercertificate_id": 0,
- "section": "VIEWER"
}Response samples
- 200
- 400
- 403
- 404
- 500
"string"Integration Decrypt
Business applications can use this service API to generate an encrypted URL to access a document and to perform signing operation on that document. The returned URL in response will be an encrypted URL which contains all the information which was provided in request body.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| auth_token | string or null |
| package_id | integer or null <int64> |
| document_id | integer or null <int64> |
| language | string or null |
| user_email | string or null |
| q | string or null |
| usercertificate_id | integer or null <int64> |
Responses
Request samples
- Payload
{- "auth_token": "string",
- "package_id": 0,
- "document_id": 0,
- "language": "string",
- "user_email": "string",
- "q": "string",
- "usercertificate_id": 0
}Response samples
- 200
{- "action": "string",
- "package_id": 0,
- "return_url": "string",
- "allowed_domains": "string",
- "user_email": "string",
- "token": {
- "access_token": "string",
- "token_type": "string",
- "expires_in": 0,
- "refresh_token": "string"
}, - "user_status": 0,
- "return_id": "string",
- "usercertificate_id": 0,
- "redirect_callback_url": true,
- "usercertificate_name": "string",
- "language": "string",
- "section": "string"
}Tiny Url Token Decrypt
Business applications can use this service API to decrypt an encrypted URL to access a document and to perform signing operation on that document. The returned URL in response will be an encrypted URL which contains all the information of the document.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| token | string or null |
Responses
Request samples
- Payload
{- "token": "string"
}Response samples
- 200
{- "url": "string"
}Decrypt Viewer Link
Business applications can use this service API to decrypt email q
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| q | string or null |
Responses
Request samples
- Payload
{- "q": "string"
}Response samples
- 200
{- "action": "string",
- "document_id": 0,
- "user_email": "string",
- "e_sign": true,
- "return_url": "string",
- "token": {
- "access_token": "string",
- "token_type": "string",
- "expires_in": 0,
- "refresh_token": "string"
}, - "user_status": 0,
- "document_owner_enterprise_id": 0,
- "language": "string"
}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.
path Parameters
| packageId required | integer <int64> The package ID for which workflow details need to be updated. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| workflow_type | string (SigningHub.Web.API.Models.WorkflowType) Enum: "SERIAL" "INDIVIDUAL" "PARALLEL" "CUSTOM" |
| workflow_mode | string (SigningHub.Web.API.Models.WorkflowModes) Enum: "ME_AND_OTHERS" "ONLY_OTHERS" "ONLY_ME" |
| continue_on_decline | boolean or null True, if workflow needs to continue even if any recipient declines the document. If no value is provided, old value will be retained. |
| message | string or null 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 | boolean or null Allow comments |
Responses
Request samples
- Payload
{- "workflow_type": "SERIAL",
- "workflow_mode": "ME_AND_OTHERS",
- "continue_on_decline": true,
- "message": "string",
- "comments": true
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }Get Workflow Details
Business applications can use this service API to get workflow details for the package.
path Parameters
| packageId required | integer <int64> The ID of the package to be downloaded. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 403
- 500
{- "package_id": 0,
- "package_name": "string",
- "shared_package": true,
- "package_owner": "string",
- "owner_name": "string",
- "package_status": "string",
- "folder": "string",
- "folder_id": 0,
- "gatekeeper": true,
- "next_signer": "string",
- "next_signer_email": [
- {
- "user_email": "string",
- "user_name": "string"
}
], - "uploaded_on": "string",
- "modified_on": "string",
- "workflow": {
- "workflow_type": "string",
- "continue_on_decline": true,
- "workflow_status": "string",
- "workflow_mode": "string",
- "message": "string",
- "read_only": true,
- "post_process": {
- "enabled": true,
- "contacts": [
- "string"
], - "recipients": [
- {
- "name": "string",
- "email": "string"
}
], - "message": "string",
- "google_drive": true,
- "one_drive": true,
- "dropbox": true,
- "workflow_recipients": true,
- "document_processing_report": true
}, - "comments": true
}, - "documents": [
- {
- "document_id": 0,
- "document_name": "string",
- "document_type": "string",
- "document_order": 0,
- "document_source": "string",
- "update_required": true,
- "document_height": 0,
- "document_width": 0,
- "document_pages": 0,
- "created_on": "string",
- "modified_on": "string",
- "form_fields": true,
- "template": {
- "template_id": 0,
- "template_name": "string",
- "read_only": true
}, - "certify": {
- "enabled": true,
- "allowed_permissions": [
- "string"
], - "default_permission": "string"
}, - "lock_form_fields": true,
- "locked": true,
- "has_signed_signature_fields": true,
- "attachments": true,
- "conformance_level": "string",
- "document_size": 0,
- "formatted": true
}
], - "users": [
- {
- "order": 0,
- "user_name": "string",
- "user_email": "string",
- "mobile_number": "string",
- "delivery_method": "string",
- "user_photo_url": "string",
- "group_name": "string",
- "group_members": [
- "string"
], - "delegator": "string",
- "gatekeeper": "string",
- "gatekeepers": {
- "emails": [
- {
- "user_email": "string"
}
]
}, - "role": "string",
- "process_status": "string",
- "processed_on": "string",
- "processed_as": "string",
- "processed_by": "string",
- "reason": "string",
- "placeholder": "string",
- "permission": {
- "print": true,
- "download": true,
- "add_text": true,
- "change_recipients": true,
- "add_attachment": true,
- "legal_notice": {
- "enabled": true,
- "allowed_notices": [
- {
- "legal_notice_id": 0,
- "legal_notice_name": "string",
- "legal_notice_html": "string"
}
], - "default_notice": {
- "legal_notice_id": 0,
- "legal_notice_name": "string",
- "legal_notice_html": "string"
}
}, - "attachment": {
- "enabled": true
}, - "artificial_intelligence": {
- "enabled": true
}, - "attachment_preview": {
- "enabled": true
}
}, - "authentications": {
- "authentication": {
- "enabled": true,
- "password": {
- "enabled": true,
- "user_password": "string"
}, - "sms_otp": {
- "enabled": true,
- "otp_length": 0,
- "retry_duration": 0,
- "mobile_number": "string",
- "methods": [
- "string"
]
}, - "totp": {
- "enabled": true
}
}, - "authentication_signing": {
- "enabled": true,
- "sms_otp": {
- "otp_length": 0,
- "retry_duration": 0,
- "mobile_number": "string",
- "methods": [
- "string"
]
}, - "totp": {
- "enabled": true
}
}, - "access_duration": {
- "enabled": true,
- "duration_by_date": {
- "enabled": true,
- "accessible": true,
- "duration": {
- "start_date_time": "string",
- "end_date_time": "string"
}
}, - "duration_by_days": {
- "enabled": true,
- "accessible": true,
- "duration": {
- "total_days": 0
}
}
}
}, - "reminder": {
- "enabled": true,
- "frequency": "string",
- "remind_after": 0,
- "repeat": {
- "enabled": true,
- "frequency": "string",
- "keep_reminding_after": 0,
- "total_reminders": 0
}
}, - "signing_order": 0,
- "user_national_id": "string",
- "guest_user": true,
- "email_language_code": "string",
- "electronic_seal": {
- "name": "string",
- "level_of_assurance": "string"
}
}
]
}Update Post Processing
Business applications can use this service API to add placeholder to a workflow a document in a package.
path Parameters
| packageId required | integer <int64> ID of the document package for which the post processing is being updated. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| enabled required | boolean True, if post processing is turned on for the package. |
| contacts | Array of strings or null |
Array of objects or null (SigningHub.Web.API.Models.PostProcessRecipientRequest) List of the name and email addresses to whom the emails are sent when the post processing is executed after the workflow completion. | |
| message | string or null <= 1500 characters A custom string message for all the contacts. Message becomes part of the email sent to the contacts. |
| google_drive | boolean or null True, if document is to be uploaded to the provided google account after the workflow completion. |
| dropbox | boolean or null True, if document is to be uploaded to the provided dropbox account after the workflow completion. |
| onedrive | boolean or null True, if document is to be uploaded to the provided oneDrive account after the workflow completion. |
| workflow_recipients | 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 | boolean True, if Send the document processing report (XML) is to be enabled to for the workflow |
Responses
Request samples
- Payload
{- "enabled": true,
- "contacts": [
- "string"
], - "recipients": [
- {
- "name": "string",
- "email": "string"
}
], - "message": "string",
- "google_drive": true,
- "dropbox": true,
- "onedrive": true,
- "workflow_recipients": true,
- "document_processing_report": true
}Response samples
- 200
- 403
- 500
{ }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"
path Parameters
| packageId required | integer <int64> SigningHub package ID, which the recipients are to be added to. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| user_email | string or null Email address of the user to be added in the workflow. |
| user_name required | string non-empty Name of the recipient to be added in the workflow. |
| user_national_id | string or null User national id of the recipient |
| email_notification | 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 | string (SigningHub.Infrastructure.Core.Enumerations.CollaboratorRole) Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" "ELECTRONIC_SEAL" |
| signing_order | integer or null <int32> Order of the recipient in the workflow. This signing order is mandatory when workflow type is "CUSTOM". |
| delivery_method | string (SigningHub.Infrastructure.Core.Enumerations.DeliveryMethod) Enum: "EMAIL" "SMS" "EMAIL_AND_SMS" |
| mobile_number | string or null <= 15 characters Mobile Number |
Responses
Request samples
- Payload
[- {
- "user_email": "string",
- "user_name": "string",
- "user_national_id": "string",
- "email_notification": true,
- "role": "SIGNER",
- "signing_order": 0,
- "delivery_method": "EMAIL",
- "mobile_number": "string"
}
]Response samples
- 200
- 400
- 401
- 403
- 404
- 500
[- {
- "user_email": "string",
- "signing_order": 0,
- "guest_user": true,
- "email_language_code": "string",
- "permission": {
- "print": true,
- "download": true,
- "add_text": true,
- "change_recipients": true,
- "add_attachment": true,
- "legal_notice": {
- "enabled": true,
- "allowed_notices": [
- {
- "legal_notice_id": 0,
- "legal_notice_name": "string",
- "legal_notice_html": "string"
}
], - "default_notice": {
- "legal_notice_id": 0,
- "legal_notice_name": "string",
- "legal_notice_html": "string"
}
}, - "attachment": {
- "enabled": true
}, - "artificial_intelligence": {
- "enabled": true
}, - "attachment_preview": {
- "enabled": true
}
}, - "reminder": {
- "enabled": true,
- "frequency": "string",
- "remind_after": 0,
- "repeat": {
- "enabled": true,
- "frequency": "string",
- "keep_reminding_after": 0,
- "total_reminders": 0
}
}
}
]Get Workflow Users
Business applications can use this service API to get workflow details for the package.
path Parameters
| packageId required | integer <int64> The ID of the package to be downloaded. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
[- {
- "order": 0,
- "user_email": "string",
- "user_name": "string",
- "mobile_number": "string",
- "delivery_method": "string",
- "user_photo_url": "string",
- "group_name": "string",
- "group_members": [
- {
- "user_email": "string",
- "user_name": "string"
}
], - "delegatee": "string",
- "delegatee_name": "string",
- "role": "string",
- "reason": "string",
- "process_status": "string",
- "processed_on": "string",
- "processed_as": "string",
- "processed_by": "string",
- "placeholder": "string",
- "signing_order": 0,
- "user_national_id": "string",
- "guest_user": true,
- "email_language_code": "string",
- "electronic_seal": {
- "name": "string",
- "level_of_assurance": "string"
}, - "gatekeepers": {
- "emails": [
- {
- "user_email": "string"
}
]
}
}
]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"
path Parameters
| packageId required | integer <int64> ID of the package for which the group is to be added. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| group_name | string or null The name of the new group to be added in workflow. |
| 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, default value of "true" will be set. |
| role | string (SigningHub.Infrastructure.Core.Enumerations.CollaboratorRole) Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" "ELECTRONIC_SEAL" |
| signing_order | integer or null <int32> Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM". |
Responses
Request samples
- Payload
[- {
- "group_name": "string",
- "email_notification": true,
- "role": "SIGNER",
- "signing_order": 0
}
]Response samples
- 200
- 400
- 401
- 403
- 404
- 500
[- {
- "permission": {
- "print": true,
- "download": true,
- "add_text": true,
- "change_recipients": true,
- "add_attachment": true,
- "legal_notice": {
- "enabled": true,
- "allowed_notices": [
- {
- "legal_notice_id": 0,
- "legal_notice_name": "string",
- "legal_notice_html": "string"
}
], - "default_notice": {
- "legal_notice_id": 0,
- "legal_notice_name": "string",
- "legal_notice_html": "string"
}
}, - "attachment": {
- "enabled": true
}, - "artificial_intelligence": {
- "enabled": true
}, - "attachment_preview": {
- "enabled": true
}
}, - "reminder": {
- "enabled": true,
- "frequency": "string",
- "remind_after": 0,
- "repeat": {
- "enabled": true,
- "frequency": "string",
- "keep_reminding_after": 0,
- "total_reminders": 0
}
}, - "signing_order": 0
}
]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"
path Parameters
| packageId required | integer <int64> ID of the package for which the placeholder is to be added. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| placeholder | string or null The name of the new placeholder to be added in workflow. |
| 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. |
| role | string (SigningHub.Infrastructure.Core.Enumerations.CollaboratorRole) Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" "ELECTRONIC_SEAL" |
| signing_order | integer or null <int32> Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM". |
Responses
Request samples
- Payload
[- {
- "placeholder": "string",
- "email_notification": true,
- "role": "SIGNER",
- "signing_order": 0
}
]Response samples
- 200
- 400
- 403
- 500
[- {
- "permission": {
- "print": true,
- "download": true,
- "add_text": true,
- "change_recipients": true,
- "add_attachment": true,
- "legal_notice": {
- "enabled": true,
- "allowed_notices": [
- {
- "legal_notice_id": 0,
- "legal_notice_name": "string",
- "legal_notice_html": "string"
}
], - "default_notice": {
- "legal_notice_id": 0,
- "legal_notice_name": "string",
- "legal_notice_html": "string"
}
}, - "attachment": {
- "enabled": true
}, - "artificial_intelligence": {
- "enabled": true
}, - "attachment_preview": {
- "enabled": true
}
}, - "reminder": {
- "enabled": true,
- "frequency": "string",
- "remind_after": 0,
- "repeat": {
- "enabled": true,
- "frequency": "string",
- "keep_reminding_after": 0,
- "total_reminders": 0
}
}, - "signing_order": 0
}
]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"
path Parameters
| packageId required | integer <int64> ID of the package for which the placeholder is to be added. |
| order required | integer <int32> Order of the recipient in the workflow. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| placeholder | string or null The name of the new placeholder to be added in workflow. If no value is provided, old value will be retained. |
| email_notification | boolean or null 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 | string (SigningHub.Web.API.Models.WorkflowCollaboratorRole) Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" |
| signing_order | integer or null <int32> Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM". |
Responses
Request samples
- Payload
{- "placeholder": "string",
- "email_notification": true,
- "role": "SIGNER",
- "signing_order": 0
}Response samples
- 200
- 400
- 403
- 500
{ }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".
path Parameters
| packageId required | integer <int64> The package ID for which workflow user needs to be updated. |
| order required | integer <int32> The order of the user in workflow. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
| user_email | string or null The email address of the new user to be updated in workflow. If no value is provided, old value will be retained. |
| user_name | string or null Name of the recipient to be updated. If no value is provided, old value will be retained. |
| email_notification | boolean or null 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 | string or null <= 15 characters Mobile number. If no value is provided, old value will be retained. |
| role | string (SigningHub.Web.API.Models.WorkflowCollaboratorRole) Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" |
| signing_order | integer or null <int32> 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 | string or null email language code |
| delivery_method | string (SigningHub.Infrastructure.Core.Enumerations.DeliveryMethod) Enum: "EMAIL" "SMS" "EMAIL_AND_SMS" |
Responses
Request samples
- Payload
{- "user_email": "string",
- "user_name": "string",
- "email_notification": true,
- "mobile_number": "string",
- "role": "SIGNER",
- "signing_order": 0,
- "email_language_code": "string",
- "delivery_method": "EMAIL"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "user_email": "string",
- "signing_order": 0,
- "guest_user": true,
- "email_language_code": "string"
}Update Workflow Users Order
Business applications can use this service API to update order of the recipient in the workflow.
path Parameters
| packageId required | integer <int64> ID of the package to which the recipients are to be added. |
| order required | integer <int32> Existing order of the recipient which is to be updated. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| order required | integer <int32> The order of the recipient which is to be updated. |
Responses
Request samples
- Payload
{- "order": 0
}Response samples
- 200
- 403
- 500
{ }Update Workflow Group
Business applications can use this service API to update the details of a group 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 wants to override the details of a specific group within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow group 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"
path Parameters
| packageId required | integer <int64> The package ID for which workflow group needs to be updated. |
| order required | integer <int32> The order of the user in workflow. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
| group_name | string or null The name of the group to be updated in workflow. If no value is provided, old value will be retained. |
| email_notification | boolean or null Setting its value to "true" sends an email notification to the group members when their turn arrives in workflow. Setting its value to "false" does not send the email notification to the group members on their turn. If no value is provided, old value will be retained. |
| access_sms_otp | boolean or null |
| mobile_number | string or null |
| role required | string (SigningHub.Web.API.Models.WorkflowCollaboratorRole) Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" |
| signing_order | integer or null <int32> Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM". |
Responses
Request samples
- Payload
{- "group_name": "string",
- "email_notification": true,
- "access_sms_otp": true,
- "mobile_number": "string",
- "role": "SIGNER",
- "signing_order": 0
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Delete Workflow User
Business applications can use this service API to delete workflow recipient.
path Parameters
| packageId required | integer <int64> The package ID from which the recipient is to be deleted. |
| order required | integer <int32> Order of the recipient in the workflow which is to be deleted. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 403
- 500
{ }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.
path Parameters
| packageId required | integer <int64> The package ID for which workflow reminders to be updated. |
| order required | integer <int32> The order of the user for which the workflow reminders to be updated. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| apply_to_all | boolean True, if reminder settings are to be applied on all the recipients in the workflow. |
| enabled | boolean True, if reminder settings are to be enabled. |
| frequency | string or null Reminder Frequency. Possible Values are DAYS | HOURS. |
| remind_after | integer <int32> Required, in case of enabled property will true. The number of days after which the first reminder would be sent to workflow user. |
object (SigningHub.Web.API.Models.RepeatRequest) RepeatRequest |
Responses
Request samples
- Payload
{- "apply_to_all": true,
- "enabled": true,
- "frequency": "string",
- "remind_after": 0,
- "repeat": {
- "enabled": true,
- "frequency": "string",
- "keep_reminding_after": 0,
- "total_reminders": 0
}
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }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.
path Parameters
| packageId required | integer <int64> The package ID for which workflow reminders to be updated. |
| order required | integer <int32> The order of the user for which the workflow reminders to be updated. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "enabled": true,
- "frequency": "string",
- "remind_after": 0,
- "repeat": {
- "enabled": true,
- "frequency": "string",
- "keep_reminding_after": 0,
- "total_reminders": 0
}
}Replicate Workflow
Business applications can use this service API to replicate complete workflow.
path Parameters
| packageId required | integer <int64> The ID of the package that need to be replicated. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 403
- 404
- 500
{- "package_id": 0,
- "package_name": "string",
- "shared_package": true,
- "package_owner": "string",
- "owner_name": "string",
- "package_status": "string",
- "folder": "string",
- "folder_id": 0,
- "gatekeeper": true,
- "next_signer": "string",
- "next_signer_email": [
- {
- "user_email": "string",
- "user_name": "string"
}
], - "uploaded_on": "string",
- "modified_on": "string",
- "workflow": {
- "workflow_type": "string",
- "continue_on_decline": true,
- "workflow_status": "string",
- "workflow_mode": "string",
- "message": "string",
- "read_only": true,
- "post_process": {
- "enabled": true,
- "contacts": [
- "string"
], - "recipients": [
- {
- "name": "string",
- "email": "string"
}
], - "message": "string",
- "google_drive": true,
- "one_drive": true,
- "dropbox": true,
- "workflow_recipients": true,
- "document_processing_report": true
}, - "comments": true
}, - "documents": [
- {
- "document_id": 0,
- "document_name": "string",
- "document_type": "string",
- "document_order": 0,
- "document_source": "string",
- "update_required": true,
- "document_height": 0,
- "document_width": 0,
- "document_pages": 0,
- "created_on": "string",
- "modified_on": "string",
- "form_fields": true,
- "template": {
- "template_id": 0,
- "template_name": "string",
- "read_only": true
}, - "certify": {
- "enabled": true,
- "allowed_permissions": [
- "string"
], - "default_permission": "string"
}, - "lock_form_fields": true,
- "locked": true,
- "has_signed_signature_fields": true,
- "attachments": true,
- "conformance_level": "string",
- "document_size": 0,
- "formatted": true
}
], - "users": [
- {
- "order": 0,
- "user_name": "string",
- "user_email": "string",
- "mobile_number": "string",
- "delivery_method": "string",
- "user_photo_url": "string",
- "group_name": "string",
- "group_members": [
- "string"
], - "delegator": "string",
- "gatekeeper": "string",
- "gatekeepers": {
- "emails": [
- {
- "user_email": "string"
}
]
}, - "role": "string",
- "process_status": "string",
- "processed_on": "string",
- "processed_as": "string",
- "processed_by": "string",
- "reason": "string",
- "placeholder": "string",
- "permission": {
- "print": true,
- "download": true,
- "add_text": true,
- "change_recipients": true,
- "add_attachment": true,
- "legal_notice": {
- "enabled": true,
- "allowed_notices": [
- {
- "legal_notice_id": 0,
- "legal_notice_name": "string",
- "legal_notice_html": "string"
}
], - "default_notice": {
- "legal_notice_id": 0,
- "legal_notice_name": "string",
- "legal_notice_html": "string"
}
}, - "attachment": {
- "enabled": true
}, - "artificial_intelligence": {
- "enabled": true
}, - "attachment_preview": {
- "enabled": true
}
}, - "authentications": {
- "authentication": {
- "enabled": true,
- "password": {
- "enabled": true,
- "user_password": "string"
}, - "sms_otp": {
- "enabled": true,
- "otp_length": 0,
- "retry_duration": 0,
- "mobile_number": "string",
- "methods": [
- "string"
]
}, - "totp": {
- "enabled": true
}
}, - "authentication_signing": {
- "enabled": true,
- "sms_otp": {
- "otp_length": 0,
- "retry_duration": 0,
- "mobile_number": "string",
- "methods": [
- "string"
]
}, - "totp": {
- "enabled": true
}
}, - "access_duration": {
- "enabled": true,
- "duration_by_date": {
- "enabled": true,
- "accessible": true,
- "duration": {
- "start_date_time": "string",
- "end_date_time": "string"
}
}, - "duration_by_days": {
- "enabled": true,
- "accessible": true,
- "duration": {
- "total_days": 0
}
}
}
}, - "reminder": {
- "enabled": true,
- "frequency": "string",
- "remind_after": 0,
- "repeat": {
- "enabled": true,
- "frequency": "string",
- "keep_reminding_after": 0,
- "total_reminders": 0
}
}, - "signing_order": 0,
- "user_national_id": "string",
- "guest_user": true,
- "email_language_code": "string",
- "electronic_seal": {
- "name": "string",
- "level_of_assurance": "string"
}
}
]
}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.
path Parameters
| packageId required | integer <int64> The ID of the document for which the log is required. |
| pageNo required | integer <int32> Default: 0 Page number to be retrieved. |
| recordsPerPage required | integer <int32> Default: 0 Total number of records to be retrieved in a page. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-search-text | string Example: c2FsZXMgY29udHJhY3QgMTA1 The search field (x-search-text header) is intended for email, document name, action, infokey, and infovalue. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "package_id": 0,
- "package_name": "string",
- "package_owner": "string",
- "owner_name": "string",
- "package_status": "string",
- "next_signer": "string",
- "next_signer_email": [
- {
- "user_email": "string",
- "user_name": "string"
}
], - "documents": [
- {
- "document_id": 0,
- "document_name": "string",
- "document_type": "string",
- "document_order": 0,
- "document_source": "string",
- "update_required": true,
- "document_height": 0,
- "document_width": 0,
- "document_pages": 0,
- "created_on": "string",
- "modified_on": "string",
- "form_fields": true,
- "template": {
- "template_id": 0,
- "template_name": "string",
- "read_only": true
}, - "certify": {
- "enabled": true,
- "allowed_permissions": [
- "string"
], - "default_permission": "string"
}, - "lock_form_fields": true,
- "locked": true,
- "has_signed_signature_fields": true,
- "attachments": true,
- "conformance_level": "string",
- "document_size": 0,
- "formatted": true
}
], - "actions": [
- {
- "log_id": 0,
- "date_time": "string",
- "action_type": "string",
- "user_email": "string",
- "user_name": "string",
- "enterprise_name": "string",
- "information": {
- "type": "string",
- "value": "string"
}
}
]
}Get Workflow History Details
Business applications can use this service API to get the details of an action performed in the document. The action is identified by the log_id provided in the resource URL. The package ID is provided in the resource URL.
path Parameters
| packageId required | integer <int64> The ID of the package for which log is required. |
| logId required | integer <int64> The ID of the log action for which the details are requested. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-base64 | string Default: true True if response should have images in base64 format. False will only return the resource URLs in response. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "data": [
- { }
], - "key": "string",
- "value": "string",
- "visible": true,
- "order": 0,
- "certificate_base64": "string",
- "certificate_base64_url": "string",
- "type": "string",
- "agent": "string"
}Get Certificate Saved In Workflow History
Business application can get the certificate that was used for to perform an workflow activity. Business application will need to provide the package id, log id and the key by which the certificate is retrieved. This API endpoint will be returned in activity log response. Client application will not need to create the whole URL on its own.
path Parameters
| packageId required | integer <int64> Id of the package for which the activity log was retrieved. |
| logId required | integer <int64> Id of the activity log record. |
| encryptKey required | string A key attribute that identifies the certificate with this activity. Key is encrypted by application so end user do not need to know the keys. Mostly this API URL will be returned in the activity log response. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 403
- 500
"string"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.
path Parameters
| packageId required | integer <int64> The package ID from which the recipient is to be deleted. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 400
- 403
- 500
{ }Import Recipient Template
path Parameters
| packageId required | integer <int64> |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
"string"Bulk Import Recipient
Business applications can use this service API to import the recipients.
path Parameters
| packageId required | integer <int64> |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| file (binary Stream) | string This is the recipient document in CSV format, posting via form data. |
| x-file-name required | string Example: recipients.csv It's the name of file with extension. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "success": [
- {
- "user_name": "string",
- "user_email": "string",
- "signing_order": 0,
- "guest_user": true,
- "email_language_code": "string",
- "delivery_method": "string",
- "mobile_number": "string"
}
], - "failure": [
- {
- "user_name": "string",
- "user_email": "string",
- "error_message": "string"
}
]
}Publish Error to Webhook
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| package_ids | Array of integers or null <int64> Array of document package ids. |
| error_code | string or null Error code of GoSign service error. |
| error_message | string or null Error message of GoSign service error message. |
| signing_server | string or null Signing server url of GoSign service. |
Responses
Request samples
- Payload
{- "package_ids": [
- 0
], - "error_code": "string",
- "error_message": "string",
- "signing_server": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Add Workflow Comments
Business applications can add the comments in the workflow. Use this service API to add comments in workflow. 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.
path Parameters
| packageId required | integer <int64> The package ID in which comments need to be added. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| send_to_owner | boolean If document owner is included in everyone's drop down but not a part of workflow collaborators |
| order | Array of integers or null <int32> If user wanna send comments to multiple recipients |
| text required | string non-empty Workflow Comment text |
Responses
Request samples
- Payload
{- "send_to_owner": true,
- "order": [
- 0
], - "text": "string"
}Response samples
- 201
- 400
- 403
- 404
- 500
{ }Get Workflow Comments
Business applications can get the comments in the workflow. Use this service API to get comments in workflow. 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.
path Parameters
| packageId required | integer <int64> The package ID to get the workflow comments. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-order | string When signing order is passed then only selected signing order comments list will be returned. |
| x-private | string When set as "true" only private comments list will be returned. In case of "false" only public comments list will be returned.If you do not set the header, then both private and public comments lists will be returned. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 500
[- {
- "id": 0,
- "text": "string",
- "date": "string",
- "private": true,
- "read": true,
- "sender": {
- "name": "string",
- "email": "string",
- "photo_url": "string"
}
}
]Mark as Read Workflow Comments
Business applications can mark as read comments in the workflow. Use this service API to mark as read comments in workflow. 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.
path Parameters
| packageId required | integer <int64> The package ID in which comments need to be mark as read. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-mark-as-read | string When set as "true" then comments are maked as read |
Responses
Response samples
- 200
- 403
- 404
- 500
{ }Get Process Evidence Report
Business applications can use this service API to download the workflow process evidence report of a document.
path Parameters
| packageId required | integer <int64> The ID of the document. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
"string"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.
path Parameters
| packageId required | integer <int64> The document ID for which workflow user needs to be updated. |
| order required | integer <int32> 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. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "print": true,
- "download": true,
- "add_text": true,
- "change_recipients": true,
- "add_attachment": true,
- "legal_notice": {
- "enabled": true,
- "allowed_notices": [
- {
- "legal_notice_id": 0,
- "legal_notice_name": "string",
- "legal_notice_html": "string"
}
], - "default_notice": {
- "legal_notice_id": 0,
- "legal_notice_name": "string",
- "legal_notice_html": "string"
}
}, - "attachment": {
- "enabled": true
}, - "artificial_intelligence": {
- "enabled": true
}, - "attachment_preview": {
- "enabled": true
}
}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.
path Parameters
| packageId required | integer <int64> The package ID for which workflow permissions to be updated. |
| order required | integer <int32> The order of the recipient for which the workflow permissions to be updated. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
| apply_to_all required | boolean True, if the permissions are to be applied on all the recipients in the workflow. |
required | object (SigningHub.Web.API.Models.WorkflowPermission) WorkflowPermission |
Responses
Request samples
- Payload
{- "apply_to_all": true,
- "permissions": {
- "print": true,
- "download": true,
- "add_text": true,
- "change_recipients": true,
- "add_attachment": true,
- "legal_notice": {
- "enabled": true,
- "legal_notice_name": "string"
}, - "attachment": {
- "enabled": true
}, - "artificial_intelligence": {
- "enabled": true
}, - "attachment_preview": {
- "enabled": true
}
}
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }Get Workflow User Authentication (Document Opening)
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.
path Parameters
| packageId required | integer <int64> The package ID for which workflow access security and authentication is to be updated. |
| order required | integer <int32> Order of the recipient in the workflow for which the access security and authentication is to be updated. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "authentication": {
- "enabled": true,
- "password": {
- "enabled": true,
- "user_password": "string"
}, - "sms_otp": {
- "enabled": true,
- "otp_length": 0,
- "retry_duration": 0,
- "mobile_number": "string",
- "methods": [
- "string"
]
}, - "totp": {
- "enabled": true
}
}, - "authentication_signing": {
- "enabled": true,
- "sms_otp": {
- "otp_length": 0,
- "retry_duration": 0,
- "mobile_number": "string",
- "methods": [
- "string"
]
}, - "totp": {
- "enabled": true
}
}, - "access_duration": {
- "enabled": true,
- "duration_by_date": {
- "enabled": true,
- "accessible": true,
- "duration": {
- "start_date_time": "string",
- "end_date_time": "string"
}
}, - "duration_by_days": {
- "enabled": true,
- "accessible": true,
- "duration": {
- "total_days": 0
}
}
}
}Update Workflow User Authentication (Document Opening)
Business applications can use this service API to update the package authentications and access duration for the recipients.
path Parameters
| packageId required | integer <int64> The package ID for which workflow access security and authentication is to be updated. |
| order required | integer <int32> Order of the recipient in the workflow for which the access security and authentication is to be updated. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
| apply_to_all | boolean True, if the access security or authentications are to be applied on all the recipients in the workflow. |
required | object (SigningHub.Web.API.Models.AccessAuthentication) AccessAuthentication |
object (SigningHub.Web.API.Models.SigningAuthentication) SigningAuthentication | |
required | object (SigningHub.Web.API.Models.PermissionAccessDuration) PermissionAccessDuration |
Responses
Request samples
- Payload
{- "apply_to_all": true,
- "authentication": {
- "enabled": true,
- "password": {
- "enabled": true,
- "user_password": "string"
}, - "sms_otp": {
- "enabled": true,
- "mobile_number": "string"
}, - "totp": {
- "enabled": true
}
}, - "authentication_signing": {
- "enabled": true,
- "sms_otp": {
- "mobile_number": "string"
}, - "totp": {
- "enabled": true
}
}, - "access_duration": {
- "enabled": true,
- "duration_by_date": {
- "enabled": true,
- "duration": {
- "start_date_time": "2019-08-24T14:15:22Z",
- "end_date_time": "2019-08-24T14:15:22Z"
}
}, - "duration_by_days": {
- "enabled": true,
- "duration": {
- "total_days": 0
}
}
}
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }This section entails the web services for the Document Preparation i.e. Add/Update/Delete Fields.
Add Attachment Field
Business applications can use this service API to add an attachment 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.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| order required | integer <int32> The order of the user in workflow for which the field is being added. |
| page_no required | integer <int32> Page number on which the field is to be created. |
| field_name | string or null <= 255 characters Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field. |
| validation_rule required | string (SigningHub.Web.API.Models.ValidationRule) Enum: "OPTIONAL" "MANDATORY" |
| note | string or null Attachment note in case of Mandatory attachment |
required | object (SigningHub.Web.API.Models.AddCommonFieldDimension) AddCommonFieldDimension |
Responses
Request samples
- Payload
{- "order": 0,
- "page_no": 0,
- "field_name": "string",
- "validation_rule": "OPTIONAL",
- "note": "string",
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}
}Response samples
- 201
- 400
- 403
- 404
- 500
{- "field_name": "string"
}Update Attachment Field
Business applications can use this service API to update an attachment 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.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| field_name required | string [ 1 .. 255 ] characters Current name of the field, that is to be updated. |
| renamed_as | string or null <= 255 characters Updated name of the field if renaming is intended. |
| page_no required | integer <int32> Page number on which the field is to be created. |
| validation_rule required | string (SigningHub.Web.API.Models.ValidationRule) Enum: "OPTIONAL" "MANDATORY" |
| note | string or null <= 500 characters Attachment note in case of Mandatory attachment |
required | object (SigningHub.Web.API.Models.AttachmentFieldUpdateDimension) AttachmentFieldUpdateDimension |
Responses
Request samples
- Payload
{- "field_name": "string",
- "renamed_as": "string",
- "page_no": 0,
- "validation_rule": "OPTIONAL",
- "note": "string",
- "dimensions": {
- "x": 0,
- "y": 0
}
}Response samples
- 200
- 400
- 403
- 404
- 500
{ }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.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| order | integer <int32> The order of the user in workflow for which the field is being added. |
| page_no | integer <int32> Page number on which the field is to be created. |
| field_name | string or null 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 | string or null Value of the field. Possible values are "true" or "false" |
required | object (SigningHub.Web.API.Models.FieldDimension) FieldDimension |
| validation_rule | string or null One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL". |
Responses
Request samples
- Payload
{- "order": 0,
- "page_no": 0,
- "field_name": "string",
- "value": "string",
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "validation_rule": "string"
}Response samples
- 200
- 403
- 500
{- "field_name": "string"
}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.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| x-folder-id | string |
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
| field_name required | string non-empty Current name of the field, that is to be updated. |
| renamed_as | string or null Updated name of the field if renaming is intended. |
| page_no | integer <int32> Page number on which the field is to be created. |
| value | string or null Value of the field. |
required | object (SigningHub.Web.API.Models.FieldDimension) FieldDimension |
| validation_rule | string or null One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL". |
Responses
Request samples
- Payload
{- "field_name": "string",
- "renamed_as": "string",
- "page_no": 0,
- "value": "string",
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "validation_rule": "string"
}Response samples
- 200
- 403
- 500
{ }Add Comment Field
Business applications can use this service API to add an comment field to a document in a package.
At least one user must exist in a workflow other then current recipient.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| page_no required | integer <int32> Page number on which the field is to be created. |
| comment required | string [ 1 .. 500 ] characters Comment text. |
required | object (SigningHub.Web.API.Models.AddCommonFieldDimension) AddCommonFieldDimension |
Array of objects or null (SigningHub.Web.API.Models.AddCommentFieldRecipient) Recipients |
Responses
Request samples
- Payload
{- "page_no": 0,
- "comment": "string",
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "recipients": [
- {
- "user_email": "string"
}
]
}Response samples
- 201
- 400
- 403
- 404
- 500
{- "id": 0
}Update Comment Field
Business applications can use this service API to update an comment in a package.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
| commentId required | integer <int64> The comment ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| comment required | string [ 1 .. 500 ] characters Comment text. |
Responses
Request samples
- Payload
{- "comment": "string"
}Response samples
- 200
- 400
- 403
- 404
- 500
{ }Delete Comment Field
Business applications can use this service API to delete a comment field to a document in a package.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
| commentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 400
- 403
- 404
- 500
{ }Get Field Comments
Business applications can use this service API to get field comment.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
| commentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 403
- 404
- 500
[- {
- "user_name": "string",
- "user_email": "string",
- "comment": "string",
- "read": true,
- "created_on": "string"
}
]Reply to a Comment
Business applications can use this service API to reply to a comment of a document in a package.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
| commentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| comment required | string [ 1 .. 500 ] characters Comment text. |
Responses
Request samples
- Payload
{- "comment": "string"
}Response samples
- 201
- 400
- 403
- 404
- 500
{ }Mark Comments as read
Business applications can use this service API to mark comments as read.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
| commentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 403
- 404
- 500
{ }Get Comment Fields
Business applications can use this service API to get comment fields.
path Parameters
| packageId required | integer <int64> The ID of the package to which the document is added. |
| documentId required | integer <int64> Default: 0 The ID of the document for which the fields are requested. If document id is not provided fields of whole package are returned. |
| pageNo required | integer <int32> Default: 0 Page no of the document for which the fields are requested. If page number is not provided fields of whole document are returned. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-mobile | string Default: TRUE Define the originator(Web/Mobile) of the request/action |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
[- {
- "id": 0,
- "document_id": 0,
- "page_no": 0,
- "unread_count": 0,
- "private": true,
- "recipients": [
- {
- "user_name": "string",
- "user_email": "string"
}
], - "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}
}
]Update DropDown Field
Business applications can use this service API to update a dropdown field of a document in a package.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| field_name required | string non-empty Current name of the field, that is to be updated. |
| validation_rule | string (SigningHub.Web.API.Models.ValidationRule) Enum: "OPTIONAL" "MANDATORY" |
Responses
Request samples
- Payload
{- "field_name": "string",
- "validation_rule": "OPTIONAL"
}Response samples
- 200
- 400
- 403
- 404
- 500
{ }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.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which workflow user needs to be updated. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| field_name required | string non-empty Name of the signature field that is to be assigned. |
| radio_group_name | string or null provide group name for radio box |
| order | integer <int32> The order of the user in workflow, to which the field is being assigned. |
| level_of_assurance | Array of strings or null 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" |
Responses
Request samples
- Payload
[- {
- "field_name": "string",
- "radio_group_name": "string",
- "order": 0,
- "level_of_assurance": [
- "string"
]
}
]Response samples
- 200
- 401
- 403
- 404
- 500
{ }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.
path Parameters
| packageId required | integer <int64> The ID of the package to which the document is added. |
| documentId required | integer <int64> The ID of the document for which the fields are requested. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| search_text | string or null Word that needs to be searched in the document. |
| order | integer <int32> 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 | string or null 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 | string or null 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 | Array of strings or null 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". Will only be provided in case of In-person and Signature. |
object (SigningHub.Web.API.Models.FieldDimension) FieldDimension | |
| placeholder | string or null Provide note in the case of Mandatory Attachment |
| radio_group_name | string or null The group name required only when adding a Radio Box type field to group multiple Radio boxes together. |
| format | string or null Text format of the field. Used for the date type field only. Possible values are
|
| value | string or null Value that user want to show in the field. |
| max_length | integer <int32> Maximum length of the value allowed in the field. Must between 1 - 9999 |
| validation_rule | string or null One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL". |
object (SigningHub.Web.API.Models.FieldValidationValue) | |
object (SigningHub.Web.API.Models.Font) Font | |
| multiline | boolean This belongs to Text Area field type and If set to true, text area field would be created with multi line option. |
Responses
Request samples
- Payload
{- "search_text": "string",
- "order": 0,
- "placement": "string",
- "field_type": "string",
- "level_of_assurance": [
- "string"
], - "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "placeholder": "string",
- "radio_group_name": "string",
- "format": "string",
- "value": "string",
- "max_length": 0,
- "validation_rule": "string",
- "validation": {
- "required": true,
- "rules": [
- {
- "type": "string",
- "value": "string"
}
]
}, - "font": {
- "name": "string",
- "size": "string",
- "embedded_size": "string"
}, - "multiline": true
}Response samples
- 200
- 403
- 404
- 500
[- {
- "field_name": "string"
}
]Delete Document Field
Business applications can use this service API to delete a field of document in a package.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| field_name required | string non-empty Name of the field to be deleted. |
Responses
Request samples
- Payload
{- "field_name": "string"
}Response samples
- 200
- 403
- 500
{ }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.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The ID of the document. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
| auto_save | 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. |
Array of objects or null (SigningHub.Web.API.Models.TextFormFillingRequest) It has the list of textboxes data to save | |
Array of objects or null (SigningHub.Web.API.Models.RadioFormFillingRequest) It has the list of radios value to save | |
Array of objects or null (SigningHub.Web.API.Models.CheckBoxFormFillingRequest) It has the list of checkboxes value to save | |
Array of objects or null (SigningHub.Web.API.Models.DropDownFormFillingRequest) It has the list of dropdowns value to save | |
Array of objects or null (SigningHub.Web.API.Models.ListBoxFormFillingRequest) It has the list of listboxes value to save |
Responses
Request samples
- Payload
{- "auto_save": true,
- "text": [
- {
- "field_name": "string",
- "value": "string"
}
], - "radio": [
- {
- "field_name": "string",
- "radio_group_name": "string",
- "value": true
}
], - "checkbox": [
- {
- "field_name": "string",
- "value": true
}
], - "dropdown": [
- {
- "field_name": "string",
- "value": "string"
}
], - "listbox": [
- {
- "field_name": "string",
- "value": "string"
}
]
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }Get Document Fields
Business applications can use this service API to get document fields i.e., initials, in-persons, signature fields or form fields.
path Parameters
| packageId required | integer <int64> The ID of the package to which the document is added. |
| documentId required | integer <int64> The ID of the document for which the fields are requested. |
| pageNo required | integer <int32> Default: 0 Page no of the document for which the fields are requested. If page number is not provided fields of whole document are returned. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-mobile | string Default: TRUE Define the originator(Web/Mobile) of the request/action |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "signature": [
- {
- "order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "embedded": true,
- "type": "string",
- "process_status": "string",
- "processed_on": "string",
- "processed_as": "string",
- "created_on": "string",
- "processed_by": "string",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "verification": {
- "field_name": "string",
- "signer_name": "string",
- "signature_status": "string",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "signing_time": "string",
- "ltv": true,
- "qualified": true,
- "certified": true,
- "certify_permission": "string",
- "timestamp_at": "string",
- "timestamp_authority": "string",
- "subject_dn": "string",
- "issuer_dn": "string",
- "cert_valid_from": "string",
- "cert_valid_to": "string",
- "signature_type": "string",
- "signature_algorithm": "string",
- "signature_application": "string",
- "signature_policy_id": 0,
- "signature_policy_uri": "string",
- "signer_photo": "string",
- "signer_photo_url": "string",
- "signed_hash": "string",
- "display": "string",
- "page_number": 0,
- "lei_number": "string",
- "lei_role": "string",
- "error_message": "string"
}, - "nid": "string",
- "display": "string",
- "level_of_assurance": [
- "string"
], - "authentication": {
- "enabled": true,
- "sms_otp": {
- "enabled": true,
- "otp_length": 0,
- "retry_duration": 0,
- "mobile_number": "string",
- "methods": [
- "string"
]
}, - "totp": {
- "enabled": true
}
}
}
], - "hand_signature": [
- {
- "order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "embedded": true,
- "type": "string",
- "process_status": "string",
- "processed_on": "string",
- "processed_as": "string",
- "processed_by": "string",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "nid": "string"
}
], - "electronic_signature": [
- {
- "order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "embedded": true,
- "type": "string",
- "process_status": "string",
- "processed_on": "string",
- "processed_as": "string",
- "processed_by": "string",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "signature_sub_type": "string",
- "authentication": {
- "enabled": true,
- "sms_otp": {
- "enabled": true,
- "otp_length": 0,
- "retry_duration": 0,
- "mobile_number": "string",
- "methods": [
- "string"
]
}, - "totp": {
- "enabled": true
}
}, - "verification": {
- "field_name": "string",
- "signer_name": "string",
- "signature_status": "string",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "signing_time": "string",
- "ltv": true,
- "qualified": true,
- "certified": true,
- "certify_permission": "string",
- "timestamp_at": "string",
- "timestamp_authority": "string",
- "subject_dn": "string",
- "issuer_dn": "string",
- "cert_valid_from": "string",
- "cert_valid_to": "string",
- "signature_type": "string",
- "signature_algorithm": "string",
- "signature_application": "string",
- "signature_policy_id": 0,
- "signature_policy_uri": "string",
- "signer_photo": "string",
- "signer_photo_url": "string",
- "signed_hash": "string",
- "display": "string",
- "page_number": 0,
- "lei_number": "string",
- "lei_role": "string",
- "error_message": "string"
}, - "nid": "string",
- "display": "string"
}
], - "initials": [
- {
- "order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "process_status": "string",
- "processed_on": "string",
- "processed_as": "string",
- "processed_by": "string",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "embedded": true
}
], - "in_person_signature": [
- {
- "order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "embedded": true,
- "type": "string",
- "process_status": "string",
- "processed_on": "string",
- "processed_as": "string",
- "processed_by": "string",
- "placeholder": "string",
- "signature_sub_type": "string",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "verification": {
- "field_name": "string",
- "signer_name": "string",
- "signature_status": "string",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "signing_time": "string",
- "ltv": true,
- "qualified": true,
- "certified": true,
- "certify_permission": "string",
- "timestamp_at": "string",
- "timestamp_authority": "string",
- "subject_dn": "string",
- "issuer_dn": "string",
- "cert_valid_from": "string",
- "cert_valid_to": "string",
- "signature_type": "string",
- "signature_algorithm": "string",
- "signature_application": "string",
- "signature_policy_id": 0,
- "signature_policy_uri": "string",
- "signer_photo": "string",
- "signer_photo_url": "string",
- "signed_hash": "string",
- "display": "string",
- "page_number": 0,
- "lei_number": "string",
- "lei_role": "string",
- "error_message": "string"
}, - "display": "string",
- "level_of_assurance": [
- "string"
], - "authentication": {
- "enabled": true,
- "sms_otp": {
- "enabled": true,
- "otp_length": 0,
- "retry_duration": 0,
- "mobile_number": "string",
- "methods": [
- "string"
]
}, - "totp": {
- "enabled": true
}
}
}
], - "text": [
- {
- "field_locale": "string",
- "required": true,
- "order": 0,
- "tab_order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "embedded": true,
- "type": "string",
- "value": "string",
- "read_only": true,
- "validation_rule": "string",
- "validation": {
- "required": true,
- "rules": [
- {
- "type": "string",
- "value": "string"
}
]
}, - "visible": true,
- "multiline": true,
- "font": {
- "name": "string",
- "size": 0,
- "embedded_size": 0
}, - "max_length": 0,
- "format_type": "string",
- "placeholder": "string",
- "format": "string",
- "color": "string",
- "border_color": "string",
- "tooltip": "string",
- "field_rotation": 0,
- "align": "string",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}
}
], - "radio": [
- {
- "required": true,
- "order": 0,
- "tab_order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "embedded": true,
- "type": "string",
- "value": true,
- "read_only": true,
- "validation_rule": "string",
- "radio_group_name": "string",
- "checked": true,
- "visible": true,
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "color": "string",
- "border_color": "string",
- "tooltip": "string",
- "field_rotation": 0
}
], - "checkbox": [
- {
- "required": true,
- "order": 0,
- "tab_order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "embedded": true,
- "type": "string",
- "value": true,
- "read_only": true,
- "checked": true,
- "visible": true,
- "validation_rule": "string",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "color": "string",
- "border_color": "string",
- "tooltip": "string",
- "field_rotation": 0
}
], - "dropdown": [
- {
- "required": true,
- "order": 0,
- "tab_order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "embedded": true,
- "validation_rule": "string",
- "read_only": true,
- "value": "string",
- "choices": [
- "string"
], - "visible": true,
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "font": {
- "name": "string",
- "size": 0,
- "embedded_size": 0
}, - "color": "string",
- "border_color": "string",
- "tooltip": "string",
- "field_rotation": 0
}
], - "listbox": [
- {
- "order": 0,
- "tab_order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "embedded": true,
- "validation_rule": "string",
- "read_only": true,
- "value": "string",
- "choices": [
- "string"
], - "visible": true,
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "font": {
- "name": "string",
- "size": 0,
- "embedded_size": 0
}, - "color": "string",
- "border_color": "string",
- "tooltip": "string",
- "field_rotation": 0
}
], - "qrcode": [
- {
- "field_name": "string",
- "type": "string",
- "page_no": 0,
- "value": "string",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "data": "string",
- "options": {
- "error_correction_level": "Default",
- "encoding": "Default",
- "pixels_per_module": 0,
- "add_margins": true
}, - "color": {
- "dots": "string",
- "background": "string"
}, - "logo": {
- "base64": "string",
- "hide_background_dots": true,
- "size": 0
}
}
], - "attachment": [
- {
- "order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "process_status": "string",
- "processed_on": "string",
- "processed_as": "string",
- "processed_by": "string",
- "attachmentRefId": 0,
- "note": "string",
- "validation_rule": "OPTIONAL",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}
}
], - "comment": [
- {
- "id": 0,
- "page_no": 0,
- "unread_count": 0,
- "private": true,
- "recipients": [
- {
- "user_name": "string",
- "user_email": "string"
}
], - "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}
}
], - "unique_identifier": [
- {
- "field_name": "string",
- "value": "string",
- "page_no": 0,
- "font": {
- "name": "string",
- "size": 0,
- "embedded_size": 0
}, - "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}
}
]
}Bulk Delete Document Field
path Parameters
| packageId required | integer <int64> Document package id. |
| documentId required | integer <int64> Document id. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
Request object containing field names.
| field_names | Array of strings or null Array of field names to be deleted. |
Responses
Request samples
- Payload
{- "field_names": [
- "string"
]
}Response samples
- 200
- 403
- 500
{- "failed_fields": [
- {
- "field_name": "string",
- "error_message": "string"
}
]
}Update Unique Identifier
Business applications can use this service API to update a unique identifier field of a document in a package.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| field_name | string or null <= 255 characters Name of the field that is to be updated. |
| page_no required | integer <int32> Page number on which the field is to be created. |
required | object (SigningHub.Web.API.Models.UpdateUniqueIdentifierDimension) UpdateUniqueIdentifierDimension |
Responses
Request samples
- Payload
{- "field_name": "string",
- "page_no": 0,
- "dimensions": {
- "x": 0,
- "y": 0
}
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }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.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| order | integer <int32> The order of the user in workflow for which the field is being added. |
| page_no | integer <int32> Page number on which the field is to be created. |
| field_name | string or null Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field. |
required | object (SigningHub.Web.API.Models.FieldDimension) FieldDimension |
Responses
Request samples
- Payload
{- "order": 0,
- "page_no": 0,
- "field_name": "string",
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}
}Response samples
- 201
- 403
- 500
{- "field_name": "string"
}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.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| field_name required | string non-empty Current name of the field, that is to be updated. |
| renamed_as | string or null Updated name of the field if renaming is intended. |
| page_no | integer <int32> Page number on which the field is to be created. |
required | object (SigningHub.Web.API.Models.FieldDimension) FieldDimension |
Responses
Request samples
- Payload
{- "field_name": "string",
- "renamed_as": "string",
- "page_no": 0,
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}
}Response samples
- 200
- 403
- 500
{ }Replicate Initial Fields
Business applications can use this service API to replicate initial fields to the multiple pages of a document in a package.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
| field_name required | string Specifies the name of the field to be replicated across multiple pages. Suggested to pass in base64 string format. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
List of page numbers
| pages required | Array of integers <int32> [ items <int32 > ] List of page number for which field need to replicate |
Responses
Request samples
- Payload
{- "pages": [
- 0
]
}Response samples
- 201
- 400
- 403
- 404
- 500
[- {
- "order": 0,
- "page_no": 0,
- "field_name": "string",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}
}
]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.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| order | integer <int32> The order of the user in workflow for which the field is being added. |
| page_no | integer <int32> Page number on which the field is to be created. |
| field_name | string or null Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field. |
| placeholder required | string non-empty String identifier for the inperson field, it can be Customer, Jack, CEO etc. |
required | object (SigningHub.Web.API.Models.FieldDimension) FieldDimension |
| display | string or null Visibility of the field that is to be added, possible values are "VISIBLE" and "INVISIBLE" |
| level_of_assurance | Array of strings or null Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE" |
object (SigningHub.Web.API.Models.SignatureFieldAuthentication) SignatureFieldAuthentication |
Responses
Request samples
- Payload
{- "order": 0,
- "page_no": 0,
- "field_name": "string",
- "placeholder": "string",
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "display": "string",
- "level_of_assurance": [
- "string"
], - "authentication_signing": {
- "enabled": true,
- "otp": {
- "enabled": true,
- "mobile_number": "string"
}, - "totp": {
- "enabled": true
}
}
}Response samples
- 201
- 400
- 403
- 500
{- "field_name": "string"
}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.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| x-folder-id | string |
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
| field_name required | string non-empty Current name of the field, that is to be updated. |
| renamed_as | string or null updated name of the field, if renaming is intended. |
| page_no | integer <int32> Page number on which the field is to be created. |
| placeholder | string or null String identifier for the in-person field, it can be Customer, Jack, CEO etc. |
object (SigningHub.Web.API.Models.FieldDimension) FieldDimension | |
| display | string or null Visibility of the field that is to be updated, possible values are "VISIBLE" and "INVISIBLE" |
| level_of_assurance | Array of strings or null Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE" |
object (SigningHub.Web.API.Models.SignatureFieldAuthentication) SignatureFieldAuthentication |
Responses
Request samples
- Payload
{- "field_name": "string",
- "renamed_as": "string",
- "page_no": 0,
- "placeholder": "string",
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "display": "string",
- "level_of_assurance": [
- "string"
], - "authentication_signing": {
- "enabled": true,
- "otp": {
- "enabled": true,
- "mobile_number": "string"
}, - "totp": {
- "enabled": true
}
}
}Response samples
- 200
- 400
- 403
- 500
{ }Replicate In-person Fields
Business applications can use this service API to replicate In-person fields to the multiple pages of a document in a package.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
| field_name required | string Specifies the name of the field to be replicated across multiple pages. Suggested to pass in base64 string format. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
List of page numbers
| pages required | Array of integers <int32> [ items <int32 > ] List of page number for which field need to replicate |
Responses
Request samples
- Payload
{- "pages": [
- 0
]
}Response samples
- 201
- 400
- 403
- 404
- 500
[- {
- "order": 0,
- "page_no": 0,
- "field_name": "string",
- "placeholder": "string",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "display": "string",
- "level_of_assurance": [
- "string"
], - "authentication_signing": {
- "enabled": true,
- "otp": {
- "enabled": true,
- "mobile_number": "string"
}, - "totp": {
- "enabled": true
}
}
}
]Add QR Code
Business applications can use this service API to add a QR Code to a document in a package.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| page_no | integer <int32> Page number on which the field is to be created. |
| field_name | string or null <= 255 characters Name of the provided field that is to be added. If not provided, system will assign an unique auto generated name to the field. |
required | object (SigningHub.Web.API.Models.FieldDimension) FieldDimension |
| data | string or null <= 500 characters 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} |
object (SigningHub.Web.API.Models.QrCodeOptions) QrCodeOptions | |
object (SigningHub.Web.API.Models.QrCodeColor) QrCodeColor | |
object (SigningHub.Web.API.Models.QrCodeLogo) QrCodeLogo |
Responses
Request samples
- Payload
{- "page_no": 0,
- "field_name": "string",
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "data": "string",
- "options": {
- "error_correction_level": "Default",
- "encoding": "Default",
- "pixels_per_module": 0,
- "add_margins": true
}, - "color": {
- "dots": "string",
- "background": "string"
}, - "logo": {
- "base64": "string",
- "hide_background_dots": true,
- "size": 0
}
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "data": "string",
- "field_name": "string",
- "value": "string"
}Update QR Code
Business applications can use this service API to update a QR Code of a document in a package.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| field_name required | string [ 1 .. 255 ] characters Current name of the field, that is to be updated. |
| renamed_as | string or null Updated name of the field if renaming is intended. |
| page_no | integer <int32> Page number for which field is need to be updated |
required | object (SigningHub.Web.API.Models.FieldDimension) FieldDimension |
| data | string or null <= 500 characters 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} |
object (SigningHub.Web.API.Models.QrCodeOptions) QrCodeOptions | |
object (SigningHub.Web.API.Models.QrCodeColor) QrCodeColor | |
object (SigningHub.Web.API.Models.QrCodeLogo) QrCodeLogo |
Responses
Request samples
- Payload
{- "field_name": "string",
- "renamed_as": "string",
- "page_no": 0,
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "data": "string",
- "options": {
- "error_correction_level": "Default",
- "encoding": "Default",
- "pixels_per_module": 0,
- "add_margins": true
}, - "color": {
- "dots": "string",
- "background": "string"
}, - "logo": {
- "base64": "string",
- "hide_background_dots": true,
- "size": 0
}
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "value": "string"
}Preview QR Code
Business applications can use this service API to preview a QR Code.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| data required | string [ 1 .. 500 ] characters The plain text data to be encoded in the QR code. |
object (SigningHub.Web.API.Models.QrCodeOptions) QrCodeOptions | |
object (SigningHub.Web.API.Models.QrCodeColor) QrCodeColor | |
object (SigningHub.Web.API.Models.QrCodeLogo) QrCodeLogo |
Responses
Request samples
- Payload
{- "data": "string",
- "options": {
- "error_correction_level": "Default",
- "encoding": "Default",
- "pixels_per_module": 0,
- "add_margins": true
}, - "color": {
- "dots": "string",
- "background": "string"
}, - "logo": {
- "base64": "string",
- "hide_background_dots": true,
- "size": 0
}
}Response samples
- 200
- 400
- 401
- 500
{- "base64": "string"
}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.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| order | integer <int32> The order of the user in workflow for which the field is being added. |
| page_no | integer <int32> Page number on which the field is to be created. |
| field_name | string or null <= 255 characters 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 | string or null Value of the field. Possible values are "true" or "false" |
| validation_rule | string (SigningHub.Web.API.Models.ValidationRule) Enum: "OPTIONAL" "MANDATORY" |
| radio_group_name required | string non-empty |
required | object (SigningHub.Web.API.Models.FieldDimension) FieldDimension |
Responses
Request samples
- Payload
{- "order": 0,
- "page_no": 0,
- "field_name": "string",
- "value": "string",
- "validation_rule": "OPTIONAL",
- "radio_group_name": "string",
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}
}Response samples
- 200
- 403
- 500
{- "field_name": "string"
}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.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| field_name required | string [ 1 .. 255 ] characters Current name of the field, that is to be updated. |
| renamed_as | string or null Updated name of the field if renaming is intended. |
| page_no | integer <int32> Page number on which the field is to be created. |
| value | string or null Value of the field. |
| validation_rule | string (SigningHub.Web.API.Models.ValidationRule) Enum: "OPTIONAL" "MANDATORY" |
| radio_group_name required | string non-empty The group name to which the field belongs. |
required | object (SigningHub.Web.API.Models.FieldDimension) FieldDimension |
Responses
Request samples
- Payload
{- "field_name": "string",
- "renamed_as": "string",
- "page_no": 0,
- "value": "string",
- "validation_rule": "OPTIONAL",
- "radio_group_name": "string",
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}
}Response samples
- 200
- 403
- 500
{ }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.
path Parameters
| packageId required | integer <int64> The package ID for which workflow details need to be updated. |
| documentId required | integer <int64> The document ID where the field is to be added. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| order | integer <int32> Order of the recipient for which the field is being created. |
| page_no | integer <int32> Page number at which the field is about to be created. |
| field_name | string or null 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 | Array of strings or null 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" |
object (SigningHub.Web.API.Models.FieldDimension) FieldDimension | |
| display | string or null Visibility of the field that is to be added, possible values are "VISIBLE" and "INVISIBLE" |
object (SigningHub.Web.API.Models.SignatureFieldAuthentication) SignatureFieldAuthentication |
Responses
Request samples
- Payload
{- "order": 0,
- "page_no": 0,
- "field_name": "string",
- "level_of_assurance": [
- "string"
], - "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "display": "string",
- "authentication_signing": {
- "enabled": true,
- "otp": {
- "enabled": true,
- "mobile_number": "string"
}, - "totp": {
- "enabled": true
}
}
}Response samples
- 200
- 400
- 403
- 500
{- "field_name": "string",
- "created_on": "string"
}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.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| x-folder-id | string |
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
| field_name required | string non-empty Current name of the field, which is to be updated. |
| level_of_assurance | Array of strings or null 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 | string or null Updated name of the field if renaming of the field is intended. |
| page_no | integer <int32> Page number on which the field is to be created. |
object (SigningHub.Web.API.Models.FieldDimension) FieldDimension | |
| display | string or null Visibility of the field that is to be updated, possible values are "VISIBLE" and "INVISIBLE" |
object (SigningHub.Web.API.Models.SignatureFieldAuthentication) SignatureFieldAuthentication |
Responses
Request samples
- Payload
{- "field_name": "string",
- "level_of_assurance": [
- "string"
], - "renamed_as": "string",
- "page_no": 0,
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "display": "string",
- "authentication_signing": {
- "enabled": true,
- "otp": {
- "enabled": true,
- "mobile_number": "string"
}, - "totp": {
- "enabled": true
}
}
}Response samples
- 200
- 400
- 403
- 500
{ }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.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| order | integer <int32> The order of the user in workflow for which the field is being added. |
| page_no | integer <int32> Page number on which the field is to be created. |
| type | string (SigningHub.Web.API.Models.TextboxType) Enum: "TEXT" "NAME" "EMAIL" "COMPANY" "JOBTITLE" "DATE" |
| value | string or null 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 | string or null 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 | integer <int32> Maximum length of the value allowed in the field. Must between 1 - 9999 |
| format | string or null Text format of the field. Used for the date type field only. Possible values are
|
| field_name | string or null 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 | string or null Field local. Possible values are ar-AE | en-US. Optional and default will be en-US. This value matters for type "DATE" |
| field_type required | string (SigningHub.Web.API.Models.FieldType) Enum: "Number" "Text" |
| validation_rule | string (SigningHub.Web.API.Models.ValidationRule) Enum: "OPTIONAL" "MANDATORY" |
object (SigningHub.Web.API.Models.FieldValidationValue) | |
required | object (SigningHub.Web.API.Models.Font) Font |
required | object (SigningHub.Web.API.Models.FieldDimension) FieldDimension |
| multiline | boolean If set to true, text area field would be created |
Responses
Request samples
- Payload
{- "order": 0,
- "page_no": 0,
- "type": "TEXT",
- "value": "string",
- "placeholder": "string",
- "max_length": 0,
- "format": "string",
- "field_name": "string",
- "field_locale": "string",
- "field_type": "Number",
- "validation_rule": "OPTIONAL",
- "validation": {
- "required": true,
- "rules": [
- {
- "type": "string",
- "value": "string"
}
]
}, - "font": {
- "name": "string",
- "size": "string",
- "embedded_size": "string"
}, - "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "multiline": true
}Response samples
- 200
- 403
- 500
{- "field_name": "string"
}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.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
| documentId required | integer <int64> The document ID for which the action is to be taken. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| field_name required | string non-empty Current name of the field, that is to be updated. |
| field_locale | string or null Field local. Possible values are ar-AE | en-US. Optional and default will be en-US. This value matters for type "DATE" |
| renamed_as | string or null Updated name of the field if renaming is intended. |
| page_no | integer <int32> Page number on which the field is to be created. |
| value | string or null 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 | integer <int32> Maximum length of the value allowed in the field. Must between 1 - 9999 |
| field_type | string (SigningHub.Web.API.Models.FieldType) Enum: "Number" "Text" |
| validation_rule | string (SigningHub.Web.API.Models.ValidationRule) Enum: "OPTIONAL" "MANDATORY" |
object (SigningHub.Web.API.Models.Font) Font | |
object (SigningHub.Web.API.Models.FieldDimension) FieldDimension | |
| placeholder | string or null Developers can provide a their own placeholder texts. These placeholders appear in the text fields while viewing the document in viewer. |
| format | string or null Text format of the field. Used for the date type field only. Possible values are
|
object (SigningHub.Web.API.Models.FieldValidationValue) |
Responses
Request samples
- Payload
{- "field_name": "string",
- "field_locale": "string",
- "renamed_as": "string",
- "page_no": 0,
- "value": "string",
- "max_length": 0,
- "field_type": "Number",
- "validation_rule": "OPTIONAL",
- "font": {
- "name": "string",
- "size": "string",
- "embedded_size": "string"
}, - "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "placeholder": "string",
- "format": "string",
- "validation": {
- "required": true,
- "rules": [
- {
- "type": "string",
- "value": "string"
}
]
}
}Response samples
- 200
- 403
- 500
{ }This section entails the web services for the Document Processing i.e. Sign Document, Recall Document, Bulk Sign, and Finish Workflow.
Get Document Attachment Image
Business applications can use this service API to get attachment image stream.
path Parameters
| packageId required | integer <int64> Document package ID |
| documentId required | integer <int64> Document ID |
| attachmentId required | integer <int64> Attachment ID of underlying attachment |
| pageNo required | integer <int64> Page number of attachment for the image |
| width required | string String containing width and height for the image |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 500
"string"Get Document Attachment Image (Base64)
Business applications can use this service API to get attachment image base64 string.
path Parameters
| packageId required | integer <int64> Document package ID |
| documentId required | integer <int64> Document ID |
| attachmentId required | integer <int64> Attachment ID of underlying attachment |
| pageNo required | integer <int64> Page number of attachment for the image |
| width required | string String containing width and height for the image |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 500
"string"Get Document Attachment Metadata
Business applications can use this service API to get attachment metadata.
path Parameters
| packageId required | integer <int64> Document package ID |
| documentId required | integer <int64> Document ID |
| attachmentId required | integer <int64> Attachment ID of underlying attachment. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 500
{- "name": "string",
- "pages": 0,
- "size": 0
}Save Package Form Fields
Business applications can use this service API to fill one or more form fields in documents by a specified user in the order.
path Parameters
| packageId required | integer <int64> Package ID to which the document is added. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
| auto_save | 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. |
required | Array of objects (SigningHub.Web.API.Models.DocumentFormFieldsRequest) Document form fields |
Responses
Request samples
- Payload
{- "auto_save": true,
- "documents": [
- {
- "id": 0,
- "fields": {
- "text": [
- {
- "field_name": "string",
- "value": "string"
}
], - "radio": [
- {
- "field_name": "string",
- "radio_group_name": "string",
- "value": true
}
], - "checkbox": [
- {
- "field_name": "string",
- "value": true
}
], - "dropdown": [
- {
- "field_name": "string",
- "value": "string"
}
], - "listbox": [
- {
- "field_name": "string",
- "value": "string"
}
]
}
}
]
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }Fill Initials
Business applications can use this service API to fill an initials field in a document by a specified user in the order.
path Parameters
| packageId required | integer <int64> |
| documentId required | integer <int64> The ID of the document. |
header Parameters
| x-folder-id | string |
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
| field_name required | string non-empty Unique identifier of the field in the document. |
| image required | string non-empty Base64 image used for the filling of the initials. |
| method | string (SigningHub.Infrastructure.Core.Enumerations.HandSignature) Enum: "DRAW" "TEXT" "UPLOAD" "SIGNATURE_PAD" "NONE" |
| apply_to_all | boolean True if all initials are to be filled. |
Responses
Request samples
- Payload
{- "field_name": "string",
- "image": "string",
- "method": "DRAW",
- "apply_to_all": true
}Response samples
- 200
- 401
- 403
- 500
{ }Approve Document
Business applications can use this service API to approve a document by a specified user in the order.
path Parameters
| packageId required | integer <int64> The ID of the package to be approved. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
| reason | string or null The reason for approving a package. |
Responses
Request samples
- Payload
{- "reason": "string"
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }Gatekeeper Approve Document
Business applications can use this service API to gatekeeper approve a document by a specified user in the order.
path Parameters
| packageId required | integer <int64> The ID of the package to be approved. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
Request Body schema:
| reason | string or null The reason for approving a package. |
Responses
Request samples
- Payload
{- "reason": "string"
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }Decline Document
Business applications can use this service API to decline a document by a specified user in the order.
path Parameters
| packageId required | integer <int64> The ID of the package to be declined. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
| reason | string or null Reason provided by the user for declining. |
Responses
Request samples
- Payload
{- "reason": "string"
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }Gatekeeper Decline Document
Business applications can use this service API to gatekeeper decline a document by a specified user in the order.
path Parameters
| packageId required | integer <int64> The ID of the package to be declined. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| reason | string or null Reason provided by the user for declining. |
Responses
Request samples
- Payload
{- "reason": "string"
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }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.
path Parameters
| packageId required | integer <int64> The ID of the package to be finished. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 403
- 500
{ }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.
path Parameters
| packageId required | integer <int64> The SigningHub package ID that contains the document to be submitted. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{ }Bulk Recall
Business applications can use this service API to Bulk Recall document.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
| x-source | string Default: Library This is the identification of the source of the document from where the document is uploaded, e.g. "My App". |
| x-search-text | string Example: c2FsZXMgY29udHJhY3QgMTA1 Search text sent in headers for further filtration of the documents. Package id, name and document owner can be searched. |
| x-folder | string Example: SU5CT1g= Folder name from where the documents are to be fetched. Possible values are INBOX and ARCHIVE. |
Request Body schema:
The package ID for which the recall needs to be trigger.
| package_ids | Array of integers or null <int64> Ids of the document package. |
| document_status | string (SigningHub.Infrastructure.Core.Enumerations.DocumentPackageStatus) Enum: "ALL" "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" |
| package_name | string or null The name of the package. |
| recipient_from | string or null The sender who shared the document package. |
| recipient_to | string or null The recipient to whom the document package is sent. |
| document_id | integer or null <int64> Ids of the document. |
| expiry | integer or null <int32> Expiry (Days). |
| modified_from | string or null <date-time> From Modified Date. |
| modified_to | string or null <date-time> To Modified Date |
| size_from | integer or null <int32> From Size (KB) |
| size_to | integer or null <int32> To Size (KB) |
| certified_documents | boolean or null Certified signed documents |
| form_fields | boolean or null Documents that have form fields |
| attachments | boolean or null Documents that have attachments |
| document_type | string (SigningHub.Web.API.Helper.DocumentType) Enum: "ALL" "PDF" "DOCX" "XML" |
| document_statuses | Array of strings or null (SigningHub.Web.API.Helper.AllowedDocumentPackageStatus) Enum: "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" Document statuses possible values are mentioned above |
| owned_by | string (SigningHub.Infrastructure.Core.Enumerations.DocumentOwnedBy) Enum: "ME_OTHERS" "ME" "OTHERS" |
Responses
Request samples
- Payload
{- "package_ids": [
- 0
], - "document_status": "ALL",
- "package_name": "string",
- "recipient_from": "string",
- "recipient_to": "string",
- "document_id": 0,
- "expiry": 0,
- "modified_from": "2019-08-24T14:15:22Z",
- "modified_to": "2019-08-24T14:15:22Z",
- "size_from": 0,
- "size_to": 0,
- "certified_documents": true,
- "form_fields": true,
- "attachments": true,
- "document_type": "ALL",
- "document_statuses": [
- "DRAFT"
], - "owned_by": "ME_OTHERS"
}Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Get Registered Devices
This API can be used to check if a device is already registered for authorized remote signing.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 403
- 404
- 500
[- {
- "device_id": "string",
- "device_name": "string",
- "secure_element": true,
- "touch_id": true
}
]Cancel Authorize Signing Request
Applications can use this API to cancel the authorized signing request against provided transaction id.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| transaction_id required | string non-empty state that need to cancel |
Responses
Request samples
- Payload
{- "transaction_id": "string"
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }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 Bulk Action Pre Validation API.
In case you need to make changes in any of the document before signing, the Save Package 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 OTP Signing Authentication 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.
path Parameters
| bulk_action required | string (SigningHub.Infrastructure.Core.Enumerations.APIBulkSignAction) Enum: "SHARE" "SIGN" Bulk action to be performed. Possible values are: SIGN | SHARE |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-otp | string Default: 456789 OTP/TOTP used as a second factor/document signing authentication for the signing operation. |
| x-open-password | string Default: pincode123 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. |
| x-open-otp | string Default: 123456 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. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
| x-mobile | string Default: TRUE Define the originator(Web/Mobile) of the request/action |
Request Body schema:
| ids | Array of integers or null <int64> An array of the document package ids that are selected for bulk signing. |
| hand_signature_initials_image | string or null Base64 image used for the filling of the initials |
| hand_signature_initials_method | string (SigningHub.Infrastructure.Core.Enumerations.HandSignature) Enum: "DRAW" "TEXT" "UPLOAD" "SIGNATURE_PAD" "NONE" |
| hand_signature_image | string or null Base64 encoded string image of the visible signature appearance |
| hand_signature_method | string (SigningHub.Infrastructure.Core.Enumerations.HandSignature) Enum: "DRAW" "TEXT" "UPLOAD" "SIGNATURE_PAD" "NONE" |
| signing_reason | string or null Reason of signing provided by the recipient. |
| signing_location | string or null Locale of the signer provided by the recipient |
| contact_information | string or null Contact information of the signer provided by the recipient |
| appearance_design | string or null 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 | string or null Name of signing server using which the document is to be signed |
| signing_capacity | string or null Name of certification profile/signing capacity using which the document is to be signed |
object (SigningHub.Web.API.Models.BulkSignAuthentication) BulkSignAuthentication | |
| transaction_id | string or null re-initiated signing process transaction id |
Responses
Request samples
- Payload
{- "ids": [
- 0
], - "hand_signature_initials_image": "string",
- "hand_signature_initials_method": "DRAW",
- "hand_signature_image": "string",
- "hand_signature_method": "DRAW",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "appearance_design": "string",
- "signing_server": "string",
- "signing_capacity": "string",
- "authentication": {
- "mechanism": "string",
- "password": "string",
- "token": "string",
- "id": "string",
- "code_verifier": "string",
- "nonce": "string"
}, - "transaction_id": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "status": "string",
- "transaction_id": "string"
}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 Sign 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.
path Parameters
| bulk_action required | string (SigningHub.Infrastructure.Core.Enumerations.APIBulkSignAction) Enum: "SHARE" "SIGN" Bulk action to be performed. Possible values are: SIGN | SHARE |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| transaction_id | string or null The identification number of the bulk signing transaction |
Responses
Request samples
- Payload
{- "transaction_id": "string"
}Response samples
- 200
- 401
- 404
- 500
{- "status": "string",
- "packages": [
- {
- "id": 0,
- "name": "string",
- "status": "string",
- "action": "string",
- "error": "string",
- "percentage": 0,
- "documents": [
- {
- "id": 0,
- "fields": [
- {
- "name": "string",
- "hash": "string",
- "hashing_algo": "string"
}
]
}
]
}
]
}Authorization Signing Request Status
Applications can use this API to get the status of authorized signing request against provided signature field name.
path Parameters
| packageId required | integer <int64> |
| documentId required | integer <int64> |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| field_name | string or null Name of signature field. |
| skip_verification | boolean No signature verification returns in response body when it is set as true. Default value for this parameter set to false. |
Responses
Request samples
- Payload
{- "field_name": "string",
- "skip_verification": true
}Response samples
- 200
- 401
- 403
- 404
- 500
{- "status": "string",
- "verification": {
- "field_name": "string",
- "signer_name": "string",
- "signature_status": "string",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "signing_time": "string",
- "ltv": true,
- "qualified": true,
- "certified": true,
- "certify_permission": "string",
- "timestamp_at": "string",
- "timestamp_authority": "string",
- "subject_dn": "string",
- "issuer_dn": "string",
- "cert_valid_from": "string",
- "cert_valid_to": "string",
- "signature_type": "string",
- "signature_algorithm": "string",
- "signature_application": "string",
- "signature_policy_id": 0,
- "signature_policy_uri": "string",
- "signer_photo": "string",
- "signer_photo_url": "string",
- "signed_hash": "string",
- "display": "string",
- "page_number": 0,
- "lei_number": "string",
- "lei_role": "string",
- "error_message": "string"
}
}Signer Authentication via OTP (Users, In-persons, Signers)
Business applications can use this service API to generate an OTP while signing an electronic signature field or in-person field. Same service can be used to authenticate OTP for a user signing digital signature field. An OTP will be sent to the mobile number saved in user profile settings. If no phone number is found it will throw an error.
path Parameters
| packageId required | integer <int64> ID of the package to which the document is added. |
| documentId required | integer <int64> The ID of the document. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| field_name required | string non-empty Unique identifier of the field in the document. |
| method | string or null Method Possible values are "EMAIL", "SMS" |
Responses
Request samples
- Payload
{- "field_name": "string",
- "method": "string"
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }Bulk OTP Signing Authentication
Business applications can use this service API to generate an OTP while bulk signing. An OTP will be sent to the mobile number saved in user profile settings. If no phone number is found it will throw an error.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
| method | string or null Method Possible values are "EMAIL", "SMS" |
| package_id | integer or null <int64> If document signing authentication is enabled, the package ID must be provided. |
Responses
Request samples
- Payload
{- "method": "string",
- "package_id": 0
}Response samples
- 200
- 401
- 500
{ }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 Processing 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.
path Parameters
| packageId required | integer <int64> The identifier of the package that contains the document for signature. |
| documentId required | integer <int64> Identifier of the document to be signed. |
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Password Authentication". As stated above, the "Scope Authentication" cannot be used in this instance. Only the authenticated user can sign documents using this API call. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-otp | string Default: 456789 OTP used as a second factor authentication for the signing operation. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
| x-mobile | string Default: TRUE Define the originator(Web/Mobile) of the request/action |
Request Body schema:
| field_name required | string non-empty Unique identifier of the signature field in the document. |
| hand_signature_image | string or null 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 | string (SigningHub.Infrastructure.Core.Enumerations.HandSignature) Enum: "DRAW" "TEXT" "UPLOAD" "SIGNATURE_PAD" "NONE" |
| signing_reason | string or null Reason of signing provided by the recipient. Note: Commitment type indication for XML documents |
| signing_location | string or null Locale of the signer provided by the recipient. |
| contact_information | string or null Contact information of the signer provided by the recipient. |
| user_name | string or null Name of the signer provided by the recipient. Note this applies to in-person signing operations only. |
| user_password | string or null Password provided by the user subject to user's signature settings. |
| appearance_design | string or null 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 | string or null 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 | boolean No signature verification returns in response body when it is set as true. Default value for this parameter set to false. |
| signing_server | string or null Name of signing server using which the document is to be signed. |
object (SigningHub.Web.API.Models.Authentication) Authentication |
Responses
Request samples
- Payload
{- "field_name": "string",
- "hand_signature_image": "string",
- "hand_signature_method": "DRAW",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "user_name": "string",
- "user_password": "string",
- "appearance_design": "string",
- "signing_capacity": "string",
- "skip_verification": true,
- "signing_server": "string",
- "authentication": {
- "mechanism": "string",
- "password": "string",
- "token": "string",
- "id": "string",
- "code_verifier": "string",
- "nonce": "string"
}
}Response samples
- 200
- 401
- 403
- 404
- 500
{- "field_name": "string",
- "status": "string",
- "transaction_id": "string",
- "verification": {
- "field_name": "string",
- "signer_name": "string",
- "signature_status": "string",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "signing_time": "string",
- "ltv": true,
- "qualified": true,
- "certified": true,
- "certify_permission": "string",
- "timestamp_at": "string",
- "timestamp_authority": "string",
- "subject_dn": "string",
- "issuer_dn": "string",
- "cert_valid_from": "string",
- "cert_valid_to": "string",
- "signature_type": "string",
- "signature_algorithm": "string",
- "signature_application": "string",
- "signature_policy_id": 0,
- "signature_policy_uri": "string",
- "signer_photo": "string",
- "signer_photo_url": "string",
- "signed_hash": "string",
- "display": "string",
- "page_number": 0,
- "lei_number": "string",
- "lei_role": "string",
- "error_message": "string"
}, - "authentication_access_token": "string"
}Bulk Action Pre Validation
This API executes pre-signing validations for each document package and respectively returns any errors along with the list of tasks that the business application needs to perform for completing the signing process. The API call will be sent by business application and will wait for the server's response. It's a synchronous call, which means the business applications need to show a loader.
If SIGN is passed as bulk_action and package is in Draft state, Sign and Share validations will be performed automatically.
You must call this API before any other bulk signing APIs.
This call should not be skipped as it provides the necessary information to the business application regarding which dialog needs to be shown including capacities and also if there is legal notice is required or not.
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 this API returns the response according to your needs, you can then perform bulk signing via Bulk Sign Packages API.
path Parameters
| bulk_action required | string (SigningHub.Infrastructure.Core.Enumerations.APIBulkSignAction) Enum: "SHARE" "SIGN" Bulk action to be performed. Possible values are: SIGN | SHARE |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-open-authentication | string Example: PASSWORD When document opening authentication is configured, it will return the authentication type, which may include the following possible values: PASSWORD, OTP, and TOTP. |
| x-password | string Default: pincode123 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. |
| x-otp | string Default: 123456 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. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
| x-folder | string Example: SU5CT1g= Folder name from where the documents are to be fetched. Possible values are INBOX and ARCHIVE. |
| x-search-text | string Example: c2FsZXMgY29udHJhY3QgMTA1 Search text sent in headers for further filtration of the documents. Package id, name and document owner can be searched. |
| x-source | string Example: Library This is the identification of the source of the document from where the document is uploaded, e.g. "My App". |
| x-recipient-details | string Example: true If "true" is passed recipient details regarding Document Access Duration will be provided along decline information |
Request Body schema:
| ids | Array of integers or null <int64> An array of the document package ids that are selected for bulk signing. |
object (SigningHub.Web.API.Models.PreBulkSignSearchCriteria) BulkSignRequest |
Responses
Request samples
- Payload
{- "ids": [
- 0
], - "search_criteria": {
- "document_status": "ALL",
- "package_name": "string",
- "package_id": 0,
- "recipient_from": "string",
- "recipient_to": "string",
- "document_id": 0,
- "expiry": 0,
- "modified_from": "2019-08-24T14:15:22Z",
- "modified_to": "2019-08-24T14:15:22Z",
- "size_from": 0,
- "size_to": 0,
- "certified_documents": true,
- "form_fields": true,
- "attachments": true,
- "document_type": "ALL",
- "document_statuses": [
- "DRAFT"
], - "owned_by": "ME_OTHERS",
- "smart_form": "string"
}
}Response samples
- 200
- 401
- 403
- 500
{- "failed_packages": [
- {
- "id": 0,
- "error": "string",
- "package_name": "string"
}
], - "tasks": {
- "legal_notice": true,
- "initial": true,
- "signature_Inperson": true,
- "signature_Electronic": true,
- "signature_ESeal": true,
- "signature_AdESeal": true,
- "signature_QSeal": true,
- "signature_AES": true,
- "signature_AATL": true,
- "signature_QES": true,
- "invisible": "string"
}, - "success_packages": [
- {
- "id": 0,
- "approve": {
- "exists": true
}, - "submit": {
- "exists": true
}, - "finish": {
- "exists": true
}, - "initial": {
- "exists": true
}, - "inperson": [
- {
- "level_of_assurance": [
- "string"
], - "invisible": true
}
], - "signatures": [
- {
- "level_of_assurance": [
- "string"
], - "invisible": true
}
], - "electronic_seal": {
- "exists": true
}, - "signing_authentication": "string",
- "legal_notice": true,
- "package_name": "string",
- "document_type": "string"
}
]
}Pre-Bulk Local Signing
Business applications can use this service API to get D2S (data to be signed) of multiple documents and transaction id.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| ids | Array of integers or null <int64> |
| hand_signature_initials_image | string or null Base64 image used for the filling of the initials |
| hand_signature_initials_method | string (SigningHub.Infrastructure.Core.Enumerations.HandSignature) Enum: "DRAW" "TEXT" "UPLOAD" "SIGNATURE_PAD" "NONE" |
| hand_signature_image | string or null Base64 encoded string image of the visible signature appearance |
| hand_signature_method | string (SigningHub.Infrastructure.Core.Enumerations.HandSignature) Enum: "DRAW" "TEXT" "UPLOAD" "SIGNATURE_PAD" "NONE" |
| signing_reason | string or null Reason of signing provided by the recipient. |
| signing_location | string or null Locale of the signer provided by the recipient. |
| contact_information | string or null Contact information of the signer provided by the recipient. |
| appearance_design | string or null 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" |
required | object (SigningHub.Web.API.Models.SignerCertificateRequestModel) SignerCertificateRequestModel |
| signing_server required | string non-empty Name of signing server using which the document is to be signed |
| signing_capacity | string or null Name of certification profile/signing capacity using which the document is to be signed |
| transaction_id | string or null The identification number of the signing transaction |
Responses
Request samples
- Payload
{- "ids": [
- 0
], - "hand_signature_initials_image": "string",
- "hand_signature_initials_method": "DRAW",
- "hand_signature_image": "string",
- "hand_signature_method": "DRAW",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "appearance_design": "string",
- "signer_certificate": {
- "signer": "string",
- "intermediate": "string"
}, - "signing_server": "string",
- "signing_capacity": "string",
- "transaction_id": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "transaction_id": "string",
- "status": "string",
- "failed_packages": [
- {
- "id": 0,
- "error": "string"
}
]
}Post-Bulk Local Signing
Business applications can use this service API to perform signature assembly and signature embedding process.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
Array of objects or null (SigningHub.Web.API.Models.RawSignatureListModel) | |
| transaction_id | string or null |
Responses
Request samples
- Payload
{- "raw_signatures": [
- {
- "package_id": 0,
- "document_id": 0,
- "field_name": "string",
- "raw_signature": "string"
}
], - "transaction_id": "string"
}Response samples
- 400
- 401
- 403
- 404
- 500
{- "Message": "string"
}Signature Pad Initialize
Business applications can use this service API to initialize get signature pad license.
query Parameters
| type | string (SigningHub.Infrastructure.Core.Enumerations.SignaturePadType) Value: "WACOM" The type of signature pad |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| access_token required | string non-empty It's bearer token provided by setLicenseProxy method of signature_sdk.js library |
Responses
Request samples
- Payload
{- "access_token": "string"
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "token": "string"
}Download T1C Setup
Business applications can use this service API to download T1C setup.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-os | string Example: SU5CT1g= TC1 setup can be download based on OS type, recommended value for x-os parameter is in Base64 encoded format. |
Responses
Response samples
- 200
- 400
- 401
- 500
0Recall 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”.
path Parameters
| packageId required | integer <int64> The ID of the package to be recalled. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }This section entails the web services for the Artificial Intelligence i.e. Get AI features and execute the relevant features.
Artificial Intelligence (AI) Execute Feature
Business applications can use this service API to execute artificial intelligence feature.
path Parameters
| packageId required | integer <int64> Package Id |
| feature required | string Feature Id |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
| x-password | string Example: pincode123 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. |
| x-otp | string Example: 123456 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. |
Request Body schema:
Request data
required | Array of objects (SigningHub.Infrastructure.Core.DataModels.Custom.ArtificialIntelligenceDocuments) documents |
Responses
Request samples
- Payload
{- "documents": [
- {
- "id": 0,
- "pages": [
- {
- "number": 0
}
]
}
]
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "response": "string"
}Artificial Intelligence (AI) Features
Business applications can use this service API to get artificial intelligence features.
path Parameters
| packageId required | integer <int64> Package Id |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
| x-password | string Example: pincode123 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. |
| x-otp | string Example: 123456 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. |
Responses
Response samples
- 200
- 401
- 403
- 500
{- "features": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "disclaimer": "string"
}
]
}This section entails the web services for the Cloud Signature Consortium (CSC) Signing.
Get Document Hash
Business applications can use this service API to get D2S (data to be signed) of PDF/XML document.
path Parameters
| packageId required | integer <int64> The identifier of the package that contains the document for signature. |
| documentId required | integer <int64> Identifier of the document to be signed. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
Data that need to get document hash
| field_name required | string non-empty Unique identifier of the signature field in the document. |
| hand_signature_image | string or null 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 | string (SigningHub.Infrastructure.Core.Enumerations.HandSignature) Enum: "DRAW" "TEXT" "UPLOAD" "SIGNATURE_PAD" "NONE" |
| signing_reason | string or null Reason of signing provided by the recipient. |
| signing_location | string or null Locale of the signer provided by the recipient. |
| contact_information | string or null Contact information of the signer provided by the recipient. |
| appearance_design | string or null 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" |
| certificates required | Array of strings List of certificates Base64 obtained from credentials/info response |
| signing_server required | string non-empty Name of RSSP (remote signing service provider) |
| signing_algo required | string non-empty Signing algo that is obtained from credentials/info response as key/algo |
Responses
Request samples
- Payload
{- "field_name": "string",
- "hand_signature_image": "string",
- "hand_signature_method": "DRAW",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "appearance_design": "string",
- "certificates": [
- "string"
], - "signing_server": "string",
- "signing_algo": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "hash": "string",
- "state": "string",
- "hashing_algo": "string"
}Embed Signature
Business applications can use this service API to embed signature in PDF/XML document.
path Parameters
| packageId required | integer <int64> The identifier of the package that contains the document for signature. |
| documentId required | integer <int64> Identifier of the document to be signed. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-base64 required | string Default: true True if response should have images in base64 format. False will only return the resource URLs in response. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
Data that need to embed signature into the document
| field_name required | string non-empty Unique identifier of the signature field in the document. |
| signing_server required | string non-empty Name of RSSP (remote signing service provider) |
| signature required | string non-empty Base64-encoded signed hash that get in the response of RSSP (remote signing service provider) request signatures/signHash |
| credential_id required | string non-empty The unique identifier associated to the credential. |
| skip_verification | boolean No signature verification returns in response body when it is set as true. Default value for this parameter set to false. |
| state required | string non-empty Unique alphanumeric value per transaction |
Responses
Request samples
- Payload
{- "field_name": "string",
- "signing_server": "string",
- "signature": "string",
- "credential_id": "string",
- "skip_verification": true,
- "state": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "field_name": "string",
- "verification": {
- "field_name": "string",
- "signer_name": "string",
- "signature_status": "string",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "signing_time": "string",
- "ltv": true,
- "qualified": true,
- "certified": true,
- "certify_permission": "string",
- "timestamp_at": "string",
- "timestamp_authority": "string",
- "subject_dn": "string",
- "issuer_dn": "string",
- "cert_valid_from": "string",
- "cert_valid_to": "string",
- "signature_type": "string",
- "signature_algorithm": "string",
- "signature_application": "string",
- "signature_policy_id": 0,
- "signature_policy_uri": "string",
- "signer_photo": "string",
- "signer_photo_url": "string",
- "signed_hash": "string",
- "display": "string",
- "page_number": 0,
- "lei_number": "string",
- "lei_role": "string",
- "error_message": "string"
}
}Get Account Token
Business applications can use this service API to get access token which is needed to resolve restricted access to authorization servers.
query Parameters
| signing_server | string RSSP (remote signing service provider) name. It must be URL encoded string to handle special characters. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "account_token": "string"
}Revoke OAuth2 Access Token
Business applications can use this service API to revoke access token of RSSP (remote signing service provider).Use this API when Access Token need to be revoked by oauth2/revoke end-point.
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
Data that need to revoke access token
| access_token required | string non-empty The token that the signature application wants to get revoked. |
| oauth2_url required | string non-empty The base URI of the OAuth 2.0 authorization server endpoint supported by the remote service for service authorization and/or credential authorization. |
| signing_server required | string non-empty Name of RSSP (remote signing service provider) |
Responses
Request samples
- Payload
{- "access_token": "string",
- "oauth2_url": "string",
- "signing_server": "string"
}Response samples
- 200
- 400
- 401
- 403
- 500
{ }Sign Document via RSSP Directly
Business applications can use this service API to sign PDF/XML document when SCAL is 1 in credentials/info response.This API will generate D2S (data to be signed), get signature from RSSP (remote signing service provider) directly and then perform signature embedding.
path Parameters
| packageId required | integer <int64> The identifier of the package that contains the document for signature. |
| documentId required | integer <int64> Identifier of the document to be signed. |
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-base64 required | string Default: true True if response should have images in base64 format. False will only return the resource URLs in response. |
| x-folder-id | string Default: 0 Specify the folder ID, for retrieving the folder items, when a shared space folder is involved. |
Request Body schema:
Data that need to sign document via RSSP (remote signing service provider)
| access_token | string or null Bearer token return by authorization server |
| field_name required | string non-empty Unique identifier of the signature field in the document. |
| signing_server required | string non-empty Name of RSSP (remote signing service provider) |
| credential_id required | string non-empty The unique identifier associated to the credential. |
| skip_verification | boolean No signature verification returns in response body when it is set as true. Default value for this parameter set to false. |
| hand_signature_image | string or null 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 | string (SigningHub.Infrastructure.Core.Enumerations.HandSignature) Enum: "DRAW" "TEXT" "UPLOAD" "SIGNATURE_PAD" "NONE" |
| signing_reason | string or null Reason of signing provided by the recipient. |
| signing_location | string or null Locale of the signer provided by the recipient. |
| contact_information | string or null Contact information of the signer provided by the recipient. |
| appearance_design | string or null 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" |
| certificates required | Array of strings List of certificates Base64 obtained from credentials/info response |
| sad required | string non-empty SAD return by RSSP (remote signing service provider) after credential authorization |
| signing_algo required | string non-empty signing algo that is obtained from credentials/info response as key/algo |
Responses
Request samples
- Payload
{- "access_token": "string",
- "field_name": "string",
- "signing_server": "string",
- "credential_id": "string",
- "skip_verification": true,
- "hand_signature_image": "string",
- "hand_signature_method": "DRAW",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "appearance_design": "string",
- "certificates": [
- "string"
], - "sad": "string",
- "signing_algo": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "field_name": "string",
- "verification": {
- "field_name": "string",
- "signer_name": "string",
- "signature_status": "string",
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "signing_time": "string",
- "ltv": true,
- "qualified": true,
- "certified": true,
- "certify_permission": "string",
- "timestamp_at": "string",
- "timestamp_authority": "string",
- "subject_dn": "string",
- "issuer_dn": "string",
- "cert_valid_from": "string",
- "cert_valid_to": "string",
- "signature_type": "string",
- "signature_algorithm": "string",
- "signature_application": "string",
- "signature_policy_id": 0,
- "signature_policy_uri": "string",
- "signer_photo": "string",
- "signer_photo_url": "string",
- "signed_hash": "string",
- "display": "string",
- "page_number": 0,
- "lei_number": "string",
- "lei_role": "string",
- "error_message": "string"
}
}Get Access Token | SAD
Business applications can use this service API to get Access Token (Bearer) | SAD to make authorized calls and get signature respectively from RSSP (remote signing service provider).
header Parameters
| Authorization required | string Default: Bearer {access_token} The OAuth access token obtained as a result of successful authentication via the "password" grant type. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
Data that need to get Access Token | SAD
| code | string or null U |