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 Plan

service plan information enables users to select and configure plans based on their needs. It supports both enterprise and individual users by allowing the selection of appropriate service plans and setting up related billing configurations

Get Service Plans

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

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 Plan

Business applications can use this service API to add service plan. An admin, who has permissions to manage service plans in his role, can add service plan.

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 .. 100 ] characters

Name of the service plan

type
required
string (Enumerations.ApiPlanType)
Enum: "INDIVIDUAL" "ENTERPRISE"
start_date
string or null <date-time>

Date on which the service plan expiry has started

end_date
string or null <date-time>

Date on which the service plan expiry has ended

features
required
Array of strings (Enumerations.ApiPlanFeatures)
Items Enum: "ALLOW_FORM_FIELDS" "ALLOW_REVIEWER" "ALLOW_ATTACHMENTS" "ALLOW_INITIALS_FIELDS" "ALLOW_INPERSON_FIELDS" "ALLOW_INTEGRATION" "ALLOW_BULK_SIGNING" "SERVICE_PLAN_FEATURE_CLOUD_DRIVES" "ALLOW_EDITOR" "ALLOW_SEND_A_COPY" "ALLOW_ELECTRONIC_SEAL" "ALLOW_DOCUMENTS_ARCHIVE" "ALLOW_SMART_FORM" "ALLOW_STAMPS" "ARTIFICIAL_INTELLIGENCE"

List of features available in the service plan. Possible values are mentioned above. ALLOW_ELECTRONIC_SEAL and ALLOW_INTEGRATION can be added only to the "Enterprise" service plan. ARTIFICIAL_INTELLIGENCE could be added if ARTIFICIAL_INTELLIGENCE is allowed in the license

public
required
boolean

True, if service plan is public

required
object (Models.ServicePlanConstraintRequest)

Service Plan - Constraints request

required
object (Models.ServicePlanLevelOfAssuranceRequest)

Service Plan - Level of assurance request

object (Models.ServicePlanCertifyOptionRequest)

Service Plan - Certify option request

pdf_a_compliancy
required
boolean

True, If PDF Compliant

object (Models.ServicePlanAutoDeleteDocumentRequest)

Service Plan - Auto delete document request

add_unique_identifier
required
boolean

True, If to add a unique identifier field in the document header.

object (Models.SignaturePadResponse)

Service Plan - Signature pad response

signature_appearances
required
Array of strings

Signature appearances, possible values are COMPANY_LOGO, HAND_SIGNATURE, DETAILED_SIGNATURE.

required
Array of objects (Models.ServicePlanSigningServerRequest)

Signing Servers

Array of objects or null (Models.ServicePlanElectronicSealServerRequest)

Electronic Seal Signing Servers that can be added to the "Enterprise" service plan.

object (Models.ServicePlanIdvProfileRequest)

ServicePlan - IDV Profile Request

required
object (Models.ServicePlanProfileRequest)

Service Plan - Profile Request

require_password
boolean

Indicates whether a password is required during user registration

object (Models.ServicePlanAuthenticationProfileRequest)

Service Plan - Authentication Profile Request

required
object (Models.ServicePlanEvidenceReportRequest)

Service Plan - Evidence Report Request

object (Models.ServicePlanOneTimePasswordRequest)

ServicePlan - One Time Password Request

time_based_one_time_password
required
boolean

True if TOTP are enabled for the service plan.

object (Models.ServicePlanSmtpServerRequest)

Service Plan - SMTP Server Request

object (Models.ServicePlanSmsNotificationRequest)

Service Plan - Sms Notification Request

object (Models.ServicePlanAutoDeleteUserRequest)

Service Plan - Auto Delete User Request

object (Models.ServicePlanBillingRequest)

Service Plan - Billing Request

Responses

Request samples

Content type
{
  • "name": "string",
  • "type": "INDIVIDUAL",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "features": [
    ],
  • "public": true,
  • "constraints": {
    },
  • "level_of_assurance": {
    },
  • "certify_options": {
    },
  • "pdf_a_compliancy": true,
  • "auto_delete_document": {
    },
  • "add_unique_identifier": true,
  • "signature_pad": {
    },
  • "signature_appearances": [
    ],
  • "signing_servers": [
    ],
  • "electronic_seal_servers": [
    ],
  • "identity_verification": {
    },
  • "verification_profile": {
    },
  • "require_password": true,
  • "authentication_profile": {
    },
  • "evidence_report": {
    },
  • "one_time_password": {
    },
  • "time_based_one_time_password": true,
  • "smtp_server": {
    },
  • "sms_notification": {
    },
  • "auto_delete_user": {
    },
  • "billing": {
    }
}

Response samples

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

Get Service Plan by ID

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

path Parameters
id
required
integer <int32>
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",
  • "created_on": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "features": [
    ],
  • "type": "string",
  • "public": true,
  • "deprecated": true,
  • "constraints": {
    },
  • "level_of_assurance": {
    },
  • "certify_options": {
    },
  • "pdf_a_compliancy": true,
  • "auto_delete_document": {
    },
  • "add_unique_identifier": true,
  • "signature_pad": {
    },
  • "signature_appearances": [
    ],
  • "signing_servers": [
    ],
  • "electronic_seal_servers": [
    ],
  • "verification_profile": {
    },
  • "require_password": true,
  • "authentication_profile": {
    },
  • "identity_verification": {
    },
  • "evidence_report": {
    },
  • "one_time_password": {
    },
  • "time_based_one_time_password": true,
  • "smtp_server": {
    },
  • "sms_notification": {
    },
  • "auto_delete_user": {
    },
  • "billing": {
    }
}

Update Service Plan

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

path Parameters
id
required
integer <int32>
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 .. 100 ] characters

Name of the service plan

start_date
string or null <date-time>

Date on which the service plan expiry has started

end_date
string or null <date-time>

Date on which the service plan expiry has ended

features
required
Array of strings (Enumerations.ApiPlanFeatures)
Items Enum: "ALLOW_FORM_FIELDS" "ALLOW_REVIEWER" "ALLOW_ATTACHMENTS" "ALLOW_INITIALS_FIELDS" "ALLOW_INPERSON_FIELDS" "ALLOW_INTEGRATION" "ALLOW_BULK_SIGNING" "SERVICE_PLAN_FEATURE_CLOUD_DRIVES" "ALLOW_EDITOR" "ALLOW_SEND_A_COPY" "ALLOW_ELECTRONIC_SEAL" "ALLOW_DOCUMENTS_ARCHIVE" "ALLOW_SMART_FORM" "ALLOW_STAMPS" "ARTIFICIAL_INTELLIGENCE"

List of features available in the service plan, possible values are mentioned above.ALLOW_ELECTRONIC_SEAL and ALLOW_INTEGRATION can be updated only to the "Enterprise" service plan. ARTIFICIAL_INTELLIGENCE could be added if ARTIFICIAL_INTELLIGENCE is allowed in the license

public
boolean

True, if service plan is public

deprecated
boolean or null

Deprecated: Default value for this parameter set to false

required
object (Models.ServicePlanConstraintRequest)

Service Plan - Constraints request

required
object (Models.ServicePlanLevelOfAssuranceRequest)

Service Plan - Level of assurance request

object (Models.ServicePlanCertifyOptionRequest)

Service Plan - Certify option request

pdf_a_compliancy
boolean

True, If PDF Compliant

object (Models.ServicePlanAutoDeleteDocumentRequest)

Service Plan - Auto delete document request

add_unique_identifier
boolean

True, If to add a unique identifier field in the document header.

object (Models.SignaturePadResponse)

Service Plan - Signature pad response

signature_appearances
required
Array of strings

Signature appearances, possible values are COMPANY_LOGO, HAND_SIGNATURE, DETAILED_SIGNATURE.

required
Array of objects (Models.ServicePlanSigningServerRequest)

Signing Servers

Array of objects or null (Models.ServicePlanElectronicSealServerRequest)

Electronic Seal Signing Servers that can be updated to the "Enterprise" service plan.

object (Models.ServicePlanIdvProfileRequest)

ServicePlan - IDV Profile Request

required
object (Models.ServicePlanProfileRequest)

Service Plan - Profile Request

require_password
boolean

Indicates whether a password is required during user registration

object (Models.ServicePlanAuthenticationProfileRequest)

Service Plan - Authentication Profile Request

required
object (Models.ServicePlanEvidenceReportRequest)

Service Plan - Evidence Report Request

object (Models.ServicePlanOneTimePasswordRequest)

ServicePlan - One Time Password Request

time_based_one_time_password
boolean

True if TOTP are enabled for the service plan.

object (Models.ServicePlanSmtpServerRequest)

Service Plan - SMTP Server Request

object (Models.ServicePlanArtificialIntelligenceServer)

ServicePlanArtificialIntelligenceServer

object (Models.ServicePlanSmsNotificationRequest)

Service Plan - Sms Notification Request

object (Models.ServicePlanAutoDeleteUserRequest)

Service Plan - Auto Delete User Request

object (Models.ServicePlanBillingRequest)

Service Plan - Billing Request

object (Models.ServicePlanDeleteRASUserRequest)

Service Plan - Delete RAS User Request

Responses

Request samples

Content type
{
  • "name": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "features": [
    ],
  • "public": true,
  • "deprecated": true,
  • "constraints": {
    },
  • "level_of_assurance": {
    },
  • "certify_options": {
    },
  • "pdf_a_compliancy": true,
  • "auto_delete_document": {
    },
  • "add_unique_identifier": true,
  • "signature_pad": {
    },
  • "signature_appearances": [
    ],
  • "signing_servers": [
    ],
  • "electronic_seal_servers": [
    ],
  • "identity_verification": {
    },
  • "verification_profile": {
    },
  • "require_password": true,
  • "authentication_profile": {
    },
  • "evidence_report": {
    },
  • "one_time_password": {
    },
  • "time_based_one_time_password": true,
  • "smtp_server": {
    },
  • "artificial_intelligence": {
    },
  • "sms_notification": {
    },
  • "auto_delete_user": {
    },
  • "billing": {
    },
  • "remove_ras_user_on_delete_user": {
    }
}

Response samples

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

Delete Service Plan

Business applications can use this service API to delete the service plan. An admin, who has permissions to manage service plans in his role, can delete the service plan.

path Parameters
id
required
integer <int32>
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"
}

Clone Service Plan

Business applications can use this service API to clone service plan. An admin, who has permissions to manage service plans in his role, can clone service plan.

path Parameters
id
required
integer <int32>
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 .. 100 ] characters

Name of the service plan that is to be added.

public
required
boolean

True, if the service plan is marked as public.

deprecated
boolean or null

Deprecated: Default value for this parameter set to false

Responses

Request samples

Content type
{
  • "name": "string",
  • "public": true,
  • "deprecated": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "created_on": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "features": [
    ],
  • "type": "string",
  • "public": true,
  • "deprecated": true,
  • "constraints": {
    },
  • "level_of_assurance": {
    },
  • "certify_options": {
    },
  • "pdf_a_compliancy": true,
  • "auto_delete_document": {
    },
  • "add_unique_identifier": true,
  • "signature_pad": {
    },
  • "signature_appearances": [
    ],
  • "signing_servers": [
    ],
  • "electronic_seal_servers": [
    ],
  • "verification_profile": {
    },
  • "require_password": true,
  • "authentication_profile": {
    },
  • "identity_verification": {
    },
  • "evidence_report": {
    },
  • "one_time_password": {
    },
  • "time_based_one_time_password": true,
  • "smtp_server": {
    },
  • "sms_notification": {
    },
  • "auto_delete_user": {
    },
  • "billing": {
    }
}

Get Basic Service Plans

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

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