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.
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)
- 10.0
-
Following is the list of updates in older versions
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
|
SSL 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
|
Kerberos 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
|
|
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 post_processing_all_recipient at document_settings > owner_settings object which provide information for post processing. | |
|
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 post_processing_all_recipient at document_settings > owner_settings object which provide information for post processing. | |
|
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 post_processing_all_recipient at document_settings > owner_settings object which provide information for post processing. | |
|
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 post_processing_all_recipient at document_settings > owner_settings object which provide information for post processing. | |
|
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
|
|
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/json |
| Accept required | string Default: application/json |
| Content-Type | string Default: application/x-www-form-urlencoded |
| x-scim | string Default: false Set to True if the generated access token should be SCIM supported |
Request Body schema: multipart/form-data
| 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 OAuth 2.0 access_token
header Parameters
| Accept required | string Default: application/json |
| Content-Type | string Default: application/x-www-form-urlencoded |
Request Body schema: multipart/form-data
| 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 required | 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 required | 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:
| user_email required | string non-empty Scope user email address |
Responses
Request samples
- Payload
{- "user_email": "string"
}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:
| profile_name | string |
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} 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:
| token | string Token obtained from 3rd party e.g Office 365, Azure Active Directory, OAuth 2, OIDC |
| code | string Code obtained from OAuth2 or OIDC (authorize response) |
| method required | string non-empty Supported method type Possible values are "OFFICE_365", "AZURE_ACTIVE_DIRECTORY", "OAUTH2", "OIDC" |
| profile_name | string 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 required | integer <int32> Authentication profile id, required for "OAUTH2" and "OIDC". 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 Redirect URL |
| code_verifier | string Code Verifier if PKCE is enabled for the client. |
| nonce | string 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 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 Method Possible values are "EMAIL", "SMS" |
Responses
Request samples
- Payload
{- "mobile_number": "string",
- "method": "string"
}Response samples
- 200
- 400
- 401
- 403
- 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
| 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 |
| Accept required | string Default: application/json |
| Content-Type | string Default: application/x-www-form-urlencoded |
Request Body schema: multipart/form-data
| 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 |
Request Body schema:
| device_token | string 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
- 403
- 404
- 500
{ }SSL Authentication
User can authenticate using his certificate. The browser will prompt to select the certificate.
header Parameters
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| profile_name | string 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",
- "authentication_access_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 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": 1
}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 required | string SAML Profile Name. |
| session_index required | string Session Index created at the time of log-in. |
| email required | 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 required | string |
| email required | 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"BankID Authentication
This API can be used to authenticate to SigningHub User using BankID.
The profile name and email are mandatory parameters and required to be passed from caller application.
The response is a JWT token on accepted the request from app
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 BankId Profile Name |
| success_url required | string non-empty Success Url |
| error_url | string Error Url |
| abort_url | string Abort Url |
| language | string User language in authentication dialog |
Responses
Request samples
- Payload
{- "profile_name": "string",
- "success_url": "string",
- "error_url": "string",
- "abort_url": "string",
- "language": "string"
}Response samples
- 200
- 500
{- "authentication_url": "string",
- "request_id": "string"
}Itsme Authentication
This API can be used to authenticate to SigningHub User using Itsme.
The profile name and email are mandatory parameters and required to be passed from caller application.
The response is a JWT token on accepted the request from app
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 Itsme Profile Name |
| callback_url required | string non-empty Callback URL to get the response |
| language | string User language in authentication dialog |
Responses
Request samples
- Payload
{- "profile_name": "string",
- "callback_url": "string",
- "language": "string"
}Response samples
- 200
- 403
- 408
- 500
{- "authentication_url": "string",
- "transaction_token": "string"
}Verisec Mobile Authentication
This API can be used to authenticate to SigningHub User using Verisec Mobile.
The profile name and email are mandatory parameters and required to be passed from caller application.
The response is a JWT token on accepted the request from app
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:
| email required | string non-empty Email address of the user |
| profile_name required | string non-empty Profile name |
| is_signing required | boolean True, in case of signing |
| package_id required | integer <int64> Document package Id |
| document_owner | string Document package owner name |
| language | string User language in authentication dialog |
Responses
Request samples
- Payload
{- "email": "string",
- "profile_name": "string",
- "is_signing": true,
- "package_id": 0,
- "document_owner": "string",
- "language": "string"
}Response samples
- 200
- 403
- 408
- 500
{- "Actor": "string",
- "Audiences": [
- "string"
], - "Claims": [
- {
- "Issuer": "string",
- "OriginalIssuer": "string",
- "Properties": {
- "property1": "string",
- "property2": "string"
}, - "Subject": {
- "AuthenticationType": "string",
- "IsAuthenticated": true,
- "Actor": { },
- "BootstrapContext": null,
- "Claims": [
- { }
], - "Label": "string",
- "Name": "string",
- "NameClaimType": "string",
- "RoleClaimType": "string"
}, - "Type": "string",
- "Value": "string",
- "ValueType": "string"
}
], - "EncodedHeader": "string",
- "EncodedPayload": "string",
- "Header": {
- "property1": null,
- "property2": null,
- "ClassName": "string",
- "Alg": "string",
- "Cty": "string",
- "Enc": "string",
- "EncryptingCredentials": {
- "Alg": "string",
- "Enc": "string",
- "KeyExchangePublicKey": {
- "KeyId": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}
}, - "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}, - "SetDefaultCtyClaim": true,
- "Key": {
- "KeyId": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}
}
}, - "IV": "string",
- "Kid": "string",
- "SigningCredentials": {
- "Algorithm": "string",
- "Digest": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}, - "Key": {
- "KeyId": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}
}, - "Kid": "string"
}, - "Typ": "string",
- "X5t": "string",
- "X5c": "string",
- "Zip": "string"
}, - "Id": "string",
- "Issuer": "string",
- "Payload": {
- "property1": null,
- "property2": null,
- "_audiences": [
- "string"
], - "_azp": "string",
- "_exp": 0,
- "_expDateTime": "2019-08-24T14:15:22Z",
- "_iat": 0,
- "_iatDateTime": "2019-08-24T14:15:22Z",
- "_id": "string",
- "_iss": "string",
- "_jti": "string",
- "_nbf": 0,
- "_nbfDateTime": "2019-08-24T14:15:22Z",
- "_sub": "string",
- "_tid": "string",
- "Actort": "string",
- "Acr": "string",
- "Amr": [
- "string"
], - "AuthTime": 0,
- "Aud": [
- "string"
], - "Azp": "string",
- "CHash": "string",
- "Expiration": 0,
- "Jti": "string",
- "Iss": "string",
- "Nonce": "string",
- "NotBefore": 0,
- "Sub": "string",
- "ValidFrom": "2019-08-24T14:15:22Z",
- "ValidTo": "2019-08-24T14:15:22Z",
- "IssuedAt": "2019-08-24T14:15:22Z",
- "Claims": [
- {
- "Issuer": "string",
- "OriginalIssuer": "string",
- "Properties": {
- "property1": "string",
- "property2": "string"
}, - "Subject": {
- "AuthenticationType": "string",
- "IsAuthenticated": true,
- "Actor": { },
- "BootstrapContext": null,
- "Claims": [
- { }
], - "Label": "string",
- "Name": "string",
- "NameClaimType": "string",
- "RoleClaimType": "string"
}, - "Type": "string",
- "Value": "string",
- "ValueType": "string"
}
]
}, - "InnerToken": null,
- "RawAuthenticationTag": "string",
- "RawCiphertext": "string",
- "RawData": "string",
- "RawEncryptedKey": "string",
- "RawInitializationVector": "string",
- "RawHeader": "string",
- "RawPayload": "string",
- "RawSignature": "string",
- "SecurityKey": {
- "KeyId": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}
}, - "SignatureAlgorithm": "string",
- "SigningCredentials": {
- "Algorithm": "string",
- "Digest": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}, - "Key": {
- "KeyId": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}
}, - "Kid": "string"
}, - "EncryptingCredentials": {
- "Alg": "string",
- "Enc": "string",
- "KeyExchangePublicKey": {
- "KeyId": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}
}, - "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}, - "SetDefaultCtyClaim": true,
- "Key": {
- "KeyId": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}
}
}, - "SigningKey": {
- "KeyId": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}
}, - "Subject": "string",
- "ValidFrom": "2019-08-24T14:15:22Z",
- "ValidTo": "2019-08-24T14:15:22Z",
- "IssuedAt": "2019-08-24T14:15:22Z"
}Verisec EID Authentication
This API can be used to authenticate to SigningHub User using Verisec e-id.
The profile name and email are mandatory parameters and required to be passed from caller application.
The response is a JWT token on accepted the request from app
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:
| email required | string non-empty Email address of the user. |
| profile_name | string Profile Name |
Responses
Request samples
- Payload
{- "email": "string",
- "profile_name": "string"
}Response samples
- 200
- 403
- 408
- 500
{- "Actor": "string",
- "Audiences": [
- "string"
], - "Claims": [
- {
- "Issuer": "string",
- "OriginalIssuer": "string",
- "Properties": {
- "property1": "string",
- "property2": "string"
}, - "Subject": {
- "AuthenticationType": "string",
- "IsAuthenticated": true,
- "Actor": { },
- "BootstrapContext": null,
- "Claims": [
- { }
], - "Label": "string",
- "Name": "string",
- "NameClaimType": "string",
- "RoleClaimType": "string"
}, - "Type": "string",
- "Value": "string",
- "ValueType": "string"
}
], - "EncodedHeader": "string",
- "EncodedPayload": "string",
- "Header": {
- "property1": null,
- "property2": null,
- "ClassName": "string",
- "Alg": "string",
- "Cty": "string",
- "Enc": "string",
- "EncryptingCredentials": {
- "Alg": "string",
- "Enc": "string",
- "KeyExchangePublicKey": {
- "KeyId": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}
}, - "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}, - "SetDefaultCtyClaim": true,
- "Key": {
- "KeyId": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}
}
}, - "IV": "string",
- "Kid": "string",
- "SigningCredentials": {
- "Algorithm": "string",
- "Digest": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}, - "Key": {
- "KeyId": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}
}, - "Kid": "string"
}, - "Typ": "string",
- "X5t": "string",
- "X5c": "string",
- "Zip": "string"
}, - "Id": "string",
- "Issuer": "string",
- "Payload": {
- "property1": null,
- "property2": null,
- "_audiences": [
- "string"
], - "_azp": "string",
- "_exp": 0,
- "_expDateTime": "2019-08-24T14:15:22Z",
- "_iat": 0,
- "_iatDateTime": "2019-08-24T14:15:22Z",
- "_id": "string",
- "_iss": "string",
- "_jti": "string",
- "_nbf": 0,
- "_nbfDateTime": "2019-08-24T14:15:22Z",
- "_sub": "string",
- "_tid": "string",
- "Actort": "string",
- "Acr": "string",
- "Amr": [
- "string"
], - "AuthTime": 0,
- "Aud": [
- "string"
], - "Azp": "string",
- "CHash": "string",
- "Expiration": 0,
- "Jti": "string",
- "Iss": "string",
- "Nonce": "string",
- "NotBefore": 0,
- "Sub": "string",
- "ValidFrom": "2019-08-24T14:15:22Z",
- "ValidTo": "2019-08-24T14:15:22Z",
- "IssuedAt": "2019-08-24T14:15:22Z",
- "Claims": [
- {
- "Issuer": "string",
- "OriginalIssuer": "string",
- "Properties": {
- "property1": "string",
- "property2": "string"
}, - "Subject": {
- "AuthenticationType": "string",
- "IsAuthenticated": true,
- "Actor": { },
- "BootstrapContext": null,
- "Claims": [
- { }
], - "Label": "string",
- "Name": "string",
- "NameClaimType": "string",
- "RoleClaimType": "string"
}, - "Type": "string",
- "Value": "string",
- "ValueType": "string"
}
]
}, - "InnerToken": null,
- "RawAuthenticationTag": "string",
- "RawCiphertext": "string",
- "RawData": "string",
- "RawEncryptedKey": "string",
- "RawInitializationVector": "string",
- "RawHeader": "string",
- "RawPayload": "string",
- "RawSignature": "string",
- "SecurityKey": {
- "KeyId": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}
}, - "SignatureAlgorithm": "string",
- "SigningCredentials": {
- "Algorithm": "string",
- "Digest": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}, - "Key": {
- "KeyId": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}
}, - "Kid": "string"
}, - "EncryptingCredentials": {
- "Alg": "string",
- "Enc": "string",
- "KeyExchangePublicKey": {
- "KeyId": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}
}, - "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}, - "SetDefaultCtyClaim": true,
- "Key": {
- "KeyId": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}
}
}, - "SigningKey": {
- "KeyId": "string",
- "CryptoProviderFactory": {
- "CryptoProviderCache": { },
- "CustomCryptoProvider": { },
- "CacheSignatureProviders": true,
- "SignatureProviderObjectPoolCacheSize": 0
}
}, - "Subject": "string",
- "ValidFrom": "2019-08-24T14:15:22Z",
- "ValidTo": "2019-08-24T14:15:22Z",
- "IssuedAt": "2019-08-24T14:15:22Z"
}This section entails the web services for the Document Package related operations i.e. Add, Delete, Download, and Share.
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
}
}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) | 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"
}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
{ }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:
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 The name of the package. Default package name is always "Untitled" if the package_name is not provided. |
| workflow_mode required | string Enum: "ME_AND_OTHERS" "ONLY_OTHERS" "ONLY_ME" |
| folder_name | string The name of the folder. It will be used to upload package in any folder of the user, either it is a custom folder or a shared folder. |
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 <int64> [ items <int64 > ] Ids of the document package. |
| document_status | string Enum: "ALL" "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" |
| package_name | string The name of the package. |
| recipient_from | string The sender who shared the document package. |
| recipient_to | string The recipient to whom the document package is sent. |
| document_id | integer <int64> Ids of the document. |
| 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 Certified signed documents |
| form_fields | boolean Documents that have form fields |
| attachments | boolean Documents that have attachments |
| document_type | string Enum: "ALL" "PDF" "DOCX" "XML" |
| document_statuses | Array of strings (AllowedDocumentPackageStatus) Items Enum: "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" Document statuses possible values are mentioned above |
| owned_by | string 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 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 Enum: "ALL" "PDF" "DOCX" "XML" Filter by document type possible values are mentioned above |
| document-statuses | Array of strings (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 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
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 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 Default: "ALL" Enum: "ALL" "PDF" "DOCX" "XML" Document Type like XML, PDF, DOCX etc |
| sort-by | string Default: "LAST_MODIFIED" 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 (AllowedDocumentPackageStatus) Items Enum: "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" Document Type |
| owned-by | string Default: "ME_OTHERS" 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: 212 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 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 Default: "ALL" Enum: "ALL" "PDF" "DOCX" "XML" Document Type like XML, PDF, DOCX etc |
| sort-by | string Default: "LAST_MODIFIED" 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 (AllowedDocumentPackageStatus) Items Enum: "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" Document Type |
| owned-by | string Default: "ME_OTHERS" 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 The dimensions of the text field | |
| 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
}
}, - "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 (SendEmailOnFinishDocumentRecipient) The recipients to whom the email has to be sent. |
| message | string <= 255 characters Email message |
Responses
Request samples
- Payload
{- "recipients": [
- {
- "name": "string",
- "email": "string"
}
], - "message": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }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 Keep signed signatures. Default value for this parameter set to true. |
| attachments | boolean Keep attachments. Default value for this parameter set to true. |
| conformance_level | boolean 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. |
| Accept required | string Default: application/json |
| Content-Type | string Default: application/octet-stream |
| 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) | string <binary> Default: "" This is the document in the raw binary format. |
Responses
Response samples
- 201
- 400
- 401
- 403
- 500
{- "documentId": 0,
- "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"
}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. |
| Accept required | string Default: application/json |
| Content-Type | string Default: application/octet-stream |
| 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,
- "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"
}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. |
| Accept required | string Default: application/json |
| Content-Type | 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,
- "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"
}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. |
| Accept required | string Default: application/json |
| Content-Type | string Default: application/octet-stream |
| 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) | string <binary> Default: "" This is the document in the raw binary format. |
Responses
Response samples
- 201
- 400
- 401
- 403
- 500
{- "documentId": 0,
- "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"
}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:
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:
This is the document in the raw binary format.
Responses
Request samples
- Payload
""Response samples
- 200
- 400
- 401
- 403
- 500
{- "documentId": 0,
- "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"
}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/json |
| Accept required | string Default: application/json |
| Content-Type | string Default: application/octet-stream |
| 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) | string <binary> Default: "" This is the document in the raw binary format. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "documentId": 0,
- "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"
}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 Certify settings object for the document. | |
| lock_form_fields required | 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> Page number in the document for which the thumbnails is requested.Its optional, default value is 1 |
| 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-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 required | integer <int32> New order of the document in the package. |
Responses
Request samples
- Payload
{- "order": 0
}Response samples
- 200
- 403
- 500
{- "package_name": "string"
}This section entails the web services for the Document Workflow related operations i.e. Get Details, Add/Update Users, and Permissions.
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 <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 <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"
}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 <int64> The ID of the Document that has been shared. |
| package_id | integer <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 Indicating response should be encoded or plan.Possible values are ENCODED, PLAIN |
| callback_url | string 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 It is required when a Guest user has to process the document. |
| collapse_panels | string 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 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 <int64> The user custom certificate Id. |
| section | string 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" "SMART_FORM" "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" |
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"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 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 <int64> [ items <int64 > ] Ids of the document package. |
| document_status | string Enum: "ALL" "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" |
| package_name | string The name of the package. |
| recipient_from | string The sender who shared the document package. |
| recipient_to | string The recipient to whom the document package is sent. |
| document_id | integer <int64> Ids of the document. |
| 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 Certified signed documents |
| form_fields | boolean Documents that have form fields |
| attachments | boolean Documents that have attachments |
| document_type | string Enum: "ALL" "PDF" "DOCX" "XML" |
| document_statuses | Array of strings (AllowedDocumentPackageStatus) Items Enum: "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" Document statuses possible values are mentioned above |
| owned_by | string 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 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
}
}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 It has all the permissions to be allowed in the workflow |
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
}
}
}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 required | boolean True, if the access security or authentications are to be applied on all the recipients in the workflow. |
required | object It has the access aauthentication data |
object It has the signing authentication data | |
required | object It has the access duration of the workflow |
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
{ }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 Enum: "SERIAL" "INDIVIDUAL" "PARALLEL" "CUSTOM" |
| workflow_mode | string Enum: "ME_AND_OTHERS" "ONLY_OTHERS" "ONLY_ME" |
| continue_on_decline | boolean True, if workflow needs to continue even if any recipient declines the document. If no value is provided, old value will be retained. |
| message | string A custom string message from the document owner to every recipient, this message appears in the sharing email as well as on the screen. If no value is provided, old value will be retained. |
| comments | boolean 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
}
}, - "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 |
Array of objects (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 <= 1500 characters A custom string message for all the contacts. Message becomes part of the email sent to the contacts. |
| google_drive | boolean True, if document is to be uploaded to the provided google account after the workflow completion. |
| dropbox | boolean True, if document is to be uploaded to the provided dropbox account after the workflow completion. |
| onedrive | boolean True, if document is to be uploaded to the provided oneDrive account after the workflow completion. |
| workflow_recipients required | 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 required | 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 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 User national id of the recipient |
| email_notification required | 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 required | string Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" "ELECTRONIC_SEAL" |
| signing_order | integer <int32> Order of the recipient in the workflow. This signing order is mandatory when workflow type is "CUSTOM". |
| delivery_method required | string Enum: "EMAIL" "SMS" "EMAIL_AND_SMS" |
| mobile_number | string <= 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
}
}, - "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 The name of the new group to be added in workflow. |
| email_notification required | 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 required | string Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" "ELECTRONIC_SEAL" |
| signing_order | integer <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
}
}, - "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 The name of the new placeholder to be added in workflow. |
| email_notification required | 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 required | string Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" "ELECTRONIC_SEAL" |
| signing_order | integer <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
}
}, - "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 The name of the new placeholder to be added in workflow. If no value is provided, old value will be retained. |
| email_notification | boolean Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn. If no value is provided, old value will be retained. |
| role required | string Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" |
| signing_order | integer <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 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 Name of the recipient to be updated. If no value is provided, old value will be retained. |
| email_notification | boolean Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn. If no value is provided, old value will be retained. |
| mobile_number | string <= 15 characters Mobile number. If no value is provided, old value will be retained. |
| role required | string Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" |
| signing_order | integer <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 email language code |
| delivery_method required | string 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 The name of the group to be updated in workflow. If no value is provided, old value will be retained. |
| email_notification | boolean 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 |
| mobile_number | string |
| role required | string Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" |
| signing_order | integer <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 required | boolean True, if reminder settings are to be applied on all the recipients in the workflow. |
| enabled required | boolean True, if reminder settings are to be enabled. |
| frequency | string Reminder Frequency. Possible Values are DAYS | HOURS. |
| remind_after required | 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 The reminders would be sent to user repeatedly. |
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
}
}, - "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> Page number to be retrieved. |
| recordsPerPage required | integer <int32> 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"
}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 |
| x-file-name required | string Example: recipients.csv It's the name of file with extension. |
Request Body schema: multipart/form-data
| file (binary Stream) | string <binary> This is the recipient document in CSV format, posting via form data. |
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 web-hook
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 <int64> [ items <int64 > ] Array of document package ids. |
| error_code | string Error code of GoSign service error. |
| error_message | string Error message of GoSign service error message. |
| signing_server | string 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 required | boolean If document owner is included in everyone's drop down but not a part of workflow collaborators |
| order | Array of integers <int32> [ items <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"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 Base64 encoded string image of the visible signature appearance |
| hand_signature_method | integer Enum: 0 1 2 3 4 0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE |
| signing_reason | string Reason of signing provided by the recipient. |
| signing_location | string Locale of the signer provided by the recipient. |
| contact_information | string Contact information of the signer provided by the recipient. |
| appearance_design | string Name of the signature appearance provided by user for signing. In case no appearance name is provided then default selected appearance would be used. Possible values are "COMPANY_LOGO", "DETAILED_SIGNATURE", "HAND_SIGNATURE" |
| signing_server 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": 0,
- "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
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| signer_name | string |
| signer_idcode | string |
| signing_method | string |
| host | string |
| signing_time | string |
| doc_id | string |
| notification_state | string |
Responses
Request samples
- Payload
{- "signer_name": "string",
- "signer_idcode": "string",
- "signing_method": "string",
- "host": "string",
- "signing_time": "string",
- "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 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"
}
}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 Base64 encoded string image of the visible signature appearance. |
| hand_signature_method | integer Enum: 0 1 2 3 4 0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE |
| signing_reason | string Reason of signing provided by the recipient. |
| signing_location | string Locale of the signer provided by the recipient. |
| contact_information | string Contact information of the signer provided by the recipient. |
| appearance_design | string Name of the signature appearance provided by user for signing. In case no appearance name is provided then default selected appearance would be used. Possible values are "COMPANY_LOGO", "DETAILED_SIGNATURE", "HAND_SIGNATURE" |
required | object (SignerCertificateRequestModel) |
| signing_server required | string non-empty Name of signing server using which the document is to be signed |
| transaction_id | string The identification number of the signing transaction |
Responses
Request samples
- Payload
{- "field_name": "string",
- "hand_signature_image": "string",
- "hand_signature_method": 0,
- "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 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 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"
}
]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 Method Possible values are "EMAIL", "SMS" |
Responses
Request samples
- Payload
{- "method": "string"
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }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 <int64> [ items <int64 > ] |
| hand_signature_initials_image | string Base64 image used for the filling of the initials |
| hand_signature_initials_method | integer (HandSignature) Enum: 0 1 2 3 4 0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE |
| hand_signature_image | string Base64 encoded string image of the visible signature appearance |
| hand_signature_method | integer (HandSignature) Enum: 0 1 2 3 4 0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE |
| signing_reason | string Reason of signing provided by the recipient. |
| signing_location | string Locale of the signer provided by the recipient. |
| contact_information | string Contact information of the signer provided by the recipient. |
| appearance_design | string Name of the signature appearance provided by user for signing. In case no appearance name is provided then default selected appearance would be used. Possible values are "COMPANY_LOGO", "DETAILED_SIGNATURE", "HAND_SIGNATURE" |
required | object (SignerCertificateRequestModel) |
| signing_server required | string non-empty Name of signing server using which the document is to be signed |
| signing_capacity | string Name of certification profile/signing capacity using which the document is to be signed |
| transaction_id | string The identification number of the signing transaction |
Responses
Request samples
- Payload
{- "ids": [
- 0
], - "hand_signature_initials_image": "string",
- "hand_signature_initials_method": 0,
- "hand_signature_image": "string",
- "hand_signature_method": 0,
- "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 (RawSignatureListModel) | |
| transaction_id | string |
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"
}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 <int64> [ items <int64 > ] Packages ids |
| folder_name required | string [ 1 .. 255 ] characters Target folder name in which packages need to move |
| document_status | string Enum: "ALL" "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" |
| package_name | string The name of the package. |
| recipient_from | string The sender who shared the document package. |
| recipient_to | string The recipient to whom the document package is sent. |
| document_id | integer <int64> Ids of the document. |
| 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 Certified signed documents |
| form_fields | boolean Documents that have form fields |
| attachments | boolean Documents that have attachments |
| document_type | string Enum: "ALL" "PDF" "DOCX" "XML" |
| document_statuses | Array of strings (AllowedDocumentPackageStatus) Items Enum: "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" Document statuses possible values are mentioned above |
| owned_by | string 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
{ }This section entails the web services for the Document Preparation i.e. Add/Update/Delete Fields.
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 Field dimensions |
Array of objects (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> 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> 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
}
}
}
]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 provide group name for radio box |
| order required | integer <int32> The order of the user in workflow, to which the field is being assigned. |
| level_of_assurance | Array of strings 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 Word that needs to be searched in the document. |
| order required | 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 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 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 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" |
object Dimensions of a field to be created in the document. X and Y location is calculated automatically. API can only configure width and height for the field. If dimensions are not provided default dimensions will be followed. that is 200 x 80 in pixels. | |
| placeholder | string Provide note in the case of Mandatory Attachment |
| radio_group_name | string The group name required only when adding a Radio Box type field to group multiple Radio boxes together. |
| format | string Text format of the field. Used for the date type field only. Possible values are
|
| value | string Value that user want to show in the field. |
| max_length required | integer <int32> Maximum length of the value allowed in the field. Must between 1 - 9999 |
| validation_rule | string One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL". |
object Validations | |
object Font of the fields text | |
| multiline required | 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
{ }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> 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": [
- {
- "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": "L",
- "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 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 <= 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 (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 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 <= 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 Enum: "OPTIONAL" "MANDATORY" |
| note | string Attachment note in case of Mandatory attachment |
required | object (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",
- "created_on": "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 <= 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 Enum: "OPTIONAL" "MANDATORY" |
| note | string <= 500 characters Attachment note in case of Mandatory attachment |
required | object (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 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 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 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 (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",
- "created_on": "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 Updated name of the field if renaming is intended. |
| page_no required | integer <int32> Page number on which the field is to be created. |
required | object (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 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 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 (FieldDimension) |
| display | string Visibility of the field that is to be added, possible values are "VISIBLE" and "INVISIBLE" |
| level_of_assurance | Array of strings Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE" |
object Field Authentication |
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",
- "created_on": "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
| 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 updated name of the field, if renaming is intended. |
| page_no required | integer <int32> Page number on which the field is to be created. |
| placeholder | string String identifier for the in-person field, it can be Customer, Jack, CEO etc. |
object (FieldDimension) | |
| display | string Visibility of the field that is to be updated, possible values are "VISIBLE" and "INVISIBLE" |
| level_of_assurance | Array of strings Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE" |
object Field Authentication |
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 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 required | integer <int32> Order of the recipient for which the field is being created. |
| page_no required | integer <int32> Page number at which the field is about to be created. |
| field_name | string Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field. |
| level_of_assurance | Array of strings 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 (FieldDimension) | |
| display | string Visibility of the field that is to be added, possible values are "VISIBLE" and "INVISIBLE" |
object Field Authentication |
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
| 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 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 Updated name of the field if renaming of the field is intended. |
| page_no required | integer <int32> Page number on which the field is to be created. |
object (FieldDimension) | |
| display | string Visibility of the field that is to be updated, possible values are "VISIBLE" and "INVISIBLE" |
object Field Authentication |
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 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 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 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 Value of the field. Possible values are "true" or "false" |
required | object (FieldDimension) |
| validation_rule | string 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",
- "created_on": "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
| 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 Updated name of the field if renaming is intended. |
| page_no required | integer <int32> Page number on which the field is to be created. |
| value | string Value of the field. |
required | object (FieldDimension) |
| validation_rule | string 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
{ }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 required | string Enum: "OPTIONAL" "MANDATORY" |
Responses
Request samples
- Payload
{- "field_name": "string",
- "validation_rule": "OPTIONAL"
}Response samples
- 200
- 400
- 403
- 404
- 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 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. |
| type required | string Enum: "TEXT" "NAME" "EMAIL" "COMPANY" "JOBTITLE" "DATE" |
| value | string Value of the field. For type = DATE, the value is expected to follow ISO 8601 format.Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00. If value is not in proper format an error will be returned. |
| placeholder | string Placeholder text for the text field. For name, email, company, job title and date, placeholder value can be "NAME", "EMAIL", "COMPANY", "JOBTITLE", "DATE". Developers can send their own placeholders to overwrite the default values. For "TEXT" developers can provide a their own placeholder texts. These placeholders appear in the text fields while viewing the document in viewer. |
| max_length required | integer <int32> Maximum length of the value allowed in the field. Must between 1 - 9999 |
| format | string Text format of the field. Used for the date type field only. Possible values are
|
| field_name | string Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field. |
| field_type required | string Enum: "Number" "Text" |
| validation_rule required | string Enum: "OPTIONAL" "MANDATORY" |
object Validations | |
required | object Font of the fields text |
required | object (FieldDimension) |
| multiline required | 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_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",
- "created_on": "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. |
| renamed_as | string Updated name of the field if renaming is intended. |
| page_no required | integer <int32> Page number on which the field is to be created. |
| value | string Value of the field. For type = DATE, the value is expected to follow ISO 8601 format.Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00. If value is not in proper format an error will be returned. |
| max_length required | integer <int32> Maximum length of the value allowed in the field. Must between 1 - 9999 |
| field_type required | string Enum: "Number" "Text" |
| validation_rule required | string Enum: "OPTIONAL" "MANDATORY" |
object Font of the fields text | |
object (FieldDimension) | |
| placeholder | string Developers can provide a their own placeholder texts. These placeholders appear in the text fields while viewing the document in viewer. |
| format | string Text format of the field. Used for the date type field only. Possible values are
|
object Validations |
Responses
Request samples
- Payload
{- "field_name": "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
{ }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 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 <= 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 Value of the field. Possible values are "true" or "false" |
| validation_rule required | string Enum: "OPTIONAL" "MANDATORY" |
| radio_group_name required | string non-empty |
required | object (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",
- "created_on": "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 Updated name of the field if renaming is intended. |
| page_no required | integer <int32> Page number on which the field is to be created. |
| value | string Value of the field. |
| validation_rule required | string Enum: "OPTIONAL" "MANDATORY" |
| radio_group_name required | string non-empty The group name to which the field belongs. |
required | object (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 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 required | integer <int32> Page number on which the field is to be created. |
| field_name | string <= 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 Field dimensions |
| data | string <= 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 Settings regarding options | |
object Settings regarding color | |
object Settings regarding logo |
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": "L",
- "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 Updated name of the field if renaming is intended. |
| page_no required | integer <int32> Page number for which field is need to be updated |
required | object Field dimensions |
| data | string <= 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 Settings regarding options | |
object Settings regarding color | |
object Settings regarding logo |
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": "L",
- "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 Settings regarding options | |
object Settings regarding color | |
object Settings regarding logo |
Responses
Request samples
- Payload
{- "data": "string",
- "options": {
- "error_correction_level": "L",
- "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"
}This section entails the web services for the Document Processing i.e. Sign Document, Recall Document, Bulk Sign, and Finish Workflow.
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 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:
The package ID for which the recall needs to be trigger.
| package_ids | Array of integers <int64> [ items <int64 > ] Ids of the document package. |
| document_status | string Enum: "ALL" "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" |
| package_name | string The name of the package. |
| recipient_from | string The sender who shared the document package. |
| recipient_to | string The recipient to whom the document package is sent. |
| document_id | integer <int64> Ids of the document. |
| 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 Certified signed documents |
| form_fields | boolean Documents that have form fields |
| attachments | boolean Documents that have attachments |
| document_type | string Enum: "ALL" "PDF" "DOCX" "XML" |
| document_statuses | Array of strings (AllowedDocumentPackageStatus) Items Enum: "DRAFT" "INPROGRESS" "PENDING" "SIGNED" "COMPLETED" "REVIEWED" "DECLINED" "EDITED" "EXPIRING_IN_SEVEN_DAYS" Document statuses possible values are mentioned above |
| owned_by | string 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 RSSP Information
Business applications can use this service API to get RSSP (remote signing service provider) information that need to perform CSC Signing.
query Parameters
| signing_server required | 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
{- "host_url": "string",
- "client_id": "string",
- "authentication_required": true,
- "authorization_required": true,
- "authentication_via_proxy_required": true,
- "time_out": 0,
- "auth_type": "string"
}Recall Document
Business applications can use this service API to stop a workflow in progress. The document ID is provided in the resource URL. After recall the document status automatically changes to “DRAFT”.
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
{ }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 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 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 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 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 Sign Packages
Business applications can use this API to sign/share/sign and share multiple documents (both electronic and digital) without displaying the documents to the end user. This API needs information from the business application about document packages and the details of signatures, in-person and initials fields. On the successful completion of bulk signing transaction, the API will return the statuses and transaction ids of the document packages.
Unlike the Sign Document API, this API not only signs a document package but also marks it as approved and reviewed based on whether the recipient is a Signer, Editor or Reviewer. Any document package for which the status returns as COMPLETED has been signed, approved or reviewed by this API.
Bulk Signing works with all the signing-time authentication methods.
If SIGN is passed as bulk_action and package is in Draft state, Sign and Share will be performed automatically.
You must call this API after the Pre Bulk Sign Documents API.
In case you need to make changes in any of the document before signing, the Fill Form Fields API should be called before calling the Pre Bulk Sign Document API. Remember, any mandatory input fields on a document require completing before this API will successfully complete; whereas, the auto-populated fields (like Name, Email, Date, Job Title, etc.) will be automatically filled.
The signatory is identified by the access token presented in the call. Therefore, authentication of the signatory is required prior to making this call. You cannot authenticate as an Enterprise Admin with the scope variable, and sign a document on behalf of a user. The access token must be issued to the signatory as a result of direct authentication.
Once document is signed, the verification response can be seen from the Bulk Signing Status API.
First or Second Factor OTP Usage for Authentication
In case OTP authentication is turned on for the server side signing operation, the client applications will need to generate an OTP for the mobile number using the Bulk Sign Authentication via OTP API call. Respective business applications must retrieve the OTP from the use and submit it when making the API call. This is done using the "x-otp" header in the request.
path Parameters
| bulk_action required | string 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 <int64> [ items <int64 > ] An array of the document package ids that are selected for bulk signing. |
| hand_signature_initials_image | string Base64 image used for the filling of the initials |
| hand_signature_initials_method | integer (HandSignature) Enum: 0 1 2 3 4 0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE |
| hand_signature_image | string Base64 encoded string image of the visible signature appearance |
| hand_signature_method | integer Enum: 0 1 2 3 4 0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE |
| signing_reason | string Reason of signing provided by the recipient. |
| signing_location | string Locale of the signer provided by the recipient |
| contact_information | string Contact information of the signer provided by the recipient |
| appearance_design | string Name of the signature appearance provided by user for signing. In case no appearance name is provided then default selected appearance would be used. Possible values are "COMPANY_LOGO", "DETAILED_SIGNATURE", "HAND_SIGNATURE" |
| signing_server | string Name of signing server using which the document is to be signed |
| signing_capacity | string Name of certification profile/signing capacity using which the document is to be signed |
object Authentication object is an optional, it contains authentication releated options | |
| transaction_id | string re-initiated signing process transaction id |
Responses
Request samples
- Payload
{- "ids": [
- 0
], - "hand_signature_initials_image": "string",
- "hand_signature_initials_method": 0,
- "hand_signature_image": "string",
- "hand_signature_method": 0,
- "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 Signing Packages API.
You must call this API after the Bulk Signing Packages API.
The signatory is identified by the access token presented in the call. Therefore, authentication of the signatory is required prior to making this call. You cannot authenticate as an Enterprise Admin with the scope variable, and sign a document on behalf of a user. The access token must be issued to the signatory as a result of direct authentication.
For RAS signing, the ACTION property will be REMOTE_AUTHORIZATION_REQURIED and the STATUS property will be PENDING, indicating that the request needs to be authorized using the mobile device. If the signing process fails in some document due to different levels of assurance configured and the user wants to re-initiate the signing process to complete the signing process on failed documents, the ACTION property will be REINITIATE_SIGNING_PROCESS, and the STATUS property will be PENDING.
path Parameters
| bulk_action required | string 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 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 Name of signature field. |
| skip_verification required | 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 Method Possible values are "EMAIL", "SMS" |
Responses
Request samples
- Payload
{- "field_name": "string",
- "method": "string"
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }V4_Signing_SendsOTP
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 Method Possible values are "EMAIL", "SMS" |
| package_id | integer <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 Document API call is invoked.The reason is because without calling that API the document will remain in a status of "In Progress" to the document owner. Once the API has been called, the status will change to "Completed" for the document owner.
Once document is signed, the verification response can be seen from Get Document Verification API.
First or Second Factor OTP Usage for Authentication
If OTP authentication is turned on for the server side signing operation, client applications will need to generate a OTP for the mobile number using Signer Authentication via OTP API call. Respective business applications must retrieve the OTP from the use and submit it when making the API call. This is done using the "x-otp" header in the request.
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 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 | integer Enum: 0 1 2 3 4 0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE |
| signing_reason | string Reason of signing provided by the recipient. Note: Commitment type indication for XML documents |
| signing_location | string Locale of the signer provided by the recipient. |
| contact_information | string Contact information of the signer provided by the recipient. |
| user_name | string Name of the signer provided by the recipient. Note this applies to in-person signing operations only. |
| user_password | string Password provided by the user subject to user's signature settings. |
| appearance_design | string Name of the signature appearance provided by user for signing. In case no appearance name is provided then default selected appearance would be used. Possible values are "COMPANY_LOGO","DETAILED_SIGNATURE","HAND_SIGNATURE" |
| signing_capacity | string Name of certification profile/signing capacity using which the document is to be signed. If not provided the default capacity will be used to sign. Provided name must be exactly same as of the actual profile due to case sensitivity. |
| skip_verification required | 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 Name of signing server using which the document is to be signed. |
object Authentication object is an optional, it contains authentication releated options |
Responses
Request samples
- Payload
{- "field_name": "string",
- "hand_signature_image": "string",
- "hand_signature_method": 0,
- "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 Signing Packages API.
path Parameters
| bulk_action required | string 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. |
Request Body schema:
| ids | Array of integers <int64> [ items <int64 > ] An array of the document package ids that are selected for bulk signing. |
Responses
Request samples
- Payload
{- "ids": [
- 0
]
}Response samples
- 200
- 401
- 403
- 500
{- "failed_packages": [
- {
- "id": 0,
- "error": "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
}
]
}Pre-Bulk CSC Signing
Business applications can use this API to get document hash (D2S) of multiple documents (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.
This API not only prepare document hash of documents in packages 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.
You must call this API after the Pre Bulk Sign Documents API.
In case you need to make changes in any of the document before signing, the Fill Form Fields API should be called before calling the Pre Bulk Sign Document API. Remember, any mandatory input fields on a document require completing before this API will successfully complete; whereas, the auto-populated fields (like Name, Email, Date, Job Title, etc.) will be automatically filled.
The signatory is identified by the access token presented in the call. Therefore, authentication of the signatory is required prior to making this call. You cannot authenticate as an Enterprise Admin with the scope variable, and sign a document on behalf of a user. The access token must be issued to the signatory as a result of direct authentication.
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:
| ids | Array of integers <int64> [ items <int64 > ] An array of the document package ids that are selected for bulk signing. |
| hand_signature_initials_image | string Base64 image used for the filling of the initials |
| hand_signature_initials_method | integer (HandSignature) Enum: 0 1 2 3 4 0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE |
| hand_signature_image | string Base64 encoded string image of the visible signature appearance |
| hand_signature_method | integer (HandSignature) Enum: 0 1 2 3 4 0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE |
| signing_reason | string Reason of signing provided by the recipient. |
| signing_location | string Locale of the signer provided by the recipient |
| contact_information | string Contact information of the signer provided by the recipient |
| appearance_design | string Name of the signature appearance provided by user for signing. In case no appearance name is provided then default selected appearance would be used. Possible values are "COMPANY_LOGO", "DETAILED_SIGNATURE", "HAND_SIGNATURE" |
| signing_server required | string non-empty Name of signing server using which the document is to be signed |
| credential_id required | string non-empty The unique identifier associated to the credential. |
| access_token required | string non-empty Bearer token return by authorization server |
| SAD | string SAD return by RSSP (remote signing service provider) after credential authorization. It is required if SCAL value is 1 in credential info response. |
| transaction_id | string re-initiated signing process transaction id |
Responses
Request samples
- Payload
{- "ids": [
- 0
], - "hand_signature_initials_image": "string",
- "hand_signature_initials_method": 0,
- "hand_signature_image": "string",
- "hand_signature_method": 0,
- "signing_reason": "string",
- "signing_location": "string",
- "contact_information": "string",
- "appearance_design": "string",
- "signing_server": "string",
- "credential_id": "string",
- "access_token": "string",
- "SAD": "string",
- "transaction_id": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "status": "string",
- "transaction_id": "string"
}Post-Bulk CSC Signing
Business applications can use this service API to embed signatures in PDF/XML documents without displaying the documents to the end user.
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:
| transaction_id required | string non-empty The identification number of the bulk signing transaction |
required | Array of objects (CscRawSignature) Signature details |
Responses
Request samples
- Payload
{- "transaction_id": "string",
- "signatures": [
- {
- "package_id": 0,
- "document_id": 0,
- "field_name": "string",
- "signature": "string"
}
]
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "status": "string"
}Unlock CSC Documents
Business applications can use this service API to unlock documents which is locked while csc 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:
| transaction_id | string The identification number of the csc signing transaction |
Responses
Request samples
- Payload
{- "transaction_id": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Signature Pad Initialize
Business applications can use this service API to initialize get signature pad license.
query Parameters
| type | string Default: "WACOM" 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
0Get 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 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 | integer Enum: 0 1 2 3 4 0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE |
| signing_reason | string Reason of signing provided by the recipient. |
| signing_location | string Locale of the signer provided by the recipient. |
| contact_information | string Contact information of the signer provided by the recipient. |
| appearance_design | string Name of the signature appearance provided by user for signing. In case no appearance name is provided then default selected appearance would be used. Possible values are "COMPANY_LOGO","DETAILED_SIGNATURE","HAND_SIGNATURE" |
| 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": 0,
- "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 required | 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 required | 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 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 required | 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 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 | integer Enum: 0 1 2 3 4 0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE |
| signing_reason | string Reason of signing provided by the recipient. |
| signing_location | string Locale of the signer provided by the recipient. |
| contact_information | string Contact information of the signer provided by the recipient. |
| appearance_design | string Name of the signature appearance provided by user for signing. In case no appearance name is provided then default selected appearance would be used. Possible values are "COMPANY_LOGO","DETAILED_SIGNATURE","HAND_SIGNATURE" |
| 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": 0,
- "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 Unique code return by RSSP (remote signing service provider) on service/credential authorization call |
| 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
{- "code": "string",
- "oauth2_url": "string",
- "signing_server": "string"
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "access_token": "string",
- "token_type": "string",
- "expires_in": "string",
- "refresh_token": "string"
}Get Filtered Credential List
Business applications can use this service API to get credential list from RSSP (remote signing service provider) and filtered as per user RUT value if its enabled in API's web.config
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 credentials list from RSSP (remote signing service provider)
| access_token required | string non-empty Bearer token return by RSSP (remote signing service provider) |
| signing_server required | string non-empty Name of RSSP(remote signing service provider) |
Responses
Request samples
- Payload
{- "access_token": "string",
- "signing_server": "string"
}Response samples
- 200
- 401
- 403
- 404
- 500
{- "credentialIDs": [
- "string"
]
}Get RSSP Info
Business applications can use this service API to get RSSP (remote signing service provider) info.
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 data
| signing_server required | string non-empty Name of RSSP (remote signing service provider) |
Responses
Request samples
- Payload
{- "signing_server": "string"
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "specs": "string",
- "name": "string",
- "logo": "string",
- "region": "string",
- "lang": "string",
- "description": "string",
- "authType": [
- "string"
], - "oauth2": "string",
- "methods": [
- "string"
]
}Get Credentials Info
Business applications can use this service API to get credential info 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 credentials info from RSSP (remote signing service provider)
| access_token required | string non-empty Bearer token return by RSSP (remote signing service provider) |
| 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. |
Responses
Request samples
- Payload
{- "access_token": "string",
- "signing_server": "string",
- "credential_id": "string"
}Response samples
- 200
- 401
- 403
- 500
{- "description": "string",
- "key": {
- "status": "string",
- "algo": [
- "string"
], - "len": 0,
- "curve": 0
}, - "cert": {
- "status": "string",
- "certificates": [
- "string"
], - "issuerDN": "string",
- "serialNumber": "string",
- "subjectDN": "string",
- "validFrom": "string",
- "validTo": "string"
}, - "authMode": "string",
- "SCAL": "string",
- "PIN": {
- "presence": "string",
- "format": "string",
- "label": "string",
- "description": "string"
}, - "OTP": {
- "presence": "string",
- "type": "string",
- "ID": "string",
- "provider": "string",
- "format": "string",
- "label": "string",
- "description": "string"
}, - "multisign": 0,
- "lang": "string"
}RSSP Credentials Authorization
Business applications can use this service API for credentials authorization 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 for credentials authorization from RSSP (remote signing service provider)
| document_name | string <= 500 characters For single document sign, pass the document name and for bulk sign pass the comma separated package names. You may pass it when making implicit call, otherwise skip it |
| access_token required | string non-empty Bearer token return by RSSP (remote signing service provider) |
| 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. |
| num_signatures required | integer <int32> The number of signatures to authorize from RSSP (remote signing service provider) |
| hash | Array of strings One or more Base64-encoded hash values to be signed. It allows the server to bind the SAD to the hash(es), thus preventing an authorization to be used to sign a different content. If the SCAL parameter returned by credentials/info method, for the current credentialID is “2” the hash parameter SHALL be used and the number of hash values SHOULD correspond to the value in numSignatures. If the SCAL parameter is “1”, the hash parameter is OPTIONAL. |
| otp | string The OTP provided by the user. It SHALL be used only when authMode from credentials/info method, is “explicit” and OTP/presence is not “false”. |
| pin | string The PIN provided by the user. It SHALL be used only when authMode from credentials/info is “explicit” and PIN/presence is not “false”. |
Responses
Request samples
- Payload
{- "document_name": "string",
- "access_token": "string",
- "signing_server": "string",
- "credential_id": "string",
- "num_signatures": 0,
- "hash": [
- "string"
], - "otp": "string",
- "pin": "string"
}Response samples
- 200
- 401
- 403
- 500
{- "SAD": "string"
}Get Sign Hash from RSSP
Business applications can use this service API to sign hash/s 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 sign hash/s from RSSP (remote signing service provider)
| access_token required | string non-empty Bearer token return by RSSP (remote signing service provider) |
| 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. |
| hash required | Array of strings One or more Base64-encoded hash values to be signed. It allows the server to bind the SAD to the hash(es), thus preventing an authorization to be used to sign a different content. If the SCAL parameter returned by credentials/info method, for the current credentialID is “2” the hash parameter SHALL be used and the number of hash values SHOULD correspond to the value in numSignatures. If the SCAL parameter is “1”, the hash parameter is OPTIONAL. |
| 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 |
| hashing_algo required | string non-empty The OID of the algorithm to use for signing. It SHALL be one of the values allowed by the credential as returned in keyAlgo by the credentials/info method |
Responses
Request samples
- Payload
{- "access_token": "string",
- "signing_server": "string",
- "credential_id": "string",
- "hash": [
- "string"
], - "sad": "string",
- "signing_algo": "string",
- "hashing_algo": "string"
}Response samples
- 200
- 401
- 403
- 500
{- "signatures": [
- "string"
]
}Send OTP via RSSP
Business applications can use this service API to send OTP via 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 send OTP via RSSP (remote signing service provider)
| access_token required | string non-empty Bearer token return by RSSP (remote signing service provider) |
| 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. |
Responses
Request samples
- Payload
{- "access_token": "string",
- "signing_server": "string",
- "credential_id": "string"
}Response samples
- 200
- 401
- 403
- 500
{ }Revoke Access Token
Business applications can use this service API to revoke access token of 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 revoke access token
| access_token required | string non-empty The token that the signature application wants to get revoked. |
| signing_server required | string non-empty Name of RSSP (remote signing service provider) |
Responses
Request samples
- Payload
{- "access_token": "string",
- "signing_server": "string"
}Response samples
- 200
- 401
- 403
- 500
{ }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
{ }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 required | 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 (TextFormFillingRequest) It has the list of textboxes data to save | |
Array of objects (RadioFormFillingRequest) It has the list of radios value to save | |
Array of objects (CheckBoxFormFillingRequest) It has the list of checkboxes value to save | |
Array of objects (DropDownFormFillingRequest) It has the list of dropdowns value to save | |
Array of objects (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
{ }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 required | 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 (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
| 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 | integer Enum: 0 1 2 3 4 0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE |
| apply_to_all required | boolean True if all initials are to be filled. |
Responses
Request samples
- Payload
{- "field_name": "string",
- "image": "string",
- "method": 0,
- "apply_to_all": true
}Response samples
- 200
- 401
- 403
- 500
{ }The Enterprise level allows enterprise administrators to manage a group or set of users. This is the most common use case scenario of SigningHub, and is a mandatory requirement for using the APIs.
This set of APIs allows an Enterprise Administrator to administer users under their control.
Register Enterprise User
Business applications can use this service API to register Enterprise Users into their Enterprise account. New users inherit the Enterprise Admin Service Plan and all associated permissions. Furthermore, the role assigned to them dictates what functionality they will have available to them. The Role dictates things such as allowed authentication methods to access the system and signing capacities available to the user. Enterprise Roles are described in detail here.
There are different scenarios to consider when registering a user. When "Password should be provided at time of user registration" option is "Enabled" in Enterprise Admin Service Plan, then:
● User will get an "account activation" email on successful registration, if password, security question and answer parameters are not provided in the call and email notification flag should not provided or set to false.
● User will get an "account registration" email on successfull registration, if password, security question and answer parameters are provided in the call. Email notification flag should be set to True in this case
● User will not get any email on successfull registration, if password, security question and answer parameters are provided in the call and email notification flag is set to False
When "Password should be provided at time of user registration" option is "Disabled" in Enterprise Admin Service Plan, then:
● User will get an "account registration" email on successfull registration, if password, security question and answer parameters are provided in the call. Email notification flag should be set to True in this case.
● User will not get any email on successfull registration, if password, security question, answer details are either provided or not and email notification flag is to set False
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" or "Password Authentication" |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| user_name required | string [ 1 .. 255 ] characters The name of the user to be registered. |
| user_email required | string [ 1 .. 255 ] characters The email address of the user account to be registered. |
| user_password | string <= 255 characters 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 | string <= 255 characters 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 | string <= 255 characters 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. |
| enterprise_role | string <= 255 characters The enterprise role to be assigned to this user - these are managed within the Enterprise account. |
| email_notification | boolean This defines whether enterprise user would get an email notification about the account creation. Default value is 'false'. |
| certificate_id | string <= 255 characters |
| job_title | string <= 255 characters Job title of user. |
| company_name | string <= 255 characters Company name of user. |
| mobile_number | string <= 255 characters Mobile number of user. |
| country | string <= 255 characters Country name for the user. All values in the appendix - Country list are accepted. |
| time_zone | string <= 255 characters Timezone name for the user. All values in the appendix - Timezone list are accepted. |
| language | string <= 255 characters Language selected for the user. All values in the appendix - Language list are accepted. |
| user_national_id | string <= 255 characters National identity number of the user. This helps to identify user in the workflow |
| user_csp_id | string <= 255 characters User ID of the user registered in CSP service inside SigningHub Engine (ADSS Server). |
| user_ra_id | string <= 255 characters User ID of the user registered in SAM service inside SigningHub Engine (ADSS Server). |
| user_csc_id | string <= 255 characters Cloud Signature Consortium (CSC) user Id that will be required when signing(CSC) via client credential flow |
| common_name | string <= 255 characters An identifiable name for the user that added as Common Name (CN) in identity certificate. |
Responses
Request samples
- Payload
{- "user_name": "string",
- "user_email": "string",
- "user_password": "string",
- "security_question": "string",
- "security_answer": "string",
- "enterprise_role": "string",
- "email_notification": true,
- "certificate_id": "string",
- "job_title": "string",
- "company_name": "string",
- "mobile_number": "string",
- "country": "string",
- "time_zone": "string",
- "language": "string",
- "user_national_id": "string",
- "user_csp_id": "string",
- "user_ra_id": "string",
- "user_csc_id": "string",
- "common_name": "string"
}Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "id": 0,
- "created_on": "string"
}Add Enterprise User Signing Certificates
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" or "Password Authentication" |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| user_email required | string non-empty Email address of the account owner. |
| capacity_name required | string [ 1 .. 100 ] characters capacity name |
| certificate_alias required | string [ 1 .. 255 ] characters certificate alias |
| isDefault required | boolean Capacity set as Default |
| level_of_assurance required | string [ 1 .. 255 ] characters Signature Type ADVANCED_ELECTRONIC_SIGNATURE | HIGH_TRUST_ADVANCED | QUALIFIED_ELECTRONIC_SIGNATURE |
| key_protection_option required | string [ 1 .. 255 ] characters Key protected by USER_PASSWORD | REMOTE_AUTHORISATION |
| certificate | string Certificate base64 |
Responses
Request samples
- Payload
{- "user_email": "string",
- "capacity_name": "string",
- "certificate_alias": "string",
- "isDefault": true,
- "level_of_assurance": "string",
- "key_protection_option": "string",
- "certificate": "string"
}Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0,
- "certificate_dn": "string"
}Update Enterprise User Signing Certificates
path Parameters
| usercertificateid required | integer <int32> The id of user certificate |
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" or "Password Authentication" |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| user_email required | string non-empty Email address of the account owner. |
| capacity_name | string <= 100 characters capacity name |
| certificate_alias | string <= 255 characters certificate alias |
| isDefault required | boolean Capacity set as Default |
| level_of_assurance required | string [ 1 .. 255 ] characters Signature Type ADVANCED_ELECTRONIC_SIGNATURE | HIGH_TRUST_ADVANCED | QUALIFIED_ELECTRONIC_SIGNATURE |
| certificate | string Certificate base64 |
Responses
Request samples
- Payload
{- "user_email": "string",
- "capacity_name": "string",
- "certificate_alias": "string",
- "isDefault": true,
- "level_of_assurance": "string",
- "certificate": "string"
}Response samples
- 200
- 400
- 401
- 403
- 422
- 500
{ }Delete Enterprise User Signing Certificates
path Parameters
| usercertificateid required | integer <int32> |
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" or "Password Authentication" |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| user_email required | string non-empty Email address of the account owner. |
Responses
Request samples
- Payload
{- "user_email": "string"
}Response samples
- 200
- 401
- 403
- 500
{ }Get Enterprise Invitations
Business applications can use this service API to get the invited users list.
path Parameters
| pageNo required | integer <int32> Page number, according the division of records per page. |
| recordsPerPage required | integer <int32> Number of records that are needed to be fetched in one request. |
query Parameters
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "NAME" "ROLE" "STATUS" Sort by. [ CREATEDON | NAME | ROLE | STATUS ] |
| asc | boolean Default: false Sort order |
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-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 Default: 212 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "created_on": "string",
- "user_email": "string",
- "user_name": "string",
- "enterprise_role": "string",
- "invited_by": "string",
- "status": "string"
}
]Invite Enterprise User
Business applications can use this API to invite existing or new SigningHub users to join an Enterprise account. The invited users can be individuals or part of another Enterprise. The invited users would get an invitation email and users would be required to click the link provided in email to accept the invitation. If a user in an Enterprise accepts this invitation they are unlinked from the existing Enterprise and will join the new enterprise.
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:
| user_name required | string non-empty The name of the user to be invited. |
| user_email required | string non-empty The email address of the user account to be invited. |
| enterprise_role | string The enterprise role under which the user should be invited. |
Responses
Request samples
- Payload
{- "user_name": "string",
- "user_email": "string",
- "enterprise_role": "string"
}Response samples
- 200
- 201
- 401
- 403
- 500
{- "Message": "string"
}Get Groups
Business applications can use this service API to retieve groups from both personal and enterprise groups for the current user.
It is possible to search based upon the criterion supplied under the "x-search-text" header.Furthermore, it is possible to search a user's personal groups or that of the enterprise to which the user belongs.
The response contains both the group name and the members thereof.Group member details returned are email address and user name.
path Parameters
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
| pageNo required | integer <int32> Page number to be retrieved. |
query Parameters
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "NAME" "DESCRIPTION" Sort the result by possible values are mentioned above. |
| asc | boolean Default: false Order the result set by ascending or descending. |
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-search-text | string Example: U2FsZXM= Search text if required. This is optional and without it the entire list is returned. |
| x-enterprise | string Default: true If set as "true" only enterprise groups list will be returned. In case of "false"only the user's groups list will be returned.If you do not set the header, then both enterprise and user's groups lists will be returned. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 403
- 500
[- {
- "id": 0,
- "group_name": "string",
- "created_on": "string",
- "description": "string",
- "enterprise": true,
- "group_members": [
- {
- "user_email": "string",
- "user_name": "string"
}
]
}
]Update Enterprise Group
Business applications can use this service API to update group information of Enterprise Groups. An enterprise Admin or the enterprise user who has permissions to manage enterprise groups in this role, can update groups. Update Enterprise Group should also be allowed with the scope token.
path Parameters
| id required | integer <int32> ID of the enterprise group. |
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 Group Name |
| description | string Group Description |
required | Array of objects (GroupMembers) |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "members": [
- {
- "user_email": "string",
- "user_name": "string"
}
]
}Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{ }Delete Enterprise Group
Business applications can use this service API to delete enterprise group of its users. An enterprise Admin or the enterprise user who has permissions to manage enterprise groups in this role, can delete enterprise groups of its user. The role dictates things such as allowed delete groups available to the user. Delete Enterprise Group should also be allowed with the scope token.
path Parameters
| id required | integer <int32> ID of the enterprise group. |
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
{ }Get Enterprise Group By Id
Business applications can use this service API to get enterprise group of its users. An enterprise Admin or the enterprise user who has permissions to manage enterprise groups in this role, can get enterprise groups of its user. Get Enterprise Group should also be allowed with the scope token.
path Parameters
| id required | integer <int32> ID of the enterprise group. |
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
{- "id": 0,
- "name": "string",
- "description": "string",
- "created_on": "string",
- "members": [
- {
- "user_email": "string",
- "user_name": "string"
}
]
}Add Enterprise Group
Business applications can use this service API to add a group for Enterprise Users. An enterprise Admin or the enterprise user who has permissions to manage enterprise groups in this role, can add new groups. Add Enterprise Group should also be allowed with the scope token.
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 Group Name |
| description | string Group Description |
required | Array of objects (GroupMembers) |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "members": [
- {
- "user_email": "string",
- "user_name": "string"
}
]
}Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0,
- "name": "string"
}Get Enterprise Branding
Business application can use this API call to retrieve the default branding of SigningHub Application that is set by at the enterprise administrator level. This includes the logo, favicon and colours that comprise the branding options. Note this is not to be confused with the SigningHub Administration level branding. For these settings click here.
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 |
Responses
Response samples
- 200
- 403
- 500
{- "logo": "string",
- "logo_url": "string",
- "favicon": "string",
- "favicon_url": "string",
- "signature_logo": "string",
- "signature_logo_url": "string",
- "email_logo": "string",
- "email_logo_url": "string",
- "colors": {
- "level_1": "string",
- "level_2": "string",
- "level_3": "string",
- "level_4": "string",
- "level_5": "string",
- "level_6": "string",
- "level_7": "string",
- "level_8": "string",
- "level_9": "string",
- "level_10": "string",
- "level_11": "string",
- "level_12": "string",
- "level_13": "string",
- "level_14": "string",
- "level_15": "string"
}
}Update Enterprise Branding
Business application can use this API call to updating the branding of SigningHub Application that is set by at the enterprise administrator level. This includes the logo, favicon and colours that comprise the branding options. Note this is not to be confused with the SigningHub Administration level branding. This API will can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
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:
| logo required | string non-empty Base64 logo of the application set by the enterprise administrator. |
| favicon required | string non-empty Base64 encoded string of the favicon image. |
| signature_logo required | string non-empty Base64 encoded string of the signature logo image. |
| email_logo required | string non-empty Base64 encoded string of the email logo image. |
required | object (EnterpriseBrandingColors) |
Responses
Request samples
- Payload
{- "logo": "string",
- "favicon": "string",
- "signature_logo": "string",
- "email_logo": "string",
- "colors": {
- "level_1": "string",
- "level_2": "string",
- "level_3": "string",
- "level_4": "string",
- "level_5": "string",
- "level_6": "string",
- "level_7": "string",
- "level_8": "string",
- "level_9": "string",
- "level_10": "string",
- "level_11": "string",
- "level_12": "string",
- "level_13": "string",
- "level_14": "string",
- "level_15": "string"
}
}Response samples
- 200
- 403
- 500
{ }Get Enterprise Branding Logo
Business application can get the application logo configured in the enterprise branding.
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
"string"Get Enterprise Branding Favicon
Business application can get the application favicon configured in the enterprise branding.
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
"string"Reset Enterprise Emails To Default
Business applications can use this service API to reset to default the enterprise emails. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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
- 500
{ }Get Enterprise Legal Notice
Business applications can use this service API to get a legal notice for Enterprise Users into their Enterprise account. An enterprise Admin who has permissions to manage Advanced Settings in his role, can Read a legal notice. The role dictates things such as allowed Get advanced settings to the user.
path Parameters
| id required | integer <int32> ID of enterprise legal notice |
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" or "Password Authentication" |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "title": "string",
- "content": "string"
}Update Enterprise Legal Notice
Business applications can use this service API to edit a legal notice for Enterprise Users into their Enterprise account. An enterprise Admin who has permissions to manage Advanced Settings in his role, can edit a legal notice. The role dictates things such as allowed Edit advanced settings to the user.
path Parameters
| id required | integer <int32> ID of enterprise legal notice |
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" or "Password Authentication" |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| title required | string [ 1 .. 255 ] characters Legal Notice Title |
| content required | string non-empty Legal Notice Content |
Responses
Request samples
- Payload
{- "title": "string",
- "content": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Delete Enterprise Legal Notice
Business applications can use this service API to delete a legal notice for Enterprise Users into their Enterprise account. An enterprise Admin who has permissions to manage Advanced Settings in his role, can delete a legal notice. The role dictates things such as allowed Delete advanced settings to the user.
path Parameters
| id required | integer <int32> ID of enterprise legal notice |
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" or "Password Authentication" |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{ }Add Enterprise Legal Notice
Business applications can use this service API to add a legal notice for Enterprise Users into their Enterprise account. An enterprise Admin who has permissions to manage Advanced Settings in his role, can add a legal notice. The role dictates things such as allowed Add advanced settings to the user.
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" or "Password Authentication" |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| title required | string [ 1 .. 255 ] characters Legal Notice Title |
| content required | string non-empty Legal Notice Content |
Responses
Request samples
- Payload
{- "title": "string",
- "content": "string"
}Response samples
- 201
- 400
- 401
- 403
- 500
{- "id": 0,
- "created_on": "2019-08-24T14:15:22Z"
}Get PowerBI Workspace Reports
Business application can use this service API to retrieve Power BI reports by workspace ID.
path Parameters
| workspace_id required | string The ID of the workspace. |
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
- 500
[- {
- "id": "string",
- "name": "string"
}
]Get PowerBI Embed Token
Business application can use this service API to get a Power BI iframe embedded token using the workspace ID and report ID.
path Parameters
| workspace_id required | string The ID of the workspace. |
| report_id required | string The report ID of the workspace. |
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
- 500
{- "token": "string"
}Get Enterprise Branding Signature Logo
Business application can get the application signature logo configured in the enterprise branding.
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
"string"Get Enterprise Branding Email Logo
Business application can get the application email logo configured in the enterprise branding.
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
"string"Reset Enterprise Branding
Business application can use this API call to reset the branding of SigningHub Application to default branding. This API will can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request
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
{- "logo": "string",
- "logo_url": "string",
- "favicon": "string",
- "favicon_url": "string",
- "signature_logo": "string",
- "signature_logo_url": "string",
- "email_logo": "string",
- "email_logo_url": "string",
- "colors": {
- "level_1": "string",
- "level_2": "string",
- "level_3": "string",
- "level_4": "string",
- "level_5": "string",
- "level_6": "string",
- "level_7": "string",
- "level_8": "string",
- "level_9": "string",
- "level_10": "string",
- "level_11": "string",
- "level_12": "string",
- "level_13": "string",
- "level_14": "string",
- "level_15": "string"
}
}Get Enterprise Packages
Business applications can use this service API to get a list of the enterprise documents filtered by different statuses. Users can divide the records into pages by providing a number of records per page. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
path Parameters
| document_status required | string Enum: "ALL" "DRAFT" "INPROGRESS" "PENDING" "DECLINED" "COMPLETED" Filter by document status possible values are mentioned above. |
| page_no required | integer <int32> Page number, according the division of records per page. |
| records_per_page required | integer <int32> Number of records that are needed to be fetched in one request. |
query Parameters
| package-name | string Default: "" Filter by package Name. |
| package-id | integer <int64> Default: 0 Filter by package Id. |
| owner | string Default: "" Filter by document owner. |
| recipient | string Default: "" Filter by workflow recipient. |
| document-type | string Default: "ALL" Filter by document type possible values are ALL, PDF, DOCX and XML. |
| from-size | string Default: "" Filter by from size. |
| to-size | string Default: "" Filter by to size. |
| sort-by | string Default: "DATE_MODIFIED" Enum: "DATE_MODIFIED" "DOCUMENT_NAME" "OWNER_NAME" Sort the result by mentioned enum values. |
| asc | boolean Default: false Sort the result by ascending or descending order. |
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 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: 212 The total number of records found with the provided search criteria. |
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"
}
], - "uploaded_on": "string",
- "modified_on": "string",
- "size": 0
}
]Get Enterprise Package
Business applications can use this service API to get an enterprise document. 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 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,
- "package_name": "string",
- "package_owner": "string",
- "owner_name": "string",
- "package_status": "string",
- "next_signer": "string",
- "next_signer_email": [
- {
- "user_email": "string",
- "user_name": "string"
}
], - "uploaded_on": "string",
- "modified_on": "string",
- "size": 0
}Delete Enterprise Package
Business applications can use this service API to delete an enterprise 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. 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 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
{ }Manually Send Workflow Completion Report
Business applications can use this service API to send workflow completion report manually.
path Parameters
| packageId required | integer <int64> Package ID of the document 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 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{ }Export Enterprise Packages
Business applications can use this service API to export list of the enterprise 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 Enum: "ALL" "DRAFT" "INPROGRESS" "PENDING" "DECLINED" "COMPLETED" Filter by document status possible values are mentioned above. |
| page_no required | integer <int32> Page number, according the division of records per page. |
| records_per_page required | integer <int32> Number of records that are needed to be fetched in one request. |
query Parameters
| package-name | string Default: "" Filter by package Name. |
| owner | string Default: "" Filter by document owner. |
| recipient | string Default: "" Filter by workflow recipient. |
| document-type | string Default: "ALL" Filter by document type possible values are ALL, PDF, DOCX and XML. |
| from-size | string Default: "" Filter by from size. |
| to-size | string Default: "" Filter by to size. |
| sort-by | string Default: "DATE_MODIFIED" Enum: "DATE_MODIFIED" "DOCUMENT_NAME" "OWNER_NAME" Sort the result by mentioned enum values. |
| asc | boolean Default: false Sort the result by ascending or descending order. |
| ids | Array of integers <int64> [ items <int64 > ] Selected package Ids |
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 Search text sent in headers for further filtration of the documents. Package id, name and document owner can be searched. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
"string"Get Workflow Users Of Enterprise Package
Business applications can use this service API to get a list of users an enterprise package. This API can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request
path Parameters
| packageId required | integer <int64> The ID of the document for which the recipients are to be 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 |
Responses
Response samples
- 200
- 400
- 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"
}
]
}
}
]Update Placeholder of Enterprise Package
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". 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> 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 The name of the new placeholder to be added in workflow. If no value is provided, old value will be retained. |
| email_notification | boolean Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn. If no value is provided, old value will be retained. |
| role required | string Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" |
| signing_order | integer <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
- 401
- 403
- 404
- 500
{ }Update Workflow User of Enterprise Package
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". 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> 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 |
Request Body schema:
| user_email | string The email address of the new user to be updated in workflow. If no value is provided, old value will be retained. |
| user_name | string Name of the recipient to be updated. If no value is provided, old value will be retained. |
| email_notification | boolean Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn. If no value is provided, old value will be retained. |
| mobile_number | string <= 15 characters Mobile number. If no value is provided, old value will be retained. |
| role required | string Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" |
| signing_order | integer <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 email language code |
| delivery_method required | string 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",
- "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
}
}, - "reminder": {
- "enabled": true,
- "frequency": "string",
- "remind_after": 0,
- "repeat": {
- "enabled": true,
- "frequency": "string",
- "keep_reminding_after": 0,
- "total_reminders": 0
}
}
}Get Workflow User Permissions of Enterprise Package
Business applications can use this service API to get the document permissions for a recipient. The recipient is identified by the order in the workflow. The ID of the package is provided in the resource URL. This API can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request
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. |
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
{- "print": true,
- "download": true,
- "add_text": true,
- "change_recipients": true,
- "add_attachment": true
}Update Workflow User Permissions of Enterprise Package
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. This API can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request
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 |
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 It has all the permissions to be allowed in the workflow |
Responses
Request samples
- Payload
{- "apply_to_all": true,
- "permissions": {
- "print": true,
- "download": true,
- "add_text": true,
- "change_recipients": true,
- "add_attachment": true
}
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Get Workflow User Authentication (Document Opening) of Enterprise Package
Business applications can use this service API to get the access security settings enabled for the package. Recipients for whom the security is configured are identified by the order in the URL. Package ID is also identified in the request URL. Recipients will not be able to access document package outside the scope of this duration if the access security is enabled. Document owner can also configure authentication based security of the package for a recipient.
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
- 400
- 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"
}, - "totp": {
- "enabled": true
}
}, - "authentication_signing": {
- "enabled": true,
- "sms_otp": {
- "otp_length": 0,
- "retry_duration": 0,
- "mobile_number": "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) of Enterprise Package
Business applications can use this service API to update the package authentications and access duration for the recipients. This API can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request
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 |
Request Body schema:
| apply_to_all required | boolean True, if the access security or authentications are to be applied on all the recipients in the workflow. |
required | object It has the access aauthentication data |
object It has the signing authentication data | |
required | object It has the access duration of the workflow |
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
{ }Update Workflow Group of Enterprise Package
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". 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> 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 |
Request Body schema:
| group_name | string The name of the group to be updated in workflow. If no value is provided, old value will be retained. |
| email_notification | boolean 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 |
| mobile_number | string |
| role required | string Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" |
| signing_order | integer <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
{ }Get Enterprise Package Details
Business applications can use this service API to get the details of an enterprise 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 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
{- "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"
}
]
}Get Enterprise Package History
Business applications can use this service API to get the details of an enterprise package history. 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. |
| pageNo required | integer <int32> Page number to be retrieved. |
| recordPerPage required | integer <int32> 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 |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "package_id": 0,
- "package_name": "string",
- "logs": [
- {
- "type": "string",
- "id": 0,
- "user_id": 0,
- "user_email": "string",
- "user_name": "string",
- "enterprise_id": 0,
- "enterprise_name": "string",
- "document_id": 0,
- "document_name": "string",
- "module": "string",
- "action": "string",
- "information": [
- {
- "key": "string",
- "value": "string"
}
], - "agent": "string",
- "agent_detail": "string",
- "created_by": "string",
- "created_on": "string",
- "dst_offset": "string",
- "modified_by": "string",
- "modified_on": "string",
- "detail": [
- {
- "data": [
- { }
], - "key": "string",
- "value": "string",
- "visible": true,
- "order": 0,
- "certificate_base64": "string",
- "type": "string",
- "processed_state": "string"
}
]
}
]
}Get Enterprise Package Timeline
Business applications can use this service API to get an enterprise package timeline details. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication". 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 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_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
}
}
]
}Send Reminder for Enterprise Package
Business applications can use this service API to a send reminder to workflow user. Recipient is identified by the order in the workflow. The ID of the package is provided in the resource URL. This API can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request
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 |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Update Electronic Seal of Enterprise Package
Business applications can use this service API to update 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 within the workflow. The ID of the document package is provided in the resource URL, and the workflow recipient is identified by the order at which it is added to the workflow. Note. 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> 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 |
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 <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
{ }Export Workflow Timeline
Business applications can use this service API to export a enterprise package timeline details. This API will can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
path Parameters
| packageId required | integer <int64> Package ID of the document 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 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
"string"Complete Enterprise Package 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 |
Responses
Response samples
- 200
- 400
- 403
- 500
{ }Get Enterprise Signing Reasons
Business applications can use this service API to get signing reason for enterprise.
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-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string"
}
]Add Enterprise Signing Reason
Business applications can use this service API to add a enterprise signing reason for Enterpsie. An admin who has permissions to manage Enterprise Roles in his role, can add new Enterprise Signing reasons.
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 Name |
Responses
Request samples
- Payload
{- "name": "string"
}Response samples
- 201
- 401
- 403
- 404
- 500
{- "id": 0,
- "name": "string"
}Delete Enterprise Signing Reason
Business applications can use this service API to delete a enterprise signing reason for Enterprise. An admin who has permissions to manage Enterprise Roles in his role, can delete enterprise signing reason. The role dictates things such as allowed Enterprise Signing Reason available to the enterprise.
path Parameters
| id required | integer <int32> ID of signing reason |
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
{ }Get Enterprise Electronic Seals
Business applications can use this service API to get electronic seals for enterprise. An admin who has permissions to manage Enterprise Electronic Seals in his role, can get electronic seals. The role dictates things such as allowed Read electronic seal available to the enterprise.
path Parameters
| pageNo required | integer <int32> Page number to be retrieved. |
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
query Parameters
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "NAME" "LEVELOFASSURANCE" "ROLENAME" sort by column. |
| asc | boolean Default: false Sorting in ascending or descending order. |
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: U2FsZXM= Search text if required. This is optional and without it the entire list is returned. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
[- {
- "id": 0,
- "basic_information": {
- "name": "string",
- "role": "string",
- "level_of_assurance": "string",
- "signing_server": "string",
- "signing_capacity": "string",
- "credential_id": "string",
- "credential_pin": "string",
- "created_on": "string"
}, - "appearance": {
- "appearance_design": {
- "design_name": "string",
- "design_preview": "string",
- "design_preview_url": "string"
}, - "hand_signature": {
- "upload_image": "string"
}, - "signature_logo": "string"
}, - "detail": {
- "signed_by": "string",
- "signing_reason": "string",
- "location": "string",
- "contact_information": "string"
}
}
]Get Enterprise Electronic Seal
Business applications can use this service API to get electronic seals for enterprise. An admin who has permissions to manage Enterprise Electronic Seals in his role, can get electronic seals. The role dictates things such as allowed Read electronic seal available to the enterprise.
path Parameters
| id required | integer <int32> ID of Electronic Seal |
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
{- "id": 0,
- "basic_information": {
- "name": "string",
- "role": "string",
- "level_of_assurance": "string",
- "signing_server": "string",
- "signing_capacity": "string",
- "credential_id": "string",
- "credential_pin": "string",
- "created_on": "string"
}, - "appearance": {
- "appearance_design": {
- "design_name": "string",
- "design_preview": "string",
- "design_preview_url": "string"
}, - "hand_signature": {
- "upload_image": "string"
}, - "signature_logo": "string"
}, - "detail": {
- "signed_by": "string",
- "signing_reason": "string",
- "location": "string",
- "contact_information": "string"
}
}Update Enterprise Electronic Seal
Business applications can use this service API to update a enterprise electronic seals for Enterprise. An admin who has permissions to manage Enterprise Electronic Seals in his role, can update enterprise electronic seal. The role dictates things such as allowed Enterprise Electronic seal available to the enterprise.
path Parameters
| id required | integer <int32> ID of electronic seal |
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:
required | object Basic information |
required | object Appearance |
required | object Detail |
Responses
Request samples
- Payload
{- "basic_information": {
- "name": "string",
- "role": "string",
- "credential_id": "string",
- "credential_pin": "string"
}, - "appearance": {
- "appearance_design": {
- "design_name": "string"
}, - "hand_signature": {
- "upload_image": "string"
}, - "signature_logo": "string"
}, - "detail": {
- "signed_by": "string",
- "signing_reason": "string",
- "location": "string",
- "contact_information": "string"
}
}Response samples
- 200
- 400
- 401
- 403
- 422
- 500
{ }Delete Enterprise Electronic Seal
Business applications can use this service API to delete a enterprise electronic seals for Enterprise. An admin who has permissions to manage Enterprise Electronic Seals in his role, can update enterprise electronic seal. The role dictates things such as allowed Enterprise Electronic seal available to the enterprise.
path Parameters
| id required | integer <int32> ID of electronic seal |
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
{ }Add Enterprise Electronic Seal
Business applications can use this service API to add a enterprise electronic seal for Enterpsie. An admin who has permissions to manage Enterprise Electronic Seals in his role, can add new Enterprise Electronic Seals. The role dictates things such as allowed Add Enterprise Electronic Seals available to the enterprise.
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:
required | object Basic information |
required | object Appearance |
required | object Detail |
Responses
Request samples
- Payload
{- "basic_information": {
- "name": "string",
- "role": "string",
- "level_of_assurance": "string",
- "signing_server": "string",
- "signing_capacity": "string",
- "credential_id": "string",
- "credential_pin": "string"
}, - "appearance": {
- "appearance_design": {
- "design_name": "string"
}, - "hand_signature": {
- "upload_image": "string"
}, - "signature_logo": "string"
}, - "detail": {
- "signed_by": "string",
- "signing_reason": "string",
- "location": "string",
- "contact_information": "string"
}
}Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0
}Bulk Delete Enterprise Electronic Seal
Business applications can use this service API to delete a enterprise electronic seals for Enterprise. An admin who has permissions to manage Enterprise Electronic Seals in his role, can update enterprise electronic seal. The role dictates things such as allowed Enterprise Electronic seal available to the enterprise.
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 IDs of electronic seal
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Get Enterprise Logs
Business applications can use this service API to get the list of enterprise-related actions performed by an enterprise user.This API is also used to get the logs with respect to search and advanced search filters with query parameters.This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
path Parameters
| pageNo required | integer <int32> Page number to be retrieved. |
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
query Parameters
| user-name | string Default: "" The user-name for which the enterprise logs to be retrieved. |
| performed-by | string Default: "" The email address for which the enterprise logs to be retrieved. |
| type | string Default: "ALL" Enum: "ALL" "ADDED" "UPDATED" "DELETED" "CLONED" "DOWNLOADED" "EXPORTED" "IMPORTED" "INVITED" The type for which the enterprise logs to be retrieved. |
| module | string Default: "ALL" Enum: "ALL" "PROFILE" "USERS" "ROLES" "CONTACTS" "GROUPS" "TEMPLATES" "LIBRARY" "ELECTRONIC_SEALS" "NOTIFICATIONS" "INTEGRATIONS" "BRANDING" "ADVANCED" "REPORTS" "DOCUMENTS" "ADVANCED_REPORTS" The module for which the enterprise logs to be retrieved. |
| created-from | string <date-time> The created-from for which the enterprise logs to be retrieved. |
| created-to | string <date-time> The created-to for which the enterprise logs to be retrieved. |
| sort-by | string Default: "CreatedOn" Enum: "CreatedOn" "Module" "Type" "PerformedBy" Sorted the result by CreatedOn, Module, Type And Name. |
| asc | boolean Default: false Sorted the result by ascending or descending order. |
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: am9obg== Search text if required. This is optional and without it the entire list is returned. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 403
[- {
- "id": 0,
- "performed_by_email": "string",
- "module": "string",
- "action": "string",
- "information": [
- {
- "Key": "string",
- "Value": "string"
}
], - "details": [
- {
- "key": "string",
- "value": "string"
}
], - "created_on": "string",
- "dst_offset": "string",
- "performed_by_name": "string"
}
]Get Enterprise Log Detail
Business applications can use this service API to get the details of an enterprise-related action performed by an enterprise user. The action is identified by the log_id provided in the resource URL. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
path Parameters
| log_id required | integer <int64> Log id of the enterprise log for which the log details to be retrieved. |
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
[- {
- "field_name": "string",
- "value_before": "string",
- "value_after": "string",
- "display_key": "string",
- "display_header_key": "string",
- "audit_detail": [
- {
- "field_name": "string",
- "value_before": "string",
- "value_after": "string",
- "display_key": "string"
}
], - "field_type": "string",
- "translate": true
}
]Document Statistics
Business applications can use this service API to get a document statistics report, of the enterprise. This API will can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
path Parameters
| pageNo required | integer <int32> Page number to be retrieved. |
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
query Parameters
| from-date | string <date-time> Date and time from when the document is updated from. |
| to-date | string <date-time> Date and time to when the document is updated to. |
| sort-by | string Default: "UPLOADED" Enum: "NAME" "UPLOADED" "SHARED" "SIGNED" "DECLINED" "APPROVED" "SUBMITTED" "DISKSPACE" Sort the result by possible values are mentioned above. |
| asc | boolean Default: false Sort the result by ascending or descending order. |
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: user@example.com Search text if required. This is optional and without it the entire list is returned. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 403
- 500
{- "document_statistics": [
- {
- "user_name": "string",
- "user_email": "string",
- "uploaded": 0,
- "shared": 0,
- "signed": 0,
- "declined": 0,
- "approved": 0,
- "updated": 0,
- "diskspace": 0,
- "enterprise": true
}
], - "total_count": {
- "uploaded": 0,
- "shared": 0,
- "signed": 0,
- "declined": 0,
- "approved": 0,
- "updated": 0,
- "diskspace": 0
}
}Signature Statistics
Business applications can use this service API to get a signature statistics report, of the enterprise. This API will can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
path Parameters
| pageNo required | integer <int32> Page number to be retrieved. |
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
query Parameters
| from-date | string <date-time> Date and time from when the document is signed from. |
| to-date | string <date-time> Date and time to when the document is signed to. |
| sort-by | string Default: "ADVANCED_ELECTRONIC_SIGNATURE" Enum: "NAME" "SIMPLE_ELECTRONIC_SIGNATURE" "ELECTRONIC_SEAL" "ADVANCED_ELECTRONIC_SEAL" "QUALIFIED_ELECTRONIC_SEAL" "ADVANCED_ELECTRONIC_SIGNATURE" "HIGH_TRUST_ADVANCED" "QUALIFIED_ELECTRONIC_SIGNATURE" "INPERSON" Sort the result by possible values are mentioned above. |
| asc | boolean Default: false Sort the result by ascending or descending order. |
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: user@example.com Search text if required. This is optional and without it the entire list is returned. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 403
- 500
{- "signature_statistics": [
- {
- "user_name": "string",
- "user_email": "string",
- "simple_electronic_signature": 0,
- "electronic_seal": 0,
- "advanced_electronic_seal": 0,
- "qualified_electronic_seal": 0,
- "high_trust_advanced": 0,
- "qualified_electronic_signature": 0,
- "advanced_electronic_signature": 0,
- "inperson": 0,
- "enterprise": true
}
], - "total_count": {
- "simple_electronic_signature": 0,
- "electronic_seal": 0,
- "advanced_electronic_seal": 0,
- "qualified_electronic_seal": 0,
- "high_trust_advanced": 0,
- "qualified_electronic_signature": 0,
- "advanced_electronic_signature": 0,
- "inperson": 0
}
}Electronic Seal Statistics
Business applications can use this service API to get an electronic seal statistics report, of the enterprise. This API will can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
query Parameters
| from-date | string <date-time> Date and time from when the document is signed by eSeal from. |
| to-date | string <date-time> Date and time to when the document is signed by eSeal to. |
| sort-by | string Default: "ELECTRONIC_SEAL" Enum: "NAME" "ELECTRONIC_SEAL" "ADVANCED_ELECTRONIC_SEAL" "QUALIFIED_ELECTRONIC_SEAL" Column name to sort data by. |
| asc | boolean Default: false Sort by ascending or descending order. |
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: U2FsZXM= Search text if required. This is optional and without it the entire list is returned. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 403
- 500
[- {
- "name": "string",
- "electronic_seal": 0,
- "advanced_electronic_seal": 0,
- "qualified_electronic_seal": 0
}
]Get Document Pie Chart by Status
Business applications can use this service API to get a document pie chart by status report, of the enterprise. This API will can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
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
[- {
- "document_status": "string",
- "count": 0
}
]Get Document Bar Chart by Activity
Business applications can use this service API to get a document bar chart by activity report, of the enterprise. This API will can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
query Parameters
| type | string Default: "SHARED" Enum: "UPLOADED" "SHARED" "SIGNED" "DECLINED" "APPROVED" "UPDATED" "DISKSPACE" "SUBMITTED" |
| from-date | string <date-time> |
| to-date | string <date-time> |
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
[- {
- "type": "string",
- "count": 0,
- "user_name": "string",
- "user_email": "string"
}
]Get Document Timeline by Activity
Business applications can use this service API to get a document timeline by activity report, of the enterprise. This API will can also be used by the administrator or the enterprise user if the "scope" variable was used in the authentication request.
query Parameters
| type | string Default: "SHARED" Enum: "UPLOADED" "SHARED" "SIGNED" "DECLINED" "APPROVED" "UPDATED" "DISKSPACE" "SUBMITTED" |
| duration | string Default: "DAILY" Enum: "DAILY" "WEEKLY" "MONTHLY" "YEARLY" |
| from-date | string <date-time> |
| to-date | string <date-time> |
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
[- {
- "type": "string",
- "date": "string",
- "group_key": "string",
- "count": 0
}
]Get Signature Pie Chart
Business applications can use this service API to get a signature pie chart report, of the enterprise. This API will can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
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
{- "allowed_signatures": 0,
- "consumed_signatures": 0,
- "allowed_electronic_signatures": 0,
- "consumed_electronic_signatures": 0
}Get Signature Pie Chart by Types
Business applications can use this service API to get a signature pie chart by types report, of the enterprise. This API will can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
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
[- {
- "type": "string",
- "count": 0
}
]Get Signature Bar Chart by Signature Levels
Business applications can use this service API to get a signature bar chart by signature levels report, of the enterprise. This API will can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
query Parameters
| type | string Default: "SIMPLE_ELECTRONIC_SIGNATURE" Enum: "SIMPLE_ELECTRONIC_SIGNATURE" "ELECTRONIC_SEAL" "ADVANCED_ELECTRONIC_SEAL" "QUALIFIED_ELECTRONIC_SEAL" "ADVANCED_ELECTRONIC_SIGNATURE" "HIGH_TRUST_ADVANCED" "QUALIFIED_ELECTRONIC_SIGNATURE" "INPERSON" |
| from-date | string <date-time> |
| to-date | string <date-time> |
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
[- {
- "type": "string",
- "count": 0,
- "user_name": "string",
- "user_email": "string"
}
]Get Signature Time Line by Signature Levels
Business applications can use this service API to get a signature timeline by signature levels report, of the enterprise. This API will can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
query Parameters
| type | string Default: "SIMPLE_ELECTRONIC_SIGNATURE" Enum: "SIMPLE_ELECTRONIC_SIGNATURE" "ELECTRONIC_SEAL" "ADVANCED_ELECTRONIC_SEAL" "QUALIFIED_ELECTRONIC_SEAL" "ADVANCED_ELECTRONIC_SIGNATURE" "HIGH_TRUST_ADVANCED" "QUALIFIED_ELECTRONIC_SIGNATURE" "INPERSON" |
| duration | string Default: "DAILY" Enum: "DAILY" "WEEKLY" "MONTHLY" "YEARLY" |
| from-date | string <date-time> |
| to-date | string <date-time> |
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
[- {
- "type": "string",
- "date": "string",
- "group_key": "string",
- "count": 0
}
]Get Signature Pie Chart by Signatories
Business applications can use this service API to get a signature pie chart by signatories report, of the enterprise. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
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
{- "enterprise_user": {
- "count": 0
}, - "non_enterprise_user": {
- "count": 0
}
}Export Document Statistics
Business applications can use this service API to export the document statistics report, of the enterprise. This API will can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
path Parameters
| pageNo required | integer <int32> Page number to be retrieved. |
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
query Parameters
| from-date | string <date-time> Date and time from when the document is updated from. |
| to-date | string <date-time> Date and time to when the document is updated to. |
| sort-by | string Default: "UPLOADED" Enum: "NAME" "UPLOADED" "SHARED" "SIGNED" "DECLINED" "APPROVED" "SUBMITTED" "DISKSPACE" Sort the result by possible values are mentioned above. |
| asc | boolean Default: false Sort the result by ascending or descending order. |
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: user@example.com Search text if required. This is optional and without it the entire list is returned. |
Responses
Response samples
- 200
- 403
- 500
"string"Export Signature Statistics
Business applications can use this service API to export the signature statistics report, of the enterprise. This API will can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
path Parameters
| pageNo required | integer <int32> Page number to be retrieved. |
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
query Parameters
| from-date | string <date-time> Date and time from when the document is signed from. |
| to-date | string <date-time> Date and time to when the document is signed to. |
| sort-by | string Default: "ADVANCED_ELECTRONIC_SIGNATURE" Enum: "NAME" "SIMPLE_ELECTRONIC_SIGNATURE" "ELECTRONIC_SEAL" "ADVANCED_ELECTRONIC_SEAL" "QUALIFIED_ELECTRONIC_SEAL" "ADVANCED_ELECTRONIC_SIGNATURE" "HIGH_TRUST_ADVANCED" "QUALIFIED_ELECTRONIC_SIGNATURE" "INPERSON" Sort the result by possible values are mentioned above. |
| asc | boolean Default: false Sort the result by ascending or descending order. |
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: user@example.com Search text if required. This is optional and without it the entire list is returned. |
Responses
Response samples
- 200
- 403
- 500
"string"Export Electronic Seal Statistics
Business applications can use this service API to export the electronic seal statistics report, of the enterprise. This API will can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
query Parameters
| from-date | string <date-time> Date and time from when the document is signed by eSeal from. |
| to-date | string <date-time> Date and time to when the document is signed by eSeal 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 |
| x-search-text | string Example: U2FsZXM= Search text if required. This is optional and without it the entire list is returned. |
Responses
Response samples
- 200
- 403
- 500
"string"Delete Enterprise User Invitation
Business applications can use this service API to delete an invitation already sent to an enterprise user. The email address of the user for whom the invitation is to be deleted is provided in JSON request body as “user_email”.
path Parameters
| id required | integer <int32> ID of invitation. It's required conditional. Its mandatory if user_email of enterprise user is not passed in the 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:
| user_email required | string non-empty The email address of the enterprise user for which the invitation is to be deleted. It's required conditional. Its mandatory if id of enterprise user is not passed in the URL. |
Responses
Request samples
- Payload
{- "user_email": "string"
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }Bulk Delete Invitation
Business applications can use this service API to delete an invitation already sent to an enterprise user. The email address of the user for whom the invitation is to be deleted is provided in JSON request body as “user_email”.
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 ids of invitations
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 404
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Bulk Invite Enterprise User
Business applications can use this service API to invite existing or new SigningHub users to join an Enterprise account in bulk through a CSV file. The CSV file must have the valid email addresses of the contacts. SigningHub supports three different types of email headers (i.e. Primary Email, E-mail Address, and Email Address) to pick up the email addresses from a CSV file.
Other optional headers in CSV file is
● Name: First Name, Middle Name, Last Name The invited users can be individuals or part of another Enterprise. The invited users would get an invitation email and users would be required to click the link provided in email to accept the invitation. If a user in an Enterprise accepts this invitation they are unlinked from the existing Enterprise and will join the new enterprise.
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: multipart/form-data
| file (binary Stream) | string <binary> Default: "" This is a csv format file in the raw binary format, posting via form data. |
| enterprise_role | string <binary> Default: "" parameter name in string format. |
Responses
Response samples
- 201
- 401
- 403
- 500
{- "success": [
- {
- "user_id": 0,
- "created_on": "string",
- "user_name": "string",
- "user_email": "string",
- "enterprise_role": "string",
- "status": "string"
}
], - "failure": [
- {
- "user_name": "string",
- "user_email": "string",
- "error_message": "string"
}
]
}Resend Invitation
Business applications can use this API to resend invitation to users to join an Enterprise account. The invited users can be individuals or part of another Enterprise. The invited users would get an invitation email and users would be required to click the link provided in email to accept the invitation. If a user in an Enterprise accepts this invitation they are unlinked from the existing Enterprise and will join the new enterprise.
path Parameters
| invitation_id required | integer <int32> The id of invitation |
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
- 201
- 401
- 403
- 500
{ }Export Enterprise Invitations
Business applications can use this service API to export the invited users list to Excel.
path Parameters
| 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
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "NAME" "ROLE" "STATUS" Sort the result by possible values are mentioned above. |
| asc | boolean Default: false Sort the result by ascending or descending order. |
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 Search text sent in headers for further filtration of the documents. Package id, name and document owner can be searched. |
Responses
Response samples
- 200
- 403
- 500
"string"Import Enterprise Invitations Template
Business applications can use this service API to get recipient import template for enterprise invitations 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 |
Responses
Response samples
- 200
- 401
- 403
- 500
"string"Get Enterprise Branding and Authentication Profile
Enterprise users can use this API to fetch branding and private authentication profile for their enterprise.
path Parameters
| enterprise_url required | string Enterprise URL, to identify enterprise for which branding and authentication profile are to be fetched. |
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" or "Password Authentication" |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 401
- 403
- 500
{- "branding": {
- "logo": "string",
- "logo_url": "string",
- "favicon": "string",
- "favicon_url": "string",
- "signature_logo": "string",
- "signature_logo_url": "string",
- "email_logo": "string",
- "email_logo_url": "string",
- "colors": {
- "level_1": "string",
- "level_2": "string",
- "level_3": "string",
- "level_4": "string",
- "level_5": "string",
- "level_6": "string",
- "level_7": "string",
- "level_8": "string",
- "level_9": "string",
- "level_10": "string",
- "level_11": "string",
- "level_12": "string",
- "level_13": "string",
- "level_14": "string",
- "level_15": "string"
}
}, - "authentication_profile": {
- "profile_id": 0,
- "profile_name": "string",
- "provider": "string",
- "method": "string",
- "app_id": "string",
- "tenant_id": "string",
- "logout_url": "string",
- "scope": "string",
- "resource": "string"
}
}Bulk Register Enterprise User
Business applications can use this service API to register Enterprise Users into their Enterprise account in bulk through a CSV file. The CSV file must have the valid email addresses of the contacts. SigningHub supports three different types of email headers (i.e. Primary Email, E-mail Address, and Email Address) to pick up the email addresses from a CSV file.
Other optional headers in CSV file are
● Name: First Name, Middle Name, Last Name
● Job Title: Job Title
● Mobile: Mobile Phone, Contact Number, Phone Number, Mobile Number
● Company: Company | Organization
● Country: Country | Work Country | Business Country | Business Country/Region | Home Country/Region | Home Country
● RAS_ID: RAS_ID
● CSP_ID: CSP_ID
● CSC_ID: CSC_ID
● Language: Language
New users inherit the Enterprise Admin Service Plan and all associated permissions. Furthermore, the role assigned to them dictates what functionality they will have available to them. The Role dictates things such as allowed authentication methods to access the system and signing capacities available to the user. Enterprise Roles are described in detail here.
There are different scenarios to consider when registering a user.When "Protect server-side signing keys with user password" option is "Enabled" in Enterprise Admin Service Plan, then:
● User will get an "account activation" email on successfull registration. Email notification flag would be ignored by the system in this case.
● User will not get any email on successfull registration, if email notification flag is set to False
When "Protect server-side signing keys with user password" option is "Disabled" in Enterprise Admin Service Plan, then:
● User will get an "account registration" email on successfull registration, if email notification flag is set to True.
● User will not get any email on successfull registration, if email notification flag is to set False
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: multipart/form-data
| file (binary Stream) | string <binary> Default: "" This is a csv format file in the raw binary format, posting via form data. |
| enterprise_role | string <binary> Default: "" parameter name in string format. |
| email_notification | string <binary> Default: "" parameter name in string format. |
Responses
Response samples
- 201
- 400
- 401
- 403
- 404
- 500
{- "success": [
- {
- "user_id": 0,
- "created_on": "string",
- "user_name": "string",
- "user_email": "string",
- "enterprise_role": "string",
- "mobile_number": "string",
- "job_title": "string",
- "company_name": "string",
- "language": "string",
- "country": "string",
- "status": "string",
- "user_national_id": "string",
- "user_ra_id": "string",
- "user_csp_id": "string",
- "enabled": true
}
], - "failure": [
- {
- "user_name": "string",
- "user_email": "string",
- "error_message": "string"
}
]
}Bulk Delete Enterprise User
Business applications can use this service API to delete enterprise users from its enterprise account. If “x-permanent” is sent with the value true in the headers it will delete the user from the system. The email address of the user to be deleted is provided in JSON request body as “user_email”.
If user has any pending documents, then these are automatically declined as result of delete operation.If user has shared documents, then the documents are automatically recalled and workflow is stopped for all these documents.The documents of the user are also deleted as part of user deletion.
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-permanent | string Default: true True, if users are to be deleted permanently from the application. If false it will only be removed from the enterprise and converted to a default individual user with a trial account. |
Request Body schema:
list of ids of enterprise users
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 404
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Get Enterprise Users
Business applications can use this service API to get the list of all the registered Enterprise Users within their Enterprise. The search field (x-search-text header) is for email address input or part thereof to handle wildcards or "emails like". There is no requirement to supply wildcard characters in the search. For example, a search string of "sh18" would find and return "sh18@ascertia.com" Enterprise User.
path Parameters
| pageNo required | integer <int32> Page number, according the division of records per page. |
| recordsPerPage required | integer <int32> Number of records that are needed to be fetched in one request. |
query Parameters
| user-name | string Default: "" |
| common-name | string Default: "" |
string Default: "" | |
| job-title | string Default: "" |
| country | string Default: "" |
| national-id | string Default: "" |
| activated | string Default: "" allowed values are [ YES | NO ] |
| enabled | string Default: "" allowed values are [ YES | NO ] |
| created-from | string <date-time> |
| created-to | string <date-time> |
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "NAME" "ROLE" "STATUS" "NID" Sort the result by possible values are mentioned above. |
| asc | boolean Default: false Order the result set by ascending or descending. |
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" or "Password Authentication" |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-search-text | string Example: IGpvaG5AYXNjZXJ0aWEuY29t Search text if required. This is optional and without it the entire list is returned. |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "user_id": 0,
- "created_on": "string",
- "user_name": "string",
- "common_name": "string",
- "user_email": "string",
- "enterprise_role": "string",
- "mobile_number": "string",
- "job_title": "string",
- "company_name": "string",
- "country": "string",
- "status": "string",
- "user_national_id": "string",
- "user_ra_id": "string",
- "user_csp_id": "string",
- "user_csc_id": "string",
- "enabled": true,
- "two_factor_authentication": true,
- "language": "string",
- "signing_certificates": [
- {
- "id": 0,
- "capacity_name": "string",
- "certificate_alias": "string",
- "certificate_dn": "string",
- "level_of_assurance": "string",
- "key_protection_option": "string",
- "isDefault": true,
- "isCustom": true
}
]
}
]Get Enterprise User
Business applications can use this service API to get the list of all the registered Enterprise Users within their Enterprise. The search field (x-search-text header) is for email address input or part thereof to handle wildcards or "emails like". There is no requirement to supply wildcard characters in the search. For example, a search string of "sh18" would find and return "sh18@ascertia.com" Enterprise User.
path Parameters
| id required | integer <int32> The id of enterprise 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-search-text | string Example: IGpvaG5AYXNjZXJ0aWEuY29t Search text if required. This is optional and without it the entire list is returned. |
Responses
Response samples
- 200
- 401
- 403
- 500
{- "user_id": 0,
- "created_on": "string",
- "user_name": "string",
- "common_name": "string",
- "user_email": "string",
- "enterprise_role": "string",
- "mobile_number": "string",
- "job_title": "string",
- "company_name": "string",
- "language": "string",
- "country": "string",
- "status": "string",
- "user_national_id": "string",
- "user_ra_id": "string",
- "user_csp_id": "string",
- "user_csc_id": "string",
- "enabled": true,
- "two_factor_authentication": true,
- "signing_certificates": [
- {
- "id": 0,
- "capacity_name": "string",
- "certificate_alias": "string",
- "certificate_dn": "string",
- "level_of_assurance": "string",
- "key_protection_option": "string",
- "isDefault": true,
- "isCustom": true
}
]
}Update Enterprise User
Business applications can use this service API to update the information of an enterprise user.
path Parameters
| id required | integer <int32> The id of enterprise user. It's required conditional. Its mandatory if user_email of enterprise user is not passed in the request body. |
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" or "Password Authentication" |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| user_email | string The email address of the user account to be updated. It's required conditional. Its mandatory if id of enterprise user is not passed in the URL. |
| user_name | string The name of the user to be updated. |
| job_title | string Job title of user. |
| company_name | string Company Name of user. |
| mobile_number | string Mobile number of user. |
| user_old_password | string The old password of the user account. |
| user_new_password | string The new password of the user account. |
| security_question | string Security question used to reset password if user forgets his password. |
| security_answer | string Security answer used to reset the password if user forgets his password. |
| enterprise_role | string The enterprise role to be assigned to this user - these are managed within the Enterprise account. |
| enabled | boolean Setting this to false would disable the user and vice versa |
| country | string Country name for the user. All values in the appendix - Country list are accepted. |
| time_zone | string Timezone name for the user. All values in the appendix - Timezone list are accepted. |
| language | string Language selected for the user. All values in the appendix - Language list are accepted. |
| user_national_id | string National identity number of the user. |
| common_name | string An identifiable name for the user that added as Common Name (CN) in identity certificate. |
| user_ra_id | string User ID of the user registered in SAM service inside SigningHub Engine (ADSS Server). |
| user_csp_id | string User ID of the user registered in CSP service inside SigningHub Engine (ADSS Server) |
| user_csc_id | string Cloud Signature Consortium (CSC) user Id that will be required when signing(CSC) via client credential flow |
Responses
Request samples
- Payload
{- "user_email": "string",
- "user_name": "string",
- "job_title": "string",
- "company_name": "string",
- "mobile_number": "string",
- "user_old_password": "string",
- "user_new_password": "string",
- "security_question": "string",
- "security_answer": "string",
- "enterprise_role": "string",
- "enabled": true,
- "country": "string",
- "time_zone": "string",
- "language": "string",
- "user_national_id": "string",
- "common_name": "string",
- "user_ra_id": "string",
- "user_csp_id": "string",
- "user_csc_id": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Delete Enterprise User
Business applications can use this service API to delete an enterprise user from its enterprise account. If “x-permanent” is sent with the value true in the headers it will delete the user from the system. The email address of the user to be deleted is provided in JSON request body as “user_email”.
If user has any pending documents, then these are automatically declined as result of delete operation.If user has shared documents, then the documents are automatically recalled and workflow is stopped for all these documents.The documents of the user are also deleted as part of user deletion.
path Parameters
| id required | integer <int32> The id of enterprise user. It's required conditional. Its mandatory if user_email of enterprise user is not passed in the request body. |
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" or "Password Authentication" |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-permanent | string Default: true True, if users are to be deleted permanently from the application. If false it will only be removed from the enterprise and converted to a default individual user with a trial account. |
Request Body schema:
| user_email | string The email address of the enterprise user to be deleted. It's required conditional. Its mandatory if id of enterprise user is not passed in the URL. |
Responses
Request samples
- Payload
{- "user_email": "string"
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }Get User Signing Certificates
Business applications can use this service API to get the list of all the certificates of Enterprise User.
path Parameters
| id required | integer <int32> The id of enterprise 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 |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "capacity_name": "string",
- "certificate_alias": "string",
- "certificate_dn": "string",
- "level_of_assurance": "string",
- "key_protection_option": "string",
- "isDefault": true,
- "isCustom": true
}
]Get User Signing Certificate
Business applications can use this service API to get the certificate of Enterprise User.
path Parameters
| id required | integer <int32> The id of enterprise user |
| signing_certificate_id required | integer <int32> |
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
- 500
[- {
- "id": 0,
- "capacity_name": "string",
- "certificate_alias": "string",
- "certificate_dn": "string",
- "level_of_assurance": "string",
- "key_protection_option": "string",
- "isDefault": true,
- "isCustom": true
}
]Get Enterprise Owners
Business applications can use this service API to obtain the list of enterprise owners within their enterprise. The Enterprise Profile role must be enabled in the enterprise settings.
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
- 500
{- "name": "string",
- "email": "string",
- "mobile_number": "string"
}Get Enterprise Default Settings
Business applications can use this API to Get Enterprise Default Settings.
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
- 500
{- "login": {
- "auto_trigger_authentication": {
- "enabled": true,
- "profile": {
- "id": 0,
- "name": "string"
}
}, - "auto_detect_location": {
- "enabled": true
}, - "trusted_device_authentication": {
- "enabled": true
}
}, - "documents": {
- "add_unique_identifier": {
- "enabled": true
}
}, - "post_processing": {
- "all_recipients": {
- "enabled": true
}
}, - "recipient_permissions": {
- "allow_print": {
- "enabled": true
}, - "allow_download": {
- "enabled": true
}, - "allow_adding_text": {
- "enabled": true
}, - "allow_attachment_merging": {
- "enabled": true
}, - "allow_change_recipient": {
- "enabled": true
}, - "legal_notice": {
- "enabled": true,
- "default": {
- "id": 0
}
}
}, - "document_permissions": {
- "certify": {
- "enabled": true
}, - "lock_form_fields": true
}, - "reminder_permissions": {
- "reminder": {
- "enabled": true,
- "frequency": "string",
- "remind_after": 999,
- "repeat": {
- "enabled": true,
- "frequency": "string",
- "keep_reminding_after": 999,
- "total_reminders": 999
}
}
}, - "guest_user": {
- "role": {
- "id": 0,
- "name": "string"
}, - "auto_detect_location_timezone": {
- "enabled": true
}
}, - "witness_reason": "string",
- "password_policy": {
- "include_number": {
- "enabled": true
}, - "include_special_character": {
- "enabled": true
}, - "include_upper_case": {
- "enabled": true
}, - "minimum_length": 0,
- "change_password_first_login": {
- "enabled": true
}, - "password_expiry": {
- "enabled": true,
- "duration": 9999
}
}, - "optimise_storage": {
- "save_each_revision": true
}, - "alert_display_time": 0
}Update Enterprise Default Settings
Business applications can use this API to Update Enterprise Default Settings.
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:
required | object Login configurations |
required | object Document settings configurations |
object Post processing settings configurations | |
required | object Recipient permissions configurations |
required | object Document permission |
required | object Send reminder permissions |
required | object Settings for guest user |
| witness_reason required | string non-empty Witness Signature Reason, Content in [USER_NAME] are variables and filled automatically. You must not edit these. |
required | object (EnterprisePasswordPolicyRequestModal) |
required | object (OptimiseStorage) |
| alert_display_time required | integer <int32> [ 1 .. 9999 ] Error Notification Display Time (sec) |
Responses
Request samples
- Payload
{- "login": {
- "auto_trigger_authentication": {
- "enabled": true,
- "profile": {
- "name": "string"
}
}, - "auto_detect_location": {
- "enabled": true
}, - "trusted_device_authentication": {
- "enabled": true
}
}, - "documents": {
- "add_unique_identifier": {
- "enabled": true
}
}, - "post_processing": {
- "all_recipients": {
- "enabled": true
}
}, - "recipient_permissions": {
- "allow_print": {
- "enabled": true
}, - "allow_download": {
- "enabled": true
}, - "allow_adding_text": {
- "enabled": true
}, - "allow_attachment_merging": {
- "enabled": true
}, - "allow_change_recipient": {
- "enabled": true
}, - "legal_notice": {
- "enabled": true,
- "default": {
- "id": 0
}
}
}, - "document_permissions": {
- "certify": {
- "enabled": true
}, - "lock_form_fields": true
}, - "reminder_permissions": {
- "reminder": {
- "enabled": true,
- "frequency": "string",
- "remind_after": 999,
- "repeat": {
- "enabled": true,
- "frequency": "string",
- "keep_reminding_after": 999,
- "total_reminders": 999
}
}
}, - "guest_user": {
- "role": {
- "name": "string"
}, - "auto_detect_location_timezone": {
- "enabled": true
}
}, - "witness_reason": "string",
- "password_policy": {
- "include_number": {
- "enabled": true
}, - "include_special_character": {
- "enabled": true
}, - "include_upper_case": {
- "enabled": true
}, - "minimum_length": 1,
- "change_password_first_login": {
- "enabled": true
}, - "password_expiry": {
- "enabled": true,
- "duration": 9999
}
}, - "optimise_storage": {
- "save_each_revision": true
}, - "alert_display_time": 1
}Response samples
- 200
- 401
- 403
- 500
{ }Get Enterprise Certificate Filter Types
Business applications can use this API to configure certificate filters to be used in client side signing using go-sign service.
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
- 500
[- {
- "name": {
- "key": "string",
- "value": "string"
}, - "value": true,
- "fields": [
- {
- "key": "string",
- "value": "string"
}
]
}
]Get Enterprise Certificate filters
Business applications can use this API to Get Enterprise Certificate filters.
path Parameters
| pageNo required | integer <int32> Page number to be retrieved. |
| recordsPerPage required | integer <int32> 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 Search text sent in headers for further filtration of the documents. Package id, name and document owner can be searched. |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "created_on": "string",
- "type": "string",
- "field": "string",
- "value": "string"
}
]Get Enterprise Certificate filter
Business applications can use this API to Get Enterprise Certificate filter by Id.
path Parameters
| id required | integer <int64> The id of enterprise certificate filter |
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
- 500
{- "id": 0,
- "created_on": "string",
- "type": "string",
- "field": "string",
- "value": "string"
}Update Enterprise Certificate filter
Business applications can use this API to Update Enterprise Certificate filter.
path Parameters
| id required | integer <int32> The id of enterprise certificate filter |
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:
| type required | string Enum: "ISSUER_DN" "KEY_USAGE" "SIGNATURE_ALGO" "POLICY_OID" "QUALIFIED_CERTIFICATES" "SAN" |
| field required | string non-empty certificate filter field ●values for FIELD parameter when TYPE is ISSUER_DN [ ORGANIZATION | ORGANIZATION_UNIT | COMMON_NAME | COUNTRY | STATE | LOCATION | ISSUER_EMAIL ] ●values for FIELD parameter when TYPE is KEY_USAGE [ DIGITAL_SIGNATURE | NON_REPUDIATION | KEY_USAGE_KEY_ENCIPHERMENT | KEY_USAGE_DATA_ENCIPHERMENT | KEY_USAGE_KEY_AGREEMENT | KEY_USAGE_KEY_CERT_SIGN | KEY_USAGE_CRL_SIGN | KEY_USAGE_ENCIPHER_ONLY | KEY_USAGE_DECIPHER_ONLY ] ●values for FIELD parameter when TYPE is SIGNATURE_ALGO [ SHA1_WITHRSA | SHA224_WITHRSA | SHA256_WITHRSA | SHA384_WITHRSA | SHA512_WITHRSA | MD128_WITHRSA | MD160_WITHRSA ] ●values for FIELD parameter when TYPE is POLICY_OID [ POLICY_OID ] ●values for FIELD parameter when TYPE is QUALIFIED_CERTIFICATES [ YES | NO ] ●values for FIELD parameter when TYPE is SAN [ OID ] |
| value | string value in string format |
Responses
Request samples
- Payload
{- "type": "ISSUER_DN",
- "field": "string",
- "value": "string"
}Response samples
- 200
- 401
- 403
- 500
{ }Delete Enterprise Certificate filter
Business applications can use this API to Delete Enterprise Certificate filter.
path Parameters
| id required | integer <int32> The id of enterprise certificate filter |
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
- 500
{ }Add Enterprise Certificate filter
Business applications can use this API to Add Enterprise Certificate filter.
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:
| type required | string Enum: "ISSUER_DN" "KEY_USAGE" "SIGNATURE_ALGO" "POLICY_OID" "QUALIFIED_CERTIFICATES" "SAN" |
| field required | string non-empty certificate filter field ●values for FIELD parameter when TYPE is ISSUER_DN [ ORGANIZATION | ORGANIZATION_UNIT | COMMON_NAME | COUNTRY | STATE | LOCATION | ISSUER_EMAIL ] ●values for FIELD parameter when TYPE is KEY_USAGE [ DIGITAL_SIGNATURE | NON_REPUDIATION | KEY_USAGE_KEY_ENCIPHERMENT | KEY_USAGE_DATA_ENCIPHERMENT | KEY_USAGE_KEY_AGREEMENT | KEY_USAGE_KEY_CERT_SIGN | KEY_USAGE_CRL_SIGN | KEY_USAGE_ENCIPHER_ONLY | KEY_USAGE_DECIPHER_ONLY ] ●values for FIELD parameter when TYPE is SIGNATURE_ALGO [ SHA1_WITHRSA | SHA224_WITHRSA | SHA256_WITHRSA | SHA384_WITHRSA | SHA512_WITHRSA | MD128_WITHRSA | MD160_WITHRSA ] ●values for FIELD parameter when TYPE is POLICY_OID [ POLICY_OID ] ●values for FIELD parameter when TYPE is QUALIFIED_CERTIFICATES [ YES | NO ] ●values for FIELD parameter when TYPE is SAN [ OID ] |
| value | string value in string format |
Responses
Request samples
- Payload
{- "type": "ISSUER_DN",
- "field": "string",
- "value": "string"
}Response samples
- 201
- 401
- 403
- 500
{- "id": 0
}Bulk Delete Enterprise Certificates filters
Business applications can use this API to Delete Enterprise Certificates filter in bulk.
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 ids of enterprise certificate filters
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Get Enterprise Advanced Settings
Business applications can use this API to Get Enterprise Advanced Settings.
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
- 500
{- "access_document_without_login": {
- "enabled": true
}, - "redirect_url_finish": "string",
- "webhooks": {
- "url": "string",
- "document": {
- "shared": true,
- "signed": true,
- "declined": true,
- "reviewed": true,
- "meeting_host": true,
- "edited": true,
- "sent_a_copy": true,
- "reminded": true,
- "recalled": true,
- "completed": true,
- "evidence_report_generated": true,
- "deleted": true
}, - "user": {
- "registered": true,
- "updated": true,
- "deleted": true
}, - "errors": {
- "signing": true
}
}, - "download_document_worklfow_completion": {
- "enabled": true
}, - "workflow_completion_report": {
- "enabled": true,
- "url": "string",
- "add_completed_document": true,
- "add_workflow_evidence_report": true
}
}Update Enterprise Advanced Settings
Business applications can use this API to Update Enterprise Advanced Settings.
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:
required | object (EnabledModal) |
| redirect_url_finish | string |
required | object (AdvancedSettingsWebhooks) |
required | object (EnabledModal) |
object (AdvancedSettingsWCReport) |
Responses
Request samples
- Payload
{- "access_document_without_login": {
- "enabled": true
}, - "redirect_url_finish": "string",
- "webhooks": {
- "url": "string",
- "document": {
- "shared": true,
- "signed": true,
- "declined": true,
- "reviewed": true,
- "meeting_host": true,
- "edited": true,
- "sent_a_copy": true,
- "reminded": true,
- "recalled": true,
- "completed": true,
- "evidence_report_generated": true,
- "deleted": true
}, - "user": {
- "registered": true,
- "updated": true,
- "deleted": true
}, - "errors": {
- "signing": true
}
}, - "download_document_worklfow_completion": {
- "enabled": true
}, - "workflow_completion_report": {
- "enabled": true,
- "url": "string",
- "add_completed_document": true,
- "add_workflow_evidence_report": true
}
}Response samples
- 200
- 401
- 403
- 500
{ }Update Enterprise Profile
Business applications can use this service API to update the enterprise profile information of the current enterprise user. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
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 Name of the enterprise whose information requires updating. |
| url required | string non-empty The url for enterprise e.g enterprise name. |
| owner required | string <email> non-empty Owner of the enterprise whose information requires updating. This is a mandatory field and must match with any enterprise user emailAddress for whom the access granted as owner of the enterprise. |
| support_email | string <= 255 characters Support contact email for enterprise |
Responses
Request samples
- Payload
{- "name": "string",
- "url": "string",
- "owner": "user@example.com",
- "support_email": "string"
}Response samples
- 200
- 400
- 403
- 404
- 422
- 500
{ }Get Enterprise Notification Settings
Business applications can use this service API to get the enterprise notification settings. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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
{- "notification_setting": {
- "templates_limit_reached": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "signature_limit_reached": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "workflow_limit_reached": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "simple_electronic_signature_limit_reached": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "user_limit_reached": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "serviceplan_reset": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "serviceplan_change": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "online_payment": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "forgot_password": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "password_changed": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "login_failed": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "document_processed_by_others": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "document_completed": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "daily_summary": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "document_subsequent_changes": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "process_document": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "recall_document": {
- "recipients": "string",
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "share_document": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}
}
}Update Enterprise Notifications Settings
Business applications can use this service API to update the enterprise notification settings. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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 (UpdateEnterpriseNotificationRequest) |
Responses
Request samples
- Payload
{- "notification_setting": {
- "templates_limit_reached": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}
}, - "signature_limit_reached": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}
}, - "workflow_limit_reached": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}
}, - "simple_electronic_signature_limit_reached": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}
}, - "user_limit_reached": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}
}, - "serviceplan_reset": {
- "on_screen": {
- "enabled": true
}
}, - "serviceplan_change": {
- "on_screen": {
- "enabled": true
}
}, - "online_payment": {
- "on_screen": {
- "enabled": true
}
}, - "forgot_password": {
- "on_screen": {
- "enabled": true
}
}, - "password_changed": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}
}, - "login_failed": {
- "on_screen": {
- "enabled": true
}
}, - "document_processed_by_others": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}, - "push": {
- "enabled": true
}
}, - "document_completed": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}, - "push": {
- "enabled": true
}
}, - "daily_summary": {
- "email": {
- "enabled": true
}
}, - "document_subsequent_changes": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}, - "push": {
- "enabled": true
}
}, - "process_document": {
- "email": {
- "enabled": true
}
}, - "recall_document": {
- "recipients": "string",
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}
}, - "share_document": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}, - "push": {
- "enabled": true
}
}
}
}Response samples
- 200
- 400
- 403
- 500
{ }Get Enterprise Email Settings
Business applications can use this service API to get the enterprise email settings. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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
[- {
- "type": "string",
- "subject": "string",
- "body": "string"
}
]Update Enterprise Email Settings
Business applications can use this service API to update the enterprise email settings. The user can update the subject and the body of the enterprise emails but can not update the email type. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication". For these email settings, go to Web Manuals > Configure Enterprise Settings > Configure your enterprise notifications > Configure your enterprise email content.
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:
| type required | string Enum: "WORKFLOW_SHARED" "WORKFLOW_PROCESSED_REVIEWED" "WORKFLOW_COMPLETED" "WORKFLOW_RECALLED" "WORKFLOW_SHARED_REMINDER" "WORKFLOW_POST_PROCESS" "WORKFLOW_SIGNED" "WORKFLOW_PROCESSED_DECLINED" "WORKFLOW_PROCESSED_EDITED" "SEND_A_COPY_SENT" "WORKFLOW_PROCESSED_BY_OTHERS" "WORKFLOW_PROCESSED_BY_ME" "ENTERPRISE_INVITATION" "PUBLISH_WORKFLOW_HISTORY_ON_COMPLETE" "WORKFLOW_ADD_COMMENT" "ACCOUNT_REGISTERED" "ACCOUNT_ACTIVATION_COMPLETION" "ENTERPRISE_USER_REGISTRATION" "ENTERPRISE_RESET_PASSWORD" "ENTERPRISE_PASSWORD_RESET_COMPLETION" "WORKSPACE_SHARED" |
| subject required | string non-empty The subject of the email. |
| body required | string non-empty The body of the email. |
Responses
Request samples
- Payload
{- "type": "WORKFLOW_SHARED",
- "subject": "string",
- "body": "string"
}Response samples
- 200
- 400
- 403
- 404
- 500
{ }Get Enterprise Library Document By ID
Business applications can use this service API to get an enterprise library document. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
path Parameters
| id required | integer <int64> The id of enterprise library 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
{- "document_name": "string",
- "template_name": "string",
- "folder_name": "string",
- "created_on": "string",
- "document_size": 0
}Update Enterprise Library Document
Business applications can use this service API to update an enterprise library document. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
path Parameters
| id required | integer <int64> The id of enterprise library 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:
| document_name required | string [ 1 .. 200 ] characters Name of the library document. |
| folder_name | string <= 255 characters Name of the folder in which library document has to be uploaded. |
| template_name | string <= 255 characters Name of the template, if one is applied on the document. If no template is applied, the value can be "null". |
Responses
Request samples
- Payload
{- "document_name": "string",
- "folder_name": "string",
- "template_name": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Delete Enterprise Library Document
Business applications can use this service API to delete enterprise library document. This API will can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
path Parameters
| id required | integer <int32> The id of enterprise library 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
{ }Add Enterprise Library Document
Business applications can use this service API to add an enterprise library document. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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 required | string Example: File Name File name is required. This will be the name of the uploaded library file. Furthermore, the recommended value for the file name parameter is in Base64 encoded format. |
Request Body schema: multipart/form-data
| file (binary Stream) | string <binary> Default: "" This is the document in the raw binary format, posting via form data. |
| folder_name | string <binary> Default: "" parameter name in string format. |
| template_name | string <binary> Default: "" parameter name in string format. |
Responses
Response samples
- 201
- 400
- 401
- 403
- 404
- 500
{- "id": 0
}Bulk Delete Enterprise Library Documents
Business applications can use this service API to bulk delete the enterprise library documents. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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 ids of enterprise library documents
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Get Enterprise Library Folders
Business applications can use this service API to get the enterprise library folders. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
path Parameters
| pageNo required | integer <int32> |
| recordsPerPage required | integer <int32> |
query Parameters
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "NAME" |
| asc | boolean Default: true |
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: folder Search text if required. This is optional and without it the entire list is returned. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "folder_id": 0,
- "folder_name": "string",
- "created_on": "string"
}
]Get Enterprise Library Folder by ID
Business applications can use this service API to get an enterprise library folder. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
path Parameters
| id required | integer <int64> The id of enterprise library 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 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "folder_name": "string",
- "created_on": "string"
}Update Enterprise Library Folder
Business applications can use this service API to update an enterprise library folder. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
path Parameters
| id required | integer <int64> The id of enterprise library 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:
| folder_name required | string [ 1 .. 255 ] characters Name of the library document folder. |
Responses
Request samples
- Payload
{- "folder_name": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Delete Enterprise Library Folder
Business applications can use this service API to delete an enterprise library folder. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
path Parameters
| id required | integer <int32> The id of enterprise library 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 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{ }Add Enterprise Library Folder
Business applications can use this service API to add an enterprise library folder. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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:
| folder_name required | string [ 1 .. 255 ] characters Name of the library document folder. |
Responses
Request samples
- Payload
{- "folder_name": "string"
}Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0
}Bulk Delete Enterprise Library Folders
Business applications can use this service API to bulk delete enterprise library folders. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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 ids of enterprise library folders
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Move Enterprise Library Document
Business applications can use this service API to move enterprise library documents to library folder of the current user. This API can also be used by the enterprise administrator or the enterpriser user if the "scope" variable was used in the authentication request.
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:
| ids required | Array of integers <int32> [ items <int32 > ] Ids of library documents. |
| folder_name required | string [ 1 .. 255 ] characters Name of the library document folder. |
Responses
Request samples
- Payload
{- "ids": [
- 0
], - "folder_name": "string"
}Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Import Enterprise Library Documents
Business applications can use this service API to import enterprise library documents. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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: multipart/form-data
| file (binary Stream) | string <binary> This is the library document in JSON format, posting via form data. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
[- {
- "document_name": "string",
- "template_name": "string"
}
]Export Enterprise Library Document
Business applications can use this service API to export the enterprise library documents. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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 ids of enterprise library documents
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 500
"string"Bulk Delete Enterprise Legal Notice
Business applications can use this service API to delete a legal notice for Enterprise Users into their Enterprise account. An enterprise Admin who has permissions to manage Advanced Settings in his role, can delete a legal notice. The role dictates things such as allowed Delete advanced settings to the 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 |
Request Body schema:
List of ids of enterprise legal notices
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 404
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Get Enterprise Integrations
Business applications can use this service API to get an integration key for the enterprise.An admin who has permission to manage the integrations in his role can get integration keys. The role specifies permissions, including which integration keys the enterprise can read.
path Parameters
| pageNo required | integer <int32> The page number to be retrieved |
| recordPerPage required | integer <int32> The total number of records to be retrieved in a page. |
query Parameters
| sort-by | string Default: "CLIENT_ID" Enum: "CLIENT_ID" "CALLBACK_URL" "CLIENT_SECRET" "HIDE_DOCUMENTTYPE" "CREATED_ON" A parameter to specify the sorting criteria for the result set. The possible values for “Sort By” are “CLIENT_ID”, “CALLBACK_URL”, “CLIENT_SECRET”,“CREATED_ON”, and “HIDE_DOCUMENTTYPE”. The default value is set to “CLIENT_ID” |
| asc | boolean Default: false A parameter to order the result set in ascending or descending order.The default value is false |
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-search-text | string Example: U2FsZXM= A parameter that represents the search text, if required. This is optional and without it, the entire list is returned |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
[- {
- "id": 0,
- "client_id": "string",
- "created_on": "string",
- "callback_url": "string",
- "client_secret": "string",
- "role_external_users": {
- "id": 0,
- "name": "string",
- "description": "string"
}, - "external_users_count": 0,
- "allowed_roles_scope": [
- {
- "id": 0,
- "name": "string",
- "description": "string"
}
], - "permission_role_scope": {
- "id": 0,
- "name": "string",
- "description": "string"
}, - "hide_recipients_documents": "string",
- "allowed_domains": "string",
- "collapse_panels": true,
- "redirect_callback_url": true,
- "webhooks": {
- "url": "string",
- "document": {
- "shared": true,
- "signed": true,
- "declined": true,
- "reviewed": true,
- "meeting_host": true,
- "edited": true,
- "sent_a_copy": true,
- "reminded": true,
- "recalled": true,
- "completed": true,
- "evidence_report_generated": true,
- "deleted": true
}, - "user": {
- "registered": true,
- "updated": true,
- "deleted": true
}, - "errors": {
- "signing": true
}
}, - "workflow_completion_report": {
- "enabled": true,
- "url": "string",
- "add_completed_document": true,
- "add_workflow_evidence_report": true
}
}
]Get Enterprise Integration By ID
Business applications can use this service API to get integration key for enterprise by its Id. An admin who has permissions to manage Integration in his role, can get Integration keys. The role dictates things such as allowed Read integration keys available to the enterprise.
path Parameters
| id required | integer <int32> Enterprise Integration 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 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "client_id": "string",
- "client_secret": "string",
- "callback_url": "string",
- "role_external_users": {
- "id": 0,
- "name": "string",
- "description": "string"
}, - "allowed_roles_scope": [
- {
- "id": 0,
- "name": "string",
- "description": "string"
}
], - "permission_role_scope": {
- "id": 0,
- "name": "string",
- "description": "string"
}, - "hide_recipients_documents": "string",
- "allowed_domains": "string",
- "collapse_panels": true,
- "redirect_callback_url": true,
- "webhooks": {
- "url": "string",
- "document": {
- "shared": true,
- "signed": true,
- "declined": true,
- "reviewed": true,
- "meeting_host": true,
- "edited": true,
- "sent_a_copy": true,
- "reminded": true,
- "recalled": true,
- "completed": true,
- "evidence_report_generated": true,
- "deleted": true
}, - "user": {
- "registered": true,
- "updated": true,
- "deleted": true
}, - "errors": {
- "signing": true
}
}, - "workflow_completion_report": {
- "enabled": true,
- "url": "string",
- "add_completed_document": true,
- "add_workflow_evidence_report": true
}
}Update Enterprise Integration
Business applications can use this service API to add an integration app key for Enterpsie. An admin who has permissions to manage Enterprise Integrations in his role, can add new Enterprise Integration Keys. The role dictates things such as allowed Edit Enterprise Integrations available to the enterprise.
path Parameters
| id required | integer <int32> Enterprise integration 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:
| client_id required | string [ 1 .. 255 ] characters Client Id for integration App key |
| callback_url required | string non-empty Callback URL for integration App key |
| hide_recipients_documents required | string non-empty Allow documents to be viewed only via this application (Client ID) possible values would be ALL | FIRST | NONE |
| role_external_users required | string non-empty Default role for users who are not part of this enterprise |
| allowed_roles_scope | Array of strings Selet roles containg the users against which you want to permeit performing the actions in the scope |
object Application permission for scope user | |
| allowed_domains | string Only configured domains will be allowed to embed SigningHub document viewer in an iFrame. Multiple domains can be added using separated e.g., https://www.google.com, https://www.hotmail.com |
| collapse_panels required | boolean If enabled, document viewer will be opened in integration with recipients and documents panel collapsed. Users will be able to open these panels by clicking on their respective icons |
| redirect_callback_url required | boolean If enabled, the recipients will be redirected to the callback URL from document viewer after completion on the tasks. |
object (Optional) Send webhook configurations. If not specified, the object will be automatically initialized with default values for its properties. | |
object (Optional) Send workflow completion report configurations. If not specified, the object will be automatically initialized with default values for its properties. |
Responses
Request samples
- Payload
{- "client_id": "string",
- "callback_url": "string",
- "hide_recipients_documents": "string",
- "role_external_users": "string",
- "allowed_roles_scope": [
- "string"
], - "permission_role_scope": {
- "name": "string"
}, - "allowed_domains": "string",
- "collapse_panels": true,
- "redirect_callback_url": true,
- "webhooks": {
- "url": "string",
- "document": {
- "shared": true,
- "signed": true,
- "declined": true,
- "reviewed": true,
- "meeting_host": true,
- "edited": true,
- "sent_a_copy": true,
- "reminded": true,
- "recalled": true,
- "completed": true,
- "evidence_report_generated": true,
- "deleted": true
}, - "user": {
- "registered": true,
- "updated": true,
- "deleted": true
}, - "errors": {
- "signing": true
}
}, - "workflow_completion_report": {
- "enabled": true,
- "url": "string",
- "add_completed_document": true,
- "add_workflow_evidence_report": true
}
}Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0
}Delete Enterprise Integration
Business applications can use this service API to delete a enterprise integration key for Enterprise. An admin who has permissions to manage Enterprise Integrations in his role, can delete enterprise integration key. The role dictates things such as delete Enterprise integration available to the enterprise.
path Parameters
| id required | integer <int32> Enterprise integration 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 |
Responses
Response samples
- 200
- 400
- 401
- 500
{ }Add Enterprise Integration
Business applications can use this service API to add an integration app key for Enterpsie. An admin who has permissions to manage Enterprise Integrations in his role, can add new Enterprise Integration Keys. The role dictates things such as allowed Add Enterprise Integrations available to the enterprise.
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:
| client_id required | string [ 1 .. 255 ] characters Client Id for integration App key |
| callback_url required | string non-empty Callback URL for integration App key |
| hide_recipients_documents required | string non-empty Allow documents to be viewed only via this application (Client ID) possible values would be ALL | FIRST | NONE |
| role_external_users required | string non-empty Default role for users who are not part of this enterprise |
| allowed_roles_scope | Array of strings Selet roles containg the users against which you want to permeit performing the actions in the scope |
object Application permission for scope user | |
| allowed_domains | string Only configured domains will be allowed to embed SigningHub document viewer in an iFrame. Multiple domains can be added using separated e.g., https://www.google.com, https://www.hotmail.com |
| collapse_panels required | boolean If enabled, document viewer will be opened in integration with recipients and documents panel collapsed. Users will be able to open these panels by clicking on their respective icons |
| redirect_callback_url required | boolean If enabled, the recipients will be redirected to the callback URL from document viewer after completion on the tasks. |
object (Optional) Send webhook configurations. If not specified, the object will be automatically initialized with default values for its properties. | |
object (Optional) Send workflow completion report configurations. If not specified, the object will be automatically initialized with default values for its properties. |
Responses
Request samples
- Payload
{- "client_id": "string",
- "callback_url": "string",
- "hide_recipients_documents": "string",
- "role_external_users": "string",
- "allowed_roles_scope": [
- "string"
], - "permission_role_scope": {
- "name": "string"
}, - "allowed_domains": "string",
- "collapse_panels": true,
- "redirect_callback_url": true,
- "webhooks": {
- "url": "string",
- "document": {
- "shared": true,
- "signed": true,
- "declined": true,
- "reviewed": true,
- "meeting_host": true,
- "edited": true,
- "sent_a_copy": true,
- "reminded": true,
- "recalled": true,
- "completed": true,
- "evidence_report_generated": true,
- "deleted": true
}, - "user": {
- "registered": true,
- "updated": true,
- "deleted": true
}, - "errors": {
- "signing": true
}
}, - "workflow_completion_report": {
- "enabled": true,
- "url": "string",
- "add_completed_document": true,
- "add_workflow_evidence_report": true
}
}Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0
}Bulk Delete Enterprise Integrations
Business applications can use this service API to delete list of enterprise integration keys for Enterprise. An admin who has permissions to manage Enterprise Integrations in his role, can delete enterprise integration keys. The role dictates things such as delete Enterprise integration available to the enterprise.
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:
List of ids of enterprise integrations
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 400
- 401
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Generate Client Secret By ID
Business applications can use this service API to generate a client secret using the application key ID.
path Parameters
| id required | integer <int32> |
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
{- "client_secret": "string"
}Get Enterprise Integrations External Users
Business applications can use this service API to get integration External Users for enterprise. An admin who has permissions to manage Integration in his role, can get Integration External users. The role dictates things such as allowed Read integration keys available to the enterprise.
path Parameters
| pageNo required | integer <int32> Page number to be retrieved. |
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
| integrationId required | integer <int32> ID of integration |
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-search-text | string Example: U2FsZXM= A parameter that represents the search text, if required. This is optional and without it, the entire list is returned |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
[- {
- "id": 0,
- "user_email": "string",
- "user_role": {
- "id": 0,
- "name": "string",
- "description": "string"
}
}
]Get Enterprise Integrations External User By Id
Business applications can use this service API to get integration External User for enterprise by its Id. An admin who has permissions to manage Integration in his role, can get Integration keys. The role dictates things such as allowed Read integration keys available to the enterprise.
path Parameters
| integrationId required | integer <int32> ID of integration |
| externalUserId required | integer <int32> External user 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 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "user_email": "string",
- "user_role": {
- "id": 0,
- "name": "string",
- "description": "string"
}
}Update Enterprise Integrations External User
Business applications can use this service API to update an integration external user for Enterpsie Integration App. An admin who has permissions to manage Enterprise Integrations in his role, can update new user in Enterprise Integration Keys. The role dictates things such as allowed Edit Enterprise Integrations available to the enterprise.
path Parameters
| integrationId required | integer <int32> ID of integration |
| externalUserId required | integer <int32> External user 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:
| user_email required | string non-empty User Email address |
| user_role required | string non-empty Role for external user |
Responses
Request samples
- Payload
{- "user_email": "string",
- "user_role": "string"
}Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0
}Delete Enterprise Integration External User
Business applications can use this service API to delete an integration External User for Enterprise. An admin who has permissions to manage Enterprise Integrations in his role, can delete enterprise integration key. The role dictates things such as delete Enterprise integration available to the enterprise.
path Parameters
| integrationId required | integer <int32> ID of integration |
| externalUserId required | integer <int32> External user 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 |
Responses
Response samples
- 200
- 400
- 401
- 500
{ }Add Enterprise Integrations External User
Business applications can use this service API to add an integration External User for Enterpsie Integration App. An admin who has permissions to manage Enterprise Integrations in his role, can add new user in Enterprise Integration Keys. The role dictates things such as allowed Add Enterprise Integrations available to the enterprise.
path Parameters
| integrationId required | integer <int32> ID of integration |
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:
| user_email required | string non-empty User Email address |
| user_role required | string non-empty Role for external user |
Responses
Request samples
- Payload
{- "user_email": "string",
- "user_role": "string"
}Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0
}Add Enterprise Integrations External Users Bulk
Business applications can use this service API to add an integration External User for Enterpsie Integration App. An admin who has permissions to manage Enterprise Integrations in his role, can add new user in Enterprise Integration Keys. The role dictates things such as allowed Add Enterprise Integrations available to the enterprise.
path Parameters
| integrationId required | integer <int32> ID of integration |
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:
| user_email required | string non-empty User Email address |
| user_role required | string non-empty Role for external user |
Responses
Request samples
- Payload
[- {
- "user_email": "string",
- "user_role": "string"
}
]Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0
}Bulk Delete Enterprise Integration External User
Business applications can use this service API to delete integration External Users for Enterprise. An admin who has permissions to manage Enterprise Integrations in his role, can delete enterprise integration key. The role dictates things such as delete Enterprise integration available to the enterprise.
path Parameters
| integrationId required | integer <int32> ID of integration |
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:
List of ids of external Users
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 400
- 401
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Bulk Delete Enterprise Group
Business applications can use this service API to bulk delete enterprise groups of its users. An enterprise Admin or an enterprise user who has permission to manage enterprise groups in this role, can bulk delete enterprise groups of its user. The role dictates whether it is allowed to delete groups available to the user. Bulk delete Enterprise groups should also be allowed with the scope token.
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:
IDs of the enterprise group.
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Get Enterprise Groups
Business applications can use this service API to retrieve enterprise groups for the current user.
It is possible to search based upon the criterion supplied under the "x-search-text" header.
The response contains both the group name and the members thereof.Group member details returned are email address and user name.
path Parameters
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
| pageNo required | integer <int32> Page number to be retrieved. |
query Parameters
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "NAME" "DESCRIPTION" Sort the result by possible values are mentioned above. |
| asc | boolean Default: false Order the result set by ascending or descending. |
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: U2FsZXM= Search text if required. This is optional and without it the entire list is returned. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 403
- 500
[- {
- "id": 0,
- "group_name": "string",
- "created_on": "string",
- "description": "string",
- "enterprise": true,
- "group_members": [
- {
- "user_email": "string",
- "user_name": "string"
}
]
}
]Get Auto Provision Profiles
Business applications can use this API to Get Auto Provision Profiles.
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
- 500
{- "enabled": true,
- "profile_name": "string",
- "scim": {
- "enabled": true
}
}Get Auto Provision Settings
Business applications can use this API to Get Auto Provision Settings.
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
- 500
{- "enabled": true,
- "profile_name": "string",
- "scim": {
- "enabled": true
}
}Update Auto Provision Settings
Business applications can use this API to Update Auto Provision Settings.
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 auto provision setting status value |
object SCIM auto provisioning settings | |
| profile_name | string Authentication profile name |
Responses
Request samples
- Payload
{- "enabled": true,
- "scim": {
- "enabled": true
}, - "profile_name": "string"
}Response samples
- 201
- 401
- 403
- 500
{ }Get Auto Provision Security Groups
Business applications can use this API to Get Auto Provision Security Groups.
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
- 201
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "role": "string"
}
]Add Auto Provision Security Groups
Business applications can use this API to Add Auto Provision Security Groups.
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 non-empty Group name. |
| role required | string non-empty Role name. |
Responses
Request samples
- Payload
{- "name": "string",
- "role": "string"
}Response samples
- 201
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "role": "string"
}
]Update Auto Provision Security Groups
Business applications can use this API to Update Auto Provision Security Groups.
path Parameters
| id required | integer <int32> The id of security group |
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:
| role required | string non-empty Role name. |
Responses
Request samples
- Payload
{- "role": "string"
}Response samples
- 201
- 401
- 403
- 500
{ }Delete Auto Provision Security Group
Business applications can use this API to Delete Auto Provision Security Groups.
path Parameters
| id required | integer <int32> The id of security group |
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
- 201
- 401
- 403
- 500
{ }Bulk Delete Auto Provision Security Groups
Business applications can use this API to Delete Auto Provision Security Groups in Bulk.
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 ids of security groups
Responses
Request samples
- Payload
[- 0
]Response samples
- 201
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Get User Activity of Enterprise user
Business applications can use this API to Get User Activity.
path Parameters
| id required | integer <int32> The id of user |
| pageNo required | integer <int32> Page no |
| recordPerPage required | integer <int32> Record per 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 |
Responses
Response samples
- 201
- 401
- 403
- 500
[- {
- "module": "string",
- "action": "string",
- "information": [
- {
- "key": "string",
- "value": "string"
}
], - "detail": [
- {
- "data": [
- {
- "data": [
- { }
], - "Key": "string",
- "Value": "string",
- "Visible": true,
- "Order": 0,
- "CertificateBase64": "string",
- "Type": "string",
- "ProcessedState": "string"
}
], - "key": "string",
- "value": "string",
- "visible": true,
- "order": 0,
- "type": "string",
- "processed_state": null
}
], - "agent": "string",
- "type": 0,
- "id": 0,
- "created_on": "2019-08-24T14:15:22Z",
- "dst_offset": "string",
- "info_key": "string",
- "package_name": "string"
}
]Get Enterprise User Consumed Statistics
Business applications can use this API to Get Enterprise User Consumed Statistics.
path Parameters
| id required | integer <int32> The id of enterprise 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 |
Responses
Response samples
- 201
- 401
- 403
- 500
[- {
- "user_name": "string",
- "user_email": "string",
- "signatures": {
- "allowed": "string",
- "consumed": "string",
- "serviceplan": {
- "allowed": "string"
}
}, - "advanced_electronic_signatures": {
- "allowed": "string",
- "consumed": "string",
- "serviceplan": {
- "allowed": "string"
}
}, - "high_trust_advanced_signatures": {
- "allowed": "string",
- "consumed": "string",
- "serviceplan": {
- "allowed": "string"
}
}, - "qualified_electronic_signatures": {
- "allowed": "string",
- "consumed": "string",
- "serviceplan": {
- "allowed": "string"
}
}, - "electronic_seals": {
- "allowed": "string",
- "consumed": "string",
- "serviceplan": {
- "allowed": "string"
}
}, - "advanced_electronic_seals": {
- "allowed": "string",
- "consumed": "string",
- "serviceplan": {
- "allowed": "string"
}
}, - "qualified_electronic_seals": {
- "allowed": "string",
- "consumed": "string",
- "serviceplan": {
- "allowed": "string"
}
}, - "simple_electronic_sigantures": {
- "allowed": "string",
- "consumed": "string",
- "serviceplan": {
- "allowed": "string"
}
}, - "storage": {
- "allowed": "string",
- "consumed": "string",
- "serviceplan": {
- "allowed": "string"
}
}, - "workflows": {
- "allowed": "string",
- "consumed": "string",
- "serviceplan": {
- "allowed": "string"
}
}, - "upload_size": {
- "allowed": "string",
- "serviceplan": {
- "allowed": "string"
}
}, - "templates": {
- "allowed": "string",
- "consumed": "string",
- "serviceplan": {
- "allowed": "string"
}
}
}
]Update Enterprise User Consumed Statistics
Business applications can use this API to Update Enterprise User Consumed Statistics.
path Parameters
| id required | integer <int32> The id of enterprise 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 |
Request Body schema:
required | object Allowed signatures |
required | object Allowed Advanced Electronic Signatures |
required | object Allowed High Trust Advanced Signatures |
required | object Allowed Qualified Electronic Signatures |
required | object Allowed Electronic Seals |
required | object Allowed Advanced Electronic Seals |
required | object Allowed Qualified Electronic Seals |
required | object Allowed simple electronic Signatures |
required | object Allowed storage in bytes |
required | object Allowed workflows |
required | object Allowed upload size in bytes |
required | object Allowed templates |
Responses
Request samples
- Payload
{- "signatures": {
- "allowed": "string"
}, - "advanced_electronic_signatures": {
- "allowed": "string"
}, - "high_trust_advanced_signatures": {
- "allowed": "string"
}, - "qualified_electronic_signatures": {
- "allowed": "string"
}, - "electronic_seals": {
- "allowed": "string"
}, - "advanced_electronic_seals": {
- "allowed": "string"
}, - "qualified_electronic_seals": {
- "allowed": "string"
}, - "simple_electronic_sigantures": {
- "allowed": "string"
}, - "storage": {
- "allowed": "string"
}, - "workflows": {
- "allowed": "string"
}, - "upload_size": {
- "allowed": "string"
}, - "templates": {
- "allowed": "string"
}
}Response samples
- 201
- 401
- 403
- 500
{ }Reset Enterprise User Password
Business applications can use this API to Reset Enterprise User Password.
path Parameters
| id required | integer <int32> The id of enterprise 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 |
Responses
Response samples
- 200
- 401
- 403
- 500
{ }Reset Enterprise User Two Factor Authentication
Business applications can use this API to Reset Enterprise User Two Factor Authentication.
path Parameters
| id required | integer <int64> The id of enterprise 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 |
Responses
Response samples
- 200
- 401
- 403
- 500
{ }Export Enterprise Users
Business applications can use this service API to export the enterprise users list to Excel. This API will can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
path Parameters
| 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
| user-name | string Default: "" |
| common-name | string Default: "" |
string Default: "" | |
| job-title | string Default: "" |
| country | string Default: "" |
| national-id | string Default: "" |
| activated | string Default: "" allowed values are [ YES | NO ] |
| enabled | string Default: "" allowed values are [ YES | NO ] |
| created-from | string <date-time> |
| created-to | string <date-time> |
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "NAME" "ROLE" "STATUS" "NID" Sort the result by possible values are mentioned above. |
| asc | boolean Default: false Order the result set by ascending or descending. |
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
"string"Import Enterprise User Template
Business applications can use this service API to get recipient import template for enterprise 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 |
Responses
Response samples
- 200
- 401
- 403
- 500
"string"Add Enterprise Contact
Business applications can use this service API to add enterprise contact. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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_name required | string [ 1 .. 255 ] characters User name of the user to be added as a contact. |
| user_email required | string [ 1 .. 255 ] characters Email address of the user to be added as a contact. |
| mobile_number | string <= 15 characters Mobile Number |
Responses
Request samples
- Payload
{- "user_name": "string",
- "user_email": "string",
- "mobile_number": "string"
}Response samples
- 201
- 401
- 403
- 422
- 500
{- "id": 0,
- "created_on": "string"
}Get Enterprise Contact by Id
Business applications can use this service API to get enterprise contact. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
path Parameters
| id required | integer <int64> ID of the enterprise contact. |
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",
- "user_national_id": "string",
- "mobile_number": "string"
}Delete Enterprise Contact
Business applications can use this service API to delete enterprise contact. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
path Parameters
| id required | integer <int64> ID of the enterprise contact. |
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
{ }Update Enterprise Contact
Business applications can use this service API to update enterprise contact. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
path Parameters
| id required | integer <int64> ID of the enterprise contact. |
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_name required | string [ 1 .. 255 ] characters User name of the user to be updated as of a contact. |
| mobile_number | string <= 15 characters Mobile number. If no value is provided, old value will be retained. |
Responses
Request samples
- Payload
{- "user_name": "string",
- "mobile_number": "string"
}Response samples
- 200
- 403
- 404
- 500
{ }Bulk Delete Enterprise Contact
Business applications can use this service API to bulk delete enterprise contact. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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:
IDs of the enterprise contact.
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Bulk Import Enterprise Contacts
Business applications can use this service API to import the bulk enterprise contact. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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: multipart/form-data
| file (binary Stream) | string <binary> This is the contacts document in CSV format, posting via form data. |
Responses
Response samples
- 200
- 401
- 403
- 422
- 500
{- "success": [
- {
- "id": 0,
- "user_name": "string",
- "user_email": "string",
- "mobile_number": "string",
- "created_on": "string"
}
], - "failure": [
- {
- "user_name": "string",
- "user_email": "string",
- "error_message": "string"
}
]
}Get Enterprise Contacts
Business applications can use this service API to retrieve enterprise contacts for the current user.
It is possible to search based upon the criterion supplied under the "x-search-text" header.
The search response information contains the user email address and respective user name.
path Parameters
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
| pageNo required | integer <int32> Page number to be retrieved. |
query Parameters
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "NAME" "EMAIL" Sort the result by possible values are mentioned above. |
| asc | boolean Default: false Order the result set by ascending or descending. |
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: am9obg== Search text if required. This is optional and without it the entire list is returned. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 403
- 500
[- {
- "id": 0,
- "user_name": "string",
- "user_email": "string",
- "mobile_number": "string",
- "enterprise": true,
- "user_national_id": "string",
- "created_on": "string"
}
]Get Roles
Business applications can use this service API to get roles for enterprise. An admin who has permissions to manage Roles in his role, can get Role users. The role dictates things such as allowed Read role users available to the enterprise.
path Parameters
| pageNo required | integer <int32> Page number to be retrieved. |
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
query Parameters
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "NAME" "DESCRIPTION" "DEFAULT" "USERCOUNT" Sort the result by possible values are mentioned above. |
| asc | boolean Default: false Sort order. |
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: U2FsZXM= Search text if required. This is optional and without it the entire list is returned. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "description": "string",
- "default": true,
- "created_on": "string",
- "user_count": 0
}
]Get Role Users
Business applications can use this service API to get roles for enterprise. An admin who has permissions to manage Roles/Users/Integrations/Advanced/Electronic Seal in his role, can get Roles. The role dictates things such as allowed Read roles available to the enterprise.
path Parameters
| id required | integer <int32> Role id. |
| pageNo required | integer <int32> Page number to be retrieved. |
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
query Parameters
| sort-by | string Default: "NAME" Enum: "NAME" "EMAILADDRESS" |
| asc | boolean Default: false |
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-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
[- {
- "user_name": "string",
- "user_email": "string",
- "created_on": "string",
- "status": "string"
}
]Get Role By Id
Business applications can use this service API to get role for enterprise. An admin who has permissions to manage Role in his role, can get role. The role dictates things such as allowed Read role available to the enterprise.
path Parameters
| id required | integer <int32> Role id |
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
{- "id": 0,
- "name": "string",
- "description": "string",
- "default": true,
- "created_on": "string",
- "user_settings": {
- "signature_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "groups": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "templates": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "library": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "notification_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "legal_notices": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "delegate_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "advanced": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "smart_form": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "cloud_drives": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}, - "googledrive": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "onedrive": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "dropbox": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}
}
}, - "enterprise_settings": {
- "profile": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "users": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "roles": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "groups": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "templates": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "library": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "notification_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "billing": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "integrations": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "branding": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "reports": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "documents": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "logs": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "advanced_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "advanced_reports_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "electronic_seals": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}
}, - "document_settings": {
- "owner_settings": {
- "upload_share": {
- "enabled": true,
- "settings": {
- "start_existing_workflow": true,
- "replicate_workflow": true,
- "enterprise_only": true,
- "workflow_mode": "string",
- "workflow_type": "string"
}
}, - "manage_recipient": {
- "enabled": true
}, - "print_document": {
- "enabled": true
}, - "download_document": {
- "enabled": true
}, - "attachment_merging": {
- "enabled": true
}, - "recall_document": {
- "enabled": true
}, - "workflow_details": {
- "enabled": true
}, - "save_template": {
- "enabled": true
}, - "invisible_signature": {
- "enabled": true
}, - "access_authentication_all_recipient": {
- "enabled": true
}, - "signing_authentication_all_recipient": {
- "enabled": true
}, - "post_processing_all_recipient": {
- "enabled": true
}
}, - "field_settings": {
- "signature": {
- "enabled": true,
- "level_of_assurance": {
- "selected": [
- "string"
], - "default": [
- "string"
]
}
}, - "inperson": {
- "enabled": true,
- "level_of_assurance": {
- "selected": [
- "string"
], - "default": [
- "string"
]
}
}, - "initial": {
- "enabled": true
}, - "form_fields": {
- "name": {
- "enabled": true
}, - "email": {
- "enabled": true
}, - "job_title": {
- "enabled": true
}, - "company": {
- "enabled": true
}, - "date": {
- "enabled": true
}, - "textbox": {
- "enabled": true
}, - "text_area": {
- "enabled": true
}, - "radio": {
- "enabled": true
}, - "checkbox": {
- "enabled": true
}, - "qrcode": {
- "enabled": true
}, - "add_text": {
- "enabled": true
}, - "attachment": {
- "enabled": true
}
}
}, - "certify_options": {
- "selected": [
- "string"
], - "default": "string"
}, - "templates": {
- "allowed": "string",
- "selected": [
- {
- "id": 0,
- "name": "string"
}
]
}, - "library": {
- "allowed": "string",
- "selected": [
- {
- "id": 0,
- "name": "string"
}
]
}, - "recipient_settings": {
- "auto_finish": true,
- "auto_close_viewer": true
}, - "miscellaneous_settings": {
- "comments": {
- "enabled": true
}, - "delete_documents": {
- "enabled": true
}, - "bulk_signing": {
- "enabled": true
}, - "action_behalf_enterprise_user": {
- "enabled": true
}, - "delegated_signing_registerd_users": {
- "enabled": true
}, - "shared_spaces": {
- "enabled": true
}, - "sign_documents": {
- "enabled": true
}, - "personal_contacts_groups": {
- "enabled": true
}
}
}, - "signature_settings": {
- "signing_servers": [
- {
- "info": {
- "id": 0,
- "name": "string",
- "order": 0,
- "provider": "string",
- "key_location": "string",
- "level_of_assurance": "string",
- "appearance_design_name": "string",
- "appearance_logo": "string",
- "auth_type": "string"
}, - "capacity": {
- "electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "advanced_electronic_signature": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "high_trust_advanced": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "qualified_electronic_signature": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "default_capacity": {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
}, - "authentications": {
- "no_password": {
- "primary": {
- "web": {
- "selected": {
- "id": 0,
- "name": "string"
}
}, - "mobile": {
- "selected": {
- "id": 0,
- "name": "string"
}
}
}, - "secondary": {
- "web": {
- "selected": {
- "name": "string"
}
}, - "mobile": {
- "selected": {
- "name": "string"
}
}
}
}, - "system_password": {
- "primary": {
- "web": {
- "selected": {
- "id": 0,
- "name": "string"
}
}, - "mobile": {
- "selected": {
- "id": 0,
- "name": "string"
}
}
}, - "secondary": {
- "web": {
- "selected": {
- "name": "string"
}
}, - "mobile": {
- "selected": {
- "name": "string"
}
}
}
}, - "user_password": {
- "primary": "string",
- "secondary": {
- "selected": {
- "name": "string"
}
}
}, - "remote_authorization": {
- "primary": "string",
- "secondary": "string"
}
}
}
], - "metadata": {
- "signing_reason": {
- "enabled": true,
- "type": {
- "selection": "string",
- "value": "string",
- "custom": true
}
}, - "signing_location": {
- "enabled": true,
- "location": "string"
}, - "contact_information": true
}, - "signing_dialog_visible": true
}, - "appearance_settings": {
- "signature": {
- "web": {
- "methods": {
- "text": {
- "enabled": true,
- "disable_text_field": true
}, - "draw": {
- "enabled": true
}, - "upload": {
- "enabled": true
}, - "signature_pad": {
- "enabled": true
}
}, - "default_method": "string"
}, - "mobile": {
- "methods": {
- "text": {
- "enabled": true,
- "disable_text_field": true
}, - "draw": {
- "enabled": true
}, - "upload": {
- "enabled": true
}, - "signature_pad": {
- "enabled": true
}
}, - "default_method": "string"
}
}, - "initial": {
- "methods": {
- "text": {
- "enabled": true,
- "disable_text_field": true
}, - "draw": {
- "enabled": true
}, - "upload": {
- "enabled": true
}, - "signature_pad": {
- "enabled": true
}
}, - "default_method": "string"
}, - "appearance_design": {
- "selected": [
- {
- "design_name": "string",
- "design_preview": "string",
- "design_preview_url": "string"
}
], - "default": {
- "design_name": "string",
- "design_preview": "string",
- "design_preview_url": "string"
}
}, - "manage_signature_logo": {
- "enabled": true
}, - "simple_electronic_signature_appearance_design": {
- "enabled": true
}, - "font": {
- "default": {
- "name": "string"
}
}
}, - "authentication_settings": {
- "primary": {
- "default": {
- "id": 0,
- "name": "string"
}
}, - "secondary": {
- "default": {
- "name": "string"
}
}, - "allow_public_authentications": true
}
}Delete Role
Business applications can use this service API to delete a role for Enterprise. An admin who has permissions to manage role in his role, can delete role. The role dictates things such as allowed role available to the enterprise.
path Parameters
| id required | integer <int32> The id of role |
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
{ }Update Role
Business applications can use this service API to update a role for Enterprise.An admin who has permissions to manage role in his role, can update new role. The role dictates things such as allowed Update role available to the enterprise.
path Parameters
| id required | integer <int32> The id of role |
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 Name |
| description | string Description |
| default required | boolean Default |
required | object User settings |
required | object Enterprise settings |
required | object Document settings |
object Signature settings | |
object Appearance settings | |
required | object Authentication settings |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "default": true,
- "user_settings": {
- "signature_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "groups": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "templates": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "library": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "notification_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "legal_notices": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "delegate_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "advanced": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "smart_form": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "cloud_drives": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}, - "googledrive": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "onedrive": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "dropbox": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}
}
}, - "enterprise_settings": {
- "profile": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "users": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "roles": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "groups": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "templates": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "library": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "notification_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "billing": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "integrations": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "branding": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "reports": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "documents": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "logs": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "advanced_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "advanced_reports_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}, - "electronic_seals": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true
}, - "add": {
- "enabled": true
}, - "update": {
- "enabled": true
}, - "delete": {
- "enabled": true
}
}
}
}, - "document_settings": {
- "owner_settings": {
- "upload_share": {
- "enabled": true,
- "settings": {
- "start_existing_workflow": true,
- "replicate_workflow": true,
- "enterprise_only": true,
- "workflow_mode": "string",
- "workflow_type": "string"
}
}, - "manage_recipient": {
- "enabled": true
}, - "print_document": {
- "enabled": true
}, - "download_document": {
- "enabled": true
}, - "attachment_merging": {
- "enabled": true
}, - "recall_document": {
- "enabled": true
}, - "workflow_details": {
- "enabled": true
}, - "save_template": {
- "enabled": true
}, - "invisible_signature": {
- "enabled": true
}, - "access_authentication_all_recipient": {
- "enabled": true
}, - "signing_authentication_all_recipient": {
- "enabled": true
}, - "post_processing_all_recipient": {
- "enabled": true
}
}, - "field_settings": {
- "signature": {
- "enabled": true,
- "level_of_assurance": {
- "selected": [
- "string"
], - "default": [
- "string"
]
}
}, - "inperson": {
- "enabled": true,
- "level_of_assurance": {
- "selected": [
- "string"
], - "default": [
- "string"
]
}
}, - "initial": {
- "enabled": true
}, - "form_fields": {
- "name": {
- "enabled": true
}, - "email": {
- "enabled": true
}, - "job_title": {
- "enabled": true
}, - "company": {
- "enabled": true
}, - "date": {
- "enabled": true
}, - "textbox": {
- "enabled": true
}, - "text_area": {
- "enabled": true
}, - "radio": {
- "enabled": true
}, - "checkbox": {
- "enabled": true
}, - "qrcode": {
- "enabled": true
}, - "add_text": {
- "enabled": true
}, - "attachment": {
- "enabled": true
}
}
}, - "certify_options": {
- "selected": [
- "string"
], - "default": "string"
}, - "templates": {
- "allowed": "string",
- "selected": [
- {
- "id": 0,
- "name": "string"
}
]
}, - "library": {
- "allowed": "string",
- "selected": [
- {
- "id": 0,
- "name": "string"
}
]
}, - "recipient_settings": {
- "auto_finish": true,
- "auto_close_viewer": true
}, - "miscellaneous_settings": {
- "comments": {
- "enabled": true
}, - "delete_documents": {
- "enabled": true
}, - "bulk_signing": {
- "enabled": true
}, - "action_behalf_enterprise_user": {
- "enabled": true
}, - "delegated_signing_registerd_users": {
- "enabled": true
}, - "shared_spaces": {
- "enabled": true
}, - "sign_documents": {
- "enabled": true
}, - "personal_contacts_groups": {
- "enabled": true
}
}
}, - "signature_settings": {
- "signing_servers": [
- {
- "info": {
- "name": "string",
- "order": 1,
- "key_location": "string",
- "appearance_design_name": "string",
- "appearance_logo": "string"
}, - "capacity": {
- "electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "name": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "name": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "name": "string"
}
]
}, - "advanced_electronic_signature": {
- "enabled": true,
- "selected": [
- {
- "name": "string"
}
]
}, - "high_trust_advanced": {
- "enabled": true,
- "selected": [
- {
- "name": "string"
}
]
}, - "qualified_electronic_signature": {
- "enabled": true,
- "selected": [
- {
- "name": "string"
}
]
}, - "default_capacity": {
- "name": "string"
}
}, - "authentications": {
- "no_password": {
- "primary": {
- "web": {
- "selected": {
- "name": "string"
}
}, - "mobile": {
- "selected": {
- "name": "string"
}
}
}, - "secondary": {
- "web": {
- "selected": {
- "name": "string"
}
}, - "mobile": {
- "selected": {
- "name": "string"
}
}
}
}, - "system_password": {
- "primary": {
- "web": {
- "selected": {
- "name": "string"
}
}, - "mobile": {
- "selected": {
- "name": "string"
}
}
}, - "secondary": {
- "web": {
- "selected": {
- "name": "string"
}
}, - "mobile": {
- "selected": {
- "name": "string"
}
}
}
}, - "user_password": {
- "secondary": {
- "selected": {
- "name": "string"
}
}
}
}
}
], - "metadata": {
- "signing_reason": {
- "enabled": true,
- "type": {
- "selection": "string",
- "value": "string",
- "custom": true
}
}, - "signing_location": {
- "enabled": true,
- "location": "string"
}, - "contact_information": true
}, - "signing_dialog_visible": true
}, - "appearance_settings": {
- "signature": {
- "web": {
- "methods": {
- "text": {
- "enabled": true,
- "disable_text_field": true
}, - "draw": {
- "enabled": true
}, - "upload": {
- "enabled": true
}, - "signature_pad": {
- "enabled": true
}
}, - "default_method": "string"
}, - "mobile": {
- "methods": {
- "text": {
- "enabled": true,
- "disable_text_field": true
}, - "draw": {
- "enabled": true
}, - "upload": {
- "enabled": true
}, - "signature_pad": {
- "enabled": true
}
}, - "default_method": "string"
}
}, - "initial": {
- "methods": {
- "text": {
- "enabled": true,
- "disable_text_field": true
}, - "draw": {
- "enabled": true
}, - "upload": {
- "enabled": true
}, - "signature_pad": {
- "enabled": true
}
}, - "default_method": "string"
}, - "appearance_design": {
- "selected": [
- {
- "design_name": "string"
}
], - "default": {
- "design_name": "string"
}
}, - "manage_signature_logo": {
- "enabled": true
}, - "simple_electronic_signature_appearance_design": {
- "enabled": true
}, - "font": {
- "default": {
- "name": "string"
}
}
}, - "authentication_settings": {
- "primary": {
- "default": {
- "name": "string"
}
}, - "secondary": {
- "default": {
- "name": "string"
}
}, - "allow_public_authentications": true
}
}Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{ }Add Role
Business applications can use this service API to add a role for Enterprise. An admin who has permissions to manage role in his role, can add new role. The role dictates things such as allowed Add role available to the enterprise.
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 Name |
| description | string Description |
| default required | boolean Default |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "default": true
}Response samples
- 201
- 401
- 403
- 422
- 500
{- "id": 0,
- "name": "string",
- "description": "string",
- "default": true,
- "created_on": "string",
- "user_settings": {
- "signature_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "groups": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "templates": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "library": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "notification_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "legal_notices": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "delegate_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "advanced": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "smart_form": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "cloud_drives": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}, - "googledrive": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "onedrive": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "dropbox": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}
}
}, - "enterprise_settings": {
- "profile": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "users": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "roles": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "groups": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "templates": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "library": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "notification_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "billing": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "integrations": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "branding": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "reports": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "documents": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "logs": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "advanced_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "advanced_reports_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "electronic_seals": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}
}, - "document_settings": {
- "owner_settings": {
- "upload_share": {
- "enabled": true,
- "settings": {
- "start_existing_workflow": true,
- "replicate_workflow": true,
- "enterprise_only": true,
- "workflow_mode": "string",
- "workflow_type": "string"
}
}, - "manage_recipient": {
- "enabled": true
}, - "print_document": {
- "enabled": true
}, - "download_document": {
- "enabled": true
}, - "attachment_merging": {
- "enabled": true
}, - "recall_document": {
- "enabled": true
}, - "workflow_details": {
- "enabled": true
}, - "save_template": {
- "enabled": true
}, - "invisible_signature": {
- "enabled": true
}, - "access_authentication_all_recipient": {
- "enabled": true
}, - "signing_authentication_all_recipient": {
- "enabled": true
}, - "post_processing_all_recipient": {
- "enabled": true
}
}, - "field_settings": {
- "signature": {
- "enabled": true,
- "level_of_assurance": {
- "selected": [
- "string"
], - "default": [
- "string"
]
}
}, - "inperson": {
- "enabled": true,
- "level_of_assurance": {
- "selected": [
- "string"
], - "default": [
- "string"
]
}
}, - "initial": {
- "enabled": true
}, - "form_fields": {
- "name": {
- "enabled": true
}, - "email": {
- "enabled": true
}, - "job_title": {
- "enabled": true
}, - "company": {
- "enabled": true
}, - "date": {
- "enabled": true
}, - "textbox": {
- "enabled": true
}, - "text_area": {
- "enabled": true
}, - "radio": {
- "enabled": true
}, - "checkbox": {
- "enabled": true
}, - "qrcode": {
- "enabled": true
}, - "add_text": {
- "enabled": true
}, - "attachment": {
- "enabled": true
}
}
}, - "certify_options": {
- "selected": [
- "string"
], - "default": "string"
}, - "templates": {
- "allowed": "string",
- "selected": [
- {
- "id": 0,
- "name": "string"
}
]
}, - "library": {
- "allowed": "string",
- "selected": [
- {
- "id": 0,
- "name": "string"
}
]
}, - "recipient_settings": {
- "auto_finish": true,
- "auto_close_viewer": true
}, - "miscellaneous_settings": {
- "comments": {
- "enabled": true
}, - "delete_documents": {
- "enabled": true
}, - "bulk_signing": {
- "enabled": true
}, - "action_behalf_enterprise_user": {
- "enabled": true
}, - "delegated_signing_registerd_users": {
- "enabled": true
}, - "shared_spaces": {
- "enabled": true
}, - "sign_documents": {
- "enabled": true
}, - "personal_contacts_groups": {
- "enabled": true
}
}
}, - "signature_settings": {
- "signing_servers": [
- {
- "info": {
- "id": 0,
- "name": "string",
- "order": 0,
- "provider": "string",
- "key_location": "string",
- "level_of_assurance": "string",
- "appearance_design_name": "string",
- "appearance_logo": "string",
- "auth_type": "string"
}, - "capacity": {
- "electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "advanced_electronic_signature": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "high_trust_advanced": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "qualified_electronic_signature": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "default_capacity": {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
}, - "authentications": {
- "no_password": {
- "primary": {
- "web": {
- "selected": {
- "id": 0,
- "name": "string"
}
}, - "mobile": {
- "selected": {
- "id": 0,
- "name": "string"
}
}
}, - "secondary": {
- "web": {
- "selected": {
- "name": "string"
}
}, - "mobile": {
- "selected": {
- "name": "string"
}
}
}
}, - "system_password": {
- "primary": {
- "web": {
- "selected": {
- "id": 0,
- "name": "string"
}
}, - "mobile": {
- "selected": {
- "id": 0,
- "name": "string"
}
}
}, - "secondary": {
- "web": {
- "selected": {
- "name": "string"
}
}, - "mobile": {
- "selected": {
- "name": "string"
}
}
}
}, - "user_password": {
- "primary": "string",
- "secondary": {
- "selected": {
- "name": "string"
}
}
}, - "remote_authorization": {
- "primary": "string",
- "secondary": "string"
}
}
}
], - "metadata": {
- "signing_reason": {
- "enabled": true,
- "type": {
- "selection": "string",
- "value": "string",
- "custom": true
}
}, - "signing_location": {
- "enabled": true,
- "location": "string"
}, - "contact_information": true
}, - "signing_dialog_visible": true
}, - "appearance_settings": {
- "signature": {
- "web": {
- "methods": {
- "text": {
- "enabled": true,
- "disable_text_field": true
}, - "draw": {
- "enabled": true
}, - "upload": {
- "enabled": true
}, - "signature_pad": {
- "enabled": true
}
}, - "default_method": "string"
}, - "mobile": {
- "methods": {
- "text": {
- "enabled": true,
- "disable_text_field": true
}, - "draw": {
- "enabled": true
}, - "upload": {
- "enabled": true
}, - "signature_pad": {
- "enabled": true
}
}, - "default_method": "string"
}
}, - "initial": {
- "methods": {
- "text": {
- "enabled": true,
- "disable_text_field": true
}, - "draw": {
- "enabled": true
}, - "upload": {
- "enabled": true
}, - "signature_pad": {
- "enabled": true
}
}, - "default_method": "string"
}, - "appearance_design": {
- "selected": [
- {
- "design_name": "string",
- "design_preview": "string",
- "design_preview_url": "string"
}
], - "default": {
- "design_name": "string",
- "design_preview": "string",
- "design_preview_url": "string"
}
}, - "manage_signature_logo": {
- "enabled": true
}, - "simple_electronic_signature_appearance_design": {
- "enabled": true
}, - "font": {
- "default": {
- "name": "string"
}
}
}, - "authentication_settings": {
- "primary": {
- "default": {
- "id": 0,
- "name": "string"
}
}, - "secondary": {
- "default": {
- "name": "string"
}
}, - "allow_public_authentications": true
}
}Clone Role
Business applications can use this service API to clone a role for Enterprise.An admin who has permissions to manage role in his role, can clone role. The role dictates things such as allowed Add role available to the enterprise.
path Parameters
| id required | integer <int32> The id of role that need to be clone |
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 Name |
| description | string Description |
| default required | boolean Default |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "default": true
}Response samples
- 201
- 401
- 403
- 404
- 422
- 500
{- "id": 0,
- "name": "string",
- "description": "string",
- "default": true,
- "created_on": "string",
- "user_settings": {
- "signature_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "groups": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "templates": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "library": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "notification_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "legal_notices": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "delegate_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "advanced": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "smart_form": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "cloud_drives": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}, - "googledrive": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "onedrive": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "dropbox": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}
}
}, - "enterprise_settings": {
- "profile": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "users": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "roles": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "groups": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "templates": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "library": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "notification_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "billing": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "integrations": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "branding": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "reports": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "documents": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "logs": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "advanced_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "advanced_reports_settings": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}, - "electronic_seals": {
- "enabled": true,
- "permissions": {
- "read": {
- "enabled": true,
- "editable": true
}, - "add": {
- "enabled": true,
- "editable": true
}, - "update": {
- "enabled": true,
- "editable": true
}, - "delete": {
- "enabled": true,
- "editable": true
}
}
}
}, - "document_settings": {
- "owner_settings": {
- "upload_share": {
- "enabled": true,
- "settings": {
- "start_existing_workflow": true,
- "replicate_workflow": true,
- "enterprise_only": true,
- "workflow_mode": "string",
- "workflow_type": "string"
}
}, - "manage_recipient": {
- "enabled": true
}, - "print_document": {
- "enabled": true
}, - "download_document": {
- "enabled": true
}, - "attachment_merging": {
- "enabled": true
}, - "recall_document": {
- "enabled": true
}, - "workflow_details": {
- "enabled": true
}, - "save_template": {
- "enabled": true
}, - "invisible_signature": {
- "enabled": true
}, - "access_authentication_all_recipient": {
- "enabled": true
}, - "signing_authentication_all_recipient": {
- "enabled": true
}, - "post_processing_all_recipient": {
- "enabled": true
}
}, - "field_settings": {
- "signature": {
- "enabled": true,
- "level_of_assurance": {
- "selected": [
- "string"
], - "default": [
- "string"
]
}
}, - "inperson": {
- "enabled": true,
- "level_of_assurance": {
- "selected": [
- "string"
], - "default": [
- "string"
]
}
}, - "initial": {
- "enabled": true
}, - "form_fields": {
- "name": {
- "enabled": true
}, - "email": {
- "enabled": true
}, - "job_title": {
- "enabled": true
}, - "company": {
- "enabled": true
}, - "date": {
- "enabled": true
}, - "textbox": {
- "enabled": true
}, - "text_area": {
- "enabled": true
}, - "radio": {
- "enabled": true
}, - "checkbox": {
- "enabled": true
}, - "qrcode": {
- "enabled": true
}, - "add_text": {
- "enabled": true
}, - "attachment": {
- "enabled": true
}
}
}, - "certify_options": {
- "selected": [
- "string"
], - "default": "string"
}, - "templates": {
- "allowed": "string",
- "selected": [
- {
- "id": 0,
- "name": "string"
}
]
}, - "library": {
- "allowed": "string",
- "selected": [
- {
- "id": 0,
- "name": "string"
}
]
}, - "recipient_settings": {
- "auto_finish": true,
- "auto_close_viewer": true
}, - "miscellaneous_settings": {
- "comments": {
- "enabled": true
}, - "delete_documents": {
- "enabled": true
}, - "bulk_signing": {
- "enabled": true
}, - "action_behalf_enterprise_user": {
- "enabled": true
}, - "delegated_signing_registerd_users": {
- "enabled": true
}, - "shared_spaces": {
- "enabled": true
}, - "sign_documents": {
- "enabled": true
}, - "personal_contacts_groups": {
- "enabled": true
}
}
}, - "signature_settings": {
- "signing_servers": [
- {
- "info": {
- "id": 0,
- "name": "string",
- "order": 0,
- "provider": "string",
- "key_location": "string",
- "level_of_assurance": "string",
- "appearance_design_name": "string",
- "appearance_logo": "string",
- "auth_type": "string"
}, - "capacity": {
- "electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "advanced_electronic_signature": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "high_trust_advanced": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "qualified_electronic_signature": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "default_capacity": {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
}, - "authentications": {
- "no_password": {
- "primary": {
- "web": {
- "selected": {
- "id": 0,
- "name": "string"
}
}, - "mobile": {
- "selected": {
- "id": 0,
- "name": "string"
}
}
}, - "secondary": {
- "web": {
- "selected": {
- "name": "string"
}
}, - "mobile": {
- "selected": {
- "name": "string"
}
}
}
}, - "system_password": {
- "primary": {
- "web": {
- "selected": {
- "id": 0,
- "name": "string"
}
}, - "mobile": {
- "selected": {
- "id": 0,
- "name": "string"
}
}
}, - "secondary": {
- "web": {
- "selected": {
- "name": "string"
}
}, - "mobile": {
- "selected": {
- "name": "string"
}
}
}
}, - "user_password": {
- "primary": "string",
- "secondary": {
- "selected": {
- "name": "string"
}
}
}, - "remote_authorization": {
- "primary": "string",
- "secondary": "string"
}
}
}
], - "metadata": {
- "signing_reason": {
- "enabled": true,
- "type": {
- "selection": "string",
- "value": "string",
- "custom": true
}
}, - "signing_location": {
- "enabled": true,
- "location": "string"
}, - "contact_information": true
}, - "signing_dialog_visible": true
}, - "appearance_settings": {
- "signature": {
- "web": {
- "methods": {
- "text": {
- "enabled": true,
- "disable_text_field": true
}, - "draw": {
- "enabled": true
}, - "upload": {
- "enabled": true
}, - "signature_pad": {
- "enabled": true
}
}, - "default_method": "string"
}, - "mobile": {
- "methods": {
- "text": {
- "enabled": true,
- "disable_text_field": true
}, - "draw": {
- "enabled": true
}, - "upload": {
- "enabled": true
}, - "signature_pad": {
- "enabled": true
}
}, - "default_method": "string"
}
}, - "initial": {
- "methods": {
- "text": {
- "enabled": true,
- "disable_text_field": true
}, - "draw": {
- "enabled": true
}, - "upload": {
- "enabled": true
}, - "signature_pad": {
- "enabled": true
}
}, - "default_method": "string"
}, - "appearance_design": {
- "selected": [
- {
- "design_name": "string",
- "design_preview": "string",
- "design_preview_url": "string"
}
], - "default": {
- "design_name": "string",
- "design_preview": "string",
- "design_preview_url": "string"
}
}, - "manage_signature_logo": {
- "enabled": true
}, - "simple_electronic_signature_appearance_design": {
- "enabled": true
}, - "font": {
- "default": {
- "name": "string"
}
}
}, - "authentication_settings": {
- "primary": {
- "default": {
- "id": 0,
- "name": "string"
}
}, - "secondary": {
- "default": {
- "name": "string"
}
}, - "allow_public_authentications": true
}
}Bulk Delete Role
Business applications can use this service API to delete a role for Enterprise. An admin who has permissions to manage role in his role, can delete role. The role dictates things such as allowed role available to the enterprise.
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 ids of role
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Update Role Basic
Business applications can use this service API to update roles basic info for enterprise. An admin who has permissions to manage roles in his role.
path Parameters
| id required | integer <int32> Role id. |
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:
Role basic info.
| name required | string [ 1 .. 255 ] characters Name |
| description | string Description |
| default required | boolean Default |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "default": true
}Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{ }This section entails the web services for the Account Management i.e. Register User, Set or Reset Password, Get Role etc.
Get User Electronic Seal Profiles
Business applications can use this service API to get a list of all the ADSS and CSC Electronic Seal profiles as configured the enterprise role.
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
[- {
- "id": 0,
- "name": "string",
- "created_on": "string",
- "level_of_assurance": "string"
}
]Get Account Invitations
Business applications can use this service API to get a list of invitations from different enterprises.
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:
| user_email | string |
Responses
Request samples
- Payload
{- "user_email": "string"
}Response samples
- 200
- 403
- 500
[- {
- "enterprise_id": 0,
- "enterprise_name": "string",
- "enterprise_role": "string",
- "invited_by": "string"
}
]Accept Account Invitation
Business applications can use this service API to accept an invitation and reject all the other invitations.
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:
| enterprise_name required | string non-empty Name of the enterprise whose invitation is to be accepted. |
Responses
Request samples
- Payload
{- "enterprise_name": "string"
}Response samples
- 200
- 403
- 500
{ }Reject All Account Invitations
Business applications can use this service API to reject all the invitations from different accounts.
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
- 500
{ }Register User Account
Business applications can use this service API to register a new user with either a Trial or an Online service plan. We utilize the billing response. We capture the billing based on the transaction key, whether it's a placeholder or a confirmed transaction.
This process depends on the service plan. If the service plan is online, then the billing response is mandatory.
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:
| user_name required | string non-empty The name of the user to be registered. |
| user_email required | string non-empty The email Address of the user to be registered. |
| job_title | string The job title of the user. (Optional) |
| company_name | string The company name for the user. (Optional) |
| mobile_number | string The mobile number of the user. (Optional) |
| country | string The country name for the user. All values in the appendix - Country list are accepted. (Optional) |
| time_zone | string The timezone name for the user. All values in the appendix - Timezone list are accepted. (Optional) |
| language | string The language selected for the user. All values in the appendix - Language list are accepted. (Optional) |
object The name of the enterprise from where the invitation is sent. In case user is accepting an invitation from an enterprise. (Optional) | |
| service_agreements required | boolean The service agreements user consent for account registration. |
| user_csp_id | string The csp ID of the user. |
| user_ra_id | string The remote authorization ID of the user. |
| user_csc_id | string The cloud Signature Consortium (CSC) user Id that will be required when signing(CSC) via client credential flow |
| marketing_emails required | boolean To receive promotional emails against marketing campaign, this must be set to true. |
object Added for billing transaction id and service plan name | |
| user_national_id | string National identity number of the user. This helps to identify users in the workflow |
Responses
Request samples
- Payload
{- "user_name": "string",
- "user_email": "string",
- "job_title": "string",
- "company_name": "string",
- "mobile_number": "string",
- "country": "string",
- "time_zone": "string",
- "language": "string",
- "invitation": {
- "enterprise_name": "string"
}, - "service_agreements": true,
- "user_csp_id": "string",
- "user_ra_id": "string",
- "user_csc_id": "string",
- "marketing_emails": true,
- "service_plan": {
- "name": "string",
- "billing_id": "string",
- "duration": "string"
}, - "user_national_id": "string"
}Response samples
- 200
- 201
- 400
- 403
- 500
{- "Message": "string"
}Get Account
Business applications can use this service API to get the account information of a logged in user.
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
- 500
{- "user_id": 0,
- "user_email": "string",
- "user_name": "string",
- "user_national_id": "string",
- "job_title": "string",
- "company_name": "string",
- "mobile_number": "string",
- "time_zone": "string",
- "language": "string",
- "country": "string",
- "created_on": "string",
- "enabled": true,
- "two_factor_authentication_enabled": true,
- "fonts": [
- {
- "property1": "string",
- "property2": "string"
}
], - "billing": {
- "user_name": "string",
- "email_address": "string",
- "mobile_number": "string",
- "provider": "string",
- "duration": "string",
- "currency": "string",
- "price": "string",
- "next_billing_date": "string",
- "billing_status": "string",
- "billing_information": true
}, - "service_plan": {
- "id": 0,
- "name": "string",
- "custom_ids": [
- {
- "property1": "string",
- "property2": "string"
}
], - "type": "string",
- "features": [
- "string"
], - "start_date": "string",
- "end_date": "string",
- "ras": {
- "url": "string",
- "client_id": "string",
- "client_secret": "string"
}, - "csp": {
- "enabled": true
}, - "constraints": {
- "users": "string",
- "signatures": "string",
- "advanced_electronic_signatures": "string",
- "high_trust_advanced_signatures": "string",
- "qualified_electronic_signatures": "string",
- "electronic_seals": "string",
- "advanced_electronic_seals": "string",
- "qualified_electronic_seals": "string",
- "simple_electronic_signatures": "string",
- "storage": "string",
- "workflows": "string",
- "max_upload_size": "string",
- "templates": "string"
}, - "settings": {
- "pdf_compliant": true,
- "signing_keys_with_password": true,
- "signature_type": "string",
- "authorized_signing": true,
- "sms_otp": true,
- "email_otp": true,
- "totp": true,
- "sms_otp_length": 0,
- "sms_otp_retry_duration": 0,
- "workflow_evidence": "string",
- "auto_archiving": true,
- "auto_deletion": true,
- "sms_notification": true,
- "certify_options": {
- "selected": [
- "string"
], - "default": "string"
}
}, - "billing": {
- "mode": "string",
- "payment_type": "string",
- "price": "string",
- "yearly_price": "string",
- "next_billing_date": "string"
}, - "fonts": [
- {
- "property1": "string",
- "property2": "string"
}
], - "signature_settings": {
- "signing_servers": [
- {
- "info": {
- "id": 0,
- "name": "string",
- "order": 0,
- "provider": "string",
- "key_location": "string",
- "signature_type": [
- "string"
], - "level_of_assurance": "string",
- "appearance_design_name": "string",
- "appearance_logo": "string",
- "auth_type": "string"
}, - "capacity": {
- "electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "advanced_electronic_signature": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "high_trust_advanced": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "qualified_electronic_signature": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}
}
}
], - "electronic_seal_signing_servers": [
- {
- "info": {
- "id": 0,
- "name": "string",
- "provider": "string"
}, - "capacity": {
- "electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "selected": [
- {
- "id": 0,
- "name": "string",
- "key_protection": "string",
- "level_of_assurance": "string"
}
]
}
}
}
], - "level_of_assurance": {
- "selected": [
- "string"
]
}
}, - "appearance_design": {
- "selected": [
- {
- "design_name": "string",
- "design_preview": "string",
- "design_preview_url": "string"
}
]
}, - "authentication_profiles": [
- {
- "id": 0,
- "name": "string",
- "method": "string"
}
], - "signature_pad": {
- "enabled": true,
- "server": "string"
}, - "add_unique_identifier": true
}, - "enterprise": {
- "enterprise_id": 0,
- "enterprise_name": "string",
- "enterprise_url": "string",
- "owner": "string",
- "owner_email": "string",
- "mobile_number": "string",
- "support_email": "string",
- "workspace_id": "string"
}, - "last_login": "string"
}Resend Activation Email
Business applications can use this service API to resend the activation email.
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:
| user_email required | string non-empty Email address of user that is to be activated. |
Responses
Request samples
- Payload
{- "user_email": "string"
}Response samples
- 200
- 403
- 500
{ }Add Feedback
Business applications can use this service API to request feedback from a user who had just deleted their account. Feedback could be used by the business to determine areas of improvements, and help determine the reason for account deletion.
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:
| feedBack | string |
| q | string |
Responses
Request samples
- Payload
{- "feedBack": "string",
- "q": "string"
}Response samples
- 200
- 400
- 401
- 403
{ }Reset Password
This API is specifically used by business applications to reset their account passwords. Access token can be used to reset password for a user.Authentication API will return new access token and refresh token in response when password is reset. Further API calls should be made using this new access/refresh token as previous access/refresh tokens are expired
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:
| security_answer | string |
| user_new_password | string |
| user_email | string |
Responses
Request samples
- Payload
{- "security_answer": "string",
- "user_new_password": "string",
- "user_email": "string"
}Response samples
- 200
- 401
- 403
- 500
{- "access_token": "string",
- "token_type": "string",
- "expires_in": 0,
- "refresh_token": "string"
}Send Forgot Password Request
Business applications can use this service API to send an email with instructions to reset a user’s password.
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:
| user_email required | string non-empty Email address of user for which the forget password request is to be sent. |
Responses
Request samples
- Payload
{- "user_email": "string"
}Response samples
- 200
- 403
- 500
{ }Set New Password
This API is specifically used by business applications to change their account passwords. SigningHub requires a business application to change password on the following events:
Password Expiry - When the account password has expired after a predefined time duration, i.e. as configured in their password policy.
Enforce Password Change on First Login - When this option is configured in their password policy.
Query parameter "q" can be used to set a new password for a user.Authentication API call will return x-change-password response header when password reset required. The value of x-change-password can be used as "q" for this API
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:
| security_question required | string non-empty Security question that is to be set. |
| security_answer required | string non-empty Security answer that is to be set. |
| password required | string non-empty Password of the user that is to be set. |
| q required | string non-empty Query parameter that you received |
Responses
Request samples
- Payload
{- "security_question": "string",
- "security_answer": "string",
- "password": "string",
- "q": "string"
}Response samples
- 200
- 403
- 500
{- "access_token": "string",
- "token_type": "string",
- "expires_in": 0,
- "refresh_token": "string"
}Recover Password
Business application can use this API to send password recovery email to the user who's password recovery is needed.
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:
| user_email required | string non-empty Email address of user who's password recovery is required |
| recovery_url | string Optional : Url of password recovery page to get relevant information from end-user and use it to set new password |
Responses
Request samples
- Payload
{- "user_email": "string",
- "recovery_url": "string"
}Response samples
- 200
- 400
- 401
- 403
- 500
{ }Account Usage Statistics
Business applications can use this service API to get the account usage statistics.
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
- 500
{- "storage": {
- "consumed": "string",
- "allowed": "string"
}, - "signature": {
- "consumed": "string",
- "allowed": "string"
}, - "advanced_electronic_signatures": {
- "consumed": "string",
- "allowed": "string"
}, - "high_trust_advanced_signatures": {
- "consumed": "string",
- "allowed": "string"
}, - "qualified_electronic_signatures": {
- "consumed": "string",
- "allowed": "string"
}, - "electronic_seals": {
- "consumed": "string",
- "allowed": "string"
}, - "advanced_electronic_seals": {
- "consumed": "string",
- "allowed": "string"
}, - "qualified_electronic_seals": {
- "consumed": "string",
- "allowed": "string"
}, - "simple_electronic_signatures": {
- "consumed": "string",
- "allowed": "string"
}, - "workflow": {
- "consumed": "string",
- "allowed": "string"
}, - "template": {
- "consumed": "string",
- "allowed": "string"
}, - "user": {
- "consumed": "string",
- "allowed": "string"
}
}Documents Statistics
Business applications can use this service API to get the documents count with respect to their statuses.
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 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
- 403
- 500
{- "draft": 0,
- "pending": 0,
- "shared": 0,
- "signed": 0,
- "approved": 0,
- "declined": 0,
- "completed": 0,
- "updated": 0,
- "archived": 0
}Get Account Password Policy
Business applications can use this service API to get the password policy for the account of a logged in user.
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:
| user_email required | string non-empty |
Responses
Request samples
- Payload
{- "user_email": "string"
}Response samples
- 200
- 403
- 500
{- "number": true,
- "special_character": true,
- "upper_case": true,
- "minimum_length": 0
}Get User Role
Business applications can use this service API to get the enterprise role and list of features of the application allowed by the enterprise admin.
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 |
| x-base64 | string Default: true True if response should have images in base64 format. False will only return the resource URLs in response. |
Responses
Response samples
- 200
- 403
- 500
{- "role_name": "string",
- "access_control": {
- "signature": {
- "signing_servers": [
- {
- "info": {
- "name": "string",
- "order": 0,
- "provider": "string",
- "key_location": "string",
- "logo": "string",
- "id": 0,
- "host_url": "string",
- "client_id": "string",
- "level_of_assurance": "string",
- "appearance_design_name": "string",
- "appearance_logo": "string",
- "auth_type": "string",
- "environment": "string",
- "port": "string"
}, - "capacities": [
- {
- "name": "string",
- "id": 0,
- "key_protection": "string",
- "level_of_assurance": "string",
- "iscustom": true,
- "isdefault": true
}
], - "authentications": {
- "no_password": {
- "primary": {
- "profile_name": "string",
- "id": 0,
- "app_id": "string",
- "tenant_id": "string",
- "authentication_mechanism": "string",
- "provider": "string",
- "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"
}
}, - "secondary": "string",
- "primary_mobile": {
- "profile_name": "string",
- "id": 0,
- "app_id": "string",
- "tenant_id": "string",
- "authentication_mechanism": "string",
- "provider": "string",
- "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"
}
}, - "secondary_mobile": "string"
}, - "user_password": {
- "primary": {
- "profile_name": "string",
- "id": 0,
- "app_id": "string",
- "tenant_id": "string",
- "authentication_mechanism": "string",
- "provider": "string",
- "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"
}
}, - "secondary": "string"
}, - "system_password": {
- "primary": {
- "profile_name": "string",
- "id": 0,
- "app_id": "string",
- "tenant_id": "string",
- "authentication_mechanism": "string",
- "provider": "string",
- "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"
}
}, - "secondary": "string",
- "primary_mobile": {
- "profile_name": "string",
- "id": 0,
- "app_id": "string",
- "tenant_id": "string",
- "authentication_mechanism": "string",
- "provider": "string",
- "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"
}
}, - "secondary_mobile": "string"
}, - "remote_authorization": {
- "primary": {
- "profile_name": "string",
- "id": 0,
- "app_id": "string",
- "tenant_id": "string",
- "authentication_mechanism": "string",
- "provider": "string",
- "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"
}
}, - "secondary": "string"
}
}
}
], - "signing_reason": {
- "selection": "string",
- "value": "string",
- "list": [
- "string"
], - "custom": true
}, - "metadata": {
- "signing_reason": true,
- "signing_location": true,
- "contact_information": true
}, - "signing_dialog_visible": true
}, - "appearance": {
- "hand_signature": {
- "web_browser": {
- "allowed_methods": [
- "string"
], - "default_method": "string",
- "disable_text_field": true
}, - "mobile": {
- "allowed_methods": [
- "string"
], - "default_method": "string",
- "disable_text_field": true
}
}, - "initials": {
- "allowed_methods": [
- "string"
], - "default_method": "string",
- "disable_text_field": true
}, - "appearance_design": {
- "all_design": [
- {
- "design_name": "string",
- "design_preview": "string",
- "design_preview_url": "string"
}
], - "allowed_design": [
- {
- "design_name": "string",
- "design_preview": "string",
- "design_preview_url": "string"
}
], - "default_design": {
- "design_name": "string",
- "design_preview": "string",
- "design_preview_url": "string"
}
}, - "simple_electronic_signature_appearance_design": true,
- "manage_signature_logo": {
- "enabled": true
}, - "fonts": [
- {
- "name": "string"
}
]
}
}, - "user_setting": {
- "emails": true,
- "emails_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "signatures": true,
- "signatures_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "groups": true,
- "groups_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "templates": true,
- "templates_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "library": true,
- "advanced": true,
- "advanced_rights": {
- "Read": true,
- "Delete": true
}, - "library_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "legal_notices": true,
- "legal_notices_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "smart_forms": true,
- "smart_forms_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "delegate": true,
- "delegate_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "cloud_drives": true,
- "cloud_drives_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true,
- "google_drive": true,
- "dropbox": true,
- "onedrive": true,
- "google_drive_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "dropbox_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "onedrive_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}
}, - "sms_otp_login": true,
- "auto_finish": true,
- "auto_close_viewer": true,
- "share": {
- "enabled": true,
- "enterprise_only": true,
- "start_existing_workflow": true,
- "replicate_workflow": true
}, - "delegated_signing": true,
- "bulk_signing": true,
- "allow_invisible_signature": true,
- "workflow_mode": "string",
- "workflow_type": "string",
- "allow_delete_document": true,
- "allow_owner_recall_document": true,
- "allow_owner_change_recipient": true,
- "allow_owner_print_document": true,
- "allow_owner_download_document": true,
- "allow_owner_attachments": true,
- "allow_owner_workflow_history": true,
- "allow_owner_save_template": true,
- "allow_comments": true,
- "allow_sign_documents": true,
- "signature_fields": {
- "signature": true,
- "inperson_signature": true,
- "initials": true,
- "level_of_assurance": {
- "signature": {
- "allowed": [
- "string"
], - "default": [
- "string"
]
}, - "in_person": {
- "allowed": [
- "string"
], - "default": [
- "string"
]
}
}
}, - "form_fields": {
- "name": true,
- "email": true,
- "job_title": true,
- "company": true,
- "date": true,
- "text": true,
- "text_area": true,
- "radio_button": true,
- "qrcode": true,
- "checkbox": true,
- "add_text": true,
- "attachment": true
}, - "level_of_assurance": [
- "string"
], - "default_level_of_assurance": "string",
- "in_person_level_of_assurance": [
- "string"
], - "in_person_default_level_of_assurance": "string",
- "enterprise_templates": {
- "Allowed": "string",
- "Values": [
- "string"
]
}, - "enterprise_library": {
- "Allowed": "string",
- "Values": [
- 0
]
}, - "allow_only_personal_contacts_groups": true,
- "require_document_access_authentication": true,
- "require_document_sign_authentication": true,
- "manage_shared_space": true,
- "certify_options": {
- "selected": [
- "string"
], - "default": "string"
}
}, - "enterprise_setting": {
- "profile": true,
- "profile_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "roles": true,
- "roles_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "users": true,
- "users_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "groups": true,
- "groups_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "templates": true,
- "templates_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "library": true,
- "library_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "emails": true,
- "emails_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "billing": true,
- "billing_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "integration": true,
- "integration_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "branding": true,
- "branding_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "advanced": true,
- "advanced_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "advanced_report": true,
- "advanced_report_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "report": true,
- "report_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "electronic_seals": true,
- "electronic_seals_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "documents": true,
- "documents_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}, - "logs": true,
- "logs_rights": {
- "Read": true,
- "Add": true,
- "Update": true,
- "Delete": true
}
}
}Get User Activity Logs
Business applications can use this service API to get the list of actions performed by a user.
path Parameters
| pageNo required | integer <int32> Page number, according the division of records per page. |
| recordsPerPage required | integer <int32> Number of records that are needed to be fetched in one request. |
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-total-records | string Example: 10 The total number of records found with the provided search criteria. |
| 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. |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "date_time": "string",
- "action_type": "string",
- "action_type_label": "string",
- "user_email": "string",
- "user_name": "string",
- "enterprise_name": "string",
- "information": {
- "type": "string",
- "type_label": "string",
- "value": "string",
- "value_label": "string"
}, - "package_name": "string",
- "agent": "string",
- "module": "string",
- "detail": [
- {
- "data": [
- {
- "data": [
- { }
], - "Key": "string",
- "Value": "string",
- "Visible": true,
- "Order": 0,
- "CertificateBase64": "string",
- "Type": "string",
- "ProcessedState": "string"
}
], - "key": "string",
- "value": "string",
- "visible": true,
- "order": 0,
- "type": "string",
- "processed_state": null
}
], - "type": 0
}
]Get User Activity Logs
Business applications can use this API to Get User Activity.
path Parameters
| pageNo required | integer <int32> Page no |
| recordPerPage required | integer <int32> Record per page |
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-total-records | string Example: 10 The total number of records found with the provided search criteria. |
| 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. |
Responses
Response samples
- 201
- 400
- 401
- 403
- 500
[- {
- "module": "string",
- "action": "string",
- "information": [
- {
- "key": "string",
- "value": "string"
}
], - "detail": [
- {
- "data": [
- {
- "data": [
- { }
], - "Key": "string",
- "Value": "string",
- "Visible": true,
- "Order": 0,
- "CertificateBase64": "string",
- "Type": "string",
- "ProcessedState": "string"
}
], - "key": "string",
- "value": "string",
- "visible": true,
- "order": 0,
- "type": "string",
- "processed_state": null
}
], - "agent": "string",
- "type": 0,
- "id": 0,
- "created_on": "2019-08-24T14:15:22Z",
- "dst_offset": "string",
- "info_key": "string",
- "package_name": "string"
}
]Add Identity for a User
SigningHub application relies on email addresses of the user to uniquely identify them as a user. If client system do not want the email address to be used frequently, they can attach another identity to the user using the following API.
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:
| user_email required | string non-empty Email of the user for whom another identity is provided. |
| name | string Authentication profile name |
| key required | string non-empty A key name stored in the database to be used as an identity. It can be another email address, user Id, Certificate Id, RUT, VO_ID, UNIQUE_NO etc |
| value required | string non-empty Value of the identity key stored in the database which later can be used to verify the user while authentication. |
Responses
Request samples
- Payload
{- "user_email": "string",
- "name": "string",
- "key": "string",
- "value": "string"
}Response samples
- 200
- 400
- 401
- 403
- 500
{ }Recurring Payment
Business applications can use this service API for recurring payment via billing by utilizing the billing ID. We capture the billing based on the transaction key, whether it is a placeholder or a confirmed transaction.
query Parameters
| billing_id required | string For TAXAMO, the Billing ID will be the custom_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 |
Responses
Response samples
- 200
- 400
- 500
{ }Upgrade Service Plan
Business applications can use this service API to upgrade the service plan via billing by utilizing the billing ID. We capture the billing based on the transaction key, whether it is a placeholder or a confirmed transaction.
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:
| name | string The name of the service plan name |
| billing_id | string For TAXAMO, the Billing ID will be the custom_id. |
| duration | string Payment type will be MONTHLY / YEARLY |
Responses
Request samples
- Payload
{- "name": "string",
- "billing_id": "string",
- "duration": "string"
}Response samples
- 200
- 400
- 500
{ }Cancel Agreement
Business applications can use this service API to cancel the billing agreement by adding remarks. We capture the billing based on the transaction key, whether it is a placeholder or a confirmed transaction.
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:
| remarks required | string non-empty Remarks for the cancel billing agreement |
Responses
Request samples
- Payload
{- "remarks": "string"
}Response samples
- 200
- 400
- 500
{ }Get User Billings
Business applications can use this service API to get user billings. A user who has permission to manage the billing in his role can get billings.
Search text sent in headers for further filtration of user billings. Search filters are "Amount", "CurrencyId", "Name", "EmailAddress".
Sorting filters are "Expiry Date", "Payment Type", "Payment Number", "VAT Amount", "Billing Model", "User Amount", "Date".
path Parameters
| pageNo required | integer <int32> The page number to be retrieved. |
| recordsPerPage required | integer <int32> The total number of records to be retrieved in a page. |
query Parameters
| sort-by | string Default: "EXPIRY_DATE" Enum: "VAT_AMOUNT" "USER_AMOUNT" "PAYMENT_TYPE" "PAYMENT_NUMBER" "BILLING_MODEL" "EXPIRY_DATE" "DATE" |
| asc | boolean Default: false |
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-search-text | string Example: IGpvaG5AYXNjZXJ0aWEuY29t Search text if required. This is optional and without it the entire list is returned. |
Responses
Response samples
- 200
- 400
- 500
{- "billing_id": 0,
- "payment_method": "string",
- "transaction_id": "string",
- "reference_number": "string",
- "type": "string",
- "payment_number": 0,
- "price": 0,
- "paid_amount": 0,
- "vat_amount": 0,
- "currency": "string",
- "vat_number": "string",
- "expiry_date": "string",
- "user_currency": "string",
- "user_amount": 0,
- "created_on": "string",
- "remarks": "string",
- "service_plan_name": "string",
- "billing_model": "string",
- "payment_type": "string",
- "duration": "string",
- "date": "string",
- "user_email": "string",
- "user_name": "string",
- "phone_number": "string"
}Get Billing Transaction Status
Business applications can use this service API with a client credentials token and user password to check the billing transaction status. If the billing transaction has succeeded, the response will be COMPLETED; otherwise, it will be IN PROGRESS.
path Parameters
| transaction_id required | string The Transaction ID will be extracted from the Taxamo request as a KEY parameter. |
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
{- "status": "string"
}Validate User
Business applications can use this service API to validate the user.
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:
| email required | string <email> non-empty Email Address |
Responses
Request samples
- Payload
{- "email": "user@example.com"
}Response samples
- 200
- 401
- 500
{- "error": "string"
}Get All Push Notification Devices
Business applications can use this service API to get registered push notification devices of the current user.
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
- 500
{- "items": [
- {
- "device_token": "string",
- "os_type": "string"
}
]
}Delete All Push Notification Devices
Business applications can use this service API to delete registered push notification devices of the current user.
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:
| device_tokens | Array of strings Token generated by the mobile apps. This token is used sending push notifications from Google's Firebase Cloud Messaging. |
Responses
Request samples
- Payload
{- "device_tokens": [
- "string"
]
}Response samples
- 200
- 403
- 500
{ }Delete Refresh Token
Business applications can use this service API to delete refresh token of the current user.
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
- 500
{ }Get Notifications
Business applications can use this service API to get the notifications of logged in user.
path Parameters
| recordPerPage required | integer <int32> Total records for a page to be retrieved. |
| pageNo required | integer <int32> Number of page to be retrieved. |
query Parameters
| type | string Default: "ALL" Enum: "ALL" "ACCOUNT" "ENTERPRISE" "DOCUMENT" Filter by type possible values are ALL, ACCOUNT, ENTERPRISE and 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-total-records | string Default: 212 The total number of records found with the provided search criteria. |
| x-unread-records | string Default: 3 Number of unread notifications so far. |
Responses
Response samples
- 200
- 403
- 500
{- "user_email": "string",
- "user_name": "string",
- "notifications": [
- {
- "notification_id": 0,
- "date_time": "string",
- "sender": "string",
- "sender_name": "string",
- "module": "string",
- "module_label": "string",
- "activity": "string",
- "activity_label": "string",
- "information": {
- "type": "string",
- "type_label": "string",
- "value": "string",
- "value_label": "string"
}, - "information_details": [
- {
- "type": "string",
- "type_label": "string",
- "value": "string",
- "value_label": "string"
}
], - "type": "string",
- "unread": true,
- "document_id": 0
}
]
}Device Registration for Push Notification
This API can be used for registering mobile devices for sending push notifications.
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:
| device_token required | string non-empty Token generated by the mobile apps. This token is used why sending push notifications from Google's Firebase Cloud Messaging. |
| os_type required | string non-empty Operating system that will handle the push notifications. Possible values are IOS and ANDROID. |
Responses
Request samples
- Payload
{- "device_token": "string",
- "os_type": "string"
}Response samples
- 200
- 403
- 500
{ }Get All Service Plans
Business applications can use this service API for billing. We use a client credential token for registered service plans, whether they are ONLINE or NOBILLING, and a user credential token for upgradable service plans.
path Parameters
| pageNo required | integer <int32> Page number to be retrieved. |
| recordsPerPage required | integer <int32> Total number of records to be retrieved in a page. |
query Parameters
| id | integer <int32> Default: 0 ID of the serivce plan |
| billing_type | string Default: "ALL" Enum: "PAY_REGULARLY" "PAY_AS_YOU_GO" "ALL" "FREE_TRIAL" |
| type | string Default: "NONE" Enum: "INDIVIDUAL" "ENTERPRISE" "NONE" |
| sort-by | string Default: "NAME" Enum: "NAME" "PRICE" "YEARLYPRICE" "SIGNATURES" "USERS" "STORAGE" |
| asc | boolean Default: false |
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-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. |
Responses
Response samples
- 200
- 401
- 500
[- {
- "id": 0,
- "custom_ids": [
- {
- "property1": "string",
- "property2": "string"
}
], - "name": "string",
- "type": "string",
- "billing": {
- "payment_type": "string",
- "mode": "string",
- "monthly": {
- "enabled": true,
- "price": 0
}, - "yearly": {
- "enabled": true,
- "price": 0
}, - "price": 0
}, - "constraints": {
- "users": {
- "count": "string"
}, - "signatures": {
- "count": "string"
}, - "storage": {
- "count": "string"
}, - "simple_electronic_signatures": {
- "count": "string"
}
}
}
]Configure Two-Factor Authentication
Business applications can use this service API to Register Two factor authentication of a logged in user.
path Parameters
| packageId required | integer <int64> Default value = 0 |
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
- 403
- 500
{- "qrcode_base64": "string",
- "account": "string",
- "manual_key": "string",
- "time_based": true,
- "recovery_codes": [
- "string"
]
}This section entails the web services for the SCIM 2.0 User Provisioning i.e. Create User, Update User, Delete User by ID, Get User by ID and Filter Users. For Details : System for Cross-domain Identity Management: Protocol : https://datatracker.ietf.org/doc/html/rfc7644
Create User
This SCIM-compliant endpoint allows business applications to provision a new enterprise user. It is primarily used for automatic user provisioning workflows in enterprise environments. The API consumes a SCIM-compliant user resource and supports optional query parameters to tailor the attributes returned in the response.
query Parameters
| attributes | string A comma-separated list of attribute names to include in the response. This allows clients to retrieve only specific attributes. |
| excludedAttributes | string A comma-separated list of attribute names to exclude from the response. This is useful for minimizing payload size by omitting unnecessary data. |
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" with the request header "x-scim" |
| Content-Type required | string Default: application/scim+json |
| Accept required | string Default: application/json |
Request Body schema:
A SCIM user object containing the user details to be created.
| schemas required | Array of strings An array of URIs indicating the schemas used to define the attributes present in the request. This is required by the SCIM 2.0 specification for both creating and updating users. i.e. [ "urn:ietf:params:scim:schemas:core:2.0:User" ] |
| userName | string The user name of the user. Provide at lease one of the property userName or name.givenName. If both are provided priority is given to the user name. If both are not provided for API "Create User" system will throw error. Similarly name could not set to empty for APIs "Update User - PUT" or "Update User - PATCH" |
object Represents a user's name components. | |
| title | string The job title of the user. Max allowed length is 255. |
required | Array of objects (ScimEmail) List of email addresses associated with the user. |
Array of objects (ScimPhoneNumbers) List of phone numbers associated with the user. | |
| active required | boolean Indicates whether the user is active. Soft-deleting a user active=false and restoring the user active=true. System will only allow to register the users with active=true. |
Array of objects (ScimRole) user's role in the enterprise. |
Responses
Request samples
- Payload
{- "schemas": [
- "string"
], - "userName": "string",
- "name": {
- "givenName": "string",
- "familyName": "string"
}, - "title": "string",
- "emails": [
- {
- "value": "string",
- "type": "string",
- "primary": true
}
], - "phoneNumbers": [
- {
- "value": "string",
- "type": "string"
}
], - "active": true,
- "roles": [
- {
- "value": "string",
- "primary": true
}
]
}Response samples
- 200
- 400
- 401
- 403
- 409
- 500
{- "schemas": [
- "string"
], - "id": "string",
- "meta": {
- "resourceType": "string",
- "created": "string",
- "lastModified": "string",
- "location": "string"
}, - "userName": "string",
- "title": "string",
- "name": {
- "givenName": "string",
- "familyName": "string"
}, - "active": true,
- "emails": [
- {
- "value": "string",
- "type": "string",
- "primary": true
}
], - "phoneNumbers": [
- {
- "value": "string",
- "type": "string"
}
], - "roles": [
- {
- "value": "string",
- "primary": true
}
]
}Filter Users
This SCIM 2.0-compliant API allows business applications to query and retrieve users based on various filters and sorting options.
The filter parameter must follow SCIM filtering syntax and be URL-encoded. Pagination is supported via startIndex and count.
You can also specify which attributes to include or exclude in the response.
query Parameters
| startIndex | integer <int32> Default: 1 The 1-based index indicating the start position of the result set. Values less than 1 will be treated as 1. |
| count | integer <int32> Default: 20 The maximum number of user records to return. A value less than 0 will be interpreted as 0. Default value is 20 |
| filter | string The SCIM filter expression (e.g., emails eq "john.doe@mailbox.com"), which must be URL-encoded. Supported properties and their corresponding operators are:
|
| sortBy | string The attribute by which to sort the returned results. Default is "meta.created" Supported values include:
|
| sortOrder | string Default: "descending" The order in which to sort the results: "ascending" or "descending". Default is "descending" |
| attributes | string Comma-separated list of attributes to include in the response. |
| excludedAttributes | string Comma-separated list of attributes to exclude from the response. |
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" with the request header "x-scim" |
| Content-Type required | string Default: application/scim+json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
[- {
- "schemas": [
- "string"
], - "id": "string",
- "meta": {
- "resourceType": "string",
- "created": "string",
- "lastModified": "string",
- "location": "string"
}, - "userName": "string",
- "title": "string",
- "name": {
- "givenName": "string",
- "familyName": "string"
}, - "active": true,
- "emails": [
- {
- "value": "string",
- "type": "string",
- "primary": true
}
], - "phoneNumbers": [
- {
- "value": "string",
- "type": "string"
}
], - "roles": [
- {
- "value": "string",
- "primary": true
}
]
}
]Delete User by ID
This SCIM-compliant endpoint allows business applications to delete a specific user resource by providing the user's unique identifier. It is typically used for deprovisioning users as part of identity lifecycle management.
path Parameters
| id required | string The unique identifier (SCIM ID) of the user to be deleted. |
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" with the request header "x-scim" |
| Content-Type required | string Default: application/scim+json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Get User by ID
This SCIM 2.0-compliant API allows business applications to fetch detailed information about a specific user
by providing the user's unique ID. You can optionally specify attributes to include or exclude in the response
using the attributes and excludedAttributes query parameters.
path Parameters
| id required | string The unique identifier (SCIM ID) of the user to retrieve. |
query Parameters
| attributes | string A comma-separated list of attributes to include in the response. |
| excludedAttributes | string A comma-separated list of attributes to exclude from the response. |
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" with the request header "x-scim" |
| Content-Type required | string Default: application/scim+json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "schemas": [
- "string"
], - "id": "string",
- "meta": {
- "resourceType": "string",
- "created": "string",
- "lastModified": "string",
- "location": "string"
}, - "userName": "string",
- "title": "string",
- "name": {
- "givenName": "string",
- "familyName": "string"
}, - "active": true,
- "emails": [
- {
- "value": "string",
- "type": "string",
- "primary": true
}
], - "phoneNumbers": [
- {
- "value": "string",
- "type": "string"
}
], - "roles": [
- {
- "value": "string",
- "primary": true
}
]
}Update User - PUT
This SCIM 2.0-compliant API allows business applications to update the attributes of an existing user. Only the attributes provided in the request will be updated; others will remain unchanged. System support to update user's name, job title, mobile number, or roles only
path Parameters
| id required | string The unique identifier of the user to update. |
query Parameters
| attributes | string Comma-separated list of attributes to include in the response. |
| excludedAttributes | string Comma-separated list of attributes to exclude from the response. |
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" with the request header "x-scim" |
| Content-Type required | string Default: application/scim+json |
| Accept required | string Default: application/json |
Request Body schema:
The updated user information.
| schemas required | Array of strings An array of URIs indicating the schemas used to define the attributes present in the request. This is required by the SCIM 2.0 specification for both creating and updating users. i.e. [ "urn:ietf:params:scim:schemas:core:2.0:User" ] |
| userName | string The user name of the user. Provide at lease one of the property userName or name.givenName. If both are provided priority is given to the user name. If both are not provided for API "Create User" system will throw error. Similarly name could not set to empty for APIs "Update User - PUT" or "Update User - PATCH" |
object Represents a user's name components. | |
| title | string The job title of the user. Max allowed length is 255. |
required | Array of objects (ScimEmail) List of email addresses associated with the user. |
Array of objects (ScimPhoneNumbers) List of phone numbers associated with the user. | |
| active required | boolean Indicates whether the user is active. Soft-deleting a user active=false and restoring the user active=true. System will only allow to register the users with active=true. |
Array of objects (ScimRole) user's role in the enterprise. |
Responses
Request samples
- Payload
{- "schemas": [
- "string"
], - "userName": "string",
- "name": {
- "givenName": "string",
- "familyName": "string"
}, - "title": "string",
- "emails": [
- {
- "value": "string",
- "type": "string",
- "primary": true
}
], - "phoneNumbers": [
- {
- "value": "string",
- "type": "string"
}
], - "active": true,
- "roles": [
- {
- "value": "string",
- "primary": true
}
]
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "schemas": [
- "string"
], - "id": "string",
- "meta": {
- "resourceType": "string",
- "created": "string",
- "lastModified": "string",
- "location": "string"
}, - "userName": "string",
- "title": "string",
- "name": {
- "givenName": "string",
- "familyName": "string"
}, - "active": true,
- "emails": [
- {
- "value": "string",
- "type": "string",
- "primary": true
}
], - "phoneNumbers": [
- {
- "value": "string",
- "type": "string"
}
], - "roles": [
- {
- "value": "string",
- "primary": true
}
]
}Update User - PATCH
This SCIM 2.0-compliant endpoint enables partial updates to an existing user's attributes using the PATCH method. Only the fields specified in the request payload will be modified, leaving all other attributes unchanged. Common use cases include updating user's name, job title, mobile number, or roles without replacing the entire resource. The request must follow the SCIM PATCH operation schema as defined in RFC 7644 Section 3.5.
path Parameters
| id required | string The unique identifier of the user to update. |
query Parameters
| attributes | string Comma-separated list of attributes to include in the response. |
| excludedAttributes | string Comma-separated list of attributes to exclude from the response. |
header Parameters
| Authorization required | string Default: Bearer {access_token} OAuth access token obtained as a result of "Client Credentials Authentication" with the request header "x-scim" |
| Content-Type required | string Default: application/scim+json |
| Accept required | string Default: application/json |
Request Body schema:
The updated user information.
| schemas required | Array of strings An array of URIs indicating the schemas used to define the attributes present in the request. This is required by the SCIM 2.0 specification for both creating and updating users. i.e. [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ] |
Array of objects (PatchOperation) A list of operations to be performed on the user resource. Each operation specifies the type of change, the target path, and the new value. |
Responses
Request samples
- Payload
{- "schemas": [
- "string"
], - "operations": [
- {
- "op": "string",
- "path": "string",
- "value": null
}
]
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "schemas": [
- "string"
], - "id": "string",
- "meta": {
- "resourceType": "string",
- "created": "string",
- "lastModified": "string",
- "location": "string"
}, - "userName": "string",
- "title": "string",
- "name": {
- "givenName": "string",
- "familyName": "string"
}, - "active": true,
- "emails": [
- {
- "value": "string",
- "type": "string",
- "primary": true
}
], - "phoneNumbers": [
- {
- "value": "string",
- "type": "string"
}
], - "roles": [
- {
- "value": "string",
- "primary": true
}
]
}This section entails the web services for the Account Folder Management i.e. Get All Folders, Get Folder By Id etc.
Get All Folders
Business applications can use this service API to get the user folders.
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
- 500
[- {
- "id": 0,
- "items_count": 0,
- "members": [
- {
- "email": "string",
- "name": "string",
- "user_id": 0
}
], - "name": "string",
- "owner": {
- "email": "string",
- "name": "string"
}, - "read": true,
- "shared": true,
- "default": true
}
]Add Folder
Business applications can use this service API to add folder/shared space.
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:
| name required | string [ 1 .. 255 ] characters Name of folder as INBOX, ARCHIVE |
| shared required | boolean Bit use to identify either this folder is the part of shared space or not |
Array of objects (FolderMemberRequest) Folder members |
Responses
Request samples
- Payload
{- "name": "string",
- "shared": true,
- "members": [
- {
- "name": "string",
- "email": "string"
}
]
}Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0
}Get Folder By Id
Business applications can use this service API to get the user folders.
path Parameters
| id required | integer <int32> |
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
- 404
- 500
{- "id": 0,
- "items_count": 0,
- "members": [
- {
- "email": "string",
- "name": "string",
- "user_id": 0
}
], - "name": "string",
- "owner": {
- "email": "string",
- "name": "string"
}, - "read": true,
- "shared": true,
- "default": true
}Update Folder
Business applications can use this service API to update folder/shared space.
path Parameters
| id required | integer <int32> |
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:
| name required | string [ 1 .. 255 ] characters Name of folder as INBOX, ARCHIVE |
Array of objects (FolderMemberRequest) Folder members |
Responses
Request samples
- Payload
{- "name": "string",
- "members": [
- {
- "name": "string",
- "email": "string"
}
]
}Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{ }Delete Folder
Business applications can use this service API to delete folder/shared space.
path Parameters
| id required | integer <int32> |
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
- 404
- 500
{ }Bulk Delete Folder
Business applications can use this service API to bulk delete folder/shared space.
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:
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]This section entails the web services for managing the settings of personal users i.e. Groups, Contact, Templates etc.
Get Groups
Business applications can use this service API to retieve groups from both personal and enterprise groups for the current user.
It is possible to search based upon the criterion supplied under the "x-search-text" header.Furthermore, it is possible to search a user's personal groups or that of the enterprise to which the user belongs.
The response contains both the group name and the members thereof.Group member details returned are email address and user name.
path Parameters
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
| pageNo required | integer <int32> Page number to be retrieved. |
query Parameters
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "NAME" "DESCRIPTION" Sort the result by possible values are mentioned above. |
| asc | boolean Default: false Order the result set by ascending or descending. |
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-search-text | string Example: U2FsZXM= Search text if required. This is optional and without it the entire list is returned. |
| x-enterprise | string Default: true If set as "true" only enterprise groups list will be returned. In case of "false"only the user's groups list will be returned.If you do not set the header, then both enterprise and user's groups lists will be returned. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 403
- 500
[- {
- "id": 0,
- "group_name": "string",
- "created_on": "string",
- "description": "string",
- "enterprise": true,
- "group_members": [
- {
- "user_email": "string",
- "user_name": "string"
}
]
}
]Get Smart Forms
Business applications can use this service API to get Smart forms
path Parameters
| pageNo required | integer <int32> Page number to be retrieved. |
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
query Parameters
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "NAME" Sort by |
| asc | boolean Default: false Ascending order |
| name | string Name |
| created-from | string <date-time> created from |
| created-to | string <date-time> created to |
| template-name | string Template name |
| active | boolean Status |
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-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. |
Responses
Response samples
- 200
- 400
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "first_recipient_instruction": "string",
- "response_recieved": 0,
- "total_response_count": 0,
- "active": true,
- "url": "string",
- "created_on": "string",
- "template": {
- "id": 0,
- "name": "string"
}, - "advanced_settings": {
- "email_validation": true,
- "signers_message": "string",
- "usage_settings": {
- "total_responses": {
- "enabled": true,
- "count": 0
}, - "limit_time_responses": {
- "enabled": true,
- "count": 0,
- "duration": "string"
}
}
}
}
]Get Template Smart Forms
Business applications can use this service API to get template Smart forms
path Parameters
| id required | integer <int32> Template id |
| pageNo required | integer <int32> Page number to be retrieved. |
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
query Parameters
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "NAME" Sort by. |
| asc | boolean Default: false Ascending order |
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-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 400
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "created_on": "string"
}
]Get Smart Forms By Id
Business applications can use this service API to get Smart form by id
path Parameters
| id required | integer <int64> smart form 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 |
Responses
Response samples
- 200
- 403
- 404
- 500
{- "id": 0,
- "name": "string",
- "first_recipient_instruction": "string",
- "response_recieved": 0,
- "total_response_count": 0,
- "active": true,
- "url": "string",
- "created_on": "string",
- "template": {
- "id": 0,
- "name": "string"
}, - "advanced_settings": {
- "email_validation": true,
- "signers_message": "string",
- "usage_settings": {
- "total_responses": {
- "enabled": true,
- "count": 0
}, - "limit_time_responses": {
- "enabled": true,
- "count": 0,
- "duration": "string"
}
}
}
}Update Smart Forms
Business applications can use this service API to update Smart form
path Parameters
| id required | integer <int64> Smart form 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:
Update request
| name required | string non-empty Name |
| first_recipient_instruction | string First recipient instruction |
| active required | boolean Status |
required | object Template |
required | object Advanced settings |
Responses
Request samples
- Payload
{- "name": "string",
- "first_recipient_instruction": "string",
- "active": true,
- "template": {
- "id": 0
}, - "advanced_settings": {
- "email_validation": true,
- "signers_message": "string",
- "usage_settings": {
- "total_responses": {
- "enabled": true,
- "count": 0
}, - "limit_time_responses": {
- "enabled": true,
- "count": 0,
- "duration": "string"
}
}
}
}Response samples
- 200
- 400
- 403
- 404
- 422
- 500
[- {
- "id": 0,
- "name": "string",
- "first_recipient_instruction": "string",
- "response_recieved": 0,
- "total_response_count": 0,
- "active": true,
- "url": "string",
- "created_on": "string",
- "template": {
- "id": 0,
- "name": "string"
}, - "advanced_settings": {
- "email_validation": true,
- "signers_message": "string",
- "usage_settings": {
- "total_responses": {
- "enabled": true,
- "count": 0
}, - "limit_time_responses": {
- "enabled": true,
- "count": 0,
- "duration": "string"
}
}
}
}
]Delete Smart Forms
Business applications can use this service API to delete smart form
path Parameters
| id required | integer <int64> Smart form 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 |
Responses
Response samples
- 200
- 403
- 404
- 500
{ }Add Smart Forms
Business applications can use this service API to add Smart forms
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:
Add request
| name required | string non-empty Name |
| first_recipient_instruction | string First recipient instruction |
| active required | boolean Status |
required | object Template |
required | object Advanced settings |
Responses
Request samples
- Payload
{- "name": "string",
- "first_recipient_instruction": "string",
- "active": true,
- "template": {
- "id": 0
}, - "advanced_settings": {
- "email_validation": true,
- "signers_message": "string",
- "usage_settings": {
- "total_responses": {
- "enabled": true,
- "count": 0
}, - "limit_time_responses": {
- "enabled": true,
- "count": 0,
- "duration": "string"
}
}
}
}Response samples
- 201
- 400
- 403
- 422
- 500
{- "id": 0,
- "url": "string",
- "created_on": "string"
}Delete Bulk Smart Forms
Business applications can use this service API to bulk delete Smart forms
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:
Smart form ids
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Validate Smart Form Rules
Business applications can use this service API to validate Smart forms rules
path Parameters
| id required | integer <int32> Template 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 |
Responses
Response samples
- 200
- 400
- 403
- 404
- 500
{ }Get Smart Form Details
Business applications can use this service API to get Smart forms details
query Parameters
| q required | string Encrypted q |
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
- 400
- 403
- 500
{- "smart_form": {
- "first_recipient_instruction": "string",
- "locked_template": true,
- "recipients": [
- {
- "role": "string",
- "placeholder": "string",
- "user_name": "string",
- "group_name": "string",
- "user_email": "string",
- "mobile_number": "string",
- "electronic_seal": {
- "name": "string",
- "level_of_assurance": "string"
}, - "delivery_method": "string"
}
]
}, - "branding": {
- "logo": "string",
- "logo_url": "string",
- "favicon": "string",
- "favicon_url": "string",
- "signature_logo": "string",
- "signature_logo_url": "string",
- "email_logo": "string",
- "email_logo_url": "string",
- "colors": {
- "level_1": "string",
- "level_2": "string",
- "level_3": "string",
- "level_4": "string",
- "level_5": "string",
- "level_6": "string",
- "level_7": "string",
- "level_8": "string",
- "level_9": "string",
- "level_10": "string",
- "level_11": "string",
- "level_12": "string",
- "level_13": "string",
- "level_14": "string",
- "level_15": "string"
}
}
}Start Smart Form Signing
Business applications can use this service API to start smart form 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 |
| x-verification-code | string Verification code in headers for OTP verification. |
Request Body schema:
Start smart form signing request
| q required | string non-empty Q |
required | Array of objects (StartSmartFormSigningRecipientRequestModal) Recipients |
Responses
Request samples
- Payload
{- "q": "string",
- "recipients": [
- {
- "group_name": "string",
- "placeholder": "string",
- "user_name": "string",
- "user_email": "string",
- "electronic_seal": {
- "name": "string",
- "level_of_assurance": "string"
}, - "mobile_number": "string"
}
]
}Response samples
- 200
- 400
- 403
- 500
{- "package_id": 0,
- "access_token": "string"
}Download Smart Forms Response
Business applications can use this service API to downalod Smart forms responses
path Parameters
| id required | integer <int64> Smart form id |
query Parameters
| format | string Default: "JSON" Enum: "CSV" "XML" "JSON" Download format |
| created-from | string <date-time> Created from |
| created-to | string <date-time> Created to |
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
"string"Get Library Documents
Business applications can use this service API to retieve documents from both personal and enterprise libraries for the current user. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
It is possible to search based upon the criteria supplied under the "x-search-text" header.Furthermore, it is possible to search a user's personal library or that of the enterprise to which the user belongs.
path Parameters
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
| pageNo required | integer <int32> Page number to be retrieved. |
query Parameters
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "NAME" "SIZE" "TEMPLATENAME" Sort by. [CREATEDON | NAME | SIZE | TEMPLATENAME] |
| asc | boolean Default: false Sort order. |
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-search-text | string Example: c2FsZXMgY29udHJhY3QgMTA1 Search text if required. This is optional and without it the entire list is returned. |
| x-enterprise | string Default: true Set to "true" to search the entire enterprise library document list. Otherwise, "false" to search only the user's library document list. |
| x-folder | string Example: SU5CT1g= Folder name from where the library documents are to be fetched, recommended value for x-folder parameter is in Base64 encoded format. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "library_id": 0,
- "document_name": "string",
- "template_name": "string",
- "template_id": 0,
- "folder": "string",
- "created_on": "string",
- "document_size": 0,
- "enterprise": true
}
]Download Personal / Enterprise Library document
Business applications can use this service API to download personal / enterprise library document bytes.
path Parameters
| id required | integer <int64> The id of personal/enterprise library 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 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
"string"Download Personal / Enterprise Library document (Base64)
Business applications can use this service API to download personal / enterprise library document base64.
path Parameters
| id required | integer <int64> The id of personal/enterprise library 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 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "base64": "string"
}Add To Library
Business applications can use this service API to add package document into library for the current user.
path Parameters
| packageId required | integer <int64> The ID of the document package. |
| 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-folder | string Example: SU5CT1g= Folder name where the library documents are to be added, recommended value for x-folder parameter is in Base64 encoded format. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Get Signature Delegation Settings
Business applications can use this service API to get delegation settings of logged in user.
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
- 500
{- "enabled": true,
- "delegate": [
- {
- "user_name": "string",
- "user_email": "string",
- "from": "string",
- "to": "string"
}
], - "gatekeeper_setting": {
- "enabled": true,
- "gatekeepers": [
- {
- "user_name": "string",
- "user_email": "string"
}
]
}
}Update Signature Delegation Settings
Business applications can use this service API to update delegation settings of logged in user.
Signature delegation allows a user to delegate any requested signing operation for them to another user. The API call requires not only the identifier and name of the individual to whom delegation is given but also the period via start and end date, when the delegation applies.
The designated user must have a SigningHub account.
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:
| enabled required | boolean Set to "true" to enable delegate signing to another user, or "false" to remove a previously set permission. If enabling delegated signing all other parameters are mandatory. |
Array of objects (DelegateRequest) | |
object (GateKeeperSettingUpdate) |
Responses
Request samples
- Payload
{- "enabled": true,
- "delegate": [
- {
- "user_email": "string",
- "user_name": "string",
- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z"
}
], - "gatekeeper_setting": {
- "enabled": true,
- "gatekeepers": [
- {
- "user_name": "string",
- "user_email": "string"
}
]
}
}Response samples
- 200
- 400
- 403
- 500
{ }Get Hand Signature Text For Web
Business application can get the hand signature appearance used for upload option on web browsers.
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
"string"Get Initials For Upload Option
Business application can get the initials appearance used for upload option.
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
"string"Get Profile Picture (Base64)
Business applications can use this service API to get profile picture of the current user. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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
{- "photo": "string"
}Update Profile Picture
Business applications can use this service API to update profile picture of the current user. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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:
| photo | string Base64 encoded string of image to be updated as profile picture. |
Responses
Request samples
- Payload
{- "photo": "string"
}Response samples
- 200
- 400
- 403
- 500
{ }Get Hand Signature Upload For Mobile
Business application can get the hand signature appearance used for upload option on mobile apps and browsers.
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
"string"Get Hand Signature Upload For Web
Business application can get the hand signature appearance used for upload option on web browsers.
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
"string"Get Signature Settings
Business applications can use this service API to get the signature settings for the current user. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
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. |
Responses
Response samples
- 200
- 401
- 403
- 500
{- "signature": {
- "signing_servers": [
- {
- "info": {
- "name": "string",
- "order": 0,
- "provider": "string",
- "key_location": "string",
- "logo": "string",
- "id": 0,
- "host_url": "string",
- "client_id": "string",
- "level_of_assurance": "string",
- "appearance_design_name": "string",
- "appearance_logo": "string",
- "auth_type": "string",
- "environment": "string",
- "port": "string"
}, - "capacities": [
- {
- "name": "string",
- "id": 0,
- "key_protection": "string",
- "level_of_assurance": "string",
- "iscustom": true,
- "isdefault": true
}
], - "authentications": {
- "no_password": {
- "primary": {
- "profile_name": "string",
- "id": 0,
- "app_id": "string",
- "tenant_id": "string",
- "authentication_mechanism": "string",
- "provider": "string",
- "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"
}
}, - "secondary": "string",
- "primary_mobile": {
- "profile_name": "string",
- "id": 0,
- "app_id": "string",
- "tenant_id": "string",
- "authentication_mechanism": "string",
- "provider": "string",
- "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"
}
}, - "secondary_mobile": "string"
}, - "user_password": {
- "primary": {
- "profile_name": "string",
- "id": 0,
- "app_id": "string",
- "tenant_id": "string",
- "authentication_mechanism": "string",
- "provider": "string",
- "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"
}
}, - "secondary": "string"
}, - "system_password": {
- "primary": {
- "profile_name": "string",
- "id": 0,
- "app_id": "string",
- "tenant_id": "string",
- "authentication_mechanism": "string",
- "provider": "string",
- "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"
}
}, - "secondary": "string",
- "primary_mobile": {
- "profile_name": "string",
- "id": 0,
- "app_id": "string",
- "tenant_id": "string",
- "authentication_mechanism": "string",
- "provider": "string",
- "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"
}
}, - "secondary_mobile": "string"
}, - "remote_authorization": {
- "primary": {
- "profile_name": "string",
- "id": 0,
- "app_id": "string",
- "tenant_id": "string",
- "authentication_mechanism": "string",
- "provider": "string",
- "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"
}
}, - "secondary": "string"
}
}
}
], - "metadata": {
- "signing_reason": true,
- "signing_location": true,
- "contact_information": true,
- "commitment_type": "string"
}, - "signing_reason": {
- "value": "string",
- "selection": "string",
- "custom": true,
- "list": [
- "string"
]
}, - "signing_location": "string",
- "contact_information": "string",
- "signing_dialog_visible": true
}, - "appearance": {
- "hand_signature": {
- "web_browser": {
- "allowed_method": [
- "string"
], - "default_method": "string",
- "upload_image": "string",
- "upload_image_url": "string",
- "text_value": "string",
- "text_image": "string",
- "text_image_url": "string",
- "disable_text_field": true
}, - "mobile": {
- "allowed_method": [
- "string"
], - "default_method": "string",
- "upload_image": "string",
- "upload_image_url": "string",
- "text_value": "string",
- "text_image": "string",
- "text_image_url": "string",
- "disable_text_field": true
}
}, - "initials": {
- "allowed_method": [
- "string"
], - "default_method": "string",
- "upload_image": "string",
- "upload_image_url": "string",
- "text_value": "string",
- "text_image": "string",
- "text_image_url": "string",
- "disable_text_field": true
}, - "appearance_design": {
- "all_design": [
- {
- "design_name": "string",
- "design_preview": "string",
- "design_preview_url": "string"
}
], - "allowed_design": [
- {
- "design_name": "string",
- "design_preview": "string",
- "design_preview_url": "string"
}
], - "default_design": {
- "design_name": "string",
- "design_preview": "string",
- "design_preview_url": "string"
}, - "signature_logo": "string"
}, - "simple_electronic_signature_appearance_design": true,
- "level_of_assurance": "string",
- "in_person_level_of_assurance": "string"
}, - "level_of_assurance": {
- "signature": [
- "string"
], - "in_person": [
- "string"
]
}
}Update Signature Settings
SigningHub gives you complete control over your signature configurations. You can customise the physical appearance of your signature, hand signature methods (i.e., draw, text and upload), and other important details that needs to be appended to your signatures. There are separate configurations available for web browsers and mobile apps. Customise these provisions as required and use a set of configurations to produce your signatures.
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:
object Set the default Level of Assurances for Signature and In-Person fields | |
required | object Set appearance meta data for signatures/initial fields |
Responses
Request samples
- Payload
{- "level_of_assurance": {
- "signature": [
- "string"
], - "in_person": [
- "string"
]
}, - "appearance": {
- "signature": {
- "web": {
- "default_method": "DRAW",
- "upload_image": "string",
- "text_value": "string"
}, - "mobile": {
- "default_method": "DRAW",
- "upload_image": "string",
- "text_value": "string"
}
}, - "initials": {
- "default_method": "DRAW",
- "upload_image": "string",
- "text_value": "string"
}, - "appearance_design": {
- "name": "string",
- "logo": "string"
}
}
}Response samples
- 200
- 400
- 403
- 500
{ }Get Initials For Text Option
Business application can get the initials appearance used for text option.
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
"string"Get Hand Signature Text For Mobile
Business application can get the hand signature appearance used for text option on mobile apps and browsers.
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
"string"Get Templates
Business applications can use this service API to get list of templates for the current user.
It is possible to search based upon the criterion supplied under the "x-search-text" header.Furthermore, it is possible to search a user's personal templates or the enterprise templates as allowed against their user role by their enterprise admin.
path Parameters
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
| pageNo required | integer <int32> Page number to be retrieved. |
query Parameters
| sort-by | string Default: "CREATED_ON" Enum: "CREATED_ON" "NAME" "DESCRIPTION" "READ_ONLY" "IS_PUBLIC" Sort by column. Possible Values are CREATED_ON and NAME. Default is sort by CREATED_ON |
| asc | boolean Default: false The resulting list order. Default resulting list will be descending |
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-search-text | string Example: TXkgdGVtcGxhdGU= Search text if required. This is optional and without it the entire list is returned. |
| x-enterprise | string Default: true When set as "true" only enterprise templates list will be returned. In case of "false"only the user's templates list will be returned.If you do not set the header, then both enterprise and user's templates lists will be returned. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
[- {
- "template_id": 0,
- "template_name": "string",
- "template_public": true,
- "read_only": true,
- "created_on": "string",
- "description": "string",
- "enterprise": true,
- "documents": [
- {
- "id": 0,
- "name": "string"
}
], - "smart_form": {
- "active_count": 0,
- "total_count": 0
}
}
]Get Signature Appearance
Business application can get the hand signature preview image file using the following API endpoint.
path Parameters
| appearanceName required | 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
- 403
- 404
- 500
"string"Update Initial Appearance
Business applications can use this service API to update the signature appearance when initialing a document of the current user. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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:
| default_method required | string Enum: "DRAW" "UPLOAD" "TEXT" "SIGNATURE_PAD" |
| upload_image | string Base64 encoded string of the image that contains the captured handwritten signature image. |
| text_value | string Text value to save against the new saved image under user settings. |
Responses
Request samples
- Payload
{- "default_method": "DRAW",
- "upload_image": "string",
- "text_value": "string"
}Response samples
- 200
- 400
- 403
- 500
{ }Update Hand Signature (Browser)
Business applications can use this service API to update the signature appearance setting used in web browsers for the current user.
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:
| default_method required | string Enum: "DRAW" "UPLOAD" "TEXT" "SIGNATURE_PAD" |
| upload_image | string Base64 encoded string of the image that contains the captured handwritten signature image. |
| text_value | string Text value to save against the new saved image under user settings. |
Responses
Request samples
- Payload
{- "default_method": "DRAW",
- "upload_image": "string",
- "text_value": "string"
}Response samples
- 200
- 400
- 403
- 500
{ }Update Signature Appearance Design
Business applications can use this service API to update signature appearance design for the current user. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
The signature appearance design defines the content of the visible signature appearance.Choices are hand signature only, hand signature with details, or hand signature with details and company logo/image.In this case "details" is defined as the "signed by", "signing time" and signing reason" fields.
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:
| default_design | string New design name to be updated for the signature design appearance . |
Responses
Request samples
- Payload
{- "default_design": "string"
}Response samples
- 200
- 400
- 403
- 500
{ }Update Hand Signature (Mobile)
Business applications can use this service API to update the signature appearance setting used in mobile browsers for the current user.
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:
| default_method required | string Enum: "DRAW" "UPLOAD" "TEXT" "SIGNATURE_PAD" |
| upload_image | string Base64 encoded string of the image that contains the captured handwritten signature image. |
| text_value | string Text value to save against the new saved image under user settings. |
Responses
Request samples
- Payload
{- "default_method": "DRAW",
- "upload_image": "string",
- "text_value": "string"
}Response samples
- 200
- 400
- 403
- 500
{ }Update Signature Settings Metadata
Business applications can use this service API to update signature settings metadata of the current user. The metadata comprises these fields, the "Signing Reason" field, the "Signing Location" field, the "Contact Information" field and the "Commitment Type Indication" field of the signer. All these are optional fields for visible signature appearance under the ETSI PAdES Signature Profile standards.
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:
| signing_reason | string String value for signing reason to be updated. System will retain fixed value configured in Role -> Signature Settings -> Signing Reason -> Allow user to manage signing reason -> Fixed drop-down |
| contact_information | string String value for contact information to be updated. System will retain old value if Role -> Signature Settings -> Meta Information -> "Allow user to manage contact information" is disabled |
| signing_location | string String value for signing location to be updated. System will retain old value if Role -> Signature Settings -> Meta Information -> "Allow user to manage location" is disabled |
| commitment_type | string The specified information will become a permanent part of your signature, and can optionally be displayed in the signed document. While signing of XML document the "Commitment Type Indications" options will be displayed. It's an Optional parameter so to skip it's value pass null/empty value, otherwise to set it possible values are PROOF_OF_ORIGIN, PROOF_OF_RECEIPT, PROOF_OF_DELIVERY, PROOF_OF_SENDER, PROOF_OF_APPROVAL, PROOF_OF_CREATION |
Responses
Request samples
- Payload
{- "signing_reason": "string",
- "contact_information": "string",
- "signing_location": "string",
- "commitment_type": "string"
}Response samples
- 200
- 400
- 403
- 500
{ }Remove Account Request
Business applications can use this service API to request the deletion of an account. This API will trigger the account deletion confirmation email against the requested user. For an enterprise account, all the enterprise users, except the enterprise owner, with in the account must be deleted first.
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-enterprise | string Default: true When set as "true" for enterprise owner and enterprise user. In case of "false" when user delete their own account. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{ }Remove Account
Business applications can use this service API to delete an account against which a "Remove Account Request" service API was initiated, and the user authorized the account deletion.
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:
| q required | string non-empty |
Responses
Request samples
- Payload
{- "q": "string"
}Response samples
- 200
- 400
- 401
{ }Get User Certification Password
Business applications can use this service API to get system generated user certificate password of the current logged-in user.
query Parameters
| signing-capacity required | string The signing capacity name is mandatory and must be configured in the service plan for individual users. For enterprise users, it should be configured in both the service plan and the enterprise role. Additionally, it is recommended to provide the signing capacity parameter in Base64 encoded format. |
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
"string"Get User Advance Settings
Business applications can use this API to Get Advance Settings for current individual user.
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
- 500
{- "documents": {
- "save_document_revision": {
- "enabled": true
}
}
}Update User Advance Settings
Business applications can use this API to Update Advance Settings for current individual user.
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 | object Document settings configurations |
Responses
Request samples
- Payload
{- "documents": {
- "save_document_revision": {
- "enabled": true
}
}
}Response samples
- 200
- 401
- 403
- 500
{ }Get General Profile Information
Business applications can use this service API to get the general profile information of the current user. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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
{- "general": {
- "user_email": "string",
- "user_name": "string",
- "job_title": "string",
- "company_name": "string",
- "mobile_number": "string",
- "enterprise_role": "string",
- "ra_userid": "string",
- "user_national_id": "string",
- "user_csc_id": "string"
}, - "security": {
- "question": "string"
}, - "locale": {
- "country": "string",
- "timezone": "string",
- "language": "string"
}, - "enterprise": {
- "enterprise_id": 0,
- "enterprise_name": "string",
- "owner": "string",
- "owner_email": "string",
- "mobile_number": "string",
- "url": "string",
- "support_email": "string"
}
}Update General Profile Information
Business applications can use this service API to update general profile information of the current user. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
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:
| user_name required | string non-empty Name of the user whose information requires updating. This is a mandatory field and must match the user name for whom the access token was granted to. |
| job_title | string Job title of the user. |
| company_name | string Company name for the user. |
| mobile_number | string Mobile number of the user. Remember to include the international dialing and country codes. For example, UK numbers require 00 44 to proceed the actual mobile number. The leading zero must be dropped from the mobile number also, and replaced with the international and country dialing codes. |
| country | string Country name for the user. All values in the appendix - Country list are accepted. |
| time_zone | string Timezone name for the user. All values in the appendix - Timezone list are accepted. |
| language | string Language selected for the user. All values in the appendix - Language list are accepted. |
| user_national_id | string National identity number of the user. |
| user_csc_id | string User CSC id |
Responses
Request samples
- Payload
{- "user_name": "string",
- "job_title": "string",
- "company_name": "string",
- "mobile_number": "string",
- "country": "string",
- "time_zone": "string",
- "language": "string",
- "user_national_id": "string",
- "user_csc_id": "string"
}Response samples
- 200
- 400
- 403
- 500
{ }Get Profile Picture
Business applications can use this service API to get profile picture of the current user. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
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"Update Locale Settings
Business applications can use this service API to update locale profile information of the current user. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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:
| country | string Country name to be set for the user. All values in the appendix - Country List are accepted. If no value is provided, previous value will be retained. |
| timezone | string Standard string for timezone information. All values in the appendix - Timezone List are accepted. If no value is provided, previous value will be retained. |
| language | string Language selected for the user. All values in the appendix - Language list are accepted. If no value is provided, previous value will be retained. |
Responses
Request samples
- Payload
{- "country": "string",
- "timezone": "string",
- "language": "string"
}Response samples
- 200
- 403
- 500
{ }Update Security Settings
Business applications can use this service API to update profile’s security information of the current user. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
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 Password of the user used for the authentication. |
| question required | string non-empty New security question to be set for the user. |
| answer required | string non-empty New security answer to be set for the user. |
Responses
Request samples
- Payload
{- "password": "string",
- "question": "string",
- "answer": "string"
}Response samples
- 200
- 400
- 403
- 500
{ }Change Password
Business applications can use this service API to change the password of the current user. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
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:
| user_old_password required | string non-empty Old password of the user. |
| user_new_password required | string non-empty New password of the user. |
Responses
Request samples
- Payload
{- "user_old_password": "string",
- "user_new_password": "string"
}Response samples
- 200
- 400
- 403
- 500
{- "access_token": "string",
- "token_type": "string",
- "expires_in": 0,
- "refresh_token": "string"
}Get Active Sessions
Business applications can use this service API to get the list of all the active sessions of the current user.
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
- 500
[- {
- "machine_name": "string",
- "agent": "string",
- "ip_address": "string"
}
]Get Authorised Devices
Business applications can use this service API to get the list of all the authorized devices of the current user that are registered for RAS 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
- 400
- 403
- 500
[- {
- "device_name": "string",
- "device_id": "string",
- "secure_element_support": true,
- "biometric": true
}
]Update Two-Factor Authentication
Business applications can use this service API to enable the two-factor authentication configurations for the current user.
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:
| totp required | string non-empty The TOTP value |
Responses
Request samples
- Payload
{- "totp": "string"
}Response samples
- 200
- 400
- 403
- 500
{ }Disable Two-Factor Authentication
Business applications can use this service API to disable the two-factor authentication for the current user.
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
- 403
- 500
{ }Regenerate Recovery Codes Two-Factor Authentication
Business applications can use this service API to regenerate the recovery codes against the two-factor authentication for the current user.
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:
| totp required | string non-empty The TOTP value |
Responses
Request samples
- Payload
{- "totp": "string"
}Response samples
- 200
- 400
- 403
- 500
[- "string"
]Get Notification Settings
Business applications can use this service API to get the logged-in user notification settings.
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
- 500
{- "notification_setting": {
- "templates_limit_reached": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "signature_limit_reached": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "workflow_limit_reached": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "simple_electronic_signature_limit_reached": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "serviceplan_reset": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "serviceplan_change": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "online_payment": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "forgot_password": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "password_changed": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "login_failed": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "document_processed_by_others": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "document_completed": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "daily_summary": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "document_subsequent_changes": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "process_document": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "recall_document": {
- "recipients": "string",
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}, - "share_document": {
- "on_screen": {
- "enabled": true,
- "editable": true
}, - "email": {
- "enabled": true,
- "editable": true
}, - "push": {
- "enabled": true,
- "editable": true
}
}
}
}Update Notifications Settings
Business applications can use this service API to update the logged-in user notification settings. The notification settings for Signatures, Simple Electronic Signatures, Workflows, and Templates can only be updated, as per the service plan configuration.
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:
object (UpdatePersonalNotificationRequest) |
Responses
Request samples
- Payload
{- "notification_setting": {
- "templates_limit_reached": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}
}, - "signature_limit_reached": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}
}, - "workflow_limit_reached": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}
}, - "simple_electronic_signature_limit_reached": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}
}, - "serviceplan_reset": {
- "on_screen": {
- "enabled": true
}
}, - "serviceplan_change": {
- "on_screen": {
- "enabled": true
}
}, - "online_payment": {
- "on_screen": {
- "enabled": true
}
}, - "forgot_password": {
- "on_screen": {
- "enabled": true
}
}, - "password_changed": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}
}, - "login_failed": {
- "on_screen": {
- "enabled": true
}
}, - "document_processed_by_others": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}, - "push": {
- "enabled": true
}
}, - "document_completed": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}, - "push": {
- "enabled": true
}
}, - "daily_summary": {
- "email": {
- "enabled": true
}
}, - "document_subsequent_changes": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}, - "push": {
- "enabled": true
}
}, - "process_document": {
- "email": {
- "enabled": true
}
}, - "recall_document": {
- "recipients": "string",
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}
}, - "share_document": {
- "on_screen": {
- "enabled": true
}, - "email": {
- "enabled": true
}, - "push": {
- "enabled": true
}
}
}
}Response samples
- 200
- 400
- 403
- 500
{ }Get Email Settings
Business applications can use this service API to get the email settings of the logged-in user.
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
- 500
[- {
- "type": "string",
- "subject": "string",
- "body": "string"
}
]Update Email Settings
Business applications can use this service API to update the email settings of the logged-in user. The user can update the subject and the body of the emails but can not update the email type. For these email settings, go to Web Manuals > Configure Personal Settings > Configure your notifications > Configure your email content.
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:
| type required | string Enum: "WORKFLOW_SHARED" "WORKFLOW_PROCESSED_REVIEWED" "WORKFLOW_COMPLETED" "WORKFLOW_RECALLED" "WORKFLOW_SHARED_REMINDER" "WORKFLOW_POST_PROCESS" "WORKFLOW_SIGNED" "WORKFLOW_PROCESSED_DECLINED" "WORKFLOW_PROCESSED_EDITED" "SEND_A_COPY_SENT" "WORKFLOW_PROCESSED_BY_OTHERS" "WORKFLOW_PROCESSED_BY_ME" "ENTERPRISE_INVITATION" "PUBLISH_WORKFLOW_HISTORY_ON_COMPLETE" "WORKFLOW_ADD_COMMENT" "ACCOUNT_REGISTERED" "ACCOUNT_ACTIVATION_COMPLETION" "ENTERPRISE_USER_REGISTRATION" "ENTERPRISE_RESET_PASSWORD" "ENTERPRISE_PASSWORD_RESET_COMPLETION" "WORKSPACE_SHARED" |
| subject required | string non-empty The subject of the email. |
| body required | string non-empty The body of the email. |
Responses
Request samples
- Payload
{- "type": "WORKFLOW_SHARED",
- "subject": "string",
- "body": "string"
}Response samples
- 200
- 400
- 403
- 404
- 500
{ }Reset User Emails To Default
Business applications can use this service API to reset the logged-in user email settings to default.
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
- 403
- 500
{ }Get Enterprise Library Documents
Business applications can use this service API to retrieve documents from both personal and enterprise libraries of the current user. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
It is possible to search based upon the criteria supplied under the "x-search-text" header.
path Parameters
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
| pageNo required | integer <int32> Page number to be retrieved. |
query Parameters
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "NAME" "SIZE" "TEMPLATENAME" Sort the result by possible values are mentioned above. |
| asc | boolean Default: false Order the result set by ascending or descending. |
| id | Array of integers <int64> [ items <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 |
| x-search-text | string Example: c2FsZXMgY29udHJhY3QgMTA1 Search text if required. This is optional and without it the entire list is returned. |
| x-folder | string Example: SU5CT1g= Folder name from where the library documents are to be fetched, recommended value for x-folder parameter is in Base64 encoded format. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "library_id": 0,
- "document_name": "string",
- "template_name": "string",
- "folder": "string",
- "created_on": "string",
- "document_size": 0,
- "enterprise": true,
- "roles": [
- {
- "name": "string",
- "id": 0
}
]
}
]Get Personal Library Document By ID
Business applications can use this service API to get a personal library document of the current user.
path Parameters
| id required | integer <int64> The id of library 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 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "document_name": "string",
- "template_name": "string",
- "folder_name": "string",
- "created_on": "string",
- "document_size": 0
}Update Personal Library Document
Business applications can use this service API to update personal library document of the current user.
path Parameters
| id required | integer <int64> The id of library 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:
| document_name required | string [ 1 .. 200 ] characters Name of the library document. |
| folder_name | string <= 255 characters Name of the folder in which library document has to be uploaded. |
| template_name | string <= 255 characters Name of the template, if one is applied on the document. If no template is applied, the value can be "null". |
Responses
Request samples
- Payload
{- "document_name": "string",
- "folder_name": "string",
- "template_name": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Delete Personal Library Document
Business applications can use this service API to delete a personal library document of the current user.
path Parameters
| id required | integer <int32> The id of library 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 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{ }Add Personal Library Document
Business applications can use this service API to add a personal library document for the current user.
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: File Name File name is required. This will be the name of the uploaded library file. Furthermore, the recommended value for the file name parameter is in Base64 encoded format. |
Request Body schema: multipart/form-data
| file (binary Stream) | string <binary> Default: "" This is the document in the raw binary format, posting via form data. |
| folder_name | string <binary> Default: "" parameter name in string format. |
| template_name | string <binary> Default: "" parameter name in string format. |
Responses
Response samples
- 201
- 400
- 401
- 403
- 404
- 500
{- "id": 0
}Bulk Delete Personal Library Documents
Business applications can use this service API to bulk delete personal library documents of the current user.
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:
List of ids of library documents
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Get Library Folders
applications can use this service API to get library folders of the current user.
path Parameters
| pageNo required | integer <int32> |
| recordsPerPage required | integer <int32> |
query Parameters
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "NAME" |
| asc | boolean Default: true |
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-search-text | string Example: folder Search text if required. This is optional and without it the entire list is returned. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
| x-enterprise | string Default: true If "x-enterprise" is set to "true", we will retrieve only the allowed folders. Otherwise, we will retrieve only personal folders. |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "folder_id": 0,
- "folder_name": "string",
- "created_on": "string"
}
]Get Personal Library Folder by ID
Business applications can use this service API to get a personal library folder of the current user.
path Parameters
| id required | integer <int64> The id of library 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 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "folder_name": "string",
- "created_on": "string"
}Update Personal Library Folder
Business applications can use this service API to personal update library folder of the current user.
path Parameters
| id required | integer <int64> The id of library 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 |
Request Body schema:
| folder_name required | string [ 1 .. 255 ] characters Name of the library document folder. |
Responses
Request samples
- Payload
{- "folder_name": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Delete Personal Library Folder
Business applications can use this service API to delete a personal library folder of the current user.
path Parameters
| id required | integer <int32> The id of library 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 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{ }Add Personal Library Folder
Business applications can use this service API to add a personal library folder for the current user.
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:
| folder_name required | string [ 1 .. 255 ] characters Name of the library document folder. |
Responses
Request samples
- Payload
{- "folder_name": "string"
}Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0
}Bulk Delete Personal Library Folders
Business applications can use this service API to bulk delete personal library folders of the current user.
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:
List of ids of library folders
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Move Personal Library Documents
Business applications can use this service API to move personal library documents to library folder of the current user.
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 required | Array of integers <int32> [ items <int32 > ] Ids of library documents. |
| folder_name required | string [ 1 .. 255 ] characters Name of the library document folder. |
Responses
Request samples
- Payload
{- "ids": [
- 0
], - "folder_name": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Get Personal Legal Notice
Business applications can use this service API to get a personal Legal Notice for Users. An admin who has permissions to manage Legal Notices in his role, can get legal notices. The role dictates things such as allowed Read legal notice available to the user.
path Parameters
| id required | integer <int32> The id of legal notice |
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
{- "id": 0,
- "title": "string",
- "content": "string"
}Update Personal Legal Notice
Business applications can use this service API to edit a personal Legal Notice for Users. An admin who has permissions to manage Legal Notices in his role, can edit legal notices. The role dictates things such as allowed Edit legal notice available to the user.
path Parameters
| id required | integer <int32> The id of legal notice |
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:
| title required | string [ 1 .. 255 ] characters Legal Notice Title |
| content required | string non-empty Legal Notice Content |
Responses
Request samples
- Payload
{- "title": "string",
- "content": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Delete Personal Legal Notice
Business applications can use this service API to delete a personal Legal Notice for Users. An admin who has permissions to manage Legal Notices in his role, can delete legal notices. The role dictates things such as allowed Delete legal notice available to the user.
path Parameters
| id required | integer <int32> The id of legal notice |
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
{ }Add Personal Legal Notice
Business applications can use this service API to add a personal Legal Notice for Users. An admin who has permissions to manage Legal Notices in his role, can add new legal notices. The role dictates things such as allowed Add legal notice available to the 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 |
Request Body schema:
| title required | string [ 1 .. 255 ] characters Legal Notice Title |
| content required | string non-empty Legal Notice Content |
Responses
Request samples
- Payload
{- "title": "string",
- "content": "string"
}Response samples
- 201
- 400
- 401
- 403
- 500
{- "id": 0,
- "created_on": "2019-08-24T14:15:22Z"
}Bulk Delete Personal Legal Notice
Business applications can use this service API to delete personal Legal Notices for Users. An admin who has permissions to manage Legal Notices in his role, can delete legal notices. The role dictates things such as allowed Delete legal notice available to the user.
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:
List of ids of legal notices
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 404
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Add Personal Group
Business applications can use this service API to add a personal group for Users. A group admin who has permissions to manage groups in this role, can add new groups.
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:
| name required | string [ 1 .. 255 ] characters Group Name |
| description | string Group Description |
required | Array of objects (GroupMembers) |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "members": [
- {
- "user_email": "string",
- "user_name": "string"
}
]
}Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0,
- "name": "string"
}Update Personal Group
Business applications can use this service API to update personal group of its users. A group Admin who has permissions to manage groups in this role, can update personal groups.
path Parameters
| id required | integer <int32> ID of the user group. |
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:
| name required | string [ 1 .. 255 ] characters Group Name |
| description | string Group Description |
required | Array of objects (GroupMembers) |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "members": [
- {
- "user_email": "string",
- "user_name": "string"
}
]
}Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{ }Delete Personal Group
Business applications can use this service API to delete personal group of its users. A group admin who has permissions to manage groups in his role, can delete groups of user. The Role dictates things such as allowed delete groups available to the user.
path Parameters
| id required | integer <int32> ID of the user group. |
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
{ }Get Personal Group by Id
Business applications can use this service API to get personal group of its users. A group admin who has permissions to manage groups in this role, can get personal groups of user.
path Parameters
| id required | integer <int32> ID of the user group. |
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
{- "id": 0,
- "name": "string",
- "description": "string",
- "created_on": "string",
- "members": [
- {
- "user_email": "string",
- "user_name": "string"
}
]
}Bulk Delete Personal Group
Business applications can use this service API to bulk delete personal groups of its users. An enterprise Admin or an enterprise user who has permission to manage groups in this role, can bulk delete personal groups of its user. The role dictates whether it is allowed to delete groups available to the user.
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 of the user group.
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Get Legal Notices
Business applications can use this service API to get the list of legal notices for the current user. This means the enterprise administrator or the enterpriser user if the "scope" variable was used in the authentication request.
path Parameters
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
| pageNo required | integer <int32> Page number to be retrieved. |
query Parameters
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "TITLE" Sorting column name, possible values are TITLE | CREATEDON. Default value will be CREATEDON |
| asc | boolean Default: false Order the result set by ascending or descending. |
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: U2FsZXM= Search text if required. This is optional and without it the entire list is returned. |
| x-enterprise | string Default: true If set as "true" only enterprise legal notices list will be returned. In case of "false"only the user's legal notices list will be returned.If you do not set the header, then both enterprise and user's legal notices lists will be returned. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 403
- 500
[- {
- "id": 0,
- "title": "string",
- "content": "string",
- "enterprise": true,
- "created_on": "string"
}
]Get Cloud Drives Settings
Business applications can use this service API to Get the cloud drive settings of the current user.
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
- 500
[- {
- "type": "string",
- "enabled": true
}
]Enable Cloud Drives Settings
Business applications can use this service API to enable the cloud drive settings of the current user.
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:
| redirect_uri | string value of redirect URL, if it was provided at time of Authorization request. |
| code required | string non-empty Authorization code. |
| type required | string non-empty Type of cloud drive, possible values could be DROPBOX | ONEDRIVE | GOOGLE_DRIVE. |
Responses
Request samples
- Payload
{- "redirect_uri": "string",
- "code": "string",
- "type": "string"
}Response samples
- 200
- 400
- 401
- 403
- 500
{ }Disable Cloud Drives Settings
Business applications can use this service API to disable the cloud drive settings of the current user.
path Parameters
| type required | integer Enum: 0 1 2 type of cloud drive, possible values could be DROPBOX | ONEDRIVE | GOOGLE_DRIVE. |
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
{ }Add Personal Contact
Business applications can use this service API to add a contact for the current user.
A contact does not require a SigningHub account and is an easy way of managing document recipients.
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:
| user_name required | string [ 1 .. 255 ] characters User name of the user to be added as a contact. |
| user_email required | string [ 1 .. 255 ] characters Email address of the user to be added as a contact. |
| mobile_number | string <= 15 characters Mobile Number |
Responses
Request samples
- Payload
{- "user_name": "string",
- "user_email": "string",
- "mobile_number": "string"
}Response samples
- 200
- 201
- 401
- 403
- 500
{- "Message": "string"
}Delete Personal Contact
Business applications can use this service API to delete personal contact of the current user.
path Parameters
| id required | integer <int64> ID of the user contact. |
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
{ }Get Personal Contact by Id
Business applications can use this service API to get personal contact of the current user.
path Parameters
| id required | integer <int64> ID of the user contact. |
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
{- "user_name": "string",
- "user_email": "string",
- "user_national_id": "string",
- "mobile_number": "string"
}Update Personal Contact
Business applications can use this service API to update personal contact of the current user.
path Parameters
| id required | integer <int64> ID of the user contact. |
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:
| user_name required | string [ 1 .. 255 ] characters User name of the user to be updated as of a contact. |
| mobile_number | string <= 15 characters Mobile number. If no value is provided, old value will be retained. |
Responses
Request samples
- Payload
{- "user_name": "string",
- "mobile_number": "string"
}Response samples
- 200
- 403
- 404
- 500
{ }Bulk Delete Personal Contact
Business applications can use this service API to bulk delete personal contacts of the current user.
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 of the user contact.
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Bulk Import Personal Contacts
Business applications can use this service API to import the bulk personal contacts of the current user
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: multipart/form-data
| file (binary Stream) | string <binary> This is the contacts document in CSV format, posting via form data. |
Responses
Response samples
- 200
- 401
- 403
- 422
- 500
{- "success": [
- {
- "id": 0,
- "user_name": "string",
- "user_email": "string",
- "mobile_number": "string",
- "created_on": "string"
}
], - "failure": [
- {
- "user_name": "string",
- "user_email": "string",
- "error_message": "string"
}
]
}Get Contacts
Business applications can use this service API to retieve contacts from both personal and enterprise contacts for the current user.
It is possible to search based upon the criterion supplied under the "x-search-text" header.Furthermore, it is possible to search a user's specific contacts or that of the enterprise to which the user belongs.
The search response information contains the user email address and respective user name.
path Parameters
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
| pageNo required | integer <int32> Page number to be retrieved. |
query Parameters
| sort-by | string Default: "CREATEDON" Enum: "CREATEDON" "NAME" "EMAIL" Sort the result by possible values are mentioned above. |
| asc | boolean Default: false Order the result set by ascending or descending. |
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-search-text | string Example: am9obg== Search text if required. This is optional and without it the entire list is returned. |
| x-enterprise | string Default: true When set as "true" only enterprise contacts list will be returned. In case of "false"only the user's contacts list will be returned.If you do not set the header, then both enterprise and user's contacts lists will be returned. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 403
- 500
[- {
- "id": 0,
- "user_name": "string",
- "user_email": "string",
- "mobile_number": "string",
- "enterprise": true,
- "user_national_id": "string",
- "created_on": "string"
}
]Get Workflow User Permission (Template)
Business applications can use this service API to get document permissions for a recipient. Recipient is identified by the order in the workflow.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
| order required | integer <int32> The order of the user in template workflow for which the permissions 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 |
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"
}
}
}Update Workflow User Permission (Template)
Business applications can use this service API to update the workflow permissions for a user that has already been added to a personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template 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 |
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 It has all the permissions to be allowed in the workflow |
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"
}
}
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Get Workflow User Authentication (Document Opening) (Template)
Business applications can use this service API to get the access security settings enabled for personal/enterprise template. Recipients will not be able to access document package outside the scope of this duration if the access security is enabled.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
| order required | integer <int32> The Order of the recipient in the template 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) (Template)
Business applications can use this service API to update the authentications and access duration for a user that has already been added to a personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template for which workflow access security and authentication is to be updated. |
| order required | integer <int32> The 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 |
Request Body schema:
| apply_to_all required | boolean True, if the access security or authentications are to be applied on all the recipients in the workflow. |
required | object It has the access aauthentication data |
object It has the signing authentication data | |
required | object It has the access duration of the workflow |
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
{ }Get Workflow Reminder (Template)
Business applications can use this service API to update the reminders for the recipients that has already been added to a personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
| order required | integer <int32> The order of the user for which the template 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
}
}Update Workflow Reminders (Template)
Business applications can use this service API to update the workflow reminders for a recipient that has already been added to a personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template for which workflow reminders to be updated. |
| order required | integer <int32> The order of the user for which the template 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 required | boolean True, if reminder settings are to be applied on all the recipients in the workflow. |
| enabled required | boolean True, if reminder settings are to be enabled. |
| frequency required | string Enum: "DAYS" "HOURS" |
| remind_after required | 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 The reminders would be sent to user repeatedly. |
Responses
Request samples
- Payload
{- "apply_to_all": true,
- "enabled": true,
- "frequency": "DAYS",
- "remind_after": 0,
- "repeat": {
- "enabled": true,
- "frequency": "DAYS",
- "keep_reminding_after": 0,
- "total_reminders": 0
}
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Add QR Code (Template)
Business applications can use this service API to add a QR Code field into personal/enterprise template.
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 to Template for more information.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template to which the field 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:
| page_no required | integer <int32> Page number on which the field is to be created. |
| field_name | string <= 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 Field dimensions |
| data | string <= 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 Settings regarding options | |
object Settings regarding color | |
object Settings regarding logo |
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": "L",
- "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
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "data": "string",
- "field_name": "string",
- "value": "string"
}Update QR Code (Template)
Business applications can use this service API to update a QR Code field of a document into personal/enterprise template.
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 of Template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template to which the field is updated. |
| 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 [ 1 .. 255 ] characters Current name of the field, that is to be updated. |
| renamed_as | string Updated name of the field if renaming is intended. |
| page_no required | integer <int32> Page number for which field is need to be updated |
required | object Field dimensions |
| data | string <= 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 Settings regarding options | |
object Settings regarding color | |
object Settings regarding logo |
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": "L",
- "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
- 422
- 500
{- "value": "string"
}Add CheckBox Field (Template)
Business applications can use this service API to add a checkbox field into personal/enterprise template.
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 to Template for more information.
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
| templateId required | integer <int32> The ID of personal/enterprise template to which the field 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 <= 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 required | boolean Value |
required | object (FieldDimension) |
| validation_rule required | string Enum: "OPTIONAL" "MANDATORY" |
Responses
Request samples
- Payload
{- "order": 0,
- "page_no": 0,
- "field_name": "string",
- "value": true,
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "validation_rule": "OPTIONAL"
}Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "field_name": "string",
- "created_on": "string"
}Update CheckBox Field (Template)
Business applications can use this service API to update a checkbox field of a document into personal/enterprise template.
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 of Template.
It's width and height cannot be updated. They will remain the same as when they were added.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template to which the field is updated. |
| 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 <= 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. |
| value required | boolean Value of the field. |
required | object (FieldDimension) |
| validation_rule required | string Enum: "OPTIONAL" "MANDATORY" |
Responses
Request samples
- Payload
{- "field_name": "string",
- "renamed_as": "string",
- "page_no": 0,
- "value": true,
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "validation_rule": "OPTIONAL"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{ }Add RadioBox Field (Template)
Business applications can use this service API to add a radio button field into personal/enterprise template.
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 to Template for more information.
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
| templateId required | integer <int32> The ID of personal/enterprise template to which the field 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 <= 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 required | boolean Value |
| validation_rule required | string Enum: "OPTIONAL" "MANDATORY" |
| radio_group_name required | string [ 1 .. 255 ] characters |
required | object (FieldDimension) |
Responses
Request samples
- Payload
{- "order": 0,
- "page_no": 0,
- "field_name": "string",
- "value": true,
- "validation_rule": "OPTIONAL",
- "radio_group_name": "string",
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}
}Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "field_name": "string",
- "created_on": "string"
}Update RadioBox Field (Template)
Business applications can use this service API to update a radio button field of a document into personal/enterprise template.
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 of Template.
It's width and height cannot be updated. They will remain the same as when they were added.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template to which the field is updated. |
| 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 <= 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. |
| value required | boolean Value of the field. |
| validation_rule required | string Enum: "OPTIONAL" "MANDATORY" |
| radio_group_name required | string [ 1 .. 255 ] characters The group name to which the field belongs. |
required | object (FieldDimension) |
Responses
Request samples
- Payload
{- "field_name": "string",
- "renamed_as": "string",
- "page_no": 0,
- "value": true,
- "validation_rule": "OPTIONAL",
- "radio_group_name": "string",
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}
}Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{ }Add TextBox Field (Template)
Business applications can use this service API to add a text input field into personal/enterprise template.
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 to Template for more information.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template to which the field 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. |
| type required | string Enum: "TEXT" "NAME" "EMAIL" "COMPANY" "JOBTITLE" "DATE" |
| value | string Value of the field. For type = DATE, the value is expected to follow ISO 8601 format.Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00. If value is not in proper format an error will be returned. |
| placeholder | string <= 255 characters 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 required | integer <int32> Maximum length of the value allowed in the field. Must between 1 - 9999 |
| format | string Text format of the field. Used for the date type field only. Possible values are
|
| field_name | string <= 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. |
| field_type required | string Enum: "Number" "Text" |
| validation_rule required | string Enum: "OPTIONAL" "MANDATORY" |
object Validations | |
required | object Font of the fields text |
required | object (FieldDimension) |
| multiline required | 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_type": "Number",
- "validation_rule": "OPTIONAL",
- "validation": {
- "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
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "field_name": "string",
- "created_on": "string"
}Update TextBox Field (Template)
Business applications can use this service API to update a text input field of a document into personal/enterprise template.
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 of Template. The latter can be used when a template was applied or the document was created using the GUI interface.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template to which the field is updated. |
| 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 <= 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. |
| value | string Value of the field. For type = DATE, the value is expected to follow ISO 8601 format.Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00. If value is not in proper format an error will be returned. |
| max_length required | integer <int32> Maximum length of the value allowed in the field. Must between 1 - 9999 |
| field_type required | string Enum: "Number" "Text" |
| validation_rule required | string Enum: "OPTIONAL" "MANDATORY" |
object Font of the fields text | |
object (FieldDimension) | |
| placeholder | string <= 255 characters Developers can provide a their own placeholder texts. These placeholders appear in the text fields while viewing the document in viewer. |
| format | string Text format of the field. Used for the date type field only. Possible values are
|
object Validations |
Responses
Request samples
- Payload
{- "field_name": "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
- 400
- 401
- 403
- 404
- 422
- 500
{ }Add Attachment Field (Template)
Business applications can use this service API to add an attachment field to a document into personal/enterprise template.
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 to Template 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
| templateId required | integer <int32> The ID of personal/enterprise template to which the field 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 <= 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 Enum: "OPTIONAL" "MANDATORY" |
| note | string Attachment note in case of Mandatory attachment |
required | object (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
- 401
- 403
- 404
- 422
- 500
{- "field_name": "string",
- "created_on": "string"
}Update Attachment Field (Template)
Business applications can use this service API to update an attachment field of a document into personal/enterprise template.
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 of Template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template to which the field is updated. |
| 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 <= 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 Enum: "OPTIONAL" "MANDATORY" |
| note | string <= 500 characters Attachment note in case of Mandatory attachment |
required | object (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
- 401
- 403
- 404
- 422
- 500
{ }Add Initial Field (Template)
Business applications can use this service API to add an initials field to a document into personal/enterprise template.
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 to Template 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
| templateId required | integer <int32> The ID of personal/enterprise template to which the field 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 <= 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. |
required | object (FieldDimension) |
| last_page required | boolean Last Page |
Responses
Request samples
- Payload
{- "order": 0,
- "page_no": 0,
- "field_name": "string",
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "last_page": true
}Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "field_name": "string",
- "created_on": "string"
}Update Initial Field (Template)
Business applications can use this service API to update an initials field of a document into personal/enterprise template.
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 of Template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template to which the field is updated. |
| 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 <= 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. |
required | object (FieldDimension) |
| last_page required | boolean Last Page |
Responses
Request samples
- Payload
{- "field_name": "string",
- "renamed_as": "string",
- "page_no": 0,
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "last_page": true
}Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{ }Add In-person Field (Template)
Business applications can use this service API to an add in-person signature field to a document into personal/enterprise template.
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 to Template for more information.
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
| templateId required | integer <int32> The ID of personal/enterprise template to which the field 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 <= 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. |
| placeholder required | string [ 1 .. 255 ] characters String identifier for the in-person field, it can be Customer, Jack, CEO etc. |
required | object (FieldDimension) |
| display required | string Enum: "VISIBLE" "INVISIBLE" |
| level_of_assurance | Array of strings Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE" |
object Field Authentication | |
| last_page required | boolean Last Page |
Responses
Request samples
- Payload
{- "order": 0,
- "page_no": 0,
- "field_name": "string",
- "placeholder": "string",
- "dimensions": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "display": "VISIBLE",
- "level_of_assurance": [
- "string"
], - "authentication_signing": {
- "enabled": true,
- "otp": {
- "enabled": true,
- "mobile_number": "string"
}, - "totp": {
- "enabled": true
}
}, - "last_page": true
}Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "field_name": "string",
- "created_on": "string"
}Update In-person Field (Template)
Business applications can use this service API to update an in-person signature field of a document into personal/enterprise template.
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 of Template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template to which the field is updated. |
| 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 <= 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. |
| placeholder required | string [ 1 .. 255 ] characters String identifier for the in-person field, it can be Customer, Jack, CEO etc. |
required | object (FieldDimension) |
| display required | string Enum: "VISIBLE" "INVISIBLE" |
| level_of_assurance | Array of strings Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE" |
object Field Authentication | |
| last_page required | boolean Last Page |
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": "VISIBLE",
- "level_of_assurance": [
- "string"
], - "authentication_signing": {
- "enabled": true,
- "otp": {
- "enabled": true,
- "mobile_number": "string"
}, - "totp": {
- "enabled": true
}
}, - "last_page": true
}Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{ }Add Digital Signature Field (Template)
Business applications can use this service API to add a digital signature field to a document into personal/enterprise template.
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 to Template for more information.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template to which the field is added. |
| 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 required | integer <int32> Order of the recipient for which the field is being created. |
| page_no required | integer <int32> Page number at which the field is about to be created. |
| field_name | string <= 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. |
| level_of_assurance | Array of strings 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" |
required | object (FieldDimension) |
| display required | string Enum: "VISIBLE" "INVISIBLE" |
object Field Authentication | |
| last_page required | boolean Last Page |
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": "VISIBLE",
- "authentication_signing": {
- "enabled": true,
- "otp": {
- "enabled": true,
- "mobile_number": "string"
}, - "totp": {
- "enabled": true
}
}, - "last_page": true
}Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "field_name": "string",
- "created_on": "string"
}Update Digital Signature Field (Template)
Business applications can use this service API to update a digital signature field of a document into personal/enterprise template.
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 of Template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template to which the field is updated. |
| 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, which is to be updated. |
| level_of_assurance | Array of strings 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 <= 255 characters Updated name of the field if renaming of the field is intended. |
| page_no required | integer <int32> Page number on which the field is to be created. |
required | object (FieldDimension) |
| display required | string Enum: "VISIBLE" "INVISIBLE" |
object Field Authentication | |
| last_page required | boolean Last Page |
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": "VISIBLE",
- "authentication_signing": {
- "enabled": true,
- "otp": {
- "enabled": true,
- "mobile_number": "string"
}, - "totp": {
- "enabled": true
}
}, - "last_page": true
}Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{ }Update DropDown Field (Template)
Business applications can use this service API to update a dropdown field of a document in a package.
path Parameters
| templateId required | integer <int32> 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 required | string Enum: "OPTIONAL" "MANDATORY" |
Responses
Request samples
- Payload
{- "field_name": "string",
- "validation_rule": "OPTIONAL"
}Response samples
- 200
- 401
- 404
- 500
{ }Assign Document Field (Template)
Business applications can use this service API to assign users to input fields, e.g. form 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.
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
| templateId required | integer <int32> The ID of personal/enterprise template. |
| 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 provide group name for radio box |
| order required | integer <int32> The order of the user in workflow, to which the field is being assigned. |
| level_of_assurance | Array of strings 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
{ }Replicate Initial Fields (Template)
Business applications can use this service API to replicate initials fields to the multiple pages of a document into personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
| 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
- 401
- 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
}
}
}
]Replicate In-person Fields (Template)
Business applications can use this service API to replicate In-person fields to the multiple pages of a document into personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
| 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
- 401
- 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
}
}
}
]Get Workflow Details (Template)
Business applications can use this service API to get workflow details of the personal/enterprise template. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
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
{- "template_id": 0,
- "template_name": "string",
- "uploaded_on": "string",
- "modified_on": "string",
- "enterprise": true,
- "description": "string",
- "read_only": true,
- "public": true,
- "workflow": {
- "workflow_type": "string",
- "continue_on_decline": true,
- "message": "string",
- "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_order": 0,
- "document_height": 0,
- "document_width": 0,
- "document_pages": 0,
- "created_on": "string",
- "modified_on": "string",
- "form_fields": true,
- "certify": {
- "enabled": true,
- "allowed_permissions": [
- "string"
], - "default_permission": "string"
}, - "lock_form_fields": true
}
], - "users": [
- {
- "order": 0,
- "user_name": "string",
- "user_email": "string",
- "user_photo_url": "string",
- "group_name": "string",
- "group_members": [
- "string"
], - "role": "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"
}
}
}, - "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"
}, - "mobile_number": "string",
- "delivery_method": "string",
- "logged_in_user": true
}
]
}Update Workflow Details (Template)
Business applications can use this service API to update the workflow details of the personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
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 Enum: "SERIAL" "INDIVIDUAL" "PARALLEL" "CUSTOM" |
| continue_on_decline | boolean True, if workflow needs to continue even if any recipient declines the document. If no value is provided, old value will be retained. |
| message | string <= 1500 characters 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 Allow comments,If no value is provided, old value will be retained. |
Responses
Request samples
- Payload
{- "workflow_type": "SERIAL",
- "continue_on_decline": true,
- "message": "string",
- "comments": true
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Get Document Fields (Template)
Business applications can use this service API to get document fields of the personal/enterprise template. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
| documentId required | integer <int64> The ID of the template document. |
| pageNo required | integer <int32> The 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 |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{- "signature": [
- {
- "order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "type": "string",
- "created_on": "string",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "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
}
}, - "last_page": true
}
], - "hand_signature": [
- {
- "order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "type": "string",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "last_page": true,
- "nid": "string"
}
], - "electronic_signature": [
- {
- "order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "type": "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
}
}, - "nid": "string",
- "display": "string",
- "last_page": true
}
], - "initials": [
- {
- "order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "last_page": true
}
], - "in_person_signature": [
- {
- "order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "type": "string",
- "placeholder": "string",
- "signature_sub_type": "string",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "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
}
}, - "last_page": true
}
], - "text": [
- {
- "required": true,
- "order": 0,
- "tab_order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "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",
- "embedded": true,
- "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,
- "type": "string",
- "value": true,
- "read_only": true,
- "validation_rule": "string",
- "radio_group_name": "string",
- "checked": true,
- "visible": true,
- "color": "string",
- "embedded": true,
- "border_color": "string",
- "tooltip": "string",
- "field_rotation": 0,
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}
}
], - "checkbox": [
- {
- "required": true,
- "order": 0,
- "tab_order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "type": "string",
- "value": true,
- "read_only": true,
- "checked": true,
- "visible": true,
- "validation_rule": "string",
- "color": "string",
- "embedded": true,
- "border_color": "string",
- "tooltip": "string",
- "field_rotation": 0,
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}
}
], - "dropdown": [
- {
- "required": true,
- "order": 0,
- "tab_order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "validation_rule": "string",
- "read_only": true,
- "value": "string",
- "choices": [
- "string"
], - "visible": true,
- "color": "string",
- "embedded": true,
- "border_color": "string",
- "tooltip": "string",
- "field_rotation": 0,
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "font": {
- "name": "string",
- "size": 0,
- "embedded_size": 0
}
}
], - "listbox": [
- {
- "order": 0,
- "tab_order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "validation_rule": "string",
- "read_only": true,
- "value": "string",
- "choices": [
- "string"
], - "visible": true,
- "color": "string",
- "embedded": true,
- "border_color": "string",
- "tooltip": "string",
- "field_rotation": 0,
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "font": {
- "name": "string",
- "size": 0,
- "embedded_size": 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": "L",
- "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,
- "attachmentRefId": 0,
- "note": "string",
- "validation_rule": "OPTIONAL",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}
}
]
}Get Workflow Users (Template)
Business applications can use this service API to get workflow users of the personal/enterprise template. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
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
[- {
- "order": 0,
- "user_email": "string",
- "user_name": "string",
- "user_photo_url": "string",
- "group_name": "string",
- "group_members": [
- {
- "user_email": "string",
- "user_name": "string"
}
], - "role": "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"
}, - "mobile_number": "string",
- "delivery_method": "string",
- "logged_in_user": true
}
]Add Users to Workflow (Template)
Business applications can use this service API to add recipients to a workflow of the personal/enterprise template. This call will only add a recipient to the template 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.
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.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
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 <= 255 characters Email address of the user to be added in the workflow. |
| user_name required | string [ 1 .. 255 ] characters Name of the recipient to be added in the workflow. |
| email_notification required | 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 required | string Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" |
| signing_order | integer <int32> Order of the recipient in the workflow. This signing order is mandatory when workflow type is "CUSTOM". |
| delivery_method required | string Enum: "EMAIL" "SMS" "EMAIL_AND_SMS" |
| mobile_number | string <= 15 characters Mobile Number |
Responses
Request samples
- Payload
[- {
- "user_email": "string",
- "user_name": "string",
- "email_notification": true,
- "role": "SIGNER",
- "signing_order": 0,
- "delivery_method": "EMAIL",
- "mobile_number": "string"
}
]Response samples
- 201
- 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
}
}, - "reminder": {
- "enabled": true,
- "frequency": "string",
- "remind_after": 0,
- "repeat": {
- "enabled": true,
- "frequency": "string",
- "keep_reminding_after": 0,
- "total_reminders": 0
}
}
}
]Add Placeholder to Workflow (Template)
Business applications can use this service API to add placeholder to a workflow of the personal/enterprise template. 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.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
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 required | string [ 1 .. 255 ] characters The name of the new placeholder to be added in workflow. |
| email_notification required | 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 required | string Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" |
| signing_order | integer <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
- 201
- 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
}
}, - "reminder": {
- "enabled": true,
- "frequency": "string",
- "remind_after": 0,
- "repeat": {
- "enabled": true,
- "frequency": "string",
- "keep_reminding_after": 0,
- "total_reminders": 0
}
}, - "signing_order": 0
}
]Add Groups to Workflow (Template)
Business applications can use this service API to add groups as a recipient to a workflow of the personal/enterprise template. 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.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
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 required | string [ 1 .. 255 ] characters The name of the new group to be added in workflow. |
| email_notification required | 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 required | string Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" |
| signing_order | integer <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
- 201
- 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
}
}, - "reminder": {
- "enabled": true,
- "frequency": "string",
- "remind_after": 0,
- "repeat": {
- "enabled": true,
- "frequency": "string",
- "keep_reminding_after": 0,
- "total_reminders": 0
}
}, - "signing_order": 0
}
]Add Logged In User to Workflow (Template)
Business applications can use this service API to add Logged In User to a workflow of the personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
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:
| email_notification required | 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 required | string Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" |
| signing_order | integer <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
[- {
- "email_notification": true,
- "role": "SIGNER",
- "signing_order": 0
}
]Response samples
- 201
- 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
}
}, - "reminder": {
- "enabled": true,
- "frequency": "string",
- "remind_after": 0,
- "repeat": {
- "enabled": true,
- "frequency": "string",
- "keep_reminding_after": 0,
- "total_reminders": 0
}
}
}
]Add Electronic Seal (Template)
Business applications can use this service API to add an Electronic Seal recipient of the personal/enterprise template. This call will only add a recipient to the template. 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.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
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 <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
- 201
- 400
- 401
- 403
- 404
- 500
[- {
- "name": "string",
- "signing_order": 0,
- "level_of_assurance": "string"
}
]Delete Workflow User (Template)
Business applications can use this service API to delete recipient of the personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
| order required | integer <int32> Order of the recipient in the template 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
- 400
- 401
- 403
- 404
- 500
{ }Update Workflow User (Template)
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 personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
| order required | integer <int32> The order of the user in template. |
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 <= 255 characters The email address of the new user to be updated in workflow. |
| user_name | string <= 255 characters Name of the recipient to be updated. If no value is provided, old value will be retained. |
| email_notification | boolean Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn. If no value is provided, old value will be retained. |
| role required | string Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" |
| signing_order | integer <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 email language code |
| delivery_method required | string Enum: "EMAIL" "SMS" "EMAIL_AND_SMS" |
| mobile_number | string <= 15 characters Mobile Number |
Responses
Request samples
- Payload
{- "user_email": "string",
- "user_name": "string",
- "email_notification": true,
- "role": "SIGNER",
- "signing_order": 0,
- "email_language_code": "string",
- "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
}
}, - "reminder": {
- "enabled": true,
- "frequency": "string",
- "remind_after": 0,
- "repeat": {
- "enabled": true,
- "frequency": "string",
- "keep_reminding_after": 0,
- "total_reminders": 0
}
}
}Update Workflow Group (Template)
Business applications can use this service API to update the details of a group that has already been added to a personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
| order required | integer <int32> The order of the user in template. |
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 The name of the group to be updated in workflow. If no value is provided, old value will be retained. |
| email_notification | boolean 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. |
| role required | string Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" |
| signing_order | integer <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
{ }Update Placeholder (Template)
Business applications can use this service API to update a placeholder of the personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
| 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 The name of the new placeholder to be added in workflow. If no value is provided, old value will be retained. |
| email_notification | boolean Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn. If no value is provided, old value will be retained. |
| role required | string Enum: "SIGNER" "REVIEWER" "EDITOR" "INPERSON_HOST" "CARBON_COPY" |
| signing_order | integer <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
- 401
- 403
- 404
- 500
{ }Update Electronic Seal (Template)
Business applications can use this service API to update the details of an Electronic Seal recipient who has already been added to a workflow of the personal/enterprise template. 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
| templateId required | integer <int32> The ID of personal/enterprise template. |
| order required | integer <int32> The order of the eseal recipient in template. |
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 <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
- 201
- 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
}
}, - "reminder": {
- "enabled": true,
- "frequency": "string",
- "remind_after": 0,
- "repeat": {
- "enabled": true,
- "frequency": "string",
- "keep_reminding_after": 0,
- "total_reminders": 0
}
}
}Update Post Processing (Template)
Business applications can use this service API to update post processing of the personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
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 |
Array of objects (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 <= 1500 characters A custom string message for all the contacts. Message becomes part of the email sent to the contacts. |
| google_drive required | boolean True, if document is to be uploaded to the provided google account after the workflow completion. |
| dropbox required | boolean True, if document is to be uploaded to the provided dropbox account after the workflow completion. |
| onedrive required | boolean True, if document is to be uploaded to the provided oneDrive account after the workflow completion. |
| workflow_recipients required | 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 required | 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
- 400
- 403
- 404
- 500
{ }Update Workflow Users Order (Template)
Business applications can use this service API to update order of the recipient in the workflow of the personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template |
| 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
- 400
- 401
- 403
- 404
- 500
{ }Get Document Image (Template)
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
| templateId required | integer <int32> The ID of personal/enterprise template. |
| documentId required | integer <int64> The ID of the document for which the image is to be requested. |
| pageNo required | integer <int32> The 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-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. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
"string"Get Document Image (Base64) (Template)
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
| templateId required | integer <int32> The ID of personal/enterprise template. |
| 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-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. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
"string"Get Template 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
| templateId required | integer <int32> The ID of personal/enterprise template. |
| 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 |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
[- {
- "page_no": 0,
- "image_base64": "string"
}
]Import recipient Template (Template)
Business applications can use this service API to get recipient import template for personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template |
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
"string"Bulk Import Recipient (Template)
Business applications can use this service API to import the recipients into personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template |
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: multipart/form-data
| file (binary Stream) | string <binary> This is the recipient document in CSV format, posting via form data. |
Responses
Response samples
- 200
- 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"
}
]
}Update Certify Policy (Template)
Business applications can use this service API to update certify signature settings for a document of the personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
| 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 Certify settings object for the document. | |
| lock_form_fields required | 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
- 401
- 403
- 404
- 500
{ }Get Personal/Enterprise Template Details
Business applications can use this service API to get details of the personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template. |
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
{- "template_id": 0,
- "template_name": "string",
- "uploaded_on": "string",
- "modified_on": "string",
- "workflow": {
- "workflow_type": "string",
- "continue_on_decline": true,
- "message": "string",
- "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_order": 0,
- "document_height": 0,
- "document_width": 0,
- "document_pages": 0,
- "created_on": "string",
- "modified_on": "string",
- "form_fields": true,
- "certify": {
- "enabled": true,
- "allowed_permissions": [
- "string"
], - "default_permission": "string"
}, - "lock_form_fields": true
}
], - "users": [
- {
- "order": 0,
- "user_name": "string",
- "user_email": "string",
- "user_photo_url": "string",
- "group_name": "string",
- "group_members": [
- "string"
], - "role": "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"
}
}
}, - "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"
}, - "mobile_number": "string",
- "delivery_method": "string",
- "logged_in_user": true
}
], - "fields": {
- "signature": [
- {
- "order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "type": "string",
- "created_on": "string",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "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
}
}, - "last_page": true
}
], - "hand_signature": [
- {
- "order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "type": "string",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "last_page": true,
- "nid": "string"
}
], - "electronic_signature": [
- {
- "order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "type": "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
}
}, - "nid": "string",
- "display": "string",
- "last_page": true
}
], - "initials": [
- {
- "order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "last_page": true
}
], - "in_person_signature": [
- {
- "order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "type": "string",
- "placeholder": "string",
- "signature_sub_type": "string",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "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
}
}, - "last_page": true
}
], - "text": [
- {
- "required": true,
- "order": 0,
- "tab_order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "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",
- "embedded": true,
- "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,
- "type": "string",
- "value": true,
- "read_only": true,
- "validation_rule": "string",
- "radio_group_name": "string",
- "checked": true,
- "visible": true,
- "color": "string",
- "embedded": true,
- "border_color": "string",
- "tooltip": "string",
- "field_rotation": 0,
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}
}
], - "checkbox": [
- {
- "required": true,
- "order": 0,
- "tab_order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "type": "string",
- "value": true,
- "read_only": true,
- "checked": true,
- "visible": true,
- "validation_rule": "string",
- "color": "string",
- "embedded": true,
- "border_color": "string",
- "tooltip": "string",
- "field_rotation": 0,
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}
}
], - "dropdown": [
- {
- "required": true,
- "order": 0,
- "tab_order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "validation_rule": "string",
- "read_only": true,
- "value": "string",
- "choices": [
- "string"
], - "visible": true,
- "color": "string",
- "embedded": true,
- "border_color": "string",
- "tooltip": "string",
- "field_rotation": 0,
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "font": {
- "name": "string",
- "size": 0,
- "embedded_size": 0
}
}
], - "listbox": [
- {
- "order": 0,
- "tab_order": 0,
- "display_order": 0,
- "field_name": "string",
- "page_no": 0,
- "validation_rule": "string",
- "read_only": true,
- "value": "string",
- "choices": [
- "string"
], - "visible": true,
- "color": "string",
- "embedded": true,
- "border_color": "string",
- "tooltip": "string",
- "field_rotation": 0,
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}, - "font": {
- "name": "string",
- "size": 0,
- "embedded_size": 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": "L",
- "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,
- "attachmentRefId": 0,
- "note": "string",
- "validation_rule": "OPTIONAL",
- "dimensions": {
- "field": {
- "x": 0,
- "y": 0,
- "width": 0,
- "height": 0
}, - "page": {
- "width": 0,
- "height": 0
}
}
}
]
}
}Delete Document Field (Template)
Business applications can use this service API to delete a field of document into personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template to which the field is deleted. |
| 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
- 400
- 401
- 403
- 404
- 500
{ }Bulk Delete Document Field (Template)
Business applications can use this service API to bulk delete the fields of document into personal/enterprise template.
path Parameters
| templateId required | integer <int32> The ID of personal/enterprise template to which the field is deleted. |
| 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_names required | Array of strings Name of the field to be deleted. |
Responses
Request samples
- Payload
{- "field_names": [
- "string"
]
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Get Enterprise Templates
Business applications can use this service API to get list of enterprise templates of the current user. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request.
It is possible to search based upon the criterion supplied under the "x-search-text" header.
path Parameters
| recordPerPage required | integer <int32> Total number of records to be retrieved in a page. |
| pageNo required | integer <int32> Page number to be retrieved. |
query Parameters
| sort-by | string Default: "CREATED_ON" Enum: "CREATED_ON" "NAME" "DESCRIPTION" "READ_ONLY" "IS_PUBLIC" Sort the result by possible values are mentioned above. |
| asc | boolean Default: false Order the result set by ascending or descending. |
| id | Array of integers <int64> [ items <int64 > ] Search by template ids. |
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: TXkgdGVtcGxhdGU= Search text if required. This is optional and without it the entire list is returned. |
| x-total-records | string Example: 10 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 400
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "public": true,
- "read_only": true,
- "description": "string",
- "created_on": "string",
- "roles": [
- {
- "name": "string",
- "id": 0
}
], - "documents": [
- {
- "id": 0,
- "name": "string"
}
]
}
]Get Template By ID
Business applications can use this service API to get a personal/enterprise template. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
path Parameters
| id required | integer <int32> The ID of personal/enterprise template. |
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
{- "name": "string",
- "public": true,
- "read_only": true,
- "description": "string",
- "created_on": "string",
- "enterprise": true,
- "documents": [
- {
- "id": 0,
- "name": "string"
}
]
}Delete Template
Business applications can use this service API to delete personal/enterprise template. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
path Parameters
| id required | integer <int32> The ID of personal/enterprise template. |
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
{ }Update Template
Business applications can use this service API to update personal/enterprise template. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
path Parameters
| id required | integer <int32> The ID of personal/enterprise template. |
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 Name. |
| description | string <= 200 characters Description. |
| read_only required | boolean True, if the template is marked as read-only. |
| public required | boolean True, if the template is marked as public. |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "read_only": true,
- "public": true
}Response samples
- 200
- 400
- 401
- 403
- 404
- 422
- 500
{ }Save Template
Business applications can use this service API to save serialize all the changes made in redis and save it in the database of the personal/enterprise template. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
path Parameters
| id required | integer <int32> The ID of personal/enterprise template. |
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:
Array of objects (FormFieldRequest) |
Responses
Request samples
- Payload
{- "form_fields": [
- {
- "field_name": "string",
- "field_value": "string"
}
]
}Response samples
- 200
- 401
- 403
- 404
- 500
{ }Save Workflow as Template
Business applications can use this service API to save workflow as template. 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> The package ID for which the save workflow as template. |
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 Name of the template that is to be added. |
| description | string <= 200 characters Name of the description that is to be added. |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string"
}Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "id": 0
}Clone Template
Business applications can use this service API to clone personal/enterprise template. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
path Parameters
| id required | integer <int32> The ID of personal/enterprise template that need to be clone. |
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 Name of the template that is to be added. |
| description | string <= 200 characters Description of the template that is to be added. |
| read_only required | boolean True, if the template is marked as read-only. |
| public required | boolean True, if the template is marked as public. |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "read_only": true,
- "public": true
}Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "id": 0
}Bulk Delete Enterprise Template
Business applications can use this service API to bulk delete the enterprise templates. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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 ids of enterprise templates.
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 400
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Bulk Delete Personal Template
Business applications can use this service API to bulk delete the user templates.
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:
List of ids of user templates.
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "error_message": "string"
}
]Export Enterprise Template
Business applications can use this service API to export the enterprise templates. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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 ids of enterprise templates
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 401
- 403
- 500
"string"Import Enterprise Template
Business applications can use this service API to import the enterprise templates. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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: multipart/form-data
| file (binary Stream) | string <binary> This is the enterprise template file in JSON format, posting via form data. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
[- {
- "success": [
- {
- "id": 0,
- "name": "string",
- "public": true,
- "read_only": true,
- "description": "string",
- "created_on": "string"
}
], - "failure": [
- {
- "name": "string",
- "error_message": "string"
}
]
}
]Add Personal Template
Business applications can use this service API to add personal template.
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: multipart/form-data
| file (binary Stream) required | string <binary> Default: "" This is the document in the raw binary format, posting via form data. |
| name required | string <binary> Default: "" parameter name in string format. |
| description | string <binary> Default: "" parameter name in string format. |
| read_only | string <binary> Default: "false" True, if template is readonly. |
Responses
Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "id": 0,
- "created_on": "string",
- "documents": [
- {
- "id": 0,
- "name": "string",
- "certify": {
- "enabled": true,
- "allowed_permissions": [
- "string"
], - "default_permission": "string"
}, - "lock_form_fields": true
}
], - "workflow": {
- "workflow_type": "string",
- "continue_on_decline": 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
}
}Add Enterprise Template
Business applications can use this service API to add enterprise template. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
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: multipart/form-data
| file (binary Stream) required | string <binary> Default: "" This is the document in the raw binary format, posting via form data. |
| name required | string <binary> Default: "" parameter name in string format. |
| description | string <binary> Default: "" parameter name in string format. |
| read_only | string <binary> Default: "false" True, if template is readonly. |
| public | string <binary> Default: "false" True, if template is public. |
Responses
Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "id": 0,
- "created_on": "string",
- "documents": [
- {
- "id": 0,
- "name": "string",
- "certify": {
- "enabled": true,
- "allowed_permissions": [
- "string"
], - "default_permission": "string"
}, - "lock_form_fields": true
}
], - "workflow": {
- "workflow_type": "string",
- "continue_on_decline": 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
}
}Discard Changes
Business applications can use this service API to discard the changes of the personal/enterprise template. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".
path Parameters
| id required | integer <int32> The ID of personal/enterprise template. |
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
{ }This section entails the web services for managing the general operations i.e. About, System Settings, and Branding.
OTP Verification
Business applications can use this service API to verify an OTP, generated using OTP Login Authentication.
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 that is generated and sent to the user's mobile. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{ }Get Profile Picture of Recipient
Business application can get the profile picture of a recipient that has signed the document.
path Parameters
| encryptKey required | string Encrypted string used to identify the recipient for which the photo is requested. |
header Parameters
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 403
- 500
"string"About SigningHub
Business applications can use this service API to get the SigningHub version and build information.
header Parameters
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 500
{- "installation_name": "string",
- "version": "string",
- "build": "string",
- "patents": {
- "us_patent_no": "string"
}, - "copyright": "string"
}System Settings
Business applications can use this service API to get the system settings of a logged in enterprise user.
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
{- "installation_name": "string",
- "installation_type": "string",
- "web_address": "string",
- "api_address": "string",
- "create_account_webpage": "string",
- "privacy_policy_webpage": "string",
- "term_of_services_webpage": "string",
- "agree_privacy_policy_and_terms_of_service": true,
- "default_country": "string",
- "allow_changing_country": true,
- "default_timezone": "string",
- "allow_changing_timezone": true,
- "default_language": "string",
- "core_setting": {
- "reminder_notification": {
- "enabled": true,
- "frequency": "string",
- "duration": "string"
}
}, - "password_policy": {
- "minimum_length": 0,
- "include_numbers": true,
- "include_uppercase": true,
- "include_special_characters": true
}, - "signature_types": {
- "ELECTRONIC_SIGNATURE": "string",
- "ELECTRONIC_SEAL": "string",
- "ADVANCED_ELECTRONIC_SEAL": "string",
- "QUALIFIED_ELECTRONIC_SEAL": "string",
- "ADVANCED_ELECTRONIC_SIGNATURE": "string",
- "HIGH_TRUST_ADVANCED": "string",
- "QUALIFIED_ELECTRONIC_SIGNATURE": "string"
}, - "support_email": "string",
- "system_error_email": "string",
- "system_maintenance_message": "string",
- "session_timeout": 0,
- "company_name": "string",
- "allow_changing_language": true,
- "allow_national_id": true,
- "profile_logo_only": true,
- "google_analytics_mobile_web": "string",
- "bing_analytics_mobile_web": "string",
- "error_notification_timeout": 0,
- "allow_marketing_emails": true,
- "hide_edit_signature_dialog": true,
- "billing": {
- "enabled": true,
- "currency": "string",
- "description": "string",
- "margin_days": 0,
- "sales_email": "string",
- "support_email": "string",
- "company_address": "string",
- "payment_gateway_configuration": {
- "property1": "string",
- "property2": "string"
}
}, - "content_security_policy": {
- "mobile_web": "string",
- "web": "string",
- "admin": "string"
}, - "default_cloud_drive_settings": {
- "dropbox": {
- "connector_name": "string",
- "app_key": "string",
- "allowed_file_types": "string",
- "multiple_selection": true
}, - "google_drive": {
- "connector_name": "string",
- "api_key": "string",
- "client_id": "string",
- "multiple_selection": true
}, - "onedrive": {
- "connector_name": "string",
- "app_id": "string",
- "multiple_selection": true
}
}, - "default_smtp_connector": {
- "connector_name": "string"
}, - "default_sms_connector": {
- "connector_name": "string"
}, - "default_push_notification_connector": {
- "connector_name": "string"
}, - "default_geoip_connector": {
- "connector_name": "string"
}, - "default_marketing_connector": {
- "connector_name": "string"
}, - "default_captcha_connector": {
- "connector_name": "string",
- "public_key": "string"
}, - "default_file_scanning_connector": {
- "connector_name": "string"
}, - "default_enterprise_service_plan": {
- "id": 0,
- "name": "string",
- "type": 0
}, - "default_individual_service_plan": {
- "id": 0,
- "name": "string",
- "type": 0
}, - "global_sign_logo_visible": true,
- "trusted_device_authentication": true
}Get SigningHub Admin Branding
Retrieve the default branding of SigningHub Application as set by the SigningHub administrator via the administration console. This includes the logo, favicon and colours that comprise the branding options. Note this is not to be confused with the Enterprise level branding. For these settings click here.
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 |
| x-base64 | string Default: true |
Responses
Response samples
- 200
- 403
- 500
{- "logo": "string",
- "logo_url": "string",
- "favicon": "string",
- "favicon_url": "string",
- "signature_logo": "string",
- "signature_logo_url": "string",
- "email_logo": "string",
- "email_logo_url": "string",
- "colors": {
- "level_1": "string",
- "level_2": "string",
- "level_3": "string",
- "level_4": "string",
- "level_5": "string",
- "level_6": "string",
- "level_7": "string",
- "level_8": "string",
- "level_9": "string",
- "level_10": "string",
- "level_11": "string",
- "level_12": "string",
- "level_13": "string",
- "level_14": "string",
- "level_15": "string"
}
}Get SH Admin Branding Logo
Business application can get the application logo configured in the application's admin console branding.
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"Get SH Admin Branding Favicon
Business application can get the application favicon configured in the application's admin console branding.
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"Get Languages
Business applications can use this service API to get the supported languages
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
- 500
{- "default_language": "string",
- "allow_changing_language": true,
- "supported_languages": {
- "property1": "string",
- "property2": "string"
}
}Get Countries
Business applications can use this service API to get the supported countries
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
- 500
{- "default_country": "string",
- "allow_changing_country": true,
- "supported_countries": {
- "property1": "string",
- "property2": "string"
}
}Get Timezones
Business applications can use this service API to get the supported timezones
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
- 500
{- "default_timezone": "string",
- "allow_changing_timezone": true,
- "supported_timezones": {
- "property1": "string",
- "property2": "string"
}
}Get avatar image
Business application can get the profile picture of a user.
query Parameters
| q required | string Encrypted string used to identify the user. |
header Parameters
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 500
"string"The API level is above that used in other sections in that this allows a SigningHub Administrator to create an Enterprise within SigningHub and hence a SigningHub Enterprise Administrator for the new Enterprise.
These APIs are strictly for SigningHub System Administrators, who have been issued a client TLS certificate for Admin Console access.
Admin Authentication
This API can be used to authenticate to SigningHub Administration.It requires a current, valid SigningHub Administration client TLS certificate.
The API call should present a client TLS certificate in the HTTPS call.
Note the password option is optional.The use of these is controlled by SigningHub Administration settings.
header Parameters
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-password | string Default: Password Password of SigningHub Administrator if required. |
Responses
Response samples
- 200
- 403
{- "access_token": "string",
- "token_type": "string",
- "expires_in": 0
}Create Account
Applications can call this API to create Individual Users as well as Enterprise Administrators and associated accounts. Only SigningHub Administrators have permission to create new Individual User accounts, Enterprise and thus Enterprise Administrator accounts, and use this API. To create Enterprise Users use the Register Enterprise User API.
Using this API will create a new Individual User, Enterprise in SigningHub, and the first Enterprise Admin for this Enterprise.
You must authenticate using your SigningHub Administration client TLS certificate as described here, in order to use this and other SigningHub Admin APIs.
header Parameters
| Authorization required | string Default: Bearer {access_token} Oauth access token of the logged in user. This must be a SigningHub Administrator who has the rights to create an account. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| user_name required | string non-empty Name of the new SigningHub user. |
| user_email required | string non-empty Email address of the new SigningHub user. |
| enterprise_name | string Name of the enterprise for the new account. If omitted a random enterprise name will be generated by SigningHub. The enterprise name is mandatory when creating enterprise accounts using enterprise service plans. |
| job_title | string Job title of the new SigningHub user. |
| company_name | string Company name of the new SigningHub user. |
| mobile_number | string Mobile number of the new SigningHub user. |
| service_plan required | string non-empty Specifies the Service Plan to be used for this account. |
| notifications | boolean This defines whether registered user would get an email notification about the account creation. Default value is 'false'. |
| user_password | string 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 | string 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 the password and security answer as mandatory fields. |
| security_answer | string 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 the password and security question as mandatory fields. |
| service_agreements required | boolean User consent terms of service and privacy policies for account registration. |
| user_national_id | string National identity number of the user. This helps to identify users in the workflow |
Responses
Request samples
- Payload
{- "user_name": "string",
- "user_email": "string",
- "enterprise_name": "string",
- "job_title": "string",
- "company_name": "string",
- "mobile_number": "string",
- "service_plan": "string",
- "notifications": true,
- "user_password": "string",
- "security_question": "string",
- "security_answer": "string",
- "service_agreements": true,
- "user_national_id": "string"
}Response samples
- 200
- 201
- 400
- 401
- 403
- 500
{- "Message": "string"
}Change User Service Plan
Applications can call this API update a user's service plan. This requires SigningHub Administrator permission.
header Parameters
| Authorization required | string Default: Bearer {access_token} Oauth access token of the logged in user. This must be a SigningHub Administrator who has the rights to create an account. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| user_email required | string non-empty Email address of the account owner. |
| service_plan required | string non-empty New Service Plan name, which is to be assigned to the user. |
Responses
Request samples
- Payload
{- "user_email": "string",
- "service_plan": "string"
}Response samples
- 200
- 400
- 401
- 403
- 500
{ }Get Accounts
API is used to get accounts and filter them based on the search criteria.
path Parameters
| pageNo required | integer <int32> Page number, according the division of records per page. |
| recordsPerPage required | integer <int32> Number of records that are needed to be fetched in one request. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Oauth access token of the logged in user. This must be a SigningHub Administrator who has the rights to create an account. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-user-name | string Default: John Doe Name of the account user to be searched |
| x-user-email | string Default: john.doe@ascertia.com Email of the account user to be searched. |
| x-enterprise-name | string Default: Ascertia Name of enterprise by which the account is to be searched. |
| x-billing-mode | string Default: ONLINE Billing mode for the account, possible values are ONLINE, OFFLINE. If developers intend to ignore billing mode, it's optional. |
| x-payment-type | string Default: PAY_REGULARLY Payment type for the account search, possible values are PAY_REGULARLY, PAY_AS_YOU_GO. |
| x-service-plan | string Default: Basic Individual Name of service plan to search |
| x-activated | string Default: True True, if accounts are activated. |
| x-enabled | string Default: True True, if accounts are enabled. |
| x-from | string Default: 2017-05-01 Date value in 8601 format from where the account is to be searched. |
| x-to | string Default: 2017-05-22 Date value in 8601 format to which the account is to be searched. |
| x-total-records | string Default: 212 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 400
- 401
- 500
{- "user_name": "string",
- "user_email": "string",
- "service_plan": "string",
- "enterprise_id": 0,
- "enterprise_name": "string",
- "created_on": "string"
}Service Plan Reset
Business applications can use this API to reset the Service Plan statistics for a user. Every user in SigningHub has an associated Service Plan. Within this the number of signatures, workflows, templates, etc., are recorded. This API call allows the calling application to reset these statistics for the given user.
header Parameters
| Authorization required | string Default: Bearer {access_token} Oauth access token of the logged in user. This must be a SigningHub Administrator who has the rights to create an account. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| user_email required | string non-empty Email of the user whose statistics are to be reset. |
Responses
Request samples
- Payload
{- "user_email": "string"
}Response samples
- 200
- 400
- 401
- 403
- 500
{ }Get Service Plans
Business applications can use this service API to get service plans. An admin, who has permissions to manage service plans in his role, can get service plans.
header Parameters
| Authorization required | string Default: Bearer {access_token} Oauth access token of the logged in user. This must be a SigningHub Administrator who has the rights to create an account. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "created_on": "string",
- "start_date": "string",
- "end_date": "string",
- "type": "string",
- "public": true,
- "require_password": true,
- "constraints": {
- "users": {
- "count": 0
}, - "signatures": {
- "count": 0
}, - "simple_electronic_signatures": {
- "count": 0
}
}, - "billing": {
- "payment_type": "string",
- "mode": "string",
- "monthly": {
- "enabled": true,
- "price": "string"
}, - "yearly": {
- "enabled": true,
- "price": "string"
}, - "auto_reset_constraints": true,
- "price": "string"
}
}
]Add Service Plan
Business applications can use this service API to add service plan. An admin, who has permissions to manage service plans in his role, can add service plan.
header Parameters
| Authorization required | string Default: Bearer {access_token} Oauth access token of the logged in user. This must be a SigningHub Administrator who has the rights to create an account. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| name required | string [ 1 .. 100 ] characters Name of the service plan |
| type required | string Enum: "INDIVIDUAL" "ENTERPRISE" |
| start_date | string <date-time> Date on which the service plan expiry has started |
| end_date | string <date-time> Date on which the service plan expiry has ended |
| features required | Array of strings (PLAN_FEATURES) Items Enum: "ALLOW_FORM_FIELDS" "ALLOW_REVIEWER" "ALLOW_ATTACHMENTS" "ALLOW_INITIALS_FIELDS" "ALLOW_INPERSON_FIELDS" "ALLOW_INTEGRATION" "ALLOW_BULK_SIGNING" "SERVICE_PLAN_FEATURE_CLOUD_DRIVES" "ALLOW_EDITOR" "ALLOW_SEND_A_COPY" "ALLOW_ELECTRONIC_SEAL" "ALLOW_DOCUMENTS_ARCHIVE" "ALLOW_SMART_FORM" List of features available in the service plan. Possible values are mentioned above. ALLOW_ELECTRONIC_SEAL and ALLOW_INTEGRATION can be added only to the "Enterprise" service plan. |
| public required | boolean True, if service plan is public |
required | object Service Plan Constraints |
required | object Level of Assurance |
object Certify Options | |
| pdf_a_compliancy required | boolean True, If PDF Compliant |
object Auto Deletion of unused documents configuration | |
| add_unique_identifier required | boolean True, If to add a unique identifier field in the document header. |
object Enable signature pad settings | |
| signature_appearances required | Array of strings Signature appearances, possible values are COMPANY_LOGO, HAND_SIGNATURE, DETAILED_SIGNATURE. |
required | Array of objects (ServicePlanSigningServerRequest) Signing Servers |
Array of objects (ServicePlanElectronicSealServerRequest) Electronic Seal Signing Servers that can be added to the "Enterprise" service plan. | |
required | object Verification Profile |
| require_password required | boolean Indicates whether a password is required during user registration |
object Authentication profile that can be added to the "Individual" service plan. | |
required | object Evidence report |
object One Time Password | |
| time_based_one_time_password required | boolean True if TOTP are enabled for the service plan. |
object SMTP Server | |
object Sms notification | |
object Auto Delete Inactive users | |
object Service Plan billing details |
Responses
Request samples
- Payload
{- "name": "string",
- "type": "INDIVIDUAL",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "features": [
- "ALLOW_FORM_FIELDS"
], - "public": true,
- "constraints": {
- "signatures": {
- "count": 0,
- "advanced_electronic_signature": {
- "count": 0
}, - "high_trust_advanced_signature": {
- "count": 0
}, - "qualified_electronic_signature": {
- "count": 0
}, - "electronic_seal": {
- "count": 0
}, - "advanced_electronic_seal": {
- "count": 0
}, - "qualified_electronic_seal": {
- "count": 0
}
}, - "simple_electronic_signatures": {
- "count": 0
}, - "storage": {
- "count": 0
}, - "workflows": {
- "count": 0
}, - "upload_size": {
- "count": 0
}, - "templates": {
- "count": 0
}, - "users": {
- "count": 0
}
}, - "level_of_assurance": {
- "allowed": [
- "ADVANCED_ELECTRONIC_SIGNATURE"
], - "default": [
- "ADVANCED_ELECTRONIC_SIGNATURE"
]
}, - "certify_options": {
- "allowed": [
- "NO_CHANGES_ALLOWED"
], - "default": "NO_CHANGES_ALLOWED"
}, - "pdf_a_compliancy": true,
- "auto_delete_document": {
- "enabled": true,
- "duration": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}, - "email_document": {
- "enabled": true,
- "workflow_evidence_report": true
}
}, - "add_unique_identifier": true,
- "signature_pad": {
- "enabled": true,
- "server": "string"
}, - "signature_appearances": [
- "string"
], - "signing_servers": [
- {
- "key_location": "SERVER",
- "order": 1,
- "signing_profile": {
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "advanced_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "high_trust_advanced_signature": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "qualified_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "signature_appearances": {
- "signature_appearance": "string",
- "signature_appearance_logo": "string"
}, - "csp": {
- "enabled": true,
- "virtual_profile": {
- "name": "string"
}, - "auto_delete_certificates": true
}
}
], - "electronic_seal_servers": [
- {
- "electronic_seal_profile": {
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}
}
], - "verification_profile": {
- "name": "string"
}, - "require_password": true,
- "authentication_profile": {
- "allowed": [
- {
- "name": "string"
}
], - "default": {
- "name": "string"
}
}, - "evidence_report": {
- "type": "BASIC",
- "delete_document_logs": true
}, - "one_time_password": {
- "email_otp": {
- "enabled": true
}, - "sms_otp": {
- "enabled": true,
- "server": "string"
}, - "otp_length": 0,
- "otp_expiry": 0,
- "otp_retry_interval": 0
}, - "time_based_one_time_password": true,
- "smtp_server": {
- "enabled": true,
- "server": "string"
}, - "sms_notification": {
- "enabled": true,
- "server": "string"
}, - "auto_delete_user": {
- "enabled": true,
- "inactive_days": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}
}, - "billing": {
- "mode": 1,
- "payment_type": "string",
- "monthly": {
- "enabled": true,
- "price": 0
}, - "yearly": {
- "enabled": true,
- "price": 0
}, - "auto_reset_constraints": true,
- "price": 0
}
}Response samples
- 201
- 400
- 401
- 403
- 404
- 500
{- "id": 0
}Get Service Plan By Id
Business applications can use this service API to get service plan. An admin, who has permissions to manage service plans in his role, can get service plan.
path Parameters
| id required | integer <int32> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Oauth access token of the logged in user. This must be a SigningHub Administrator who has the rights to create an account. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 401
- 403
- 500
{- "id": 0,
- "name": "string",
- "start_date": "string",
- "end_date": "string",
- "features": [
- "string"
], - "type": "string",
- "public": true,
- "constraints": {
- "users": {
- "count": 0
}, - "signatures": {
- "count": 0,
- "advanced_electronic_signature": {
- "count": 0
}, - "high_trust_advanced_signature": {
- "count": 0
}, - "qualified_electronic_signature": {
- "count": 0
}, - "electronic_seal": {
- "count": 0
}, - "advanced_electronic_seal": {
- "count": 0
}, - "qualified_electronic_seal": {
- "count": 0
}
}, - "simple_electronic_signatures": {
- "count": 0
}, - "storage": {
- "count": 0
}, - "workflows": {
- "count": 0
}, - "upload_size": {
- "count": 0
}, - "templates": {
- "count": 0
}
}, - "level_of_assurance": {
- "allowed": [
- "string"
], - "default": [
- "string"
]
}, - "certify_options": {
- "allowed": [
- "string"
], - "default": "string"
}, - "pdf_a_compliancy": true,
- "auto_delete_document": {
- "enabled": true,
- "duration": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}, - "email_document": {
- "enabled": true,
- "workflow_evidence_report": true
}
}, - "add_unique_identifier": true,
- "signature_pad": {
- "enabled": true,
- "server": "string"
}, - "signature_appearances": [
- "string"
], - "signing_servers": [
- {
- "key_location": "string",
- "order": 0,
- "signing_profile": {
- "id": 0,
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "advanced_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "high_trust_advanced_signature": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "qualified_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "signature_appearances": {
- "signature_appearance": "string",
- "signature_appearance_logo": "string"
}, - "csp": {
- "enabled": true,
- "virtual_profile": {
- "id": 0,
- "name": "string"
}, - "auto_delete_certificates": true
}
}
], - "electronic_seal_servers": [
- {
- "electronic_seal_profile": {
- "id": 0,
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}
}
], - "verification_profile": {
- "id": 0,
- "name": "string"
}, - "require_password": true,
- "authentication_profile": {
- "allowed": [
- {
- "id": 0,
- "name": "string"
}
], - "default": {
- "id": 0,
- "name": "string"
}
}, - "evidence_report": {
- "type": "string",
- "delete_document_logs": true
}, - "one_time_password": {
- "email_otp": {
- "enabled": true
}, - "sms_otp": {
- "enabled": true,
- "server": "string"
}, - "otp_length": 0,
- "otp_expiry": 0,
- "otp_retry_interval": 0
}, - "time_based_one_time_password": true,
- "smtp_server": {
- "enabled": true,
- "Server": "string"
}, - "sms_notification": {
- "enabled": true,
- "Server": "string"
}, - "auto_delete_user": {
- "enabled": true,
- "inactive_days": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}
}, - "billing": {
- "payment_type": "string",
- "mode": "string",
- "monthly": {
- "enabled": true,
- "price": "string"
}, - "yearly": {
- "enabled": true,
- "price": "string"
}, - "auto_reset_constraints": true,
- "price": "string"
}
}Update Service Plan
Business applications can use this service API to update service plan. An admin, who has permissions to manage service plans in his role, can update service plan.
path Parameters
| id required | integer <int32> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Oauth access token of the logged in user. This must be a SigningHub Administrator who has the rights to create an account. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| name required | string [ 1 .. 100 ] characters Name of the service plan |
| start_date | string <date-time> Date on which the service plan expiry has started |
| end_date | string <date-time> Date on which the service plan expiry has ended |
| features required | Array of strings (PLAN_FEATURES) Items Enum: "ALLOW_FORM_FIELDS" "ALLOW_REVIEWER" "ALLOW_ATTACHMENTS" "ALLOW_INITIALS_FIELDS" "ALLOW_INPERSON_FIELDS" "ALLOW_INTEGRATION" "ALLOW_BULK_SIGNING" "SERVICE_PLAN_FEATURE_CLOUD_DRIVES" "ALLOW_EDITOR" "ALLOW_SEND_A_COPY" "ALLOW_ELECTRONIC_SEAL" "ALLOW_DOCUMENTS_ARCHIVE" "ALLOW_SMART_FORM" List of features available in the service plan, possible values are mentioned above.ALLOW_ELECTRONIC_SEAL and ALLOW_INTEGRATION can be updated only to the "Enterprise" service plan. |
| public required | boolean True, if service plan is public |
required | object Service Plan Constraints |
required | object Level of Assurance |
object Certify Options | |
| pdf_a_compliancy required | boolean True, If PDF Compliant |
object Auto Deletion of unused documents configuration | |
| add_unique_identifier required | boolean True, If to add a unique identifier field in the document header. |
object Enable signature pad settings | |
| signature_appearances required | Array of strings Signature appearances, possible values are COMPANY_LOGO, HAND_SIGNATURE, DETAILED_SIGNATURE. |
required | Array of objects (ServicePlanSigningServerRequest) Signing Servers |
Array of objects (ServicePlanElectronicSealServerRequest) Electronic Seal Signing Servers that can be updated to the "Enterprise" service plan. | |
required | object Verification Profile |
| require_password required | boolean Indicates whether a password is required during user registration |
object Authentication profile that can be updated to the "Individual" service plan. | |
required | object Authentication Profile |
object One Time Password | |
| time_based_one_time_password required | boolean True if TOTP are enabled for the service plan. |
object SMTP Server | |
object Sms notification | |
object Auto Delete Inactive users | |
object Service Plan billing details |
Responses
Request samples
- Payload
{- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "features": [
- "ALLOW_FORM_FIELDS"
], - "public": true,
- "constraints": {
- "signatures": {
- "count": 0,
- "advanced_electronic_signature": {
- "count": 0
}, - "high_trust_advanced_signature": {
- "count": 0
}, - "qualified_electronic_signature": {
- "count": 0
}, - "electronic_seal": {
- "count": 0
}, - "advanced_electronic_seal": {
- "count": 0
}, - "qualified_electronic_seal": {
- "count": 0
}
}, - "simple_electronic_signatures": {
- "count": 0
}, - "storage": {
- "count": 0
}, - "workflows": {
- "count": 0
}, - "upload_size": {
- "count": 0
}, - "templates": {
- "count": 0
}, - "users": {
- "count": 0
}
}, - "level_of_assurance": {
- "allowed": [
- "ADVANCED_ELECTRONIC_SIGNATURE"
], - "default": [
- "ADVANCED_ELECTRONIC_SIGNATURE"
]
}, - "certify_options": {
- "allowed": [
- "NO_CHANGES_ALLOWED"
], - "default": "NO_CHANGES_ALLOWED"
}, - "pdf_a_compliancy": true,
- "auto_delete_document": {
- "enabled": true,
- "duration": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}, - "email_document": {
- "enabled": true,
- "workflow_evidence_report": true
}
}, - "add_unique_identifier": true,
- "signature_pad": {
- "enabled": true,
- "server": "string"
}, - "signature_appearances": [
- "string"
], - "signing_servers": [
- {
- "key_location": "SERVER",
- "order": 1,
- "signing_profile": {
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "advanced_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "high_trust_advanced_signature": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "qualified_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "signature_appearances": {
- "signature_appearance": "string",
- "signature_appearance_logo": "string"
}, - "csp": {
- "enabled": true,
- "virtual_profile": {
- "name": "string"
}, - "auto_delete_certificates": true
}
}
], - "electronic_seal_servers": [
- {
- "electronic_seal_profile": {
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}
}
], - "verification_profile": {
- "name": "string"
}, - "require_password": true,
- "authentication_profile": {
- "allowed": [
- {
- "name": "string"
}
], - "default": {
- "name": "string"
}
}, - "evidence_report": {
- "type": "BASIC",
- "delete_document_logs": true
}, - "one_time_password": {
- "email_otp": {
- "enabled": true
}, - "sms_otp": {
- "enabled": true,
- "server": "string"
}, - "otp_length": 0,
- "otp_expiry": 0,
- "otp_retry_interval": 0
}, - "time_based_one_time_password": true,
- "smtp_server": {
- "enabled": true,
- "server": "string"
}, - "sms_notification": {
- "enabled": true,
- "server": "string"
}, - "auto_delete_user": {
- "enabled": true,
- "inactive_days": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}
}, - "billing": {
- "mode": 1,
- "payment_type": "string",
- "monthly": {
- "enabled": true,
- "price": 0
}, - "yearly": {
- "enabled": true,
- "price": 0
}, - "auto_reset_constraints": true,
- "price": 0
}
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
{ }Delete Service Plan
Business applications can use this service API to delete the service plan. An admin, who has permissions to manage service plans in his role, can delete the service plan.
path Parameters
| id required | integer <int32> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Oauth access token of the logged in user. This must be a SigningHub Administrator who has the rights to create an account. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{ }Clone Service Plan
Business applications can use this service API to clone service plan. An admin, who has permissions to manage service plans in his role, can clone service plan.
path Parameters
| id required | integer <int32> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Oauth access token of the logged in user. This must be a SigningHub Administrator who has the rights to create an account. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
Request Body schema:
| name required | string [ 1 .. 100 ] characters Name of the service plan that is to be added. |
| public required | boolean True, if the service plan is marked as public. |
Responses
Request samples
- Payload
{- "name": "string",
- "public": true
}Response samples
- 201
- 401
- 403
- 404
- 422
- 500
{- "id": 0,
- "name": "string",
- "start_date": "string",
- "end_date": "string",
- "features": [
- "string"
], - "type": "string",
- "public": true,
- "constraints": {
- "users": {
- "count": 0
}, - "signatures": {
- "count": 0,
- "advanced_electronic_signature": {
- "count": 0
}, - "high_trust_advanced_signature": {
- "count": 0
}, - "qualified_electronic_signature": {
- "count": 0
}, - "electronic_seal": {
- "count": 0
}, - "advanced_electronic_seal": {
- "count": 0
}, - "qualified_electronic_seal": {
- "count": 0
}
}, - "simple_electronic_signatures": {
- "count": 0
}, - "storage": {
- "count": 0
}, - "workflows": {
- "count": 0
}, - "upload_size": {
- "count": 0
}, - "templates": {
- "count": 0
}
}, - "level_of_assurance": {
- "allowed": [
- "string"
], - "default": [
- "string"
]
}, - "certify_options": {
- "allowed": [
- "string"
], - "default": "string"
}, - "pdf_a_compliancy": true,
- "auto_delete_document": {
- "enabled": true,
- "duration": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}, - "email_document": {
- "enabled": true,
- "workflow_evidence_report": true
}
}, - "add_unique_identifier": true,
- "signature_pad": {
- "enabled": true,
- "server": "string"
}, - "signature_appearances": [
- "string"
], - "signing_servers": [
- {
- "key_location": "string",
- "order": 0,
- "signing_profile": {
- "id": 0,
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "advanced_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "high_trust_advanced_signature": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "qualified_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "signature_appearances": {
- "signature_appearance": "string",
- "signature_appearance_logo": "string"
}, - "csp": {
- "enabled": true,
- "virtual_profile": {
- "id": 0,
- "name": "string"
}, - "auto_delete_certificates": true
}
}
], - "electronic_seal_servers": [
- {
- "electronic_seal_profile": {
- "id": 0,
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}
}
], - "verification_profile": {
- "id": 0,
- "name": "string"
}, - "require_password": true,
- "authentication_profile": {
- "allowed": [
- {
- "id": 0,
- "name": "string"
}
], - "default": {
- "id": 0,
- "name": "string"
}
}, - "evidence_report": {
- "type": "string",
- "delete_document_logs": true
}, - "one_time_password": {
- "email_otp": {
- "enabled": true
}, - "sms_otp": {
- "enabled": true,
- "server": "string"
}, - "otp_length": 0,
- "otp_expiry": 0,
- "otp_retry_interval": 0
}, - "time_based_one_time_password": true,
- "smtp_server": {
- "enabled": true,
- "Server": "string"
}, - "sms_notification": {
- "enabled": true,
- "Server": "string"
}, - "auto_delete_user": {
- "enabled": true,
- "inactive_days": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}
}, - "billing": {
- "payment_type": "string",
- "mode": "string",
- "monthly": {
- "enabled": true,
- "price": "string"
}, - "yearly": {
- "enabled": true,
- "price": "string"
}, - "auto_reset_constraints": true,
- "price": "string"
}
}Country List
The key/value pairs for country references that SigningHub recognizes. These are used in various API calls.
"AlandIslands": "AlandIslands",
"Albania": "Albania",
"Algeria": "Algeria",
"American Samoa": "American Samoa",
"Andorra": "Andorra",
"Angola": "Angola",
"Anguilla": "Anguilla",
"Antarctica": "Antarctica",
"Antigua and Barbuda": "Antigua and Barbuda",
"Argentina": "Argentina",
"Armenia": "Armenia",
"Aruba": "Aruba",
"Australia": "Australia",
"Austria": "Austria",
"Azerbaijan": "Azerbaijan",
"Bahamas": "Bahamas",
"Bahrain": "Bahrain",
"Bangladesh": "Bangladesh",
"Barbados": "Barbados",
"Belarus": "Belarus",
"Belgium": "Belgium",
"Belize": "Belize",
"Benin": "Benin",
"Bermuda": "Bermuda",
"Bouvet Island": "Bouvet Island",
"Bhutan": "Bhutan",
"Bolivia": "Bolivia",
"Bosnia and Herzegovina": "Bosnia and Herzegovina",
"Botswana": "Botswana",
"Brazil": "Brazil",
"British Indian Ocean Territory": "British Indian Ocean Territory",
"British Virgin Islands": "British Virgin Islands",
"Brunei": "Brunei",
"Bulgaria": "Bulgaria",
"Burkina Faso": "Burkina Faso",
"Burundi": "Burundi",
"Cambodia": "Cambodia",
"Cameroon": "Cameroon",
"Canada": "Canada",
"Cape Verde": "Cape Verde",
"Cayman Islands": "Cayman Islands",
"Central African Republic": "Central African Republic",
"Chad": "Chad",
"Chile": "Chile",
"China": "China",
"Christmas Island": "Christmas Island",
"Cocos-Keeling-Islands": "Cocos-Keeling-Islands",
"Colombia": "Colombia",
"Comoros": "Comoros",
"Congo": "Congo",
"Cook Islands": "Cook Islands",
"Costa Rica": "Costa Rica",
"Croatia": "Croatia",
"Cuba": "Cuba",
"Cyprus": "Cyprus",
"Czech Republic": "Czech Republic",
"Denmark": "Denmark",
"Democratic Republic of Congo": "Democratic Republic of Congo",
"Djibouti": "Djibouti",
"Dominica": "Dominica",
"Dominican Republic": "Dominican Republic",
"East Timor": "East Timor",
"Ecuador": "Ecuador",
"Egypt": "Egypt",
"El Salvador": "El Salvador",
"Equatorial Guinea": "Equatorial Guinea",
"Eritrea": "Eritrea",
"Estonia": "Estonia",
"Ethiopia": "Ethiopia",
"Falkland Islands": "Falkland Islands",
"Faroe Islands": "Faroe Islands",
"Federated States of Micronesia": "Federated States of Micronesia",
"Fiji": "Fiji",
"Finland": "Finland",
"France": "France",
"French Guiana": "French Guiana",
"French Polynesia": "French Polynesia",
"French Southern and Antarctic Lands": "French Southern and Antarctic Lands",
"Gabon": "Gabon",
"Gambia": "Gambia",
"Georgia": "Georgia",
"Germany": "Germany",
"Ghana": "Ghana",
"Gibraltar": "Gibraltar",
"Greece": "Greece",
"Greenland": "Greenland",
"Grenada": "Grenada",
"Guadeloupe": "Guadeloupe",
"Guam": "Guam",
"Guatemala": "Guatemala",
"Guernsey": "Guernsey",
"Guinea": "Guinea",
"Guinea-Bissau": "Guinea-Bissau",
"Guyana": "Guyana",
"HeardIs land and Mcdonald Islands": "HeardIs land and Mcdonald Islands",
"Haiti": "Haiti",
"Honduras": "Honduras",
"Hong Kong": "Hong Kong",
"Hungary": "Hungary",
"Iceland": "Iceland",
"India": "India",
"Indonesia": "Indonesia",
"Iran": "Iran",
"Iraq": "Iraq",
"Ireland": "Ireland",
"Isle of Man": "Isle of Man",
"Israel": "Israel",
"Italy": "Italy",
"CôtedIvoire": "CôtedIvoire",
"Jamaica": "Jamaica",
"Japan": "Japan",
"Jersey": "Jersey",
"Jordan": "Jordan",
"Kazakhstan": "Kazakhstan",
"Kenya": "Kenya",
"Kiribati": "Kiribati",
"Kuwait": "Kuwait",
"Kyrgyzstan": "Kyrgyzstan",
"Laos": "Laos",
"Latvia": "Latvia",
"Lebanon": "Lebanon",
"Lesotho": "Lesotho",
"Liberia": "Liberia",
"Libya": "Libya",
"Liechtenstein": "Liechtenstein",
"Lithuania": "Lithuania",
"Luxembourg": "Luxembourg",
"Macau": "Macau",
"Macedonia": "Macedonia",
"Madagascar": "Madagascar",
"Malawi": "Malawi",
"Malaysia": "Malaysia",
"Maldives": "Maldives",
"Mali": "Mali",
"Malta": "Malta",
"Marshall Islands": "Marshall Islands",
"Mauritania": "Mauritania",
"Mauritius": "Mauritius",
"Mayotte": "Mayotte",
"Mexico": "Mexico",
"Micronesia": "Micronesia",
"Moldova": "Moldova",
"Monaco": "Monaco",
"Mongolia": "Mongolia",
"Montenegro": "Montenegro",
"Morocco": "Morocco",
"Montserrat": "Montserrat",
"Mozambique": "Mozambique",
"Myanmar": "Myanmar",
"Namibia": "Namibia",
"Nauru": "Nauru",
"Nepal": "Nepal",
"Netherlands": "Netherlands",
"Netherlands Antilles": "Netherlands Antilles",
"New Caledonia": "New Caledonia",
"New Zealand": "New Zealand",
"Nicaragua": "Nicaragua",
"Niger": "Niger",
"Nigeria": "Nigeria",
"Niue": "Niue",
"Norfolk Island": "Norfolk Island",
"Northern Mariana Islands": "Northern Mariana Islands",
"North Korea": "North Korea",
"Norway": "Norway",
"Oman": "Oman",
"Pakistan": "Pakistan",
"Palau": "Palau",
"Panama": "Panama",
"Papua New Guinea": "Papua New Guinea",
"Paraguay": "Paraguay",
"Peru": "Peru",
"Philippines": "Philippines",
"Pitcairn Islands": "Pitcairn Islands",
"Palestinian Occupied Territories": "Palestinian Occupied Territories",
"Poland": "Poland",
"Portugal": "Portugal",
"Puerto Rico": "Puerto Rico",
"Qatar": "Qatar",
"Reunion": "Reunion",
"Romania": "Romania",
"Russia": "Russia",
"Rwanda": "Rwanda",
"Saint Barthélemy": "Saint Barthélemy",
"Saint Kitts and Nevis": "Saint Kitts and Nevis",
"Saint Lucia": "Saint Lucia",
"Saint Vincent and the Grenadines": "Saint Vincent and the Grenadines",
"Samoa": "Samoa",
"San Marino": "San Marino",
"São Tomé and Príncipe": "São Tomé and Príncipe",
"Saudi Arabia": "Saudi Arabia",
"Senegal": "Senegal",
"Serbia": "Serbia",
"Serbiaand Montenegro": "Serbiaand Montenegro",
"Seychelles": "Seychelles",
"Sierra Leone": "Sierra Leone",
"Singapore": "Singapore",
"Slovakia": "Slovakia",
"Slovenia": "Slovenia",
"Solomon Islands": "Solomon Islands",
"Somalia": "Somalia",
"South Africa": "South Africa",
"South Korea": "South Korea",
"Spain": "Spain",
"Sri Lanka": "Sri Lanka",
"Saint Helena Ascension and Tristanda Cunha": "Saint Helena Ascension and Tristanda Cunha",
"Saint Pierre and Miquelon": "Saint Pierre and Miquelon",
"Sudan": "Sudan",
"Suriname": "Suriname",
"Svalbard and Jan Mayen": "Svalbard and Jan Mayen",
"Swaziland": "Swaziland",
"Sweden": "Sweden",
"Switzerland": "Switzerland",
"Syria": "Syria",
"Taiwan": "Taiwan",
"Tajikistan": "Tajikistan",
"Tanzania": "Tanzania",
"Thailand": "Thailand",
"Togo": "Togo",
"Tokelau": "Tokelau",
"Tonga": "Tonga",
"Tunisia": "Tunisia",
"Trinidad and Tobago": "Trinidad and Tobago",
"Turkey": "Turkey",
"Turkmenistan": "Turkmenistan",
"Turks And Caicos Islands": "Turks And Caicos Islands",
"Tuvalu": "Tuvalu",
"United Arab Emirates": "United Arab Emirates",
"Uganda": "Uganda",
"United Kingdom": "United Kingdom",
"Ukraine": "Ukraine",
"Uruguay": "Uruguay",
"United States": "United States",
"US Virgin Islands": "US Virgin Islands",
"Uzbekistan": "Uzbekistan",
"Vanuatu": "Vanuatu",
"Vatican City State": "Vatican City State",
"Venezuela": "Venezuela",
"Vietnam": "Vietnam",
"Wallis and Futuna": "Wallis and Futuna",
"Western Sahara": "Western Sahara",
"Yemen": "Yemen",
"Zambia": "Zambia",
"Zimbabwe": "Zimbabwe"
Timezone List
The key/value pairs for time zones that SigningHub recognizes. These are used in various API calls.
{"Dateline Standard Time": "(UTC-12:00) International Date Line West ",
"Samoa Standard Time": "(UTC-11:00) Midway Island, Samoa",
"Hawaiian Standard Time": "(UTC-10:00) Hawaii",
"Alaskan Standard Time": "(UTC-09:00) Alaska",
"Pacific Standard Time": "(UTC-08:00) Pacific Time (US & Canada)",
"Pacific Standard Time (Mexico)": "(UTC-08:00) Tijuana, Baja California",
"US Mountain Standard Time": "(UTC-07:00) Arizona",
"Mountain Standard Time (Mexico)": "(UTC-07:00) Chihuahua, La Paz, Mazatlan",
"Mountain Standard Time": "(UTC-07:00) Mountain Time (US & Canada)",
"Central America Standard Time": "(UTC-06:00) Central America",
"Central Standard Time": "(UTC-06:00) Central Time (US & Canada)",
"Central Standard Time (Mexico)": "(UTC-06:00) Guadalajara, Mexico City, Monterrey",
"Canada Central Standard Time": "(UTC-06:00) Saskatchewan",
"SA Pacific Standard Time": "(UTC-05:00) Bogota, Lima, Quito",
"Eastern Standard Time": "(UTC-05:00) Eastern Time (US & Canada)",
"US Eastern Standard Time": "(UTC-05:00) Indiana (East)",
"Venezuela Standard Time": "(UTC-04:30) Caracas",
"Paraguay Standard Time": "(UTC-04:00) Asuncion",
"Atlantic Standard Time": "(UTC-04:00) Atlantic Time (Canada)",
"SA Western Standard Time": "(UTC-04:00) Georgetown, La Paz, San Juan",
"Central Brazilian Standard Time": "(UTC-04:00) Manaus",
"Pacific SA Standard Time": "(UTC-04:00) Santiago",
"Newfoundland Standard Time": "(UTC-03:30) Newfoundland",
"E. South America Standard Time": "(UTC-03:00) Brasilia",
"Argentina Standard Time": "(UTC-03:00) Buenos Aires",
"SA Eastern Standard Time": "(UTC-03:00) Cayenne",
"Greenland Standard Time": "(UTC-03:00) Greenland",
"Montevideo Standard Time": "(UTC-03:00) Montevideo",
"Mid-Atlantic Standard Time": "(UTC-02:00) Mid-Atlantic",
"Azores Standard Time": "(UTC-01:00) Azores",
"Cabo Verde Standard Time": "(UTC-01:00) Cape Verde Is.",
"Morocco Standard Time": "(UTC) Casablanca",
"Coordinated Universal Time": "(UTC) Coordinated Universal Time",
"GMT Standard Time": "(UTC) Dublin, Edinburgh, Lisbon, London, Saint Peter Port, Saint Helier",
"Greenwich Standard Time": "(UTC) Monrovia, Reykjavik",
"W. Europe Standard Time": "(UTC+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna",
"Central Europe Standard Time": "(UTC+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague",
"Romance Standard Time": "(UTC+01:00) Brussels, Copenhagen, Madrid, Paris",
"Central European Standard Time": "(UTC+01:00) Sarajevo, Skopje, Warsaw, Zagreb",
"W. Central Africa Standard Time": "(UTC+01:00) West Central Africa",
"Jordan Standard Time": "(UTC+02:00) Amman",
"GTB Standard Time": "(UTC+02:00) Athens, Bucharest, Istanbul",
"Middle East Standard Time": "(UTC+02:00) Beirut",
"Egypt Standard Time": "(UTC+02:00) Cairo",
"South Africa Standard Time": "(UTC+02:00) Harare, Pretoria",
"FLE Standard Time": "(UTC+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius",
"Jerusalem Standard Time": "(UTC+02:00) Jerusalem",
"E. Europe Standard Time": "(UTC+02:00) Minsk",
"Namibia Standard Time": "(UTC+02:00) Windhoek",
"Arabic Standard Time": "(UTC+03:00) Baghdad",
"Arab Standard Time": "(UTC+03:00) Kuwait, Riyadh",
"Russia TZ 2 Standard Time": "(UTC+03:00) Moscow, St. Petersburg, Volgograd",
"E. Africa Standard Time": "(UTC+03:00) Nairobi",
"Russia TZ 3 Standard Time": "(UTC+04:00) Izhevsk, Samara",
"Georgian Standard Time": "(UTC+04:00) Tbilisi",
"Iran Standard Time": "(UTC+03:30) Tehran",
"Arabian Standard Time": "(UTC+04:00) Abu Dhabi, Muscat",
"Azerbaijan Standard Time": "(UTC+04:00) Baku",
"Mauritius Standard Time": "(UTC+04:00) Port Louis",
"Caucasus Standard Time": "(UTC+04:00) Yerevan",
"Afghanistan Standard Time": "(UTC+04:30) Kabul",
"Russia TZ 4 Standard Time": "(UTC+05:00) Ekaterinburg",
"Pakistan Standard Time": "(UTC+05:00) Islamabad, Karachi",
"West Asia Standard Time": "(UTC+05:00) Tashkent",
"India Standard Time": "(UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi",
"Sri Lanka Standard Time": "(UTC+05:30) Sri Jayawardenepura",
"Nepal Standard Time": "(UTC+05:45) Kathmandu",
"Novosibirsk Standard Time": "(UTC+06:00) Almaty, Novosibirsk",
"Central Asia Standard Time": "(UTC+06:00) Astana, Dhaka",
"Myanmar Standard Time": "(UTC+06:30) Yangon (Rangoon)",
"SE Asia Standard Time": "(UTC+07:00) Bangkok, Hanoi, Jakarta",
"Russia TZ 6 Standard Time": "(UTC+07:00) Krasnoyarsk",
"China Standard Time": "(UTC+08:00) Beijing, Chongqing, Hong Kong, Urumqi",
"Russia TZ 7 Standard Time": "(UTC+08:00) Irkutsk, Ulaan Bataar",
"Malay Peninsula Standard Time": "(UTC+08:00) Kuala Lumpur, Singapore",
"W. Australia Standard Time": "(UTC+08:00) Perth",
"Taipei Standard Time": "(UTC+08:00) Taipei",
"Tokyo Standard Time": "(UTC+09:00) Osaka, Sapporo, Tokyo",
"Korea Standard Time": "(UTC+09:00) Seoul",
"Russia TZ 8 Standard Time": "(UTC+09:00) Yakutsk",
"Cen. Australia Standard Time": "(UTC+09:30) Adelaide",
"AUS Central Standard Time": "(UTC+09:30) Darwin",
"E. Australia Standard Time": "(UTC+10:00) Brisbane",
"AUS Eastern Standard Time": "(UTC+10:00) Canberra, Melbourne, Sydney",
"West Pacific Standard Time": "(UTC+10:00) Guam, Port Moresby",
"Tasmania Standard Time": "(UTC+10:00) Hobart",
"Russia TZ 9 Standard Time": "(UTC+10:00) Vladivostok",
"Central Pacific Standard Time": "(UTC+11:00) Magadan, Solomon Is., New Caledonia",
"New Zealand Standard Time": "(UTC+12:00) Auckland, Wellington",
"Fiji Standard Time": "(UTC+12:00) Fiji, Marshall Is.",
"Kamchatka Standard Time": "(UTC+12:00) Petropavlovsk-Kamchatsky",
"Tonga Standard Time": "(UTC+13:00) Nuku'alofa",
"Bahia Standard Time": "(UTC-03:00) Salvador",
"Syria Standard Time": "(UTC+02:00) Damascus",
"North Asia East Standard Time": "(UTC+08:00) Irkutsk, Ulaan Bataar",
"North Asia Standard Time": "(UTC+07:00) Krasnoyarsk",
"Magadan Standard Time": "(UTC+12:00) Magadan",
"N. Central Asia Standard Time": "(UTC+06:00) Almaty, Novosibirsk",
"Ulaanbaatar Standard Time": "(UTC+08:00) Ulaanbaatar",
"Vladivostok Standard Time": "(UTC+10:00) Vladivostok",
"Yakutsk Standard Time": "(UTC+09:00) Yakutsk",
"Ekaterinburg Standard Time": "(UTC+05:00) Ekaterinburg",
"Cape Verde Standard Time": "(UTC-01:00) Cape Verde Is.",
"Russian Standard Time": "(UTC+03:00) Moscow, St. Petersburg, Volgograd",
"Bangladesh Standard Time": "(UTC+06:00) Dhaka"
}
Supported Languages
The key/value pairs for country codes that SigningHub recognizes
. These are used in various API calls and for setting the language preference when using tight integration iframe functionality.
"en-US" : "English",
"nl-NL" : "Nederlands",
"es-ES" : "Español (ES)",
"es-LA" : "Español (LA)",
"fr-FR" : "Français",
"de-DE" : "Deutsch",
"ar-AE" : "العربية",
"tr-TR" : "Türkçe",
"lv-LV" : "Latviski",
"nb-NO" : "Norsk",
"el-GR" : "ελληνικά",
"hi-IN" : "हिंदी",
"id-ID" : "Bahasa Indonesia",
"ja-JP" : "日本語",
"pt-Pt" : "Português (PT)",
"pt-BR" : "Português (Brasil)",
"ro-RO" : "Română",
"ru-RU" : "Pусский",
"sr-CR" : "Srpski",
"th-TH" : "ภาษาไทย",
"vi-VN" : "Tiếng Việt",
"zh-CN" : "简体中文",
"it-IT" : "Italiano",
"fi-FI" : "Suomo",
"et-ET" : "Eesti",
"pl-PL" : "Polski",
"sv-SE" : "Svenska",
"da-DK" : "Dansk",
"cr-CR" : "Cрпски",