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

Prerequisites

To access SigningHub Admin APIs, you must authenticate using an TLS client PFX file issued to your Admin.

Obtain an TLS PFX – The Admin requires TLS authentication. This .pfx file is used in the authentication request to SigningHub. You’ll typically install it in your server/application environment (e.g., certificate store, keystore, or as a .pfx file with private key).
Authenticate with PFX (Get Subject Token) – Call the Admin authentication endpoint using the TLS .pfx file. The service returns a subject token, which represents the authenticated PFX identity. The subject token is a temporary security token that represents the authenticated identity of your PFX. This token on its own cannot be used for API calls — it must be exchanged for an access token.
Create an API Key – set a client ID, and generate an API Key in SigningHub, using the Configuration menu > Integrations screen. Note the Clinet ID and Client Secret. See details, how to configure an API key.
Exchange Subject Token for Access Token – Call the Admin token endpoint with the required parameters (grant_type and subject_token). The client_id and client_secret must be Base64-encoded and passed using Basic Authorization. The response includes an OAuth 2.0 bearer access token.
Use Access Token in API Calls – Include the bearer token in the Authorization header of all Admin API requests

Access Token

This section provides information of supported tokens by SigningHub.

PFX Token - Base64-encoded client ID and client secret are used for authentication by passing a subject token obtained through TLS client authentication with a .pfx file. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The PFX must belong to a SigningHub Administrator authorized to perform this action.

Updates

10.0
- 10.0.3
- 10.0.4
- 10.0.5
- 10.0.6

10.0.3 | Following are the APIs that have been affected by the changes:

New APIs

New APIs

Authentication	Password Authentication Set New Password Forgot Password Decrypt URL Reset Password Logout
Dashboard	Get Admin Dashboard Data
Configurations	Get System Settings Update System Settings
Connectors	Get Connectors Add Connector Get Basic Connectors Get Connector by ID Delete Connector Update Connector Get Certificate Info Get Certificate (Base64) Get SAML Connector IDP Send Message Export SAML Data
Authentication Profiles	Get Authentication Profiles Add Authentication Profile Get Basic Authentication Profiles Get Authentication Profile by ID Delete Authentication Profile Update Authentication Profile
Certification Profiles	Get Certification Profiles Add Certification Profile Get Basic Certification Profiles Get Certification Profile by ID Delete Certification Profile Update Certification Profile
Signing Profiles	Get Signing Profiles Add Signing Profile Get Basic Signing Profiles Get Signing Profile by ID Delete Signing Profile Update Signing Profile
Electronic Seal Profiles	Get Electronic Seal Profiles Add Electronic Seal Profile Get Basic Electronic Seal Profiles Get Electronic Seal Profile by ID Delete Electronic Seal Profile Update Electronic Seal Profile
Verification Profiles	Get Verification Profiles Add Verification Profile Get Basic Verification Profiles Get Verification Profile Delete Verification Profile Update Verification Profile
Virtual ID Profiles	Get Virtual ID Profiles Add Virtual ID Profile Get Basic Virtual ID Profiles Get Virtual ID Profile Delete Virtual ID Profile Update Virtual ID Profile
Service Agreements	Get Service Agreements Add Service Agreement Get Service Agreement by ID Update Service Agreement Delete Service Agreement
License Configuration	Get License Constraints Validate License Expiry Download License Update License Download Base64 License Update Base64 License
Branding	Get Branding Update Branding Get Logo Get Favicon Reset Branding
Instances	Get Instances Get Instance by ID Update Instance Delete Instance Get Status
System Integration	Get System Integrations Get System Integration by ID Update System Integration Delete System Integration Add System Integration Create Client Secret
Service Plan	Get Service Plans Add Service Plan Get Service Plan by ID Update Service Plan Delete Service Plan Clone Service Plan Get Basic Service Plans
Account Management	Get Accounts Get Account by ID Delete Account by ID Update Account Get Account by Email Get Saved Searches Save Search Get Save Search by ID Update Saved Search Delete Saved Search Get Enterprise Users Get Account Alerts Reset Usage Statistics Get User Activity by User ID Check Existing User Unlock User Account Get Account Billing Delete Bulk Account Export Accounts Mark Account as Dormant Archive Account Reset Account Password Change User Service Plan Register User Account Get Admin Account Signing Certificates Add User Signing Certificate Get User Signing Certificate by ID Update User Signing Certificates Delete User Signing Certificates Add User Signing Certificate with Base64 Update User Signing Certificates Base64 Revoke User Signing Certificates
Billing	Get Billings Get Billing Details Get Saved Searches Billing Save Search Update Save Search Delete Saved Searche Get User Information Get Transaction Logs Get Transaction Log Details Export Billing Data Add Manual Billing
Access Control	Get Operators Add Operator Get Operator by ID Update Operator Delete Operator Get Operator Certificate Get Roles Add Role Get Role Operators Get Role by ID Update Role Delete Role
Operator Logs	Get Operator Logs Get Operator Log Details Get Operator Log Searches Add Operator Log Search Delete Operator Log Search Update Operator Log Search Get Admin Activities
Advanced Reports	Get Workspaces Update Workspace Get Power BI Reports Get PowerBI Embed Token
Reports	Get Monthly Registrations Statistics Export Monthly Registrations Statistics Get Monthly Logins Statistics Export Monthly Logins Statistics Get Monthly Workflows Statistics Export Monthly Workflows Statistics Get Monthly Signatures Statistics Export Monthly Signatures Statistics Get Users SMS Usage Statistics Export Sms Usage Statistics Get Billings Statistics Get Billings Detail Get Billings TimeLine Get Top Ten Billings Users Export Billings Statistics Get Service Plans Statistics Export Service Plans Statistics Get Documents Statistics Export Documents Statistics Get Documents TimeLine Get Top Ten Documents Users Get Documents Statuses Get Signature Statistics Export Signatures Statistics Get Signatures TimeLine Get Top Ten Signatures Users Get Signatures Statistics By Types Get Signatures Usage Statistics
User Session API's	Get Operator Update Operator Change Password Get Providers
System Reference API's	Get Branding Logos Get Languages Get Countries Get Time Zones Get Appearances

10.0.4 | Following are the APIs that have been affected by the changes:

New APIs
Updates in existing APIs

New APIs

Reports	Get Signature Signing Servers
Operator Alerts	Get System Alerts Get System Alert Mark System Alerts as Read

Reports

Get Signature Signing Servers

Operator Alerts

Get System Alerts

Get System Alert

Mark System Alerts as Read

Updates in existing APIs

Authentication Profile

Get Authentication Profiles

10.0.3 (Get Authentication Profiles) 10.0.4 (Get Authentication Profiles)

10.0.3 (Get Authentication Profiles)	10.0.4 (Get Authentication Profiles)
From 10.0.4, SigningHub has added a new authentication mechanism PassKey to provide new sign-in option using pass key.
	New mechanism added `"PassKey"`

From 10.0.4, SigningHub has added a new authentication mechanism PassKey to provide new sign-in option using pass key.

New mechanism added

"PassKey"

Add Authentication Profile

10.0.3 (Add Authentication Profile) 10.0.4 (Add Authentication Profile)

10.0.3 (Add Authentication Profile)	10.0.4 (Add Authentication Profile)
From 10.0.4, SigningHub has added a new authentication mechanism PassKey to provide new sign-in option using pass key.
	New mechanism added `"PassKey"`

From 10.0.4, SigningHub has added a new authentication mechanism PassKey to provide new sign-in option using pass key.

New mechanism added

"PassKey"

Update Authentication Profile

10.0.3 (Update Authentication Profile) 10.0.4 (Update Authentication Profile)

10.0.3 (Update Authentication Profile)	10.0.4 (Update Authentication Profile)
From 10.0.4, SigningHub has added a new authentication mechanism PassKey to provide new sign-in option using pass key.
	New mechanism added `"PassKey"`

From 10.0.4, SigningHub has added a new authentication mechanism PassKey to provide new sign-in option using pass key.

New mechanism added

"PassKey"

Authentication

Password Authentication

10.0.3 (Password Authentication) 10.0.4 (Password Authentication)

10.0.3 (Password Authentication)	10.0.4 (Password Authentication)
From 10.0.4, SigningHub has added a new property in response refresh_token to provide refresh token along with access token that user can use to fetch a new access token.
	New property added in response `"refresh_token"`
	New grant_type added in request `"grant_type : refresh_token"`

From 10.0.4, SigningHub has added a new property in response refresh_token to provide refresh token along with access token that user can use to fetch a new access token.

New property added in response

"refresh_token"

New grant_type added in request

"grant_type : refresh_token"

User Session API's

Below are the APIs that are affected by the change.

Get Providers

Get Providers
From 10.0.4, SigningHub has added a new connection provider parameter in response TSA to provide external timestamp server.

Connectors

Below are the APIs that are affected by the change.

Get Connectors

Get Connectors
From 10.0.4, SigningHub has added a new provider in response named TSA to provide timestamp server.

Get Basic Connectors

Get Basic Connectors
From 10.0.4, SigningHub has added a new provider in response named TSA to provide timestamp server.

Get Connector by ID

Get Connector by ID
From 10.0.4, SigningHub has added a new provider in response named TSA to provide timestamp server.

Add Connector

Add Connector
From 10.0.4, SigningHub has added a new provider named TSA to provide timestamp server.

Update Connector

Update Connector
From 10.0.4, SigningHub has added a new provider named TSA to provide timestamp server.

Signing Profiles

Below are the APIs that are affected by the change.

Get Signing Profiles

Get Signing Profiles
From 10.0.4, SigningHub has added a new profile detail in response SIGNATURE_TIMESTAMP_CONNECTOR to provide timestamp server.

Get Signing Profile by ID

Get Signing Profile by ID
From 10.0.4, SigningHub has added a new profile detail in response SIGNATURE_TIMESTAMP_CONNECTOR to provide timestamp server.

Add Signing Profile

Add Signing Profile
From 10.0.4, SigningHub has added a new profile detail in request SIGNATURE_TIMESTAMP_CONNECTOR to provide timestamp server.

Update Signing Profile

Update Signing Profile
From 10.0.4, SigningHub has added a new profile detail in request SIGNATURE_TIMESTAMP_CONNECTOR to provide timestamp server.

Electronic Seal Profiles

Below are the APIs that are affected by the change.

Get Electronic Seal Profiles

Get Electronic Seal Profiles
From 10.0.4, SigningHub has added a new profile detail in response SIGNATURE_TIMESTAMP_CONNECTOR to provide timestamp server.

Get Electronic Seal Profile by ID

Get Electronic Seal Profile by ID
From 10.0.4, SigningHub has added a new profile detail in response SIGNATURE_TIMESTAMP_CONNECTOR to provide timestamp server.

Add Electronic Seal Profile

Add Electronic Seal Profile
From 10.0.4, SigningHub has added a new profile detail in request SIGNATURE_TIMESTAMP_CONNECTOR to provide timestamp server.

Update Electronic Seal Profile

Update Electronic Seal Profile
From 10.0.4, SigningHub has added a new profile detail in request SIGNATURE_TIMESTAMP_CONNECTOR to provide timestamp server.

Reports

Below are the APIs that are affected by the change.

Get Signature Statistics

10.0.3 (Get Signature Statistics) 10.0.4 (Get Signature Statistics)

10.0.3 (Get Signature Statistics)	10.0.4 (Get Signature Statistics)
From 10.0.4, SigningHub has added a new option parameter in request signing-server to provide signing profile id against which data is required.
	New parameter added `"signing-server": "int"`

From 10.0.4, SigningHub has added a new option parameter in request signing-server to provide signing profile id against which data is required.

New parameter added

"signing-server": "int"

Export Signature Statistics

10.0.3 (Export Signature Statistics) 10.0.4 (Export Signature Statistics)

10.0.3 (Export Signature Statistics)	10.0.4 (Export Signature Statistics)
From 10.0.4, SigningHub has added a new option parameter in request signing-server to provide signing profile id against which data is required.
	New parameter added `"signing-server": "int"`

From 10.0.4, SigningHub has added a new option parameter in request signing-server to provide signing profile id against which data is required.

New parameter added

"signing-server": "int"

System Integration

Below are the APIs that are affected by the change.

Get System Integrations

10.0.3 (Get System Integrations) 10.0.4 (Get System Integrations)

10.0.3 (Get System Integrations)	10.0.4 (Get System Integrations)
From 10.0.4, SigningHub has added the new reponse parameters allowed_domains which will be used as a frame-ancestor in CSP.
	New parameter added `"allowed_domains"`

From 10.0.4, SigningHub has added the new reponse parameters allowed_domains which will be used as a frame-ancestor in CSP.

New parameter added

"allowed_domains"

Get System Integration by ID

10.0.3 (Get System Integration by ID) 10.0.4 (Get System Integration by ID)

10.0.3 (Get System Integration by ID)	10.0.4 (Get System Integration by ID)
From 10.0.4, SigningHub has added the new reponse parameters allowed_domains which will be used as a frame-ancestor in CSP.
	New parameter added `"allowed_domains"`

From 10.0.4, SigningHub has added the new reponse parameters allowed_domains which will be used as a frame-ancestor in CSP.

New parameter added

"allowed_domains"

Update System Integration

10.0.3 (Update System Integration) 10.0.4 (Update System Integration)

10.0.3 (Update System Integration)	10.0.4 (Update System Integration)
From 10.0.4, SigningHub has added the new request parameters allowed_domains which will be used as a frame-ancestor in CSP.
	New parameter added `"allowed_domains"`

From 10.0.4, SigningHub has added the new request parameters allowed_domains which will be used as a frame-ancestor in CSP.

New parameter added

"allowed_domains"

Add System Integration

10.0.3 (Add System Integration) 10.0.4 (Add System Integration)

10.0.3 (Add System Integration)	10.0.4 (Add System Integration)
From 10.0.4, SigningHub has added the new request and reponse parameters allowed_domains which will be used as a frame-ancestor in CSP.
	New parameter added `"allowed_domains"`

From 10.0.4, SigningHub has added the new request and reponse parameters allowed_domains which will be used as a frame-ancestor in CSP.

New parameter added

"allowed_domains"

Configurations

Below are the APIs that are affected by the change.

Get System Settings

10.0.3 (Get System Settings)	10.0.4 (Get System Settings)
From 10.0.4, SigningHub has added support of LICENSE_ALERT_ARTIFICIAL_INTELLIGENCE_CONSUMED_QUOTA and respective object is return in response if it is allowed in license

Update System Settings

10.0.3 (Update System Settings)	10.0.4 (Update System Settings)
From 10.0.4, SigningHub has added support of optional parameter LICENSE_ALERT_ARTIFICIAL_INTELLIGENCE_CONSUMED_QUOTA

License Configuration

Below are the APIs that are affected by the change.

Get License Constraints

10.0.3 (Get License Constraints)	10.0.4 (Get License Constraints)
From 10.0.4, SigningHub has added support of LICENSE_ALLOWED_ARTIFICIAL_INTELLIGENCE module and it is return in response if it is allowed in license

Connectors

Below are the APIs that are affected by the change.

Get Connectors

10.0.3 (Get Connectors)	10.0.4 (Get Connectors)
From 10.0.4, SigningHub has added support of Artificial Intelligence (AI) connector if it is allowed in license

Get Connector by ID

10.0.3 (Get Connector by ID)	10.0.4 (Get Connector by ID)
From 10.0.4, SigningHub has added support of Artificial Intelligence (AI) connector if it is allowed in license

Add Connector

10.0.3 (Add Connector)	10.0.4 (Add Connector)
From 10.0.4, SigningHub has added support of Artificial Intelligence (AI) connector if it is allowed in license

Update Connector

10.0.3 (Update Connector)	10.0.4 (Update Connector)
From 10.0.4, SigningHub has added support of Artificial Intelligence (AI) connector if it is allowed in license

Service Plan

Below are the APIs that are affected by the change.

Get Service Plans

10.0.3 (Get Service Plans) 10.0.4 (Get Service Plans)

10.0.3 (Get Service Plans)	10.0.4 (Get Service Plans)
From 10.0.4, SigningHub has added support of artificial_intelligence_tokens under constraints and artificial_intelligence for Artificial Intelligence (AI) configurations.
	New parameter added `"artificial_intelligence_tokens": { "count": 0 }` `"artificial_intelligence": { "enabled": true, "server": "string" }`

From 10.0.4, SigningHub has added support of artificial_intelligence_tokens under constraints and artificial_intelligence for Artificial Intelligence (AI) configurations.

New parameter added

"artificial_intelligence_tokens": { "count": 0 } "artificial_intelligence": { "enabled": true, "server": "string" }

10.0.3 (Get Service Plans) 10.0.4 (Get Service Plans)

10.0.3 (Get Service Plans)	10.0.4 (Get Service Plans)
From 10.0.4, SigningHub has introduced a new feature Stamps feature enables enterprise and personal users to create, manage, and apply digital stamps to documents during signing workflows.
	New feature added `Stamps`

From 10.0.4, SigningHub has introduced a new feature Stamps feature enables enterprise and personal users to create, manage, and apply digital stamps to documents during signing workflows.

New feature added

Stamps

Add Service Plan

10.0.3 (Add Service Plan) 10.0.4 (Add Service Plan)

10.0.3 (Add Service Plan)	10.0.4 (Add Service Plan)
From 10.0.4, SigningHub has added support of artificial_intelligence_tokens under constraints and artificial_intelligence for Artificial Intelligence (AI) configurations.
	New parameter added `"artificial_intelligence_tokens": { "count": 0 }` `"artificial_intelligence": { "enabled": true, "server": "string" }`

From 10.0.4, SigningHub has added support of artificial_intelligence_tokens under constraints and artificial_intelligence for Artificial Intelligence (AI) configurations.

New parameter added

"artificial_intelligence_tokens": { "count": 0 } "artificial_intelligence": { "enabled": true, "server": "string" }

10.0.3 (Add Service Plan) 10.0.4 (Add Service Plan)

10.0.3 (Add Service Plan)	10.0.4 (Add Service Plan)
From 10.0.4, SigningHub has introduced a new feature Stamps feature enables enterprise and personal users to create, manage, and apply digital stamps to documents during signing workflows.
	New feature added `Stamps`

From 10.0.4, SigningHub has introduced a new feature Stamps feature enables enterprise and personal users to create, manage, and apply digital stamps to documents during signing workflows.

New feature added

Stamps

Get Service Plan By Id

10.0.3 (Get Service Plan By Id) 10.0.4 (Get Service Plan By Id)

10.0.3 (Get Service Plan By Id)	10.0.4 (Get Service Plan By Id)
From 10.0.4, SigningHub has added support of artificial_intelligence_tokens under constraints and artificial_intelligence for Artificial Intelligence (AI) configurations.
	New parameter added `"artificial_intelligence_tokens": { "count": 0 }` `"artificial_intelligence": { "enabled": true, "server": "string" }`

From 10.0.4, SigningHub has added support of artificial_intelligence_tokens under constraints and artificial_intelligence for Artificial Intelligence (AI) configurations.

New parameter added

"artificial_intelligence_tokens": { "count": 0 } "artificial_intelligence": { "enabled": true, "server": "string" }

10.0.3 (Get Service Plan By Id) 10.0.4 (Get Service Plan By Id)

10.0.3 (Get Service Plan By Id)	10.0.4 (Get Service Plan By Id)
From 10.0.4, SigningHub has introduced a new feature Stamps feature enables enterprise and personal users to create, manage, and apply digital stamps to documents during signing workflows.
	New feature added `Stamps`

From 10.0.4, SigningHub has introduced a new feature Stamps feature enables enterprise and personal users to create, manage, and apply digital stamps to documents during signing workflows.

New feature added

Stamps

Update Service Plan

10.0.3 (Update Service Plan) 10.0.4 (Update Service Plan)

10.0.3 (Update Service Plan)	10.0.4 (Update Service Plan)
From 10.0.4, SigningHub has added support of artificial_intelligence_tokens under constraints and artificial_intelligence for Artificial Intelligence (AI) configurations.
	New parameter added `"artificial_intelligence_tokens": { "count": 0 }` `"artificial_intelligence": { "enabled": true, "server": "string" }`

From 10.0.4, SigningHub has added support of artificial_intelligence_tokens under constraints and artificial_intelligence for Artificial Intelligence (AI) configurations.

New parameter added

"artificial_intelligence_tokens": { "count": 0 } "artificial_intelligence": { "enabled": true, "server": "string" }

10.0.3 (Update Service Plan) 10.0.4 (Update Service Plan)

10.0.3 (Update Service Plan)	10.0.4 (Update Service Plan)
From 10.0.4, SigningHub has introduced a new feature Stamps feature enables enterprise and personal users to create, manage, and apply digital stamps to documents during signing workflows.
	New feature added `Stamps`

From 10.0.4, SigningHub has introduced a new feature Stamps feature enables enterprise and personal users to create, manage, and apply digital stamps to documents during signing workflows.

New feature added

Stamps

Clone Service Plan

10.0.3 (Clone Service Plan) 10.0.4 (Clone Service Plan)

10.0.3 (Clone Service Plan)	10.0.4 (Clone Service Plan)
From 10.0.4, SigningHub has added support of artificial_intelligence_tokens under constraints and artificial_intelligence for Artificial Intelligence (AI) configurations.
	New parameter added `"artificial_intelligence_tokens": { "count": 0 }` `"artificial_intelligence": { "enabled": true, "server": "string" }`

From 10.0.4, SigningHub has added support of artificial_intelligence_tokens under constraints and artificial_intelligence for Artificial Intelligence (AI) configurations.

New parameter added

"artificial_intelligence_tokens": { "count": 0 } "artificial_intelligence": { "enabled": true, "server": "string" }

10.0.3 (Clone Service Plan) 10.0.4 (Clone Service Plan)

10.0.3 (Clone Service Plan)	10.0.4 (Clone Service Plan)
From 10.0.4, SigningHub has introduced a new feature Stamps feature enables enterprise and personal users to create, manage, and apply digital stamps to documents during signing workflows.
	New feature added `Stamps`

From 10.0.4, SigningHub has introduced a new feature Stamps feature enables enterprise and personal users to create, manage, and apply digital stamps to documents during signing workflows.

New feature added

Stamps

Get Branding

10.0.3 (Get Branding) 10.0.4 (Get Branding)

10.0.3 (Get Branding)	10.0.4 (Get Branding)
From 10.0.4, SigningHub has added the new response parameter status which indicates whether the slider is active or inactive.
	New parameter added `status`

From 10.0.4, SigningHub has added the new response parameter status which indicates whether the slider is active or inactive.

New parameter added

status

Update Branding

10.0.3 (Update Branding) 10.0.4 (Update Branding)

10.0.3 (Update Branding)	10.0.4 (Update Branding)
From 10.0.4, SigningHub has added the new request and response parameter status which indicates whether the slider is active or inactive.
	New parameter added `status`

From 10.0.4, SigningHub has added the new request and response parameter status which indicates whether the slider is active or inactive.

New parameter added

status

Reset Branding

10.0.3 (Reset Branding) 10.0.4 (Reset Branding)

10.0.3 (Reset Branding)	10.0.4 (Reset Branding)
From 10.0.4, SigningHub has added the new response parameter status which indicates whether the slider is active or inactive.
	New parameter added `status`

From 10.0.4, SigningHub has added the new response parameter status which indicates whether the slider is active or inactive.

New parameter added

status

10.0.5 | Following are the APIs that have been affected by the changes:

New APIs
Updates in existing APIs

New APIs

Accounts	Get User Enterprises Assign AI Client to Account Unassign AI Client from Account
AI Client Manager	Get AI Clients Add AI Client Get AI Client by ID Update AI Client Delete AI Client
Configurations	Reset to Default
Identity Verification Profile	Get Identity Verification Profiles Get Basic Identity Verification Profiles Get Identity Verification Profile Add Identity Verification Profile Update Identity Verification Profile Delete Identity Verification Profile Get Identity Verification Provider

Updates in existing APIs

Dashboard

Below are the APIs that are affected by the change.

Get Dashboard

10.0.4 (Get Dashboard)	10.0.5 (Get Dashboard)
From 10.0.5, SigningHub has added support of IDENTITY_VERIFICATION module and it is return in response if it is allowed in license.

License Configuration

Below are the APIs that are affected by the change.

Get License Constraints

10.0.4 (Get License Constraints)	10.0.5 (Get License Constraints)
From 10.0.5, SigningHub has added support of LICENSE_ALLOWED_IDENTITY_VERIFICATION module and it is return in response if it is allowed in license.

Configurations

Below are the APIs that are affected by the change.

Get System Settings

10.0.4 (Get System Settings)	10.0.5 (Get System Settings)
From 10.0.5, SigningHub has added support of LICENSE_ALERT_IDENTITY_VERIFICATION_CONSUMED_QUOTA_ENABLED and LICENSE_ALERT_IDENTITY_VERIFICATION_CONSUMED_QUOTA and respective object is return in response if it is allowed in license

Update System Settings

10.0.4 (Update System Settings)	10.0.5 (Update System Settings)
From 10.0.5, SigningHub has added support of LICENSE_ALERT_IDENTITY_VERIFICATION_CONSUMED_QUOTA_ENABLED and LICENSE_ALERT_IDENTITY_VERIFICATION_CONSUMED_QUOTA

Accounts

Below are the APIs that are affected by the change.

Get Accounts

10.0.4 (Get Accounts) 10.0.5 (Get Accounts)

From 10.0.5, SigningHub introduced a new optional request header parameter, x-detail set true, then return user enterprise details. More over new optional response parameters ai_client_id and service_plan.ai_enabled is added. both will be provided if ARTIFICIAL_INTELLIGENCE is allowed in the license.

New request header parameter added

"x-detail"

New request response parameters added

"ai_client_id" "service_plan.ai_enabled"

Export Accounts

10.0.4 (Export Accounts) 10.0.5 (Export Accounts)

From 10.0.5, SigningHub introduced a new optional request header parameter, x-detail set true, then return user enterprise details.More over AI Client Id is added in the exported file. It will not be provided if Artificial Intelligence (AI) not allowed in the license and service plan.

New request header parameter added

"x-detail"

Get Account by ID

10.0.4 (Get Account by ID)	10.0.5 (Get Account by ID)
From 10.0.5, SigningHub introduced a new optional request header parameter, x-enterprise-id to allow access to a specific enterprise when multiple enterprises are available. Additionally, a new response parameter ai_client_id is added to provide assigned AI Client Id. It will not be provided if Artificial Intelligence (AI) not allowed in the license and service plan. Furthermore, two additional response parameters, enterprise_created_by and enterprise_created_on, have been added to provide information about the enterprise creation.
	New request header parameter added `"x-enterprise-id"` `"ai_client_id"` `"enterprise_created_by"` `"enterprise_created_on"`
From 10.0.5, SigningHub introduced identity_verifications response object under usage_statistics to show cosumed and allowed stats of Identity verification transactions.
	New response object added `"identity_verifications: { "allowed": 0, "consumed": 0 }"`

Get Account by Email

10.0.4 (Get Account by Email)	10.0.5 (Get Account by Email)
From 10.0.5, SigningHub introduced a new optional request header parameter, x-enterprise-id to allow access to a specific enterprise when multiple enterprises are available. Additionally, a new response parameter ai_client_id is added to provide assigned AI Client Id. It will not be provided if Artificial Intelligence (AI) not allowed in the license and service plan. Furthermore, two additional response parameters, enterprise_created_by and enterprise_created_on, have been added to provide information about the enterprise creation.
	New request header parameter added `"x-enterprise-id"` `"ai_client_id"` `"enterprise_created_by"` `"enterprise_created_on"`
From 10.0.5, SigningHub introduced identity_verifications response object under usage_statistics to show cosumed and allowed stats of Identity verification transactions.
	New response object added `"identity_verifications: { "allowed": 0, "consumed": 0 }"`

Reset Usage Statistics

10.0.4 (Reset Usage Statistics) 10.0.5 (Reset Usage Statistics)

From 10.0.5, SigningHub introduced a new optional request header parameter, x-enterprise-id to allow access to a specific enterprise when multiple enterprises are available.

New request header parameter added

"x-enterprise-id"

Get User Activity by User ID

10.0.4 (Get User Activity by User ID) 10.0.5 (Get User Activity by User ID)

From 10.0.5, SigningHub introduced a new optional request header parameter, x-enterprise-id to allow access to a specific enterprise when multiple enterprises are available.

New request header parameter added

"x-enterprise-id"

Get Account Billing

10.0.4 (Get Account Billing) 10.0.5 (Get Account Billing)

From 10.0.5, SigningHub introduced a new optional request header parameter, x-enterprise-id to allow access to a specific enterprise when multiple enterprises are available.

New request header parameter added

"x-enterprise-id"

Update Account

10.0.4 (Update Account) 10.0.5 (Update Account)

From 10.0.5, SigningHub introduced a new optional request header parameter, x-enterprise-id to allow access to a specific enterprise when multiple enterprises are available.

New request header parameter added

"x-enterprise-id"

Change User Service Plan

10.0.4 (Change User Service Plan) 10.0.5 (Change User Service Plan)

From 10.0.5, SigningHub introduced a new optional request header parameter, x-enterprise-id to allow access to a specific enterprise when multiple enterprises are available.

New request header parameter added

"x-enterprise-id"

Get Admin Account Signing Certificates

10.0.4 (Get Admin Account Signing Certificates) 10.0.5 (Get Admin Account Signing Certificates)

From 10.0.5, SigningHub introduced a new optional request header parameter, x-enterprise-id to allow access to a specific enterprise when multiple enterprises are available.

New request header parameter added

"x-enterprise-id"

Get User Signing Certificate by ID

10.0.4 (Get User Signing Certificate by ID) 10.0.5 (Get User Signing Certificate by ID)

From 10.0.5, SigningHub introduced a new optional request header parameter, x-enterprise-id to allow access to a specific enterprise when multiple enterprises are available.

New request header parameter added

"x-enterprise-id"

Add User Signing Certificate

10.0.4 (Add User Signing Certificate) 10.0.5 (Add User Signing Certificate)

From 10.0.5, SigningHub introduced a new optional request header parameter, x-enterprise-id to allow access to a specific enterprise when multiple enterprises are available.

New request header parameter added

"x-enterprise-id"

Update User Signing Certificates Base64

10.0.4 (Update User Signing Certificates Base64) 10.0.5 (Update User Signing Certificates Base64)

From 10.0.5, SigningHub introduced a new optional request header parameter, x-enterprise-id to allow access to a specific enterprise when multiple enterprises are available.

New request header parameter added

"x-enterprise-id"

Update User Signing Certificates

10.0.4 (Update User Signing Certificates) 10.0.5 (Update User Signing Certificates)

From 10.0.5, SigningHub introduced a new optional request header parameter, x-enterprise-id to allow access to a specific enterprise when multiple enterprises are available.

New request header parameter added

"x-enterprise-id"

Delete User Signing Certificates

10.0.4 (Delete User Signing Certificates) 10.0.5 (Delete User Signing Certificates)

From 10.0.5, SigningHub introduced a new optional request header parameter, x-enterprise-id to allow access to a specific enterprise when multiple enterprises are available.

New request header parameter added

"x-enterprise-id"

Revoke User Signing Certificates

10.0.4 (Revoke User Signing Certificates) 10.0.5 (Revoke User Signing Certificates)

From 10.0.5, SigningHub introduced a new optional request header parameter, x-enterprise-id to allow access to a specific enterprise when multiple enterprises are available.

New request header parameter added

"x-enterprise-id"

Billing

Below are the APIs that are affected by the change.

Add Manual Billing

10.0.4 (Add Manual Billing) 10.0.5 (Add Manual Billing)

From 10.0.5, SigningHub introduced a new optional request header parameter, x-enterprise-id to allow access to a specific enterprise when multiple enterprises are available.

New request header parameter added

"x-enterprise-id"

Configurations

Below are the APIs that are affected by the change.

Get System Settings

10.0.4 (Get System Settings)	10.0.5 (Get System Settings)
From 10.0.5, SigningHub introduced a new optional response key, DEFAULT_ARTIFICIAL_INTELLIGENCE_CONNECTOR to provide default connector information of AI server. (It will be provided if ARTIFICIAL_INTELLIGENCE is allowed in the license)
	New optional key added `DEFAULT_ARTIFICIAL_INTELLIGENCE_CONNECTOR`
From 10.0.5, SigningHub introduced a new key to the SystemSetting table for each core thread key, using a postfix as the _VALUE, so that each enterprise can customize their values as per their needs. For example, the email retry thread has a key in SystemSetting to configure the core thread CORE_EMAIL_RETRY_THREAD. Its Cron value will be saved against the same key with the postfix CORE_EMAIL_RETRY_THREAD_VALUE.
Older keys standard CORE_REMINDER_EMAIL_TIME `TIME` CORE_REMINDER_FREQUENCY `DAILY`	New keys standard CORE_REMINDER_THREAD_VALUE `STRINGIFIED JSON` `"attribute_name": "CORE_REMINDER_THREAD_VALUE", "attribute_value": "{\"Mode\":\"DAILY\",\"Value\":\"03:00\"}"`

Update System Settings

10.0.4 (Update System Settings)	10.0.5 (Update System Settings)
From 10.0.5, SigningHub introduced a new optional request key, DEFAULT_ARTIFICIAL_INTELLIGENCE_CONNECTOR to set default connector information of AI server. (It will be accommodated if ARTIFICIAL_INTELLIGENCE is allowed in the license)
	New optional key added `DEFAULT_ARTIFICIAL_INTELLIGENCE_CONNECTOR`
From 10.0.5, SigningHub introduced a new key to the SystemSetting table for each core thread key, using a postfix as the _VALUE, so that each enterprise can customize their values as per their needs. For example, the email retry thread has a key in SystemSetting to configure the core thread CORE_EMAIL_RETRY_THREAD. Its Cron value will be saved against the same key with the postfix CORE_EMAIL_RETRY_THREAD_VALUE.
Older keys standard CORE_REMINDER_EMAIL_TIME `TIME` CORE_REMINDER_FREQUENCY `DAILY`	New keys standard CORE_REMINDER_THREAD_VALUE `STRINGIFIED JSON` `"attribute_name": "CORE_REMINDER_THREAD_VALUE", "attribute_value": "{\"Mode\":\"DAILY\",\"Value\":\"03:00\"}"`

Access Control

Below are the APIs that are affected by the change.

Add Role

10.0.4 (Add Role)	10.0.5 (Add Role)
From 10.0.5, SigningHub introduced a new optional request object with key ARTIFICIAL_INTELLIGENCE for attribute role_detail to enable AI Client Manager for operator roles. (It will be accommodated if ARTIFICIAL_INTELLIGENCE is allowed in the license)
	New optional request object is added `"role_detail":[{"attribute_name":"ARTIFICIAL_INTELLIGENCE","read":true,"add_update":true,"delete":true}]`
From 10.0.5, SigningHub introduced a new optional request object with key IDENTITY_VERIFICATION_PROFILE for attribute role_detail. (It will be accommodated if IDENTITY_VERIFICATION_PROFILE is allowed in the license)
	New optional request object is added `"role_detail":[{"attribute_name":"IDENTITY_VERIFICATION_PROFILE","read":true,"add_update":true,"delete":true}]`

Get Role by ID

10.0.4 (Get Role by ID)	10.0.5 (Get Role by ID)
From 10.0.5, SigningHub introduced a new optional response object with key ARTIFICIAL_INTELLIGENCE for attribute role_detail to provide information about the AI Client Manager configurations for operator roles. (It will be provided if ARTIFICIAL_INTELLIGENCE is allowed in the license)
	New optional response object is added `"role_detail":[{"attribute_name":"ARTIFICIAL_INTELLIGENCE","read":true,"add_update":true,"delete":true}]`
From 10.0.5, SigningHub introduced a new optional response object with key IDENTITY_VERIFICATION_PROFILE for attribute role_detail. (It will be provided if IDENTITY_VERIFICATION_PROFILE is allowed in the license)
	New optional response object is added `"role_detail":[{"attribute_name":"IDENTITY_VERIFICATION_PROFILE","read":true,"add_update":true,"delete":true}]`

Update Role

10.0.4 (Update Role)	10.0.5 (Update Role)
From 10.0.5, SigningHub introduced a new optional request object with key ARTIFICIAL_INTELLIGENCE for attribute role_detail to enable/disable AI Client Manager for operator roles. (It will be accommodated if ARTIFICIAL_INTELLIGENCE is allowed in the license)
	New optional request object is added `"role_detail":[{"attribute_name":"ARTIFICIAL_INTELLIGENCE","read":true,"add_update":true,"delete":true}]`
From 10.0.5, SigningHub introduced a new optional request object with key IDENTITY_VERIFICATION_PROFILE for attribute role_detail. (It will be accommodated if IDENTITY_VERIFICATION_PROFILE is allowed in the license)
	New optional request object is added `"role_detail":[{"attribute_name":"IDENTITY_VERIFICATION_PROFILE","read":true,"add_update":true,"delete":true}]`

Service Plan

Below are the APIs that are affected by the change.

Get Service Plans

10.0.4 (Get Service Plans)	10.0.5 (Get Service Plans)
From 10.0.5, SigningHub has added support of ARTIFICIAL_INTELLIGENCE under features and artificial_intelligence is removed.
	New parameter added `"ARTIFICIAL_INTELLIGENCE"`
	Breaking Change \| Parameter removed `"artificial_intelligence": { "enabled": true, "server": "string" }`
From 10.0.5, SigningHub has added support of remove_ras_key_pair under signature settings for service plans configurations.
	New parameter added `"remove_ras_key_pair": { "enabled": true }`
From 10.0.5, SigningHub has added support of remove_ras_user_on_delete_user under signature settings for service plans configurations.
	New parameter added `"remove_ras_user_on_delete_user": { "enabled": true }`
From 10.0.5, SigningHub has added support of IDENTITY_VERIFICATION.
	New parameter added `"identity_verification": { "enabled": true, "allowed": [{ "id": 0, "name": "string" }]}`

Add Service Plan

10.0.4 (Add Service Plan)	10.0.5 (Add Service Plan)
From 10.0.5, SigningHub has added support of ARTIFICIAL_INTELLIGENCE under features and artificial_intelligence is removed.
	New parameter added `"ARTIFICIAL_INTELLIGENCE"`
	Breaking Change \| Parameter removed `"artificial_intelligence": { "enabled": true, "server": "string" }`
From 10.0.5, SigningHub has added support of remove_ras_key_pair under signature settings for service plans configurations.
	New parameter added `"remove_ras_key_pair": { "enabled": true }`
From 10.0.5, SigningHub has added support of remove_ras_user_on_delete_user under signature settings for service plans configurations.
	New parameter added `"remove_ras_user_on_delete_user": { "enabled": true }`
From 10.0.5, SigningHub has added support of IDENTITY_VERIFICATION.
	New parameter added `"identity_verification": { "enabled": true, "allowed": [{ "name": "string" }]}`

Get Service Plan By Id

10.0.4 (Get Service Plan By Id)	10.0.5 (Get Service Plan By Id)
From 10.0.5, SigningHub has added support of ARTIFICIAL_INTELLIGENCE under features and artificial_intelligence is removed.
	New parameter added `"ARTIFICIAL_INTELLIGENCE"`
	Breaking Change \| Parameter removed `"artificial_intelligence": { "enabled": true, "server": "string" }`
From 10.0.5, SigningHub has added support of remove_ras_key_pair under signature settings for service plans configurations.
	New parameter added `"remove_ras_key_pair": { "enabled": true }`
From 10.0.5, SigningHub has added support of remove_ras_user_on_delete_user under signature settings for service plans configurations.
	New parameter added `"remove_ras_user_on_delete_user": { "enabled": true }`
From 10.0.5, SigningHub has added support of IDENTITY_VERIFICATION.
	New parameter added `"identity_verification": { "enabled": true, "allowed": [{ "id": 0, "name": "string" }]}`

Update Service Plan

10.0.4 (Update Service Plan)	10.0.5 (Update Service Plan)
From 10.0.5, SigningHub has added support of ARTIFICIAL_INTELLIGENCE under features and artificial_intelligence is removed.
	New parameter added `"ARTIFICIAL_INTELLIGENCE"`
	Breaking Change \| Parameter removed `"artificial_intelligence": { "enabled": true, "server": "string" }`
From 10.0.5, SigningHub has added support of remove_ras_key_pair under signature settings for service plans configurations.
	New parameter added `"remove_ras_key_pair": { "enabled": true }`
From 10.0.5, SigningHub has added support of remove_ras_user_on_delete_user under signature settings for service plans configurations.
	New parameter added `"remove_ras_user_on_delete_user": { "enabled": true }`
From 10.0.5, SigningHub has added support of IDENTITY_VERIFICATION.
	New parameter added `"identity_verification": { "enabled": true, "allowed": [{ "name": "string" }]}`

Clone Service Plan

10.0.4 (Clone Service Plan)	10.0.5 (Clone Service Plan)
From 10.0.5, SigningHub has added support of ARTIFICIAL_INTELLIGENCE under features and artificial_intelligence is removed.
	New parameter added `"ARTIFICIAL_INTELLIGENCE"`
	Breaking Change \| Parameter removed `"artificial_intelligence": { "enabled": true, "server": "string" }`
From 10.0.5, SigningHub has added support of remove_ras_key_pair under signature settings for service plans configurations.
	New parameter added `"remove_ras_key_pair": { "enabled": true }`
From 10.0.5, SigningHub has added support of remove_ras_user_on_delete_user under signature settings for service plans configurations.
	New parameter added `"remove_ras_user_on_delete_user": { "enabled": true }`
From 10.0.5, SigningHub has added support of IDENTITY_VERIFICATION.
	New parameter added `"identity_verification": { "enabled": true, "allowed": [{ "id": 0, "name": "string" }]}`

Authentication Profiles

Below are the APIs that are affected by the change.

Get Authentication Profile by ID

10.0.4 (Get Authentication Profile by ID) 10.0.5 (Get Authentication Profile by ID)

From 10.0.5, SigningHub removed the profile_detail_value nested array from each profile_detail item in the response. The CONTAINER and DOMAIN values (previously nested inside a DOMAIN_ATTRIBUTES entry via profile_detail_value) are now returned as flat profile_detail entries with attribute_name set to "CONTAINER" or "DOMAIN" respectively.

Response included nested array

"profile_detail_value": [{ "attribute_name": "CONTAINER", "attribute_value": "..." }, { "attribute_name": "DOMAIN", "attribute_value": "..." }]

Flat profile_detail entries returned instead

{ "attribute_name": "CONTAINER", "attribute_value": "..." }
{ "attribute_name": "DOMAIN", "attribute_value": "..." }

DOMAIN_ATTRIBUTES entry present

{ "attribute_name": "DOMAIN_ATTRIBUTES", "attribute_value": "", "profile_detail_value": [...] }

DOMAIN_ATTRIBUTES entry removed

Add Authentication Profile

10.0.4 (Add Authentication Profile) 10.0.5 (Add Authentication Profile)

From 10.0.5, SigningHub removed the profile_detail_value nested array from the request body. The CONTAINER and DOMAIN values must now be sent as flat profile_detail entries with attribute_name set to "CONTAINER" or "DOMAIN" respectively, instead of nesting them inside a DOMAIN_ATTRIBUTES entry via profile_detail_value.

Request used nested array

{ "attribute_name": "DOMAIN_ATTRIBUTES", "profile_detail_value": [{ "attribute_name": "CONTAINER", "attribute_value": "..." }, { "attribute_name": "DOMAIN", "attribute_value": "..." }] }

Flat profile_detail entries required instead

{ "attribute_name": "CONTAINER", "attribute_value": "..." }
{ "attribute_name": "DOMAIN", "attribute_value": "..." }

Update Authentication Profile

10.0.4 (Update Authentication Profile) 10.0.5 (Update Authentication Profile)

Request used nested array

{ "attribute_name": "DOMAIN_ATTRIBUTES", "profile_detail_value": [{ "attribute_name": "CONTAINER", "attribute_value": "..." }, { "attribute_name": "DOMAIN", "attribute_value": "..." }] }

Flat profile_detail entries required instead

{ "attribute_name": "CONTAINER", "attribute_value": "..." }
{ "attribute_name": "DOMAIN", "attribute_value": "..." }

Connectors

Below are the APIs that are affected by the change.

Get Connectors

From 10.0.5, SigningHub has support of IDENTITY_VERIFICATION provider in the response.
	`{ "provider": "IDENTITY_VERIFICATION", "connector_detail": [] }`

Get Basic Connectors

From 10.0.5, SigningHub has support of IDENTITY_VERIFICATION provider in the response.
	`{ "provider": "IDENTITY_VERIFICATION" }`

Get Connector by ID

From 10.0.5, SigningHub has support of IDENTITY_VERIFICATION provider in the response.
	`{ "provider": "IDENTITY_VERIFICATION", "connector_detail": [] }`

Add Connector

From 10.0.5, SigningHub has support of IDENTITY_VERIFICATION provider in the request.
	`{ "provider": "IDENTITY_VERIFICATION", "connector_detail": [] }`

Update Connector

From 10.0.5, SigningHub has support of IDENTITY_VERIFICATION provider in the request.
	`{ "provider": "IDENTITY_VERIFICATION", "connector_detail": [] }`

User Session API's

Below are the APIs that are affected by the change.

Get Providers

From 10.0.5, SigningHub has added a new connection provider parameter in response IDENTITY_VERIFICATION to provide identity verifications.

10.0.6 | Following are the APIs that have been affected by the changes:

New APIs
Updates in existing APIs

New APIs

Policy

Accounts

Get Enterprise Log Detail

Get Guest User Info

Updates in existing APIs

Configurations

Below are the APIs that are affected by the change.

Get System Settings

10.0.5 (Get System Settings) 10.0.6 (Get System Settings)

From version 10.0.6, SigningHub introduces support for hiding the “Can’t access your account?” option in the application and configuring a custom “Forgot/Reset Password” URL. These settings allow administrators to control the visibility of the password recovery option on the SigningHub login screen and define a custom URL for password reset redirection. When the “Hide the forgot/reset password option” setting is enabled, the “Can’t access your account?” option is removed from the login screen. If a “Forgot/Reset Password URL” is configured, users are redirected to the specified URL when initiating a password reset.

New response parameters added

"HIDE_FORGOT_RESET_PASSWORD_OPTION"
"FORGOT_RESET_PASSWORD_BASEURL"

10.0.5 (Get System Settings) 10.0.6 (Get System Settings)

From version 10.0.6, SigningHub introduces support for the Authentication Flow. It supports two modes: POPUP and REDIRECT. Selecting REDIRECT redirects the user to the authentication page, while selecting POPUP opens the authentication page in a popup window.

New response parameter added

"USER_AUTHENTICATION_FLOW"

Update System Settings

10.0.5 (Update System Settings) 10.0.6 (Update System Settings)

New request parameters added

"HIDE_FORGOT_RESET_PASSWORD_OPTION"
"FORGOT_RESET_PASSWORD_BASEURL"

10.0.5 (Update System Settings) 10.0.6 (Update System Settings)

New request parameter added

"USER_AUTHENTICATION_FLOW"

Possible key values are

Key: "POPUP" Value: "Pop-up"
Key: "REDIRECT" Value: "Redirect"

Account Management

Below are the APIs that are affected by the change.

Reset Account Password

10.0.5 (Reset Account Password)	10.0.6 (Reset Account Password)
From version 10.0.6, SigningHub provides support for configuring a custom password reset URL. A new field, “Forgot/Reset Password URL”, has been added in SigningHub Admin under Password Settings. When configured, this URL is used as the base URL for password reset workflows.

Update Guest Account

10.0.5 (Update Guest Account) 10.0.6 (Update Guest Account)

From version 10.0.6, SigningHub also provides support for updating the mobile number and NID of guest users.

New request parameter added

"mobile_number":"string"

"national_id":"string"

Service Plan

Below are the APIs that are affected by the change.

Add Service Plan

10.0.5 (Add Service Plan)	10.0.6 (Add Service Plan)
From version 10.0.6, auto_delete_document attributes have been moved under basic inside auto_delete_document and a new object advanced for advnaced document deletion has been introduced, alongside, in which different policies can be configured.
`"auto_delete_document": { "enabled": true, "duration": 0, "notify": { "enabled": true, "duration": 0 }, "email_document": { "enabled": true, "workflow_evidence_report": true } }`	`"auto_delete_document": { "basic": { "enabled": true, "duration": 0, "notify": { "enabled": true, "duration": 0 }, "email_document": { "enabled": true, "workflow_evidence_report": true } }, "advanced": { "enabled": true, "policies": "string" } }`

Update Service Plan

10.0.5 (Update Service Plan)	10.0.6 (Update Service Plan)
From version 10.0.6, auto_delete_document attributes have been moved under basic inside auto_delete_document and a new object advanced for advnaced document deletion has been introduced, alongside, in which different policies can be configured.
`"auto_delete_document": { "enabled": true, "duration": 0, "notify": { "enabled": true, "duration": 0 }, "email_document": { "enabled": true, "workflow_evidence_report": true } }`	`"auto_delete_document": { "basic": { "enabled": true, "duration": 0, "notify": { "enabled": true, "duration": 0 }, "email_document": { "enabled": true, "workflow_evidence_report": true } }, "advanced": { "enabled": true, "policies": "string" } }`

Get All Service Plans

10.0.5 (Get All Service Plans)	10.0.6 (Get All Service Plans)
From version 10.0.6, auto_delete_document attributes have been moved under basic inside auto_delete_document and a new object advanced for advnaced document deletion has been introduced, alongside, representing the configured policies.
`"auto_delete_document": { "enabled": true, "duration": 0, "notify": { "enabled": true, "duration": 0 }, "email_document": { "enabled": true, "workflow_evidence_report": true } }`	`"auto_delete_document": { "basic": { "enabled": true, "duration": 0, "notify": { "enabled": true, "duration": 0 }, "email_document": { "enabled": true, "workflow_evidence_report": true } }, "advanced": { "enabled": true, "policies": "string" } }`

Get Service Plan by Id

10.0.5 (Get Service Plan by Id)	10.0.6 (Get Service Plan by Id)
From version 10.0.6, auto_delete_document attributes have been moved under basic inside auto_delete_document and a new object advanced for advnaced document deletion has been introduced, alongside, representing the configured policies.
`"auto_delete_document": { "enabled": true, "duration": 0, "notify": { "enabled": true, "duration": 0 }, "email_document": { "enabled": true, "workflow_evidence_report": true } }`	`"auto_delete_document": { "basic": { "enabled": true, "duration": 0, "notify": { "enabled": true, "duration": 0 }, "email_document": { "enabled": true, "workflow_evidence_report": true } }, "advanced": { "enabled": true, "policies": "string" } }`

Clone Service Plan

10.0.5 (Clone Service Plan)	10.0.6 (Clone Service Plan)
From version 10.0.6, auto_delete_document attributes have been moved under basic inside auto_delete_document and a new object advanced for advnaced document deletion has been introduced, alongside, representing the configured policies.
`"auto_delete_document": { "enabled": true, "duration": 0, "notify": { "enabled": true, "duration": 0 }, "email_document": { "enabled": true, "workflow_evidence_report": true } }`	`"auto_delete_document": { "basic": { "enabled": true, "duration": 0, "notify": { "enabled": true, "duration": 0 }, "email_document": { "enabled": true, "workflow_evidence_report": true } }, "advanced": { "enabled": true, "policies": "string" } }`

Branding

Below are the APIs that are affected by the change.

Get Branding

10.0.5 (Get Branding) 10.0.6 (Get Branding)

From version 10.0.6, SigningHub supports multilingual branding content through the new translated_content response parameter, which contains a list of localizations and their respective content. For backward compatibility, the existing content parameter remains unchanged and continues to return the default branding content. From version 10.0.6 onward, all translated branding content is returned through the translated_content parameter.

New response parameter added

"translated_content": {"localizations": [{"locale": "string","content": "string"}]}

Update Branding

10.0.5 (Update Branding) 10.0.6 (Update Branding)

From version 10.0.6, SigningHub supports multilingual branding content through the new translated_content parameter, which contains a list of localizations and their respective content. The existing content parameter is no longer used for updating branding content. From version 10.0.6 onward, translated branding content must be provided through the translated_content parameter, and the response returns the configured localized content.

New request parameter added

{"order": 1,"status": true,"translated_content":{"localizations":[{"locale":'en-US',"content":'string'}]}}

New response parameter added

{"order": 1,"status": true,"translated_content":{"localizations":[{"locale":'en-US',"content":'string'}]}}

Reset Branding

10.0.5 (Reset Branding) 10.0.6 (Reset Branding)

New response parameter added

{"order": 1,"status": true,"translated_content":{"localizations":[{"locale":'en-US',"content":'string'}]}}

APIs Developer Guide

The APIs Developer Guide provides the information required to integrate with and use the SigningHub Admin APIs effectively. It includes guidance on authentication, authorization, request and response formats, error handling, best practices, and common integration workflows to help developers build secure and reliable applications using SigningHub services.

Appendix

Country List

The key/value pairs for country references that SigningHub recognizes. These are used in various API calls.

"Afghanistan": "Afghanistan",
"Aland Islands": "Aland Islands",
"Albania": "Albania",
"Algeria": "Algeria",
"American Samoa": "American Samoa",
"Andorra": "Andorra",
"Angola": "Angola",
"Anguilla": "Anguilla",
"Antarctica": "Antarctica",
"Antigua and Barbuda": "Antigua and Barbuda",
"Argentina": "Argentina",
"Armenia": "Armenia",
"Aruba": "Aruba",
"Australia": "Australia",
"Austria": "Austria",
"Azerbaijan": "Azerbaijan",
"Bahamas": "Bahamas",
"Bahrain": "Bahrain",
"Bangladesh": "Bangladesh",
"Barbados": "Barbados",
"Belarus": "Belarus",
"Belgium": "Belgium",
"Belize": "Belize",
"Benin": "Benin",
"Bermuda": "Bermuda",
"Bouvet Island": "Bouvet Island",
"Bhutan": "Bhutan",
"Bolivia": "Bolivia",
"Bosnia and Herzegovina": "Bosnia and Herzegovina",
"Botswana": "Botswana",
"Brazil": "Brazil",
"British Indian Ocean Territory": "British Indian Ocean Territory",
"British Virgin Islands": "British Virgin Islands",
"Brunei": "Brunei",
"Bulgaria": "Bulgaria",
"Burkina Faso": "Burkina Faso",
"Burundi": "Burundi",
"Cambodia": "Cambodia",
"Cameroon": "Cameroon",
"Canada": "Canada",
"Cape Verde": "Cape Verde",
"Cayman Islands": "Cayman Islands",
"Central African Republic": "Central African Republic",
"Chad": "Chad",
"Chile": "Chile",
"China": "China",
"Christmas Island": "Christmas Island",
"Cocos-Keeling-Islands": "Cocos-Keeling-Islands",
"Colombia": "Colombia",
"Comoros": "Comoros",
"Congo": "Congo",
"Cook Islands": "Cook Islands",
"Costa Rica": "Costa Rica",
"Croatia": "Croatia",
"Cuba": "Cuba",
"Cyprus": "Cyprus",
"Czech Republic": "Czech Republic",
"Denmark": "Denmark",
"Democratic Republic of Congo": "Democratic Republic of Congo",
"Djibouti": "Djibouti",
"Dominica": "Dominica",
"Dominican Republic": "Dominican Republic",
"East Timor": "East Timor",
"Ecuador": "Ecuador",
"Egypt": "Egypt",
"El Salvador": "El Salvador",
"Equatorial Guinea": "Equatorial Guinea",
"Eritrea": "Eritrea",
"Estonia": "Estonia",
"Ethiopia": "Ethiopia",
"Falkland Islands": "Falkland Islands",
"Faroe Islands": "Faroe Islands",
"Federated States of Micronesia": "Federated States of Micronesia",
"Fiji": "Fiji",
"Finland": "Finland",
"France": "France",
"French Guiana": "French Guiana",
"French Polynesia": "French Polynesia",
"French Southern and Antarctic Lands": "French Southern and Antarctic Lands",
"Gabon": "Gabon",
"Gambia": "Gambia",
"Georgia": "Georgia",
"Germany": "Germany",
"Ghana": "Ghana",
"Gibraltar": "Gibraltar",
"Greece": "Greece",
"Greenland": "Greenland",
"Grenada": "Grenada",
"Guadeloupe": "Guadeloupe",
"Guam": "Guam",
"Guatemala": "Guatemala",
"Guernsey": "Guernsey",
"Guinea": "Guinea",
"Guinea-Bissau": "Guinea-Bissau",
"Guyana": "Guyana",
"HeardIs land and Mcdonald Islands": "HeardIs land and Mcdonald Islands",
"Haiti": "Haiti",
"Honduras": "Honduras",
"Hong Kong": "Hong Kong",
"Hungary": "Hungary",
"Iceland": "Iceland",
"India": "India",
"Indonesia": "Indonesia",
"Iran": "Iran",
"Iraq": "Iraq",
"Ireland": "Ireland",
"Isle of Man": "Isle of Man",
"Israel": "Israel",
"Italy": "Italy",
"CôtedIvoire": "CôtedIvoire",
"Jamaica": "Jamaica",
"Japan": "Japan",
"Jersey": "Jersey",
"Jordan": "Jordan",
"Kazakhstan": "Kazakhstan",
"Kenya": "Kenya",
"Kiribati": "Kiribati",
"Kuwait": "Kuwait",
"Kyrgyzstan": "Kyrgyzstan",
"Laos": "Laos",
"Latvia": "Latvia",
"Lebanon": "Lebanon",
"Lesotho": "Lesotho",
"Liberia": "Liberia",
"Libya": "Libya",
"Liechtenstein": "Liechtenstein",
"Lithuania": "Lithuania",
"Luxembourg": "Luxembourg",
"Macau": "Macau",
"Macedonia": "Macedonia",
"Madagascar": "Madagascar",
"Malawi": "Malawi",
"Malaysia": "Malaysia",
"Maldives": "Maldives",
"Mali": "Mali",
"Malta": "Malta",
"Marshall Islands": "Marshall Islands",
"Mauritania": "Mauritania",
"Mauritius": "Mauritius",
"Mayotte": "Mayotte",
"Mexico": "Mexico",
"Micronesia": "Micronesia",
"Moldova": "Moldova",
"Monaco": "Monaco",
"Mongolia": "Mongolia",
"Montenegro": "Montenegro",
"Morocco": "Morocco",
"Montserrat": "Montserrat",
"Mozambique": "Mozambique",
"Myanmar": "Myanmar",
"Namibia": "Namibia",
"Nauru": "Nauru",
"Nepal": "Nepal",
"Netherlands": "Netherlands",
"Netherlands Antilles": "Netherlands Antilles",
"New Caledonia": "New Caledonia",
"New Zealand": "New Zealand",
"Nicaragua": "Nicaragua",
"Niger": "Niger",
"Nigeria": "Nigeria",
"Niue": "Niue",
"Norfolk Island": "Norfolk Island",
"Northern Mariana Islands": "Northern Mariana Islands",
"North Korea": "North Korea",
"Norway": "Norway",
"Oman": "Oman",
"Pakistan": "Pakistan",
"Palau": "Palau",
"Panama": "Panama",
"Papua New Guinea": "Papua New Guinea",
"Paraguay": "Paraguay",
"Peru": "Peru",
"Philippines": "Philippines",
"Pitcairn Islands": "Pitcairn Islands",
"Palestinian Occupied Territories": "Palestinian Occupied Territories",
"Poland": "Poland",
"Portugal": "Portugal",
"Puerto Rico": "Puerto Rico",
"Qatar": "Qatar",
"Reunion": "Reunion",
"Romania": "Romania",
"Russia": "Russia",
"Rwanda": "Rwanda",
"Saint Barthélemy": "Saint Barthélemy",
"Saint Kitts and Nevis": "Saint Kitts and Nevis",
"Saint Lucia": "Saint Lucia",
"Saint Vincent and the Grenadines": "Saint Vincent and the Grenadines",
"Samoa": "Samoa",
"San Marino": "San Marino",
"São Tomé and Príncipe": "São Tomé and Príncipe",
"Saudi Arabia": "Saudi Arabia",
"Senegal": "Senegal",
"Serbia": "Serbia",
"Serbiaand Montenegro": "Serbiaand Montenegro",
"Seychelles": "Seychelles",
"Sierra Leone": "Sierra Leone",
"Singapore": "Singapore",
"Slovakia": "Slovakia",
"Slovenia": "Slovenia",
"Solomon Islands": "Solomon Islands",
"Somalia": "Somalia",
"South Africa": "South Africa",
"South Korea": "South Korea",
"Spain": "Spain",
"Sri Lanka": "Sri Lanka",
"Saint Helena Ascension and Tristanda Cunha": "Saint Helena Ascension and Tristanda Cunha",
"Saint Pierre and Miquelon": "Saint Pierre and Miquelon",
"Sudan": "Sudan",
"Suriname": "Suriname",
"Svalbard and Jan Mayen": "Svalbard and Jan Mayen",
"Swaziland": "Swaziland",
"Sweden": "Sweden",
"Switzerland": "Switzerland",
"Syria": "Syria",
"Taiwan": "Taiwan",
"Tajikistan": "Tajikistan",
"Tanzania": "Tanzania",
"Thailand": "Thailand",
"Togo": "Togo",
"Tokelau": "Tokelau",
"Tonga": "Tonga",
"Tunisia": "Tunisia",
"Trinidad and Tobago": "Trinidad and Tobago",
"Turkey": "Turkey",
"Turkmenistan": "Turkmenistan",
"Turks And Caicos Islands": "Turks And Caicos Islands",
"Tuvalu": "Tuvalu",
"United Arab Emirates": "United Arab Emirates",
"Uganda": "Uganda",
"United Kingdom": "United Kingdom",
"Ukraine": "Ukraine",
"Uruguay": "Uruguay",
"United States": "United States",
"US Virgin Islands": "US Virgin Islands",
"Uzbekistan": "Uzbekistan",
"Vanuatu": "Vanuatu",
"Vatican City State": "Vatican City State",
"Venezuela": "Venezuela",
"Vietnam": "Vietnam",
"Wallis and Futuna": "Wallis and Futuna",
"Western Sahara": "Western Sahara",
"Yemen": "Yemen",
"Zambia": "Zambia",
"Zimbabwe": "Zimbabwe"

Timezone List

The key/value pairs for time zones that SigningHub recognizes. These are used in various API calls.

{
"Dateline Standard Time": "(UTC-12:00) International Date Line West ",
"Samoa Standard Time": "(UTC-11:00) Midway Island, Samoa",
"Hawaiian Standard Time": "(UTC-10:00) Hawaii",
"Alaskan Standard Time": "(UTC-09:00) Alaska",
"Pacific Standard Time": "(UTC-08:00) Pacific Time (US & Canada)",
"Pacific Standard Time (Mexico)": "(UTC-08:00) Tijuana, Baja California",
"US Mountain Standard Time": "(UTC-07:00) Arizona",
"Mountain Standard Time (Mexico)": "(UTC-07:00) Chihuahua, La Paz, Mazatlan",
"Mountain Standard Time": "(UTC-07:00) Mountain Time (US & Canada)",
"Central America Standard Time": "(UTC-06:00) Central America",
"Central Standard Time": "(UTC-06:00) Central Time (US & Canada)",
"Central Standard Time (Mexico)": "(UTC-06:00) Guadalajara, Mexico City, Monterrey",
"Canada Central Standard Time": "(UTC-06:00) Saskatchewan",
"SA Pacific Standard Time": "(UTC-05:00) Bogota, Lima, Quito",
"Eastern Standard Time": "(UTC-05:00) Eastern Time (US & Canada)",
"US Eastern Standard Time": "(UTC-05:00) Indiana (East)",
"Venezuela Standard Time": "(UTC-04:00) Caracas",
"Paraguay Standard Time": "(UTC-04:00) Asuncion",
"Atlantic Standard Time": "(UTC-04:00) Atlantic Time (Canada)",
"SA Western Standard Time": "(UTC-04:00) Georgetown, La Paz, San Juan",
"Central Brazilian Standard Time": "(UTC-04:00) Manaus",
"Pacific SA Standard Time": "(UTC-04:00) Santiago",
"Newfoundland Standard Time": "(UTC-03:30) Newfoundland",
"E. South America Standard Time": "(UTC-03:00) Brasilia",
"Argentina Standard Time": "(UTC-03:00) Buenos Aires",
"SA Eastern Standard Time": "(UTC-03:00) Cayenne",
"Greenland Standard Time": "(UTC-03:00) Greenland",
"Montevideo Standard Time": "(UTC-03:00) Montevideo",
"Mid-Atlantic Standard Time": "(UTC-02:00) Mid-Atlantic",
"Azores Standard Time": "(UTC-01:00) Azores",
"Cabo Verde Standard Time": "(UTC-01:00) Cape Verde Is.",
"Morocco Standard Time": "(UTC) Casablanca",
"Coordinated Universal Time": "(UTC) Coordinated Universal Time",
"GMT Standard Time": "(UTC) Dublin, Edinburgh, Lisbon, London, Saint Helier, St. Peter Port",
"W. Europe Standard Time": "(UTC+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna",
"Central Europe Standard Time": "(UTC+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague",
"Romance Standard Time": "(UTC+01:00) Brussels, Copenhagen, Madrid, Paris",
"Central European Standard Time": "(UTC+01:00) Sarajevo, Skopje, Warsaw, Zagreb",
"W. Central Africa Standard Time": "(UTC+01:00) West Central Africa",
"Jordan Standard Time": "(UTC+02:00) Amman",
"GTB Standard Time": "(UTC+02:00) Athens, Bucharest, Istanbul",
"Middle East Standard Time": "(UTC+02:00) Beirut",
"Egypt Standard Time": "(UTC+02:00) Cairo",
"South Africa Standard Time": "(UTC+02:00) Harare, Pretoria",
"FLE Standard Time": "(UTC+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius",
"Jerusalem Standard Time": "(UTC+02:00) Jerusalem",
"E. Europe Standard Time": "(UTC+02:00) Minsk",
"Namibia Standard Time": "(UTC+02:00) Windhoek",
"Arabic Standard Time": "(UTC+03:00) Baghdad",
"Arab Standard Time": "(UTC+03:00) Kuwait, Riyadh",
"Russia TZ 2 Standard Time": "(UTC+03:00) Moscow, St. Petersburg, Volgograd",
"E. Africa Standard Time": "(UTC+03:00) Nairobi",
"Russia TZ 3 Standard Time": "(UTC+04:00) Izhevsk, Samara",
"Georgian Standard Time": "(UTC+04:00) Tbilisi",
"Iran Standard Time": "(UTC+03:30) Tehran",
"Arabian Standard Time": "(UTC+04:00) Abu Dhabi, Muscat",
"Azerbaijan Standard Time": "(UTC+04:00) Baku",
"Mauritius Standard Time": "(UTC+04:00) Port Louis",
"Caucasus Standard Time": "(UTC+04:00) Yerevan",
"Afghanistan Standard Time": "(UTC+04:30) Kabul",
"Russia TZ 4 Standard Time": "(UTC+05:00) Ekaterinburg",
"Pakistan Standard Time": "(UTC+05:00) Islamabad, Karachi",
"West Asia Standard Time": "(UTC+05:00) Tashkent",
"India Standard Time": "(UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi",
"Sri Lanka Standard Time": "(UTC+05:30) Sri Jayawardenepura",
"Nepal Standard Time": "(UTC+05:45) Kathmandu",
"Novosibirsk Standard Time": "(UTC+06:00) Almaty, Novosibirsk",
"Central Asia Standard Time": "(UTC+06:00) Astana, Dhaka",
"Myanmar Standard Time": "(UTC+06:30) Yangon (Rangoon)",
"SE Asia Standard Time": "(UTC+07:00) Bangkok, Hanoi, Jakarta",
"Russia TZ 6 Standard Time": "(UTC+07:00) Krasnoyarsk",
"China Standard Time": "(UTC+08:00) Beijing, Chongqing, Hong Kong, Urumqi",
"Russia TZ 7 Standard Time": "(UTC+08:00) Irkutsk, Ulaan Bataar",
"Malay Peninsula Standard Time": "(UTC+08:00) Kuala Lumpur, Singapore",
"W. Australia Standard Time": "(UTC+08:00) Perth",
"Taipei Standard Time": "(UTC+08:00) Taipei",
"Tokyo Standard Time": "(UTC+09:00) Osaka, Sapporo, Tokyo",
"Korea Standard Time": "(UTC+09:00) Seoul",
"Russia TZ 8 Standard Time": "(UTC+09:00) Yakutsk",
"Cen. Australia Standard Time": "(UTC+09:30) Adelaide",
"AUS Central Standard Time": "(UTC+09:30) Darwin",
"E. Australia Standard Time": "(UTC+10:00) Brisbane",
"AUS Eastern Standard Time": "(UTC+10:00) Canberra, Melbourne, Sydney",
"West Pacific Standard Time": "(UTC+10:00) Guam, Port Moresby",
"Tasmania Standard Time": "(UTC+10:00) Hobart",
"Russia TZ 9 Standard Time": "(UTC+10:00) Vladivostok",
"Central Pacific Standard Time": "(UTC+11:00) Magadan, Solomon Is., New Caledonia",
"New Zealand Standard Time": "(UTC+12:00) Auckland, Wellington",
"Fiji Standard Time": "(UTC+12:00) Fiji, Marshall Is.",
"Kamchatka Standard Time": "(UTC+12:00) Petropavlovsk-Kamchatsky",
"Tonga Standard Time": "(UTC+13:00) Nuku'alofa",
"Bahia Standard Time": "(UTC-03:00) Salvador",
"Syria Standard Time": "(UTC+02:00) Damascus",
"Magadan Standard Time": "(UTC+12:00) Magadan",
"Ulaanbaatar Standard Time": "(UTC+08:00) Ulaanbaatar",
"Bangladesh Standard Time": "(UTC+06:00) Dhaka"
}

Supported Languages

The key/value pairs for country codes that SigningHub recognizes . These are used in various API calls and for setting the language preference when using tight integration iframe functionality.

"en-US" : "English",
"nl-NL" : "Nederlands",
"es-ES" : "Español (ES)",
"es-LA" : "Español (LA)",
"fr-FR" : "Français",
"de-DE" : "Deutsch",
"ar-AE" : "العربية",
"tr-TR" : "Türkçe",
"lv-LV" : "Latviski",
"nb-NO" : "Norsk",
"el-GR" : "ελληνικά",
"hi-IN" : "हिंदी",
"id-ID" : "Bahasa Indonesia",
"ja-JP" : "日本語",
"pt-Pt" : "Português (PT)",
"pt-BR" : "Português (Brasil)",
"ro-RO" : "Română",
"ru-RU" : "Pусский",
"sr-CR" : "Srpski",
"th-TH" : "ภาษาไทย",
"vi-VN" : "Tiếng Việt",
"it-IT" : "Italian",
"fi-FI" : "Finnish",
"et-ET" : "Estonian",
"pl-PL" : "Polish",
"sv-SE" : "Swedish",
"da-DK" : "Danish",
"ar-DZ" : "Algeria",
"hu-HU" : "Hungarian",
"ka-KA" : "Georgian",
"zh-CN" : "简体中文",
"zh-TW" : "繁体中文",
"ko-KR" : "한국"