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

Branding

The Branding Module stores system-level branding information for the application. Administrators can configure company logos (e.g., product logo and favicon) and customize the color scheme for elements such as the page header, dialog headers, action buttons, scrollbars, selected menu options, right panels, list headers, document background, right panel headers, and progress bars. They can also customize error message content, including images and text.

Get Branding

Business applications can use this API call to retrieve the system branding of the SigningHub application that is set at the administrator level. This includes the logo, favicon, colors, background images for web and mobile and slider images that comprise the branding options.

header Parameters
x-base64
string

Default base64 header is true.

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-base64
string
Default: true

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

Responses

Response samples

Content type
application/json
{
  • "branding": {
    },
  • "default_branding": {
    }
}

Update Branding

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

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

Base64 string of the logo image of the application.

favicon
required
string non-empty

Base64 encoded string of the favicon image.

required
object (Models.BackgroundImageRequest)

BackgroundImageRequest

required
object (Models.BrandingColors)

BrandingColors

Array of objects or null (Models.UpdateSliderItem)

Base64 encoded string of the slider images

Responses

Request samples

Content type
{
  • "logo": "string",
  • "favicon": "string",
  • "background_image": {
    },
  • "colors": {
    },
  • "slider_items": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Favicon

Business applications can use this service API to get favicon.

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

Reset Branding

Business applications can use this service API to reset branding. An admin, who has permissions to manage branding in his role, can reset branding.

header Parameters
x-base64
string

Default base64 header is true.

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-base64
string
Default: true

Responses

Response samples

Content type
application/json
{
  • "logo": "string",
  • "logo_url": "string",
  • "favicon": "string",
  • "favicon_url": "string",
  • "background_image": {
    },
  • "colors": {
    },
  • "slider_items": [
    ]
}