Documentation Powered by Redocly

SigningHub API Guide

Download OpenAPI specification:Download

Welcome

Welcome to SigningHub, a high trust digital signing solution for all your paperless business transactions. It is ideal for those organisations that recognise the value of using cryptographic digital signatures to protect their users and their documents against unauthorised or accidental or fraudulent changes.


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.
  • Visit the Ascertia Community Portal to find answers to 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. 
Intended Readership
This guide is intended for developers who will integrate SigningHub into their respective 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.

Main Tags
Most Popular Pages
➤ Welcome
➤ Prerequisites
➤ Access Tokens
➤ Quick Integration
➤ Updates
➤ SignalR
➤ APIs Developer Guide
➤ Appendix
➤ Authentication
➤ Account Management
➤ Add Package
➤ Upload Document
➤ Get Workflow Details
➤ Sign Document

Artificial Intelligence (AI)

This section entails the web services for the Artificial Intelligence i.e. Get AI features and execute the relevant features.

Artificial Intelligence (AI) Execute Feature

Business applications can use this service API to execute artificial intelligence feature.

path Parameters
packageId
required
integer <int64>

Package Id

feature
required
string

Feature Id

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-folder-id
string
Default: 0

Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

x-password
string
Example: pincode123

The password set by the document owner for accessing the document, if any. If the password has not been set, then the value shall be null.

x-otp
string
Example: 123456

The One-Time Password (OTP) set by the document owner for accessing the document, if any. If the OTP has not been set, then the value shall be null.

x-identity-verification
string

The Identity Verification token obtained from Get Identity Verification Flow Status, if applicable. If the policy has not been set, then the value shall be null.

Request Body schema:

Request data

required
Array of objects (Custom.ArtificialIntelligenceDocuments)

documents

Responses

Request samples

Content type
{
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "response": "string"
}

Artificial Intelligence (AI) Features

Business applications can use this service API to get artificial intelligence features.

path Parameters
packageId
required
integer <int64>

Package Id

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-folder-id
string
Default: 0

Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

x-password
string
Example: pincode123

The password set by the document owner for accessing the document, if any. If the password has not been set, then the value shall be null.

x-otp
string
Example: 123456

The One-Time Password (OTP) set by the document owner for accessing the document, if any. If the OTP has not been set, then the value shall be null.

x-identity-verification
string

The Identity Verification token obtained from Get Identity Verification Flow Status, if applicable. If the policy has not been set, then the value shall be null.

Responses

Response samples

Content type
application/json
{
  • "features": [
    ]
}