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

Identity Verification Profiles

Identity Verification Profiles enable the configuration and management of user identity validation methods by integrating with external identity providers such as Innovatrics and eWallet services, allowing secure verification of user identity during onboarding and authentication processes.

Get Identity Verification Profiles

Business applications can use this service API to get identity verification profiles. An admin, who has permissions to manage identity verification profiles in his role, can get identity verification profiles.

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 Identity Verification Profile

Business applications can use this service API to add identity verification profile. An admin, who has permissions to manage identity verification profiles in his role, can add new identity verification profile.

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

Name of the profile

description
string or null <= 255 characters

Description of the profile

status
boolean

Status of the profile

Array of objects or null (Models.IdentityVerificationProfileDetailRequest)

Details of the profile

Responses

Request samples

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

Response samples

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

Get Basic Identity Verification Profiles

Business applications can use this service API to get basic identity verification profiles. For admin, there is no need of any permission to retrieve basic identity verification profiles.

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

Get Identity Verification Profile

Business applications can use this service API to get identity verification profile by id. An admin, who has permissions to manage identity verification profiles in his role, can get identity verification profile.

path Parameters
id
required
integer <int64>

Id of the identity verification profile.

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",
  • "status": true,
  • "created_on": "string",
  • "profile_detail": [
    ]
}

Delete Identity Verification Profile

Business applications can use this service API to delete identity verification profile. An admin, who has permissions to manage identity verification profiles in his role, can delete identity verification profile.

path Parameters
id
required
integer <int64>

Id of the identity verification profile.

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

Update Identity Verification Profile

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

path Parameters
id
required
integer <int64>

Id of the identity verification profile.

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

Name of the profile

description
string or null <= 255 characters

Description of the profile

status
boolean

Status of the profile

Array of objects or null (Models.IdentityVerificationProfileDetailRequest)

Details of the profile

Responses

Request samples

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

Response samples

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

Get Identity Verification Provider

Business applications can use this service API to get identity verification information. An admin, who has permissions to manage identity verification profiles in his role, can get identity verification information.

path Parameters
connector_name
required
string

Connector of the identity verification.

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