Documentation Powered by Redocly

SigningHub Admin 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 Token
➤ Updates
➤ APIs Developer Guide
➤ Appendix
➤ Authentication
➤ Service Plans
➤ Account Management
➤ Billing Management
➤ Access Control
➤ Operator Logs
➤ Advanced Reports

Policies

The Policy Module provides functionality to create, retrieve, update, and delete policies. It enables administrators to manage policy configurations and maintain policy information through centralized policy management APIs.

Add Policy

Business applications can use this service API to add policy for Users. An admin who has permissions to manage Policies in his role, can add new policy.

path Parameters
type
required
string

Allowed Value: document-deletion

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-forwarded-for
string

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Request Body schema:
name
required
string [ 1 .. 255 ] characters
status
required
boolean

True if enabled, False if disabled

Array of objects or null (Models.PolicyDetailRequest)

List of policy details

Responses

Request samples

Content type
{
  • "name": "string",
  • "status": true,
  • "policy_detail": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_on": "string"
}

Get All Policies

Business applications can use this service API to get all policies for Users.

path Parameters
type
required
string

Allowed Value: document-deletion

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-forwarded-for
string

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Policy

Business applications can use this service API to update policy for Users. An admin who has permissions to manage Policies in his role, can update policy.

path Parameters
type
required
string

Allowed Value: document-deletion

id
required
integer <int64>
header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-forwarded-for
string

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Request Body schema:
name
required
string [ 1 .. 255 ] characters
status
required
boolean

True if enabled, False if disabled

Array of objects or null (Models.PolicyDetailRequest)

List of policy details

Responses

Request samples

Content type
{
  • "name": "string",
  • "status": true,
  • "policy_detail": [
    ]
}

Response samples

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

Get Policy By Id

Business applications can use this service API to get policy by id for Users.

path Parameters
type
required
string

Allowed Value: document-deletion

id
required
integer <int64>
header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-forwarded-for
string

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "status": true,
  • "created_on": "string",
  • "policy_detail": [
    ]
}

Delete Policy

Business applications can use this service API to delete policy for Users.

path Parameters
type
required
string

Allowed Value: document-deletion

id
required
integer <int64>
header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-forwarded-for
string

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Responses

Response samples

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