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

System Integration

The System Integration Module enables system administrators to configure system-wide integrations. These integrations are available for use by all enterprises and users across the system.

Get System Integrations

Business applications can use this service API to get the system integrations. An admin who has permission to manage the system integrations in his role can get system integrations.

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

records
required
integer <int32>

Total number of records to be retrieved in a page.

query Parameters
sort-by
string (AdminEnumerations.SystemIntegrationSortBy)
Enum: "CLIENT_ID" "ACTIVE" "CREATED_ON"
asc
boolean
Default: false
header Parameters
x-search-text
string
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)

x-search-text
string
Default: John doe

A parameter that represents the search text, if required. This is optional and without it, the entire list is returned. Furthermore, the recommended value for the search text parameter is in Base64 encoded format or plain text.

x-total-records
string
Default: 212

The total number of records found with the provided search criteria.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get System Integration by ID

Business applications can use this service API to get the system integration. An admin who has permission to manage the system integration in his role can get system integration.

path Parameters
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,
  • "client_id": "string",
  • "client_secret": "string",
  • "validity_period": "string",
  • "valid_from": "2019-08-24T14:15:22Z",
  • "valid_to": "2019-08-24T14:15:22Z",
  • "active": true,
  • "created_on": "2019-08-24T14:15:22Z",
  • "allowed_domains": "string"
}

Update System Integration

path Parameters
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:
client_id
required
string non-empty

Client id of system integration

validity_period
required
string non-empty

Validity period of integration, possible values are CUSTOM, THREE_MONTHS, SIX_MONTHS, TWELVE_MONTHS, EIGHTEEN_MONTHS, TWENTY_FOUR_MONTHS

valid_from
string or null

Validity start date (Only required when validity period is CUSTOM)

valid_to
string or null

Validity end date (Only required when validity period is CUSTOM)

active
boolean

Status of system integration

allowed_domains
string or null <= 1000 characters

Allows iframing of the SigningHub application only from configured domains when CSP is enabled in the integration. Multiple domains can be added, separated by commas (e.g., https://www.google.com, https://www.hotmail.com).

Responses

Request samples

Content type
{
  • "client_id": "string",
  • "validity_period": "string",
  • "valid_from": "string",
  • "valid_to": "string",
  • "active": true,
  • "allowed_domains": "string"
}

Response samples

Content type
application/json
{
  • "validity_period": "string",
  • "valid_from": "2019-08-24T14:15:22Z",
  • "valid_to": "2019-08-24T14:15:22Z"
}

Delete System Integration

path Parameters
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"
}

Add System Integration

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:
client_id
required
string non-empty

Client id of system integration

validity_period
required
string non-empty

Validity period of integration, possible values are CUSTOM, THREE_MONTHS, SIX_MONTHS, TWELVE_MONTHS, EIGHTEEN_MONTHS, TWENTY_FOUR_MONTHS

valid_from
string or null

Validity start date (Only required when validity period is set to CUSTOM)

valid_to
string or null

Validity end date (Only required when validity period is set to CUSTOM)

active
boolean

Status of system integration

allowed_domains
string or null <= 1000 characters

Allows iframing of the SigningHub application only from configured domains when CSP is enabled in the integration. Multiple domains can be added, separated by commas (e.g., https://www.google.com, https://www.hotmail.com).

Responses

Request samples

Content type
{
  • "client_id": "string",
  • "validity_period": "string",
  • "valid_from": "string",
  • "valid_to": "string",
  • "active": true,
  • "allowed_domains": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "client_secret": "string",
  • "validity_period": "string",
  • "valid_from": "2019-08-24T14:15:22Z",
  • "valid_to": "2019-08-24T14:15:22Z",
  • "created_on": "2019-08-24T14:15:22Z",
  • "allowed_domains": "string"
}

Create Client Secret

path Parameters
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
{
  • "client_secret": "string"
}