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

Service Agreements

The Service Agreements Module lets administrators configure custom Terms of Service and Privacy Policy, ensuring user consent across all SigningHub platforms during key actions like login, registration, and account deletion.

Get Service Agreements

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

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
[
  • {
    }
]

Add Service Agreement

Business applications can use this service API to add a service agreement. An admin who has permission to manage service agreements in his role can add a new service agreement.

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

The name of the service agreement.

description
string or null <= 255 characters

The description of the service agreement.

terms_of_service
string or null

The content of the service agreement.

terms_of_service_url
string or null

The url of the service agreement.

privacy_policy
string or null

The privacy policy of the service agreement.

privacy_policy_url
string or null

The privacy policy url of the service agreement.

active
boolean

True, if the status of the service agreement is active.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "terms_of_service": "string",
  • "terms_of_service_url": "string",
  • "privacy_policy": "string",
  • "privacy_policy_url": "string",
  • "active": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_on": "2019-08-24T14:15:22Z"
}

Get Service Agreement by ID

Business applications can use this service API to get a service agreement by ID. An admin who has permission to manage service agreements in his role can get a service agreement.

path Parameters
id
required
integer <int64>

The ID of the service agreement.

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",
  • "description": "string",
  • "terms_of_service": "string",
  • "terms_of_service_url": "string",
  • "privacy_policy": "string",
  • "privacy_policy_url": "string",
  • "active": true
}

Update Service Agreement

Business applications can use this service API to update a service agreement. An admin who has permission to manage service agreements in his role can update a service agreement.

path Parameters
id
required
integer <int64>

The ID of the service agreement.

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

The name of the service agreement.

description
string or null <= 255 characters

The description of the service agreement.

terms_of_service
string or null

The content of the service agreement.

terms_of_service_url
string or null

The url of the service agreement.

privacy_policy
string or null

The privacy policy of the service agreement.

privacy_policy_url
string or null

The privacy policy url of the service agreement.

active
boolean

True, if the status of the service agreement is active.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "terms_of_service": "string",
  • "terms_of_service_url": "string",
  • "privacy_policy": "string",
  • "privacy_policy_url": "string",
  • "active": true
}

Response samples

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

Delete Service Agreement

Business applications can use this service API to delete a service agreement. An admin who has permission to manage the service agreements in his role can delete a service agreement.

path Parameters
id
required
integer <int64>

The ID of the service agreement.

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