SigningHub 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 Tokens ➤ Quick Integration ➤ Updates ➤ SignalR ➤ APIs Developer Guide ➤ Appendix	➤ Authentication ➤ Account Management ➤ Add Package ➤ Upload Document ➤ Get Workflow Details ➤ Sign Document

Prerequisites

To access SigningHub via RESTful API a suitable Enterprise Admin account and API key is required. An Enterprise Admin can generate a unique API key to identify your application. Authentication uses the Enterprise Admin (or alternatively Enterprise User) and associated API key to generate an OAuth 2.0 bearer token. This token is then required for authorisation for all API calls.

Create an Enterprise Admin account – the business application has to connect to this account and makes JSON requests to control the signing users/recipients. The SigningHub cloud service can be used for testing and you can create a free Enterprise Admin. Once you have created the account, contact Ascertia support (support@ascertia.com) and provide the name of your enterprise to have the standard restrictions removed from your account, to allow you to fully test the web services integration option. This restriction is for number of signatures, workflows, and templates. .
Create an API Key – set an Application Name, Call-back URL and generate an API Key in SigningHub, using the Enterprise Settings menu > Integrations screen. Note the Application Name and API Key. See details, how to configure an API key.
Create workflow templates (Optional) – the workflow template defines the location of each signature field and the user that is expected to sign the document. It also defines other document and workflow control options including PDF permissions, the ability to download or print document for example. Templates may increase efficiency, especially when a standard contract or agreement is used many times. SigningHub also supports dynamic creation of signature fields for use cases where documents are created and uploaded in real time where templates may not be appropriate. .

It is important to understand that you know what type of signature you require. That is basic electronic versus digital. Digital signatures have more legal weight but in terms of SigningHub it means every signatory must have a SigningHub account. Conversely, for lower value/less sensitive transactions, electronic signatures may suffice, and in those use cases it is not necessary to create a SigningHub account for every signatory. Thus, the coding implementation differs dependent upon the signature type required. In terms of tight and loose integration this is the difference between end users having to authenticate to SigningHub or not.

Access Tokens

Supported Tokens

This section provides information of supported tokens by SigningHub.

Client Credentials Token - The Client Credentials grant type is used by clients to obtain an access token outside of the context of a user. This is typically used by clients to access resources about themselves rather than to access a user's resources. The business application should use client credentials token to authenticate themselves and to manage an enterprise or use scope token API to perform actions on behalf of the user. Click here for more details
User Credentials Token - The Password grant type is a way to exchange a user's credentials for an access token. This is typically used to access users' resources like upload, share, etc. Enterprise Actions should be allowed in the user's role to manage them. Click here for more details
Scope Token - The business application uses scope API to create a token that then allows the business application to perform actions on behalf of the users. This will require a business application to be authenticated first. Click here for more details

Below is the list of APIs that provides information of which api is allowed to be used by token.

✅ shows that API is supported
(-) shows that API is not supported

Section	API	Client Credentials	User Credentials	Client Credentials with User as Scope
Authentication	Password Authentication
	Kerberos Authentication
	Single Sign On Authentication	✅	-	-
	OTP Login Authentication	-	✅	-
	Pre Login Authentication	✅	-	-
	Get Public Authentication Profiles	✅	-	-
	Logout/Device De-Registration	-	✅	-
	Revoke Refresh Tokens	-	✅	-
	Scope Authentication	✅	-	-
	SSL Authentication
	SAML Authentication	✅
	Verisec Authentication	✅	-	-
	Verisec Authentication Status	✅	-	-
	SAML Authentication Logout	✅
Document Package	Add Package	-	✅	✅
	Get Packages	-	✅	✅
	Export Packages	-	✅	✅
	Get Package Timeline	-	✅	-
	Export Package Timeline	-	✅	-
	Print Document	-	✅	-
	Rename Package	-	✅	✅
	Share Document Package	-	✅	✅
	Change Document Package Owner	-	✅	✅
	Open Document Package	-	✅	-
	Start New Workflow From Existing Document Package	-	✅	✅
	Close Document Package	-	✅	-
	Merge Document	-	✅	-
	Merge All Documents	-	✅	-
	Download Package (Base64)	-	✅	✅
	Download Package	-	✅	✅
	Bulk Download Packages	-	✅	-
	Get Package Verification	-	✅	✅
	Delete Package	-	✅	✅
	Upload Document Base64	-	✅	✅
	Upload Document Stream	-	✅	✅
	Update Document	-	✅	✅
	Multipart Document Upload	-	✅	✅
	Add or Update Document from Library	-	✅	✅
	Apply Workflow Template	-	✅	✅
	Get Certify Policy for a Document	-	✅	✅
	Update Certify Policy for a Document	-	✅	✅
	Rename Document	-	✅	✅
	Download Document	-	✅	✅
	Download Document(Base64)	-	✅	✅
	Get Document Details	-	✅	✅
	Get Document Image	-	✅	✅
	Get Document Image (Base64)	-	✅	✅
	Get Document Thumbnail	-	✅	-
	Get Document Thumbnails (Base64)	-	✅	-
	Get Document Verification	-	✅	✅
	Change Document Order	-	✅	✅
	Delete Document	-	✅	✅
	Upload XML StyleSheet (.XSLT)	-	✅	✅
	Upload XML StyleSheet (.XSLT) Base64	-	✅	✅
	Update Document Properties	-	✅	✅
	Get Package Details	-	✅	✅
	Multipart Document Update	-	✅	✅
	Send Email on Finish Document	-	✅	-
Document Workflow	Get Attachments	-	✅	-
	Replicate Workflow	-	✅	✅
	Upload Attachment	-	✅	-
	Download Attachment	-	✅	-
	Download Attachment (base64)	-	✅	-
	Delete Attachment	-	✅	-
	Mark as Read Workflow Comments	-	✅	✅
	Get Workflow Details	-	✅	✅
	Update Workflow Details	-	✅	✅
	Update Post Processing	-	✅	✅
	Get Workflow Reminder	-	✅	✅
	Update Workflow Reminders	-	✅	✅
	Get Workflow History	-	✅	✅
	Get Workflow History Details	-	✅	✅
	Get Certificate Saved In Workflow History	-	✅	✅
	Complete Workflow in the Middle (Terminate Workflow)	-	✅	✅
	Get Process Evidence Report	-	✅	✅
	Pre Validate Workflow User	-	✅	✅
	Get Workflow Users	-	✅	✅
	Add Users to Workflow	-	✅	✅
	Add Groups to Workflow	-	✅	✅
	Add Placeholder to Workflow	-	✅	✅
	Update Placeholder	-	✅	✅
	Update Workflow User	-	✅	✅
	Update Workflow Users Order	-	✅	✅
	Update Workflow Group	-	✅	✅
	Delete Workflow User	-	✅	✅
	Download Import Recipient Template	-	✅	✅
	Bulk Import Recipient	-	✅	✅
	Get Workflow User Permissions	-	✅	✅
	Get Workflow User Permissions For Enterprise	-	✅	✅
	Update Workflow User Permissions	-	✅	✅
	Get Workflow User Authentication (Document Opening)	-	✅	✅
	Update Workflow User Authentication(Document Opening)	-	✅	✅
	Open Document via Password	-	✅	-
	Open Document via OTP (Generate)	-	✅	✅
	Add Workflow Comments	-	✅	✅
	Get Workflow Comments	-	✅	✅
	Add shared space	-	✅	✅
	Get shared spaces	-	✅	✅
	Delete shared space	-	✅	✅
	Get shared space	-	✅	✅
	Update shared space	-	✅	✅
	Get shared space Documents	-	✅	✅
	Move Package to Custom/Shared Space folder	-	✅	✅
	Bulk Move Packages to Custom/Shared Space folder	-	✅	-
	Add Electronic Seal to Workflow	-	✅	✅
	Update Electronic Seal to Workflow	-	✅	✅
	Send Reminder	-	✅	✅
	Bulk Send Reminder	-	✅	✅
	Start New Workflow From Existing Document Package	-	✅	✅
	Create Identity Verification Flow	-	✅	✅
	Get Identity Verification Flow Status	-	✅	✅
	Identity Verification Callback	Allow Anonymous	-	-
Document Preparation	Get Document Fields	-	✅	✅
	AutoPlace Fields	-	✅	✅
	Assign Document Field	-	✅	✅
	Delete Document Field	-	✅	✅
	Add Digital Signature Field	-	✅	✅
	Update Digital Signature Field	-	✅	✅
	Add In-person Field	-	✅	✅
	Update In-Person Field	-	✅	✅
	Replicate In-person Fields	-	✅	✅
	Add Initial Field	-	✅	✅
	Update Initial Field	-	✅	✅
	Add Stamp Field	-	✅	✅
	Update Stamp Field	-	✅	✅
	Replicate Stamp Fields	-	✅	✅
	Replicate Initial Fields	-	✅	✅
	Add Checkbox Field	-	✅	✅
	Update Checkbox Field	-	✅	✅
	Add Textbox Field	-	✅	✅
	Update Textbox Field	-	✅	✅
	Add Radiobox Field	-	✅	✅
	Update Radiobox Field	-	✅	✅
	Add QR code	-	✅	✅
	Update QR code	-	✅	✅
	Preview QR Code	-	✅	✅
	Add Attachment Field	-	✅	✅
	Update Attachment Field	-	✅	✅
	Add Comment Field	-	✅	✅
	Update Comment Field	-	✅	✅
	Reply to a Comment	-	✅	✅
	Delete Comment Field	-	✅	✅
	Get Field Comments	-	✅	✅
	Mark Comments as read	-	✅	✅
	On Page Comments	-	✅	-
	Get Comment Fields	-	✅	✅
	Update DropDown Field	-	✅	✅
	Update Unique Identifier	-	✅	✅
Document Processing	Recall Document	-	✅	✅
	Load Applet	-	✅	-
	Get Jwt Token	-	✅	-
	Pre Local Signing	-	✅	-
	Post Local Signing	-	✅	-
	Get Certificates Detail	-	✅	-
	Pre EID Easy Signing	-	✅	-
	EID Easy Webhook	Allow Anonymous	-	-
	Post EID Easy Signing	-	✅	-
	Pre Bulk Local Signing	-	✅	-
	Post Bulk Local Signing	-	✅	-
	Bulk Recall	-	✅	✅
	Approve Document	-	✅	-
	GateKeeper Approve Document	-	✅	-
	Decline Document	-	✅	-
	GateKeeper Decline Document	-	✅	-
	Finish Processing	-	✅	✅
	Submit Document	-	✅	-
	Signer Authentication Via OTP (Users, In-Persons, E-Signers)	-	✅	✅
	Bulk OTP Signing Authentication	-	✅	-
	Sign Document	-	✅	-
	Bulk Sign Packages	-	✅	-
	Bulk Signing Pre Validation	-	✅	-
	Bulk Signing Status	-	✅	-
	Fill Form Fields	-	✅	✅
	Fill Initials	-	✅	-
	Get Registered Devices	-	✅	-
	Authorization Signing Request Status	-	✅	-
	Download T1C Setup	-	✅	-
	Signature Pad Initialize	-	✅	-
	Get Document Attachment Image	-	✅	✅
	Get Document Attachment Image (Base64)	-	✅	✅
	Get Document Attachment Metadata	-	✅	✅
Cloud Signature Consortium (CSC) Signing	Get Document Hash	-	✅	-
	Embed Signature	-	✅	-
	Get Account Token	-	✅	-
	Revoke OAuth2 Access Token	-	✅	-
	Sign Document via RSSP Directly	-	✅	-
	Get Access Token \| SAD	-	✅	-
	Get Filtered Credential List	-	✅	-
	Get RSSP Info	-	✅	-
	Get Credentials Info	-	✅	-
	RSSP Credentials Authorization	-	✅	-
	Get Sign Hash from RSSP	-	✅	-
	Send OTP via RSSP	-	✅	-
	Revoke Access Token	-	✅	-
	Pre-Bulk CSC Signing	-	✅	-
	Post-Bulk CSC Signing	-	✅	-
	Unlock CSC Documents	-	✅	-
	Get RSSP Information	-	✅	-
			User Credentials (with Allowed in Role)
Enterprise Management	Register Enterprise User	✅	✅	-
	Get Enterprise Users	✅	✅	-
	Update Enterprise User	✅	✅	-
	Delete Enterprise User	✅	✅	-
	Add Enterprise user Signing Certificates	✅	✅	-
	Update Enterprise user Signing Certificates	✅	✅	-
	Delete Enterprise user Signing Certificates	✅	✅	-
	Get Enterprise Invitations	-	✅	-
	Delete Enterprise User Invitation	-	✅	-
	Get Groups	-	✅	-
	Get Enterprise AI Tools	-	✅	✅
	Get Enterprise AI Tool by ID	-	✅	✅
	Add Enterprise AI Tool	-	✅	✅
	Update Enterprise AI Tool	-	✅	✅
	Delete Enterprise AI Tool	-	✅	✅
	Create Enterprise AI Client	-	✅	✅
	Update Enterprise AI Client	-	✅	✅
	Get Enterprise AI Client	-	✅	✅
	Delete Enterprise AI Client	-	✅	✅
	Add Enterprise Group	-	✅	✅
	Add Enterprise Group	-	✅	✅
	Get Enterprise Group	-	✅	✅
	Update Enterprise Group	-	✅	✅
	Delete Enterprise Group	-	✅	✅
	Bulk Delete Enterprise Group	-	✅	✅
	Get Enterprise Branding Logo	-	✅	✅
	Get Enterprise Branding Favicon	-	✅	✅
	Get Enterprise Packages	-	✅	✅
	Get Enterprise Package	-	✅	✅
	Manually Send Workflow Completion Report	-	✅	✅
	Export Enterprise Packages	-	✅	✅
	Delete Enterprise Package	-	✅	✅
	Bulk Delete Enterprise Package	-	✅	✅
	Complete Enterprise Package in the Middle (Terminate Workflow)	-	✅	✅
	Add Enterprise legal notice	✅	✅	-
	Update Enterprise legal notice	✅	✅	-
	Delete Enterprise legal notice	✅	✅	-
	Get Enterprise Legal Notice	✅	✅	-
	Get Workflow Users For Enterprise	-	✅	-
	Update Workflow User of Enterprise Package	-	✅	✅
	Update Placeholder of Enterprise Package	-	✅	✅
	Update Workflow Group of Enterprise Package	-	✅	✅
	Update Workflow User Authentication For Enterprise	-	✅	✅
	Get Workflow User Authentication For Enterprise	-	✅	✅
	Update Workflow User Permissions For Enterprise	-	✅	✅
	Get Workflow User Authentication For Enterprise	-	✅	✅
	Reset Enterprise Emails To Default	-	✅	✅
	Get Enterprise Electronic Seals	-	✅	✅
	Get Enterprise Electronic Seal	-	✅	✅
	Add Enterprise Electronic Seal	-	✅	✅
	Update Enterprise Electronic Seal	-	✅	✅
	Delete Enterprise Electronic Seal	-	✅	✅
	Bulk Delete Enterprise Electronic Seal	-	✅	✅
	Get Roles	-	✅	✅
	Add Role	-	✅	✅
	Get Role by ID	-	✅	✅
	Clone Role	-	✅	✅
	Update Role	-	✅	✅
	Update Role Basic	-	✅	✅
	Delete Role	-	✅	✅
	Get Allowed Enterprise Roles	-	✅	✅
	Bulk Delete Role	-	✅	✅
	Get Role Users	-	✅	✅
	Add Enterprise Contact	-	✅	✅
Get Enterprise Contact	-	✅	✅
Update Enterprise Contact	-	✅	✅
Delete Enterprise Contact	-	✅	✅
Bulk Import Enterprise Contacts	-	✅	✅
Bulk Delete Enterprise Contact	-	✅	✅
Download Import Enterprise Contact Template	-	✅	✅
Get Enterprise Integrations	-	✅	✅
Get Enterprise Integration by ID	-	✅	✅
Add Enterprise Integration	-	✅	✅
Update Enterprise Integration	-	✅	✅
Delete Enterprise Integration	-	✅	✅
Bulk Delete Enterprise Integration	-	✅	✅
Get Enterprise Integrations External Users	-	✅	✅
Get Enterprise Integrations External User by ID	-	✅	✅
Add Enterprise Integrations External User	-	✅	✅
Update Enterprise Integrations External User	-	✅	✅
Delete Enterprise Integrations External User	-	✅	✅
Bulk Delete Enterprise Integration External User	-	✅	✅
Get Enterprise Branding Signature Logo	-	✅	✅
Get Enterprise Branding Email Logo	-	✅	✅
Reset Enterprise Branding	-	✅	✅
Get Enterprise Branding	-	✅	✅
Update Enterprise Branding	-	✅	✅
Document Statistics	-	✅	✅
Signature Statistics	-	✅	✅
Electronic Seal Statistics	-	✅	✅
Get Document Pie Chart by Status	-	✅	✅
Get Document Bar Chart by Activity	-	✅	✅
Get Document Timeline by Activity	-	✅	✅
Get Signature Pie Chart	-	✅	✅
Get Signature Pie Chart by Types	-	✅	✅
Get Signature Bar Chart by Signature Levels	-	✅	✅
Get Signature Time Line by Signature Levels	-	✅	✅
Get Signature Pie Chart by Signatories	-	✅	✅
Export Document Statistics	-	✅	✅
Export Signature Statistics	-	✅	✅
Export Electronic Seal Statistics	-	✅	✅
Get Enterprise Library Document by ID	-	✅	✅
Add Enterprise Library Document	-	✅	✅
Update Enterprise Library Document	-	✅	✅
Delete Enterprise Library Document	-	✅	✅
Bulk Delete Enterprise Library Document	-	✅	✅
Move Enterprise Library Document	-	✅	✅
Import Enterprise Library Document	-	✅	✅
Export Enterprise Library Document	-	✅	✅
Get Enterprise Library Folders	-	✅	✅
Get Enterprise Library Folder by ID	-	✅	✅
Add Enterprise Library Folder	-	✅	✅
Update Enterprise Library Folder	-	✅	✅
Delete Enterprise Library Folder	-	✅	✅
Bulk Delete Enterprise Library Folder	-	✅	✅
Get Enterprise Library Documents	-	✅	✅
Bulk Register Enterprise User	-	✅	✅
Bulk Delete Enterprise User	-	✅	✅
Get Enterprise User	-	✅	✅
Get User Signing Certificates	-	✅	✅
Get User Signing Certificate	-	✅	✅
Bulk Delete Invitation	-	✅	✅
Resend Invitation	-	✅	✅
Update Auto Provision Settings	-	✅	✅
Get Auto Provision Settings	-	✅	✅
Get Auto Provision Security Groups	-	✅	✅
Add Auto Provision Security Groups	-	✅	✅
Update Auto Provision Security Groups	-	✅	✅
Delete Auto Provision Security Group	-	✅	✅
Bulk Delete Auto Provision Security Groups	-	✅	✅
Export Enterprise Users	-	✅	✅
Export Enterprise Invitations	-	✅	✅
Get User Activity of Enterprise User	-	✅	✅
Get Enterprise User Consumed Statistics	-	✅	✅
Update Enterprise User Consumed Statistics	-	✅	✅
Reset Enterprise User Password	-	✅	✅
Get Enterprise Default Settings	-	✅	✅
Update Enterprise Default Settings	-	✅	✅
Bulk Delete Enterprise Legal Notice	-	✅	✅
Get Enterprise Certificate filters	-	✅	✅
Get Enterprise Certificate filter	-	✅	✅
Add Enterprise Certificate filter	-	✅	✅
Update Enterprise Certificate filter	-	✅	✅
Delete Enterprise Certificate filter	-	✅	✅
Bulk Delete Enterprise Certificates filters	-	✅	✅
Get Enterprise Advanced Settings	-	✅	✅
Update Enterprise Advanced Settings	-	✅	✅
Get Enterprise Package Details	-	✅	✅
Get Enterprise Package History	-	✅	✅
Get Enterprise Package Timeline	-	✅	✅
Send Reminder for Enterprise Package	-	✅	✅
Export Workflow Timeline	-	✅	✅
Update Electronic Seal of Enterprise Package	-	✅	✅
Get Enterprise Notification Settings	-	✅	✅
Update Enterprise Notifications Settings	-	✅	✅
Get Enterprise Email Settings	-	✅	✅
Update Enterprise Email Settings	-	✅	✅
Get Enterprise Signing Reasons	-	✅	✅
Add Enterprise Signing Reason	-	✅	✅
Delete Enterprise Signing Reason	-	✅	✅
Get Enterprise Contacts	-	✅	✅
Get Enterprise Groups	-	✅	✅
Reset Enterprise User Two Factor Authentication	-	✅	✅
Import Enterprise Users Template	-	✅	✅
Download Import Enterprise Invitations Template	-	✅	✅
Generate Client Secret by ID	✅	-	-
Get Enterprise Certificate Filter Types	-	✅	✅
Get Enterprise Owners	-	✅	✅
Get Enterprise Stamps	-	✅	✅
Get Enterprise Stamp	-	✅	✅
Add Enterprise Stamp	-	✅	✅
Update Enterprise Stamp	-	✅	✅
Delete Enterprise Stamp	-	✅	✅
Bulk Delete Enterprise Stamps	-	✅	✅
Export Enterprise Stamps	-	✅	✅
Import Enterprise Stamps	-	✅	✅
Download Import Enterprise Stamp Template	-	✅	✅
Add Enterprise Identity Verification Policy	-	✅	✅
Update Enterprise Identity Verification Policy	-	✅	✅
Get Enterprise Identity Verification Policies	-	✅	✅
Get Enterprise Identity Verification Policy	-	✅	✅
Delete Enterprise Identity Verification Policy	-	✅	✅
Bulk Delete Enterprise Identity Verification Policies	-	✅	✅
Download Import Enterprise Library Template	-	✅	✅
Download Import Enterprise Template (Template)	-	✅	✅
Account Management	Add Feedback	✅	-	-
	Get Account Invitations	✅	✅	-
	Accept Account Invitation	-	✅	-
	Reject All Account Invitations	-	✅	-
	Register User Account	Yes (Client MSOfficeApp, MobileSDK and System Level)	-	-
	Cancel Agreement	-	✅	-
	Recurring Payment	✅	✅	-
	Get All Service Plans	✅	✅	-
	Upgrade Service Plan	-	✅	-
	Get User Billings	✅	✅	-
	Get Billing Transaction Status	✅	✅	-
	Get Account	-	✅	-
	Resend Activation Email	✅	✅	-
	Account Usage Statistics	-	✅	-
	Documents Statistics	-	✅	✅
	Get Account Password Policy	-	✅	-
	Get User Role	-	✅	✅
	Device Registration for Push Notifications	-	✅	-
	Add Identity for a User	-	✅	-
	Get User Activity logs	-	✅	-
	Get Notifications	-	✅	-
	Change Password	-	✅	-
	Reset Password	✅	✅	-
	Set New Password	✅	-	-
	Recover Password	✅	-	-
	Send Forgot Password Request	✅	✅	-
	Configure two factor authentication	✅	-	-
	Get User Electronic Seal Profiles	-	✅	✅
	Get User Identity Verification Policies	-	✅	✅
	Get All Push Notification Devices	-	✅	-
	Delete All Push Notification Devices	-	✅	-
	Delete Refresh Token	-	✅	-
	Validate User	-	✅	-
Folders Management	Get All Folders	-	✅	-
	Get Folder by ID	-	✅	-
	Add Folder	-	✅	-
	Update Folder	-	✅	-
	Delete Folder	-	✅	-
	Bulk Delete Folder	-	✅	-
Personal Settings	Remove Account Request	✅	-	-
	Download Personal / Enterprise Library document	-	✅	-
	Download Personal / Enterprise Library document (Base64)	-	✅	-
	Remove Account	-	✅	-
	Get Library Documents	-	✅	-
	Get Signature Delegation Settings	-	✅	-
	Update Signature Delegation Settings	-	✅	-
	Get General Profile Information	-	✅	✅
	Update General Profile Information	-	✅	-
	Get Profile Picture	-	✅	-
	Get Profile Picture (Base64)	-	✅	-
	Update Profile Picture	-	✅	-
	Update Locale Settings	-	✅	-
	Update Security Settings	-	✅	-
	Get Signature Settings	-	✅	✅
	Get Hand Signature Text For Web	-	✅	-
	Get Initials For Upload Option	-	✅	-
	Get Hand Signature Upload For Mobile	-	✅	-
	Get Hand Signature Upload For Web	-	✅	-
	Get Initials for Text Option	-	✅	-
	Get Hand Signature Text For Mobile	-	✅	-
	Get Signature Appearance	-	✅	-
	Update Initial Appearance	-	✅	-
	Update Hand Signature (Browser)	-	✅	-
	Update Signature Appearance Design	-	✅	-
	Update Hand Signature(Mobile)	-	✅	-
	Update Signature Settings	-	✅	-
	Get Hand Signature Draw For Web	-	✅	-
	Get Hand Signature Draw For Mobile	-	✅	-
	Get Initials For Draw Option	-	✅	-
	Update Signature settings Metadata	-	✅	-
	Get Templates	-	✅	-
	Reset User Emails To Default	-	✅	-
	Get Groups	-	✅	-
	Add Personal Group	-	✅	-
	Get Personal Group	-	✅	-
	Update Personal Group	-	✅	-
	Delete Personal Group	-	✅	-
	Bulk Delete Personal Group	-	✅	-
	Get Contacts	-	✅	-
	Add Contact	-	✅	-
	Get Personal Contact	-	✅	-
	Update Personal Contact	-	✅	-
	Delete Personal Contact	-	✅	-
	Bulk Import Personal Contacts	-	✅	-
	Bulk Delete Personal Contact	-	✅	-
	Download Import Personal Contact Template	-	✅	-
	Get Cloud Drives Settings	-	✅	-
	Enable Cloud Drives Settings	-	✅	-
	Disable Cloud Drives Settings	-	✅	-
	Add personal Legal Notice	-	✅	✅
	Update personal Legal Notice	-	✅	✅
	Get Legal Notices	-	✅	✅
	Get Personal Legal Notice	-	✅	✅
	Delete Personal Legal Notice	-	✅	✅
	Bulk Delete Personal Legal Notice	-	✅	-
	Get Notification Settings	-	✅	-
	Update Notifications Settings	-	✅	-
	Get Email Settings	-	✅	-
	Update Email Settings	-	✅	-
	Get Personal Library Document by ID	-	✅	-
	Add Personal Library Document	-	✅	-
	Update Personal Library Document	-	✅	-
	Delete Personal Library Document	-	✅	-
Bulk Delete Personal Library Document	-	✅	-
Move Personal Library Document	-	✅	-
Get Library Folders	-	✅	-
Get Personal Library Folder by ID	-	✅	-
Add Personal Library Folder	-	✅	-
Update Personal Library Folder	-	✅	-
Delete Personal Library Folder	-	✅	-
Bulk Delete Personal Library Folder	-	✅	-
Get Active Sessions	-	✅	-
Revoke Active Sessions	-	✅	-
Get Authorised Devices	-	✅	-
Update Two-Factor Authentication	-	✅	-
Disable Two-Factor Authentication	-	✅	-
Regenerate Recovery Codes Two-Factor Authentication	-	✅	-
Get User Certification Password	-	✅	-
Get User Advance Settings	-	✅	-
Update User Advance Settings	-	✅	-
Add To Library	-	✅	-
Get Smart Forms	-	✅	-
Get Smart Forms by ID	-	✅	-
Add Smart Forms	-	✅	-
Update Smart Forms	-	✅	-
Delete Smart Forms	-	✅	-
Delete Bulk Smart Forms	-	✅	-
Validate Smart Form Rules	-	✅	-
Get Smart Form Details	✅	-	-
Start Smart Form Signing	✅	-	-
Get Template Smart Forms	-	✅	-
Download Smart Forms Response	-	✅	-
Get Smart Form Url (Integration)	-	✅	-
Smart Form Decrypt	-	✅	-
Get Personal Stamps	-	✅	-
Get Personal Stamp	-	✅	-
Add Personal Stamp	-	✅	-
Update Personal Stamp	-	✅	-
Delete Personal Stamp	-	✅	-
Bulk Delete Personal Stamp	-	✅	-
General	OTP Verification	-	✅	-
	Get Service Agreements	✅	-	-
	Get Profile Picture of Recipient	✅	✅	-
	About SigningHub	✅	✅	✅
	System Settings	✅	✅	-
	Get Languages	✅	✅	-
	Get Countries	✅	✅	-
	Get Timezones	✅	✅	-
	Get SigningHub Admin Branding	✅	✅	-
	Get SH Admin Branding Logo	✅	✅	-
	Get SH Admin Branding Favicon	✅	✅	-
Template	Save Workflow as Template	-	✅	✅
	Artificial Intelligence (AI) Execute Feature (Template)	-	✅	✅
	Artificial Intelligence (AI) Features (Template)	-	✅	✅
	Clone Template	-	✅	✅
	Update Template	-	✅	✅
	Delete Template	-	✅	✅
	Get Template by ID	-	✅	✅
	Bulk Delete Personal Template	-	✅	-
	Get Enterprise Templates	-	✅	✅
	Bulk Delete Enterprise Template	-	✅	✅
	Import Enterprise Library Documents	-	✅	✅
	Export Enterprise Template Document	-	✅	✅
	Add Personal Template	-	✅	-
	Add Enterprise Template	-	✅	✅
	Get Workflow Details (Template)	-	✅	✅
	Get Document Fields (Template)	-	✅	✅
	Get Workflow Users (Template)	-	✅	✅
	Get Workflow User Permission (Template)	-	✅	✅
	Get Workflow User Authentication (Document Opening) (Template)	-	✅	✅
	Get Workflow Reminders (Template)	-	✅	✅
	Add Users to Workflow (Template)	-	✅	✅
	Add Placeholder to Workflow (Template)	-	✅	✅
	Add Groups to Workflow (Template)	-	✅	✅
	Add Logged In User to Workflow (Template)	-	✅	✅
	Add Electronic Seal (Template)	-	✅	✅
	Delete Workflow User (Template)	-	✅	✅
	Update Workflow User (Template)	-	✅	✅
	Update Workflow Group (Template)	-	✅	✅
	Update Placeholder (Template)	-	✅	✅
	Update Electronic Seal (Template)	-	✅	✅
	Save Template	-	✅	✅
	Update Workflow User Permission (Template)	-	✅	✅
	Update Workflow Reminders (Template)	-	✅	✅
	Update Workflow User Authentication (Document Opening) (Template)	-	✅	✅
	Update Workflow Users Order (Template)	-	✅	✅
	Update Post Processing (Template)	-	✅	✅
	Update Workflow Details (Template)	-	✅	✅
	Add CheckBox Field (Template)	-	✅	✅
	Add RadioBox Field (Template)	-	✅	✅
	Add QR Code (Template)	-	✅	✅
	Update QR Code (Template)	-	✅	✅
	Add TextBox Field (Template)	-	✅	✅
	Add Attachment Field (Template)	-	✅	✅
	Update CheckBox Field (Template)	-	✅	✅
	Update RadioBox Field (Template)	-	✅	✅
	Update TextBox Field (Template)	-	✅	✅
	Update Attachment Field (Template)	-	✅	✅
	Delete Document Field (Template)	-	✅	✅
	Assign Document Field (Template)	-	✅	✅
	Add Initial Field (Template)	-	✅	✅
	Add Stamp Field (Template)	-	✅	✅
	Add In-person Field (Template)	-	✅	✅
	Add Digital Signature Field (Template)	-	✅	✅
	Update Initial Field (Template)	-	✅	✅
	Update Stamp Field (Template)	-	✅	✅
	Update In-person Field (Template)	-	✅	✅
	Update Digital Signature Field (Template)	-	✅	✅
	Get Document Image Base64 (Template)	-	✅	✅
	Get Document Image (Template)	-	✅	✅
	Bulk Import Recipient (Template)	-	✅	✅
	Import recipient (Template)	-	✅	✅
	Update Certify Policy (Template)	-	✅	✅
	Replicate Initial Fields (Template)	-	✅	✅
	Replicate In-person Fields (Template)	-	✅	✅
Get Personal/Enterprise Template Details	-	✅	-
Discard Changes	-	✅	✅
Bulk Delete Document Field (Template)	-	✅	✅
Update DropDown Field (Template)	-	✅	✅
Get Template Document Thumbnails (Base64)	-	✅	✅
Replicate Stamp Fields (Template)	-	✅	✅
Add Personal Template to Enterprise	-	✅	✅
SigningHub Admin APIs	Admin Authentication
	Create Account
	Change User Service Plan
	Get Accounts
	Service Plan Reset
	Get Service Plans
	Get Service Plan by ID
	Add Service Plan
	Update Service Plan
	Clone Service Plan
	Delete Service Plan
User Provisioning Via SCIM	Create User	✅	-	-
	Delete User by ID	✅	-	-
	Get User by ID	✅	-	-
	Filter Users	✅	-	-
	Update User - PUT	✅	-	-
	Update User - PATCH	✅	-	-
User PassKey	Create Passkey Challenge	-	✅	-
	Create Passkey	-	✅	-
	Get Passkeys	-	✅	-
	Get Passkey by ID	-	✅	-
	Update Passkey	-	✅	-
	Delete Passkey	-	✅	-
	Login Passkey Challenge	✅	✅	-
Artificial Intelligence	Artificial Intelligence (AI) Execute Feature	-	✅	-
Artificial Intelligence	Artificial Intelligence (AI) Features	-	✅	-
QR Code Document	Decrypt QR Code Link	✅	✅	-
	Get QR Code Information	-	✅	-
	Get QR Code Document Image Bytes	-	✅	-
	Get QR Code Document Verification	-	✅	-

Quick Integration

This section provides a quick "Do this and it works" guide for developers to understand how they can integrate SigningHub features within their business applications.

Overview

SigningHub exposes an external communication channel that allows external business applications to authenticate themselves, send requests and receive responses. This integration can be done with an on-premise instance (or private cloud instance) or the public cloud service running here www.signinghub.com.

The business application uses a secure HTTPS session to pass the document and its workflow control data to SigningHub. Using this approach, SigningHub can quickly and easily integrate with business applications to provide users with document review and digital signature approval functionality.

There is no Software Development Kit (SDK) for the integration, instead, SigningHub provides REST APIs that simplify the integration and can be used with any language including .Net, Java, PHP, etc.

Integration Scenarios

There are two ways to integrate SigningHub within a business application:

Tight Integration - The business application uses SigningHub to provide document review and digital signature functionality. Users interact with the business web application and when they get to the point where a document requires approval SigningHub is invoked to display it within an iframe. The user is unaware that SigningHub functionality is used. The user can review the entire document and sign in their defined location. Tight integration is suitable for ECM, CRM, and ERP web applications or portals where a known user already interacts in a defined way. The user login information can be used by the business application to create and connect the user to their respective SigningHub account.
Loose Integration - The business application sends a document to SigningHub together with control information. SigningHub creates and manages the workflow and emails each user in turn prompting them to log in, review and sign the document. Users log in and see the document within the SigningHub view and sign screen. They can review the entire document and sign in their defined location. This mode is most suitable for integration with a back-office application that has no exposed public-interface
This Quick Guide summarises how to use tight integration. The SigningHub software includes an example tight integration demo website built in .NET to help developers with web application/portal integration.
SmartForm Integration – This integration enables seamless in-app signing experiences by embedding SmartForms directly into your web application using the SigningHub API. Users can view, fill, and sign forms without login or registration, while your system handles all notifications, routing, and status tracking. Structured fields and predefined workflows are supported, and the signing interface is securely loaded via iframe, keeping the entire process within your application.

Tight Integration

The following diagram summarizes the process for tight integration:

In this mode of integration, users interact with the business web application. At some point, there is a need to view and sign a document. For ease of use, the user does not need to register or login in order to view and sign the document. In tight integration, the web application uses iframe technology to embed the SigningHub view and sign page within an existing webpage.

The user’s signing field is highlighted for them, and clicking on such enables them to create their digital signature. All of these web service interactions are performed in a way that ensures the user has a seamless experience fully consistent with the existing business application.

When using tight integration, users do not login directly to the SigningHub and no email is generated by SigningHub. It is the business application’s responsibility to manage the workflow and keep the user informed.

The process is:

(Manual Step) - an Enterprise Account must be created
(Manual Step) - an Enterprise Client ID, Client Secret and Call back URL must be configured
(Manual Optional Step) - the Enterprise Admin creates a workflow template
(Manual Optional Step) - the Enterprise Admin uploads a document to Enterprise Library which will be later sent to your user to sign
(Coding) - the business application gets a client credential access token which is then used to get scope token
(Optional coding) - the business application registers a new Enterprise User
(Coding) - the business application gets a scope token using client credentials access token which is used for subsequent API calls
(Coding) - the business application uploads a new package to the Enterprise User (used as Scope) account
(Coding) - the business application applies a template or dynamically adds fields to the document
(Coding) - the business application starts the document workflow
(Coding) - the document is shown to the Enterprise User (used as Scope) within an iframe
(Manual) - the enterprise user review and signs the document within an iframe
(Optional coding) - the business application downloads the package/document

These steps are explained in more detail here:

Step 1 - Create an Enterprise Admin Account (Manual) - the business application has to register for an enteprise account. The SigningHub cloud service www.signinghub.com can be used for testing and you can create a free Enterprise Admin account by clicking the FREE TRIAL button.
Step 2 - Generate the API Key (Manual) - Click here for instructions
Step 3 - Create a Workflow Template (Manual, Optional) - Click here for instructions. If template can't be used and you want to dynamically add fields then skip this step
Step 4 - Add a Document to the Library (Manual, optional) - If a standard document or contract is used you can avoid uploading the document programmatically for every use case. All you need is to maintain your document in your enterprise library and use the ID of the document as a reference in your application. Click here for more information about managing documents in an enterprise library
Step 5 - Get client credential token via the API (Coding) - this call authenticates the business application access to SigningHub. This requires the Enterprise Client Secret and Client Id that in return sends the access token. For authentication, the business application needs to send an HTTP POST request to SigningHub. The following is an example request/response:

Header Parameters

Content Type

required

string

Default: application/x-www-form-urlencoded

required

string

Default: application/json

REQUEST BODY SCHEMA

grant_type

required

string "client_credentials"

Define the OAuth 2.0 grant type.

client_id

required

string non-empty

Application Name that is configured in your Enterprise Account when configuring the integration options.

client_secret

required

string non-empty

API Key that that is generated in your Enterprise Account when configuring the integration options.

Post

/authenticate

Request Body

grant_type=client_credentials&

client_id= CLIENT_ID&

client_secret= CLIENT_SECRET&

Sample Response

{

access_token: "string",

token_type: "bearer",

expires_in: "0"

refresh_token: "string"

}

Step 6 - Register an Enterprise User via the API (Coding, Optional) - this represents the user account that will be used to upload the document and will be shared to sign the signature field. An account for the signer must exist, if it does not then to create a signer, the business application needs to send the following example request only once. To learn more about each parameter used consult the developer manuals here.

Header Parameters

Content Type

required

string

Default: application/json

required

string

Default: application/json

Authorization

required

string

Default: Bearer {access_token}

Access token obtained after a successful authentication. This service requires the access token to be obtained using the client credentials.

REQUEST BODY SCHEMA

user_email

required

string

The email address of the user account to be registered.

user_name

required

string

The name of the user to be registered.

job_title

required

string

Job title of user.

company_name

required

string

Company name of user.

mobile_number

required

string

Mobile number of user.

user_password

required

string

The password of the user account. This is optional if you want your users to authenticate externally e.g. via SAML, Salesforce, Office 365 etc. rather than using a SigningHub ID (email/password). If password is provided, application expects the security question and answer as mandatory fields.

security_question

required

string

Security question used to reset password if user forgets his password. This is mandatory if you wish to allow the user to sign without manually, via an email link, completing the registration process. If security question is provided, application expects password and security answer as mandatory fields.

security_answer

required

string

Security answer used to reset the password if user forgets his password. This is mandatory if you wish to allow the user to sign without manually, via an email link, completing the registration process. If security answer is provided, application expects password and security question as mandatory fields.

enterprise_role

required

string

The enterprise role to be assigned to this user - these are managed within the Enterprise account.

email_notification

required

string

This defines whether enterprise user would get an email notification about the account creation. Default value is 'false'.

Post

/v4/enterprise/users

Request Body

{

user_email: "john@ascertia.com",

user_name: "John Smith",

job_title: Software Engineer

company_name: Ascertia

mobile_number: 0092655675

user_password: Password@12

security_question: Favourite Book

security_answer: Harry Potter

enterprise_role: Enterprise Users

email_notification: false

}

Sample Response

{ }

Step 7 - Authenticate Enterprise User (Coding) - this authenticates access to SigningHub and requires the Enterprise User email address and client credentials access token. An OAuth 2.0 access token is returned. For authentication, the business application needs to send an HTTP POST request to SigningHub. The received access token is then used to upload, prepare and share the document. Following is an example request/response:

Header Parameters

Content Type

required

string

Default: application/json

required

string

Default: application/json

Authorization

required

string

Default: Bearer {access_token}

This service requires the access token to be obtained using the client credentials.

REQUEST BODY SCHEMA

user_email

required

string non-empty

Email of a registered enterprise user

Post

/v4/authenticate/scope

Request Body

{

user_email: "ENTERPRISE_USER_EMAIL"

}

Sample Response

{

access_token: "string",

token_type: "bearer",

expires_in: "0"

refresh_token: "string"

}

Step 8 - Add Package (Coding) - This service API is used to add/create a document package to hold one or more documents. This package can then be used to add documents and recipients in order to start a new workflow.

Header Parameters

Content Type

required

string

Default: application/json

required

string

Default: application/json

Authorization

required

string

Default: Bearer {access_token_scope}

Access token returned in Scope API call

REQUEST BODY SCHEMA

package_name

required

string non-empty

The name of the package.

workflow_mode

string

Default: ONLY_OTHERS

Enum: "ME_AND_OTHERS" "ONLY_OTHERS" "ONLY_ME"

folder_name

string

Default: Inbox

The name of the folder. It will be used to upload package in any folder of the user, either its a custom folder or a shared folder.

Post

/v4/packages

Request Body

{

package_name: "string",

workflow_mode: "ME_AND_OTHERS",

folder_name: "string",

}

Sample Response

{

package_id: 1151,

workflow_mode: "ME_AND_OTHERS",

workflow_type: "string",

}

Step 8.1 - Add Document or dynamically add fields (Coding) - Business applications can use this service API to add a document from the user’s library to a package. The package_id is provided in the URL which should be the same as found in the previous call. The document ID must be provided as document_id in the resource URL to identify the library document to be copied.

Path Parameters

packageId

required

integer &

The ID of the package to which the document is being added.

documentId

required

integer

The ID of the document that will be fetched from libary and added to the package

Header Parameters

Content Type

required

string

Default: application/json

required

string

Default: application/json

Authorization

required

string

Default: Bearer {access_token_scope}

Access token returned in Scope API call

In the case where the business application creates the document dynamically then you can upload the document using the Upload Document API call explained here , as opposed to using a document from your respective library

Post

/v4/packages/{package_id}/documents/library/{document_id}

Sample Response

{

document_id: integer,

document_name: "string",

document_order: integer

document_type: "string"

document_source: "string"

document_width: 0

document_height: 0

document_pages: 0

uploaded_on: "2015-01-12T11:12:13"

modified_on: "2015-01-13T10:10:15"

form_fields: true

lock_form_fields: true

certify: {

enabled: true

permission: "FORM_FILLING_ALLOWED"

}

template: {

template_name: "Sales Contract Template"

read_only: true

}

Step 9 - Apply Template or dynamically add fields (Coding) - Business applications can use this service API to apply a workflow template to a document. The document ID on which template has to be applied is provided in the resource URL. In this call the package_id should be same as used in step 9 and the document_id is the one the user got in the response of step 8.

Path Parameters

packageId

required

integer

The ID of the package.

documentId

required

integer

The ID of the document on which the template will be applied.

Header Parameters

Content Type

required

string

Default: application/json

required

string

Default: application/json

Authorization

required

string

Default: Bearer {access_token_user}

Access token returned in Scope API call

REQUEST BODY SCHEMA

template_name

required

string non-empty

Name of template to be applied on the document.

apply_to_all

boolen

Default: false

True, if template has to be applied on all the documents in the package.

In the case where the template contains a placeholder or a user that you wish to change then you can use the Update Workflow User API call as explained here.

Alternatively if due to the dynamic nature of the document you cannot apply a template and want to add different fields, e.g. text field, checkbox, initials, signature fields etc., then you can add them dynamically by providing the X, Y, Width, Height coordinates, package ID, document ID, page number and assign to a user. Click here to learn more.

Post

/v4/packages/{packageId}/documents/{documentId}/template

Request Body

{

template_name: "string",

apply_to_all: true,

}

Sample Response

{

document_id: 123,

document_name: "sales contract 105",

document_order: 1

document_type: "PDF"

document_source: "My App"

document_width: 600

document_height: 800

document_pages: 12

uploaded_on: "2015-01-12T11:12:13"

modified_on: "2015-01-13T10:10:15"

form_fields: true

lock_form_fields: true

certify: {

enabled: true

permission: "FORM_FILLING_ALLOWED"

}

template: {

template_name: "Sales Contract Template"

read_only: true

}

Step 10 - Share Package (Coding) - Business applications can use this service API to share a document with the designated signatories and start a new workflow. The document should already have been prepared by optinally applying a template and optionally updating the users and actions defined in template. The package ID to be shared is provided in the resource URL. In this call the package_id should be same as used in step 8.

Path Parameters

packageId

required

integer

The ID of the package that has to be shared.

Header Parameters

Content Type

required

string

Default: application/json

required

string

Default: application/json

Authorization

required

string

Default: Bearer {access_token_scope}

Access token returned in Scope API call

Post

v4/packages/{package_id}/workflow

Sample Response

[{

package_id: integer

documents: [123,124,125]

}]

Step 11 - Generate Integration URL for Encrypted Data (Coding) - Business applications can use this service API to generate an encrypted URL to access a document and to perform signing operation on that document. The returned URL in response will be an encrypted URL which contains all the information which was provided in request body. See sample request below.

Header Parameters

Content Type

required

string

Default: application/json

required

string

Default: application/json

Authorization

required

string

Default: Bearer {access_token_scope}

REQUEST BODY SCHEMA

package_id

integer

The ID of the package that has been shared in step 10.

document_id

integer

The ID of the Document that has been shared.

language

string ""

Language code in which application is required be shown to end user. if no value is provided then system defined language will be used.

user_email

string ""

user_email is required when a Guest user has to process the document.

callback_url

string ""

URL, where user will be redirected after completing the required actions. if no value is provided then system will follow what's been configured in Enterprise Settings > Integration.

collapse_panels

string "false"

True, will hide the panels in the IFrame mode. if no value is provided then it will follow what's been set in Integration options.

lock_panels

string "false"

True, will lock the panels in the IFrame mode. if no value is provided then it will follow what's been set in Integration options.

redirect_callback_url

string "false"

False, if you do not want to have a user automatically redirected to the call-back URL. After the user has performed their task, they will stay on the document viewer screen and will not be redirected unless they press the "Close" button.

response_type

string ""

Indicating response should be encoded or plan.Possible values are ENCODED, PLAIN

usercertificate_id

integer

The user custom certificate Id.

section

enum

Section wise integration, if not provided Default value : VIEWER

Possible values are

Enum: "VIEWER" "DASHBOARD" "WORKFLOW" "DOCUMENTS" "ACTIVITY" "NOTIFICATIONS" "PERSONAL_INFORMATION" "AUTHORISED_DEVICES" "TWO_FACTOR_AUTHENTICATION" "SECURITY" "PERSONAL_CONTACTS" "PERSONAL_GROUPS" "PERSONAL_LIBRARY""PERSONAL_STAMPS" "PERSONAL_TEMPLATES" "PERSONAL_LEGAL_NOTICES" "SMART_FORM" "SIGNATURES_SETTINGS" "CLOUD_DRIVE_SETTINGS" "DELEGATION_SETTINGS" "PERSONAL_NOTIFICATION_SETTINGS" "ENTERPRISE_INFORMATION" "ENTERPRISE_LOGS" "ENTERPRISE_CONTACTS" "ENTERPRISE_GROUPS" "ENTERPRISE_USERS" "ENTERPRISE_ROLES" "ENTERPRISE_DOCUMENTS" "ENTERPRISE_LIBRARY" "ENTERPRISE_TEMPLATES" "ENTERPRISE_LEGAL_NOTICES" "ENTERPRISE_ELECTRONIC_SEALS" "ENTERPRISE_DOCUMENTS_REPORTS" "ENTERPRISE_SIGNATURES_REPORTS" "ENTERPRISE_ELECTRONIC_SEALS_REPORTS" "ENTERPRISE_ADVANCED_REPORTS" "ENTERPRISE_BRANDING" "ENTERPRISE_INTEGRATIONS" "ENTERPRISE_CERTIFICATE_FILTERS" "ENTERPRISE_NOTIFICATIONS" "ENTERPRISE_ADVNACED_SETTINGS" "PASSWORDLESS_LOGIN" "ENTERPRISE_STAMPS" "ENTERPRISE_IDENTITY_VERIFICATION_POLICY" "ENTERPRISE_ARTIFICIAL_INTELLIGENCE_CLIENT" "ENTERPRISE_ARTIFICIAL_INTELLIGENCE_TOOLS"

Note: If the section is VIEWER or WORKFLOW, SigningHub will redirect you to the Viewer; otherwise, it will navigate to the specified SigningHub section.

Post

/v4/links/integration

Request Body

{

document_id: 23,

package_id: 12,

language: "en-US",

response_type: "PLAIN",

callback_url: "https://web.signinghub.com/",

user_email: "joe@gmail.com",

collapse_panels: "true",

lock_panels: "true",

redirect_callback_url: "false",

usercertificate_id: 45

section: "VIEWER"

}

Sample Response

"https://web.signinghub.com/Integration?q=QUVTMjU2LUdDTTm7sHn5UnS-2B-MB9OYT4MM4iHd4nGT-2B-3lkpLq-2B-15xg8av10bU807OEkv9fOc7jm1wsnDS1aAxCAUhEkrxup3BVNMknwQPg”

Step 12 - Review Document in Iframe (Coding) - Client web applications create an iframe with the source of the iframe that is being returned in step 11 as follows:

Iframe view in browser

Step 13 - Handle Call-back (Coding) - Once the user has signed, declined or reviewed and approved the document within the SigningHub document viewer, the user can close the document and return to the web application. When the user closes the document, SigningHub immediately returns control to the web application using the configured URL for that specific integration. This is the 'call-back' parameter, configured under the Application Integration settings.
Control is returned to the web application as soon as the user navigates away from the document viewer window. For cases such as signature operations this occurs when the user completes the signing process and clicks on 'Finish' button. Browser navigation (back button) is another way of navigating away from the document viewer and will also result in control passing back to the web application, and invoke the call-back URL.

When control returns to the web application, SigningHub appends the following parameters to the call-back URL to inform the web application of the action status. Response type can be encoded or plain depending on the value response_type sent in the request

Respose Details

Response Type	Description
ENCODED	[callback_url]?lang=en_USpackage_id%3D1017545%26action%3Dnone
Plain	[callback_url]?lang=en_US&package_id=1017545&action=signed

Parameters Details

Name	Description
package_id	The ID of the package that was shown to the user.
action	Provides information about the action the user performed on the document. The possible values are: none: There was no action signed: The user signed the document shared: The user shared the document declined: The user declined to sign the document reviewed: The user approved the document as a reviewer forbidden: The user will be redirected to Call Back URL, set by the business application if a call failed due to any reason. Based on this action value, business application can take necessary action to either show message or redirect to user to any other customised screen.

Name

Description

package_id

The ID of the package that was shown to the user.

action

Provides information about the action the user performed on the document. The possible values are:

none: There was no action
signed: The user signed the document
shared: The user shared the document
declined: The user declined to sign the document
reviewed: The user approved the document as a reviewer
forbidden: The user will be redirected to Call Back URL, set by the business application if a call failed due to any reason. Based on this action value, business application can take necessary action to either show message or redirect to user to any other customised screen.

Step 13.1 - Check Workflow Status (Coding) - Once the document has been shared and the workflow is in progress, the document owner may want to see the current status of the workflow. The status of workflow at any time can be checked by using the Get Workflow Details API. Click here for details.

Step 15 - Download Package/Document (Coding)
- a) If the workflow consists of multiple documents, then you can use the Download Package API call to download the package as a zip file as explained here.
- b) If the client application wants to download a single document from package then use Download Document API call as explained here

The instructions above constitute a minimal but functional JSON request to SigningHub. To get in-depth details refer to the SigningHub Web Services manual.

SmartForm Integration

The following diagram summarizes the process for Smart Form integration:

In this integration model, users interact solely with the business web application, which triggers the signing process at a specific point—such as after completing a form, application, or survey. The SmartForm document, along with control metadata, is sent to SigningHub. This metadata defines structured fields like checkboxes, dropdowns, text areas, and rating scales, which are embedded directly into the document.

To ensure a smooth user experience, no registration or login is required. The business application embeds the SigningHub signing interface directly into its web page using iframe technology. The required signing fields are clearly highlighted, allowing users to fill out the form and apply their digital signature in a guided and intuitive manner.

All web service interactions are handled behind the scenes, ensuring the experience remains fully integrated within the business application. Users never interact with SigningHub directly, and no emails are triggered by SigningHub. It is the sole responsibility of the business application to manage the workflow, notify users, and ensure completion of the signing process.

The process is:

(Manual Step) Create an Enterprise Account
(Manual Step) Generate Enterprise Client ID and Client Secret
(Manual Step) - Obtain an access token using the enterprise API credentials
(Manual Step) - Create a SmartForm
(Coding) - Retrieve the SmartForm integration URL using the SmartForm ID

These steps are explained in more detail below:

Step 1 – Create an Enterprise Account (Manual) - The business application must register for an Enterprise account. For testing purposes, you can use the SigningHub cloud service at www.signinghub.com and create a free account by clicking the FREE TRIAL button.
Step 2 – Generate API Credentials (Manual) - Follow the steps here to generate the Client ID and Client Secret from the SigningHub Web interface.
Step 3 – Obtain Access Token (Coding) - Use your enterprise credentials (Client ID and Secret) to request an access token from SigningHub’s authentication endpoint.
Step 4 – Create a SmartForm (Manual) - Design and publish your SmartForm via the SigningHub Web interface, defining required fields and workflow routing.
Step 5 – Retrieve SmartForm Integration URL (Coding) - Make an authenticated HTTP GET request to SigningHub using the SmartForm ID and access token. This returns the SmartForm integration URL, which the business application can embed via iframe. Example request/response:

Path Parameters

required

integer &

The ID of the smart form.

Header Parameters

Content Type

required

string

Default: application/json

required

string

Default: application/json

Authorization

required

string

Default: Bearer {access_token}

Access token returned in Authenticate API call

Post

/v4/account/smart-forms/{id}/url

Sample Response

{

url: "string",

}

Updates

10.0
- 10.0.1
- 10.0.2
- 10.0.3
- 10.0.4
- 10.0.5
- 10.0.6
Following is the list of updates in older versions
- 8.6.0 APIs

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

New APIs
Updates in existing APIs

New APIs

Document Package	Merge Document Merge All Documents Multipart Document Upload Get Document Thumbnail Get Document Thumbnails (Base64) Export Packages Get Package Timeline Export Package Timeline Bulk Download Packages Send Email on Finish Document Multipart Document Update Load Applet Get Jwt Token Pre Local Signing Post Local Signing Get Certificates Detail Pre EID Easy Signing EID Easy Webhook Post EID Easy Signing Pre-Bulk Local Signing Post-Bulk Local Signing
Document Workflow	Download Import Recipient Template Bulk Import Recipient Send Reminder Bulk Send Reminder Start New Workflow From Existing Workflow
Enterprise Management	Reset Enterprise User Two Factor Authentication Import Enterprise Users Template Download Import Enterprise Invitations Template Generate Client Secret by ID Get Enterprise Contacts Get Enterprise Groups Get Enterprise Certificate Filter Types Get Enterprise Owners
Account Management	Get Notifications Get User Activity Logs Get All Service Plans Recurring Payment Upgrade Service Plan Cancel Agreement Validate User Get Billing Transaction Status Get User Billings
Document Preparation	Replicate Initial Fields Replicate In-person Fields Get Comment Fields Update DropDown Field Update Unique Identifier
Document Processing	Bulk Recall Pre-Bulk CSC Signing Post-Bulk CSC Signing Unlock CSC Documents Download T1C Setup Signature Pad Initialize
Authentications	SSL Authentication SAML Authentication SAML Authentication Logout
Personal Settings	Get User Advance Settings Update User Advance Settings Add To Library
Template	Bulk Delete Document Field (Template) Update DropDown Field (Template) Replicate Initial Fields (Template) Replicate In-person Fields (Template) Get Template Document Thumbnails (Base64)

Updates in existing APIs

Document Package

Below are the APIs that are affected by the change.

Upload Document

8.6.8 (Upload Document)	10.0 (Upload Document)
From 10.0, SigningHub has introduced the multiple response parameters to provide detailed information about the uploaded document.

Upload Document Base64

8.6.8 (Upload Document Base64)	10.0 (Upload Document Base64)
From 10.0, SigningHub has introduced the multiple response parameters to provide detailed information about the uploaded document.

Get Document Image

8.6.8 (Get Document Image) 10.0 (Get Document Image)

8.6.8 (Get Document Image)	10.0 (Get Document Image)
From 10.0, SigningHub has introduced the x-formatted and x-folder-id header parameters to support xml formatted view and shared space folder access.
	New header parameters added `"x-formatted": "string"` `"x-folder-id": "long"`

From 10.0, SigningHub has introduced the x-formatted and x-folder-id header parameters to support xml formatted view and shared space folder access.

New header parameters added

"x-formatted": "string"
"x-folder-id": "long"

Get Document Image (Base64)

8.6.8 (Get Document Image (Base64)) 10.0 (Get Document Image (Base64))

8.6.8 (Get Document Image (Base64))	10.0 (Get Document Image (Base64))
From 10.0, SigningHub has introduced the x-formatted and x-folder-id header parameters to support xml formatted view and shared space folder access.
	New header parameters added `"x-formatted": "string"` `"x-folder-id": "long"`

From 10.0, SigningHub has introduced the x-formatted and x-folder-id header parameters to support xml formatted view and shared space folder access.

New header parameters added

"x-formatted": "string"
"x-folder-id": "long"

Upload Attachment

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Get Attachments

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Delete Attachment

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Download Attachment

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Download Attachment (base64)

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Close Document Package

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Download Package

From 10.0, SigningHub has introduced the x-folder-id header parameter to support shared space folder access as well as the document-ids query parameter for downloading the documents within the package.

New parameters added

"x-folder-id": "int"
"document-ids": "List"

Download Package (Base64)

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access well as the document-ids query parameter for downloading the documents within the package.

New parameter added

"x-folder-id": "int"
"document-ids": "List"

Get Package Verification

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Open Document Package

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Download Document

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Download Document (Base64)

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Get Document Details

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Get Document Verification

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Get Packages

From 10.0, SigningHub has introduced the package-name, package-id, recipient-from, recipient-to , document-id, expiry, modified-from, modified-to, size-from, size-to , certified-documents, form-fields, attachments, document-type, document-statuses, and owned-by query parameters to support advanced search.

New parameter added

"package-name": "string"

"package-id": "long"

"recipient-from": "string"

"recipient-to": "string"

"document-id": "long"

"expiry": "int"

"modified-from": "date-time"

"modified-to": "date-time"

"size-from": "int"

"size-to": "int"

"certified-documents": "bool"

"form-fields": "bool"

"attachments": "bool"

"document-type": "string"

"document-statuses": "string[]"

"owned-by": "string"

Bulk Delete Document Package

From 10.0, SigningHub has introduced the document-status, package-name, recipient-from, recipient-to , document-id, expiry, modified-from, modified-to, size-from, size-to , certified-documents, form-fields, attachments, document-type, document-statuses, and owned-by request body parameters to support advanced search.

New parameters added

"document-status": "string"

"package-name": "string"

"recipient-from": "string"

"recipient-to": "string"

"document-id": "long"

"expiry": "int"

"modified-from": "date-time"

"modified-to": "date-time"

"size-from": "int"

"size-to": "int"

"certified-documents": "bool"

"form-fields": "bool"

"attachments": "bool"

"document-type": "string"

"document-statuses": "string[]"

"owned-by": "string"

Bulk Move Packages to Custom/Shared Space folder

New parameters added

"document-status": "string"

"package-name": "string"

"recipient-from": "string"

"recipient-to": "string"

"document-id": "long"

"expiry": "int"

"modified-from": "date-time"

"modified-to": "date-time"

"size-from": "int"

"size-to": "int"

"certified-documents": "bool"

"form-fields": "bool"

"attachments": "bool"

"document-type": "string"

"document-statuses": "string[]"

"owned-by": "string"

Document Workflow

Below are the APIs that are affected by the change.

Update Electronic Seal to Workflow

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Update Workflow User Permissions

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Update Workflow User Authentication (Document Opening)

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Update Placeholder

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Update Workflow User

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Update Workflow Group

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Get Workflow History Details

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Get Certificate Saved In Workflow History

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Complete Workflow in the Middle (Terminate Workflow)

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Get Process Evidence Report

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Authenticate via OTP

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Document Preparation

Below are the APIs that are affected by the change.

Update In-person Field

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Update Digital Signature Field

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Update CheckBox Field

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Get Document Fields

From 10.0, SigningHub has introduced the tooltip, border_color, and field_rotation in the response body to provide the information for form fields.

New parameters added

"tooltip": "string"

"border_color": "string"

"field_rotation": "int"

Document Processing

Below are the APIs that are affected by the change.

Approve Document

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Decline Document

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Finish Processing

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Bulk Sign Packages

From 10.0, SigningHub has introduced the x-folder-id, and x-mobile header parameters to support shared space folder access and originator(Web/Mobile) support. Additionally, a new URL parameter, bulk_action added to facilitate bulk sharing of packages, and the hand_signature_method request parameter to set the hand signature mode.

New parameter added

"x-folder-id": "int"
"x-mobile": "string"
"bulk_action": "string"
"hand_signature_method": "string"

Bulk Signing Status

From 10.0, SigningHub has introduced the URL parameter bulk_action is added to support share package feature in bulk.

New parameter added

"bulk_action": "string"

Submit Document

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Sign Document

From 10.0, SigningHub has introduced the x-folder-id, and x-mobile header parameters to support shared space folder access and originator(Web/Mobile). Along this new request parameter hand_signature_method is to set the hand signature mode.

New parameter added

"x-folder-id": "int"
"x-mobile": "string"
"hand_signature_method": "string"

Bulk Action Pre Validation

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access. Along this new URL parameter bulk_action is added to support share package feature in bulk.

New parameter added

"x-folder-id": "int"
"bulk_action": "string"

Get Document Hash

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access, as well as hand_signature_method request parameter to set the hand signature mode.

New parameter added

"x-folder-id": "int"
"hand_signature_method": "string"

Embed Signature

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Sign Document via RSSP Directly

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access as well as the hand_signature_method request parameter to set the hand signature mode.

New parameter added

"x-folder-id": "int"
"hand_signature_method": "string"

Fill Form Fields

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Fill Initials

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Bulk OTP Signing Authentication

8.6.8 (Bulk OTP Signing Authentication) 10.0 (Bulk OTP Signing Authentication)

From 10.0, SigningHub has introduced the x-folder-id header parameter and packageId request parameter to support document signing authentication and shared space folder access.

New parameters added

"x-folder-id": "string"
"packageId": "long"

Bulk Signing Pre Validation

8.6.8 (Bulk Signing Pre Validation) 10.0 (Bulk Signing Pre Validation)

From 10.0, SigningHub has introduced the x-otp and x-password header parameters to support document access authentication. Additionally, a new response parameter signing_authentication, indicates the type of one-time authentication enabled, such as OTP or TOTP.

New parameters added

"x-otp": "string"
"x-password": "string"

Enterprise Management

Below are the APIs that are affected by the change.

Get Enterprise Users

8.6.8 (Get Enterprise Users) 10.0 (Get Enterprise Users)

From 10.0, SigningHub has introduced the two_factor_authentication to provide two factor authentication is enabled or not, certificate_dn to provide certificate dn with signing certificate.

New parameter added

"two_factor_authentication": true
"certificate_dn": "string"

Register Enterprise User

8.6.8 (Register Enterprise User) 10.0 (Register Enterprise User)

From 10.0, SigningHub has introduced the created_on in response body.

New parameter added

"created_on": 2019-08-24T14:15:22Z

Get Role Users

8.6.8 (Get Role Users) 10.0 (Get Role Users)

From 10.0, SigningHub has introduced the created_on and status in response body to provide more detail of user.

New parameter added

"created_on": string
"status": string

Get Enterprise Package Timeline

8.6.8 (Get Enterprise Package Timeline)	10.0 (Get Enterprise Package Timeline)
From 10.0, SigningHub has update the timeline_details property of the response.

Get Enterprise Logs

8.6.8 (Get Enterprise Logs)	10.0 (Get Enterprise Logs)
From 10.0, SigningHub has added the new QUERY PARAMETERS -> module option's ADVANCED_REPORTS to support search of Advanced Reports.

Get Enterprise Integrations

8.6.8 (Get Enterprise Integrations) 10.0 (Get Enterprise Integrations)

From 10.0, SigningHub has added the new response parameter client_secret and external_users_count.

New parameter added

"client_secret":"string"
"external_users_count": "int"

Get Enterprise Branding

8.6.8 (Get Enterprise Branding) 10.0 (Get Enterprise Branding)

From 10.0, SigningHub has added the new response parameters level_14 and level_15 to provide information about sidebar menus and the color of error validation text.

New parameter added

"level_14":"string"
"level_15": "string"

Reset Enterprise Branding

8.6.8 (Reset Enterprise Branding) 10.0 (Reset Enterprise Branding)

From 10.0, SigningHub has added the new response parameters level_14 and level_15 to provide information about sidebar menus and the color of error validation text.

New parameter added

"level_14":"string"
"level_15": "string"

Update Enterprise Branding

8.6.8 (Update Enterprise Branding) 10.0 (Update Enterprise Branding)

From 10.0, SigningHub has added the new request parameters level_14 and level_15 to provide information about sidebar menus and the color of error validation text.

New parameter added

"level_14":"string"
"level_15": "string"

Account Management

Below are the APIs that are affected by the change.

Get Notifications

8.6.8 (Get Notifications) 10.0 (Get Notifications)

From 10.0, SigningHub has introduced the type query param to filter notifications.

New query parameters added

"type": "ALL" | "ACCOUNT" | "LIBRARY" | "ENTERPRISE" | "DOCUMENT" | "SETTING" | "BILLING" | "WORKFLOW"

Register User Account

8.6.8 (Register User (Free Trial)) 10.0 (Register User Account)

From version 10.0, SigningHub's process depends on the service plan. For online plans, a billing response is mandatory.

New parameters added

"serviceplan": {"name": "string","billing_response": "string","signature": "string" }

Documents Statistics

From 10.0, SigningHub has introduced the x-folder-id header parameters to support shared space folder access.

New parameter added

"x-folder-id": "int"

Get Enterprise Branding and Authentication Profile

8.6.8 (Get Enterprise Branding and Authentication Profile) 10.0 (Get Enterprise Branding and Authentication Profile)

From 10.0, SigningHub has added the new response parameters level_14 and level_15 to provide information about sidebar menus and the color of error validation text.

New parameter added

"level_14":"string"
"level_15": "string"

General

Below are the APIs that are affected by the change.

Get SigningHub Admin Branding

8.6.8 (Get SigningHub Admin Branding) 10.0 (Get SigningHub Admin Branding)

From 10.0, SigningHub has added the new response parameters level_14 and level_15 to provide information about sidebar menus and the color of error validation text.

New parameter added

"level_14":"string"
"level_15": "string"

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

New APIs
Updates in existing APIs

New APIs

Personal Settings

Get Smart Forms

Get Smart Forms by ID

Add Smart Forms

Update Smart Forms

Delete Smart Forms

Delete Bulk Smart Forms

Validate Smart Form Rules

Get Smart Form Details

Start Smart Form Signing

Get Template Smart Forms

Download Smart Forms Response

Get Smart Form Url (Integration)

Smart Form Decrypt

Updates in existing APIs

Document Workflow

Below are the APIs that are affected by the change.

Generate Integration URL for Encrypted Data (Coding)

10.0 (Generate Integration URL for Encrypted Data (Coding)) 10.0.1 (Generate Integration URL for Encrypted Data (Coding))

From 10.0.1, SigningHub has introduced the section header parameters to support section wise access.

New parameter added

"section": "string"

Personal Settings

Below are the APIs that are affected by the change.

Get Signature Settings

10.0 (Get Signature Settings) 10.0.1 (Get Signature Settings)

From 10.0.1, SigningHub has introduced the environment in the response body to provide the environment of EID Easy signing server.

New parameter added

"environment": "string"

Get Templates

10.0 (Get Templates) 10.0.1 (Get Templates)

From 10.0.1, SigningHub has introduced the smart_form in the response parameter to provide information about Smart forms

New parameter added

"smart_form": { "active_count": 0, "total_count": 0 }

Account Management

Below are the APIs that are affected by the change.

Get Account

From 10.0.1, SigningHub has introduced a new feature in the service_plan > features > SMART_FORM if allowed in the service plan

New data added

service_plan > features > SMART_FORM

Get User Role

From 10.0.1, SigningHub has introduced a new response parameter smart-form under user settings

New parameter added

"smart_forms": true, "smart_forms_rights": { "Read": true, "Add": true, "Update": true, "Delete": true }

Document Package

Below are the APIs that are affected by the change.

Get Packages

From 10.0.1, SigningHub has introduced a new query parameter smart-form to search by name

New parameter added

"smart-form": "string"

Export Packages

From 10.0.1, SigningHub has introduced a new query parameter smart-form to search by name

New parameter added

"smart-form": "string"

Enterprise Management

Below are the APIs that are affected by the change.

Get Role by ID

From 10.0.1, SigningHub has introduced a new response parameter smart-form under user settings

New parameter added

"smart_form": { "enabled": true, "permissions": { "read": { "enabled": true, "editable": true }, "add": { "enabled": true, "editable": true }, "update": { "enabled": true, "editable": true }, "delete": { "enabled": true, "editable": true } } },

Add Role

From 10.0.1, SigningHub has introduced a new request parameter smart-form under user settings

New parameter added

"smart_form": { "enabled": true, "permissions": { "read": { "enabled": true, "editable": true }, "add": { "enabled": true, "editable": true }, "update": { "enabled": true, "editable": true }, "delete": { "enabled": true, "editable": true } } },

Clone Role

From 10.0.1, SigningHub has introduced a new response parameter smart-form under user settings

New parameter added

"smart_form": { "enabled": true, "permissions": { "read": { "enabled": true, "editable": true }, "add": { "enabled": true, "editable": true }, "update": { "enabled": true, "editable": true }, "delete": { "enabled": true, "editable": true } } },

Update Role

From 10.0.1, SigningHub has introduced a new request parameter smart-form under user settings

New parameter added

"smart_form": { "enabled": true, "permissions": { "read": { "enabled": true, "editable": true }, "add": { "enabled": true, "editable": true }, "update": { "enabled": true, "editable": true }, "delete": { "enabled": true, "editable": true } } },

SigningHub Admin APIs

Below are the APIs that are affected by the change.

Add Service Plan

From 10.0.1, SigningHub has introduced a new parameter to add ALLOW_SMART_FORM in the features

New parameter added

"ALLOW_SMART_FORM"

Update Service Plan

From 10.0.1, SigningHub has introduced a new parameter to add ALLOW_SMART_FORM in the features

New parameter added

"ALLOW_SMART_FORM"

Get Service Plan by ID

From 10.0.1, SigningHub has introduced a new response parameter to provide Smart form feature information

New parameter added

"ALLOW_SMART_FORM"

Authentication

Below are the APIs that are affected by the change.

Single Sign On Authentication

10.0 (Single Sign On Authentication) 10.0.1 (Single Sign On Authentication)

From 10.0.1, SigningHub has changed error Status Code for guest user from 401 to 404.

Status Code

401

Status Code

404

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

New APIs
Updates in existing APIs

New APIs

User Provisioning Via SCIM

Updates in existing APIs

General

Below are the APIs that are affected by the change.

System Settings

From 10.0.2, SigningHub returns trusted device authentication response data for configuration and display.

Response

"trusted_device_authentication": true

General

Below are the APIs that are affected by the change.

Password Authentication

From 10.0.2, SigningHub returns the "x-device"="required" if the administrator/enterprise setting are requiring to trust the device, and the user must have to provide the device information in the request header.

If the administrator/enterprise setting is requiring the device information then this header is returned.

Response Header

"x-device": "required"

If the administrator/enterprise setting are requiring the device information then use the below-format with your own device information Example: JSON Serialize of { DeviceId = "DeviceId", Name = "Chrome", Version = "120.0.0.0", Type = "Browser", Vendor = "Google", Model = "Desktop", OS = "Windows", OSVersion = "10.0.19045", Cpu = "x64", UserAgent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36" } then Base64

Request Header

"x-device": "eyJEZXZpY2VJZCI6ImRmNWJlNzFiLTdlNTMtNGEzMi05MjUwLWQ0NmU4Njc4YWRhNCIsIk5hbWUiOiJDaHJvbWUiLCJWZXJzaW9uIjoiMTIwLjAuMC4wIiwiVHlwZSI6IkJyb3dzZXIiLCJWZW5kb3IiOiJHb29nbGUiLCJNb2RlbCI6IkRlc2t0b3AiLCJPUyI6IldpbmRvd3MiLCJPU1ZlcnNpb24iOiIxMC4wLjE5MDQ1IiwiQ3B1IjoieDY0IiwiVXNlckFnZW50IjoiTW96aWxsYS81LjAgKFdpbmRvd3MgTlQgMTAuMDsgV2luNjQ7IHg2NCkgQXBwbGVXZWJLaXQvNTM3LjM2IChLSFRNTCwgbGlrZSBHZWNrbykgQ2hyb21lLzEyMC4wLjAuMCBTYWZhcmkvNTM3LjM2In0="

Single Sign On Authentication

If the administrator/enterprise setting is requiring the device information then this header is returned.

Response Header

"x-device": "required"

If the administrator/enterprise setting are requiring the device information then use the below-format with your own device informations Example: JSON Serialize of { DeviceId = "DeviceId", Name = "Chrome", Version = "120.0.0.0", Type = "Browser", Vendor = "Google", Model = "Desktop", OS = "Windows", OSVersion = "10.0.19045", Cpu = "x64", UserAgent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36" } then Base64

Request Header

"x-device": "eyJEZXZpY2VJZCI6ImRmNWJlNzFiLTdlNTMtNGEzMi05MjUwLWQ0NmU4Njc4YWRhNCIsIk5hbWUiOiJDaHJvbWUiLCJWZXJzaW9uIjoiMTIwLjAuMC4wIiwiVHlwZSI6IkJyb3dzZXIiLCJWZW5kb3IiOiJHb29nbGUiLCJNb2RlbCI6IkRlc2t0b3AiLCJPUyI6IldpbmRvd3MiLCJPU1ZlcnNpb24iOiIxMC4wLjE5MDQ1IiwiQ3B1IjoieDY0IiwiVXNlckFnZW50IjoiTW96aWxsYS81LjAgKFdpbmRvd3MgTlQgMTAuMDsgV2luNjQ7IHg2NCkgQXBwbGVXZWJLaXQvNTM3LjM2IChLSFRNTCwgbGlrZSBHZWNrbykgQ2hyb21lLzEyMC4wLjAuMCBTYWZhcmkvNTM3LjM2In0="

Client Credentials Authentication

From 10.0.2, SigningHub has introduced new request header x-scim to support SCIM protocol.

New Request Header Parameter

"x-scim": "bool"

Account Management

Below are the APIs that are affected by the change.

Configure Two-Factor Authentication

From 10.0.2, SigningHub returns two-factor authentication response data for configuration and display.

Response

{ "qrcode_base64": "string", "account": "string", "manual_key": "string", "time_based": true, "recovery_codes": [ "string" ] }

Get Notifications

10.0.1 (Get Notifications) 10.0.2 (Get Notifications)

From 10.0.2, SigningHub has introduced the new response parameter information_details which provide information details list.

New response parameter added

"information_details": "[object]"

Get Account

10.0.1 (Get Account) 10.0.2 (Get Account)

From 10.0.2, SigningHub has introduced the new response parameter service_plan > deprecated which provide the service plan deprecated information and display_plan_upgrade_banner to display banner in the application.

New response parameter added

"display_plan_upgrade_banner": "bool" "deprecated": "bool"

Get User Role

10.0.1 (Get User Role) 10.0.2 (Get User Role)

From 10.0.2, SigningHub has introduced the new response parameter user_setting > require_document_access_authentication_apply_to, require_document_sign_authentication_apply_to which provide service plan start and end date. SigningHub has also introduced the new response parameter user_setting.readonly_user_fields which provide information for restricted user fields.

New response parameter added

"require_document_access_authentication_apply_to": "string" "require_document_sign_authentication_apply_to": "string"
"readonly_user_fields": { "job_title": true, "company": true }

Enterprise Management

Below are the APIs that are affected by the change.

Get Role by ID

10-0-1 (Get Role by ID) 10-0-2 (Get Role by ID)

From 10-0-2, SigningHub has introduced the new response parameter document_settings > owner_settings > access_authentication_all_recipient > apply_to, document_settings > owner_settings > signing_authentication_all_recipient > apply_to and post_processing_all_recipient to provide the recipient authentication information and the post_processing_all_recipient information at document_settings > owner_settings object which provide information for post processing. SigningHub has also introduced the new response parameter document_settings.miscellaneous_settings.readonly_user_fields which provide information for restricted user fields.

New response parameter added

"post_processing_all_recipient": { "enabled": true }
"apply_to": "string"
"readonly_user_fields": { "job_title": true, "company": true }

Add Role

10-0-1 (Add Role) 10-0-2 (Add Role)

New response parameter added

"post_processing_all_recipient": { "enabled": true }
"apply_to": "string"
"readonly_user_fields": { "job_title": true, "company": true }

Clone Role

10-0-1 (Clone Role) 10-0-2 (Clone Role)

New response parameter added

"post_processing_all_recipient": { "enabled": true }
"apply_to": "string"
"readonly_user_fields": { "job_title": true, "company": true }

Update Role

10-0-1 (Update Role) 10-0-2 (Update Role)

From 10-0-2, SigningHub has introduced the new request parameter document_settings > owner_settings > access_authentication_all_recipient > apply_to, document_settings > owner_settings > signing_authentication_all_recipient > apply_to and post_processing_all_recipient to provide the recipient authentication information and the post_processing_all_recipient information at document_settings > owner_settings object which provide information for post processing. SigningHub has also introduced the new request parameter document_settings.miscellaneous_settings.readonly_user_fields which set configurations for restricted user fields.

New request parameter added

"post_processing_all_recipient": { "enabled": true }
"apply_to": "string"
"readonly_user_fields": { "job_title": true, "company": true }

Get Enterprise Default Settings

10-0-1 (Get Enterprise Default Settings) 10-0-2 (Get Enterprise Default Settings)

From 10-0-2, SigningHub has introduced the new response parameter post_processing and login > "trusted_device_authentication": { "enabled" : true} object which provide information for post processing and the trusted device information.

New response parameter added

"post_processing": {"all_recipients": { "enabled": true } }
"trusted_device_authentication": { "enabled" : true}

Update Enterprise Default Settings

10-0-1 (Update Enterprise Default Settings) 10-0-2 (Update Enterprise Default Settings)

From 10-0-2, SigningHub has introduced the new request parameter post_processing and login > "trusted_device_authentication": { "enabled" : true} object which provide information for post processing and the trusted device information.

New request parameter added

"post_processing": {"all_recipients": { "enabled": true } }
"trusted_device_authentication": { "enabled" : true}

Get Auto Provision Settings

From 10.0.2, SigningHub added new response parameter scim to provide the SCIM configurations.

Response

scim:{ enabled : "bool" }

Update Auto Provision Settings

From 10.0.2, SigningHub added new request parameter scim to enable/disable the SCIM configurations.

Request

scim:{ enabled : "bool" }

SigningHub Admin APIs

Below are the APIs that are affected by the change.

Get Service Plans

From 10-0-2, SigningHub has introduced the new response parameter deprecated object which provide information for deprecation status to display.

Response

"deprecated": "bool"

Get Service Plan by ID

From 10-0-2, SigningHub has introduced the new response parameter deprecated object which provide information for deprecation status to display.

Response

"deprecated": "bool"

Update Service Plan

From 10-0-2, SigningHub has introduced the new request parameter deprecated object to update the deprecation status.

Request

"deprecated": "bool"

Clone Service Plan

From 10-0-2, SigningHub has introduced the new request parameter deprecated object to update the Deprecated status.

Request

"deprecated": "bool"

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

New APIs
Updates in existing APIs

New APIs

Account Management	Initialize SslCommerz Request

Updates in existing APIs

General

Below are the APIs that are affected by the change.

About SigningHub

10.0.2 (About SigningHub)	10.0.3 (About SigningHub)
From 10.0.3, "About SigningHub" API will be accessible via Client Credentials token.

Enterprise Management

Below are the APIs that are affected by the change.

Get Enterprise Branding

10.0.2 (Get Enterprise Branding) 10.0.3 (Get Enterprise Branding)

From 10.0.3, SigningHub has added the new response parameters background_image and slider_items to provide information about background image and slider items.

New parameter added

"background_image": { "web": { "image": "string", "image_url": "string" }, "mobile": { "image": "string", "image_url": "string" }}
"slider_items": [{ "id": "int", "content": "string", "order": "int", "web": { "image": "string", "image_url": "string" }}]

Update Enterprise Branding

10.0.2 (Update Enterprise Branding)	10.0.3 (Update Enterprise Branding)
From 10.0.3, SigningHub has added the new request parameters background_image and slider_items to provide information about background image and slider items.
	New parameter added `"background_image": { "web": { "image": "string", "image_url": "string" }, "mobile": { "image": "string", "image_url": "string" }}` `"slider_items": [{ "id": "int", "content": "string", "order": "int", "web": { "image": "string", "image_url": "string" }}]`
From 10.0.3, SigningHub has added the new response parameters id, content, order and web to provide information about slider items.
	New parameter added `"id": "int"` `"content": "string"` `"order": "int"` `"web": { "image": "string", "image_url": "string" }`

Reset Enterprise Branding

10.0.2 (Reset Enterprise Branding) 10.0.3 (Reset Enterprise Branding)

From 10.0.3, SigningHub has added the new response parameters background_image and slider_items to provide information about background image and slider items.

New parameter added

"background_image": { "web": { "image": "string", "image_url": "string" }, "mobile": { "image": "string", "image_url": "string" }}
"slider_items": [{ "id": "int", "content": "string", "order": "int", "web": { "image": "string", "image_url": "string" }}]

Document Preparation

Below are the APIs that are affected by the change.

Add Textbox Field

10.0.2 (Add Textbox Field) 10.0.3 (Add Textbox Field)

From 10.0.3, SigningHub has added the new request parameter field_locale to support Arabic for Date field.

New parameter added

"field_locale": "string"

Update Textbox Field

10.0.2 (Update Textbox Field) 10.0.3 (Update Textbox Field)

From 10.0.3, SigningHub has added the new request parameter field_locale to support Arabic for Date field.

New parameter added

"field_locale": "string"

Get Document Fields

10.0.2 (Get Document Fields) 10.0.3 (Get Document Fields)

From 10.0.3, SigningHub has added the new response parameters field_locale to support Arabic for Date field.

New parameter added

"field_locale": "string"

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

New APIs
Updates in existing APIs

New APIs

Enterprise Management	Bulk Delete Enterprise Package Get Enterprise Stamps Get Enterprise Stamp Add Enterprise Stamp Update Enterprise Stamp Delete Enterprise Stamp Bulk Delete Enterprise Stamps Export Enterprise Stamps Import Enterprise Stamps Download Import Enterprise Stamp Template
Artificial Intelligence	Artificial Intelligence (AI) Execute Feature Artificial Intelligence (AI) Features
Template	Artificial Intelligence (AI) Execute Feature (Template) Artificial Intelligence (AI) Features (Template) Replicate Stamp Fields (Template) Add Stamp Field (Template) Update Stamp Field (Template)
Document Processing	Get Document Attachment Image Get Document Attachment Image (Base64) Get Document Attachment Metadata Fill Stamps
Document Preparation	Add Stamp Field Update Stamp Field Replicate Stamp Fields
Personal Settings	Get Personal Stamps Get Personal Stamp Add Personal Stamp Update Personal Stamp Delete Personal Stamp Bulk Delete Personal Stamp Revoke Active Sessions
Passkey Authentication	Create Passkey Challenge Create Passkey Get Passkeys Update Passkey Get Passkey by ID Delete Passkey Login Passkey Challenge

Updates in existing APIs

Authentication

Below are the APIs that are affected by the change.

Single Sign On Authentication

10.0.3 (Single Sign On Authentication) 10.0.4 (Single Sign On Authentication)

From 10.0.4, SigningHub has added a new authentication mechanism Pass Key to provide login option using pass key.

New mechanism added

"PassKey"

Document Package

Below are the APIs that are affected by the change.

Sign Document Package

10.0.3 (Sign Document Package) 10.0.4 (Sign Document Package)

From 10.0.4, SigningHub has added a new authentication mechanism Pass Key to provide signing option using pass key.

New mechanism added

"PassKey"

Bulk Document Sign

10.0.3 (Bulk Document Sign) 10.0.4 (Bulk Document Sign)

From 10.0.4, SigningHub has added a new authentication mechanism Pass Key to provide bulk signing option using pass key.

New mechanism added

"PassKey"

Merge All Documents

10.0.3 (Merge All Documents) 10.0.4 (Merge All Documents)

From 10.0.4, SigningHub has added a new response parameter document_id to provide the source document ID into which the documents are merged. .

New response parameter added

"document_id": 0

Reports

Below are the APIs that are affected by the change.

Signature Statistics

10.0.3 (Signature Statistics) 10.0.4 (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"

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"

Enterprise Management

Below are the APIs that are affected by the change.

Export Enterprise Users

10.0.3 (Export Enterprise Users) 10.0.4 (Export Enterprise Users)

From 10.0.4, SigningHub has added the new request parameters ids as nullable to export registered users specific to the provided IDs.

New parameter added

"ids"

Export Enterprise Invitations

10.0.3 (Export Enterprise Invitations) 10.0.4 (Export Enterprise Invitations)

From 10.0.4, SigningHub has added the new request parameters ids as nullable to export invitation users specific to the provided IDs.

New parameter added

"ids"

Get Role by ID

From 10.0.4, SigningHub has introduced a new response parameter artificial_intelligence under document_settings

New parameter added

"artificial_intelligence": { "enabled": true }

From 10.0.4, SigningHub has introduced a new response parameters stamps under document and signing sections

New response parameters added

"user_settings": {"stamps": {"enabled": true,"permissions": {"read": {"enabled": true,"editable": true},"add": {"enabled": true,"editable": true},"update": {"enabled": true,"editable": true},"delete": {"enabled": true,"editable": true}}}}
"enterprise_settings": {"stamps": {"enabled": true,"permissions": {"read": {"enabled": true,"editable": true},"add": {"enabled": true,"editable": true},"update": {"enabled": true,"editable": true},"delete": {"enabled": true,"editable": true}}}}
"document_settings": {"field_settings": {"stamp": {"enabled": true}},"stamps": {"allowed": "string","selected": [{"id": 0,"name": "string"}]}}}

Add Role

From 10.0.4, SigningHub has introduced a new response parameter artificial_intelligence under document_settings
	New parameter added `"artificial_intelligence": { "enabled": true }`
From 10.0.4, SigningHub has introduced a new response parameter stamps under the documents and signing section
	New response parameters added `"user_settings": {"stamps": {"enabled": true,"permissions": {"read": {"enabled": true,"editable": true},"add": {"enabled": true,"editable": true},"update": {"enabled": true,"editable": true},"delete": {"enabled": true,"editable": true}}}}` `"enterprise_settings": {"stamps": {"enabled": true,"permissions": {"read": {"enabled": true,"editable": true},"add": {"enabled": true,"editable": true},"update": {"enabled": true,"editable": true},"delete": {"enabled": true,"editable": true}}}}` `"document_settings": {"field_settings": {"stamp": {"enabled": true}},"stamps": {"allowed": "string","selected": [{"id": 0,"name": "string"}]}}}`

Clone Role

From 10.0.4, SigningHub has introduced a new response parameter artificial_intelligence under document_settings
	New parameter added `"artificial_intelligence": { "enabled": true }`
From 10.0.4, SigningHub has introduced a new response parameter stamps under the documents and signing section
	New response parameters added `"user_settings": {"stamps": {"enabled": true,"permissions": {"read": {"enabled": true,"editable": true},"add": {"enabled": true,"editable": true},"update": {"enabled": true,"editable": true},"delete": {"enabled": true,"editable": true}}}}` `"enterprise_settings": {"stamps": {"enabled": true,"permissions": {"read": {"enabled": true,"editable": true},"add": {"enabled": true,"editable": true},"update": {"enabled": true,"editable": true},"delete": {"enabled": true,"editable": true}}}}` `"document_settings": {"field_settings": {"stamp": {"enabled": true}},"stamps": {"allowed": "string","selected": [{"id": 0,"name": "string"}]}}}`

Update Role

From 10.0.4, SigningHub has introduced a new request parameter artificial_intelligence under document_settings
	New parameter added `"artificial_intelligence": { "enabled": true }`
From 10.0.4, SigningHub has introduced a new request parameters Stamps under the documents and signing section
	New request parameters added `"user_settings": {"stamps": {"enabled": true,"permissions": {"read": {"enabled": true,"editable": true},"add": {"enabled": true,"editable": true},"update": {"enabled": true,"editable": true},"delete": {"enabled": true,"editable": true}}}}` `"enterprise_settings": {"stamps": {"enabled": true,"permissions": {"read": {"enabled": true,"editable": true},"add": {"enabled": true,"editable": true},"update": {"enabled": true,"editable": true},"delete": {"enabled": true,"editable": true}}}}` `"document_settings": {"field_settings": {"stamp": {"enabled": true}},"stamps": {"allowed": "string","selected": [{"id": 0,"name": "string"}]}}}`

Get Enterprise User Consumed Statistics

From 10.0.4, SigningHub has introduced a new request parameter artificial_intelligence

New parameter added

"artificial_intelligence": { "allowed": "string", "consumed": "string", "serviceplan": {} }

Update Enterprise User Consumed Statistics

From 10.0.4, SigningHub has introduced a new request parameter artificial_intelligence

New parameter added

"artificial_intelligence": { "allowed": "string" }

Get Enterprise Notification Settings

From 10.0.4, SigningHub has introduced a new request parameter artificial_intelligence_tokens_limit_reached under notification_setting

New parameter added

"artificial_intelligence": { "allowed": "string" }

Update Enterprise Notifications Settings

From 10.0.4, SigningHub has introduced a new request parameter artificial_intelligence_tokens_limit_reached under notification_setting

New parameter added

"artificial_intelligence_tokens_limit_reached": { "on_screen": { "enabled": true }, "email": { "enabled": true } }

Get Enterprise Default Settings

From 10.0.4, SigningHub has introduced two new response parameters allow_artificial_intelligence and allow_attachment_preview under recipient_permissions

New parameter added

"allow_artificial_intelligence": { "enabled": true }

New parameter added

"allow_attachment_preview": { "enabled": true }

Update Enterprise Default Settings

From 10.0.4, SigningHub has introduced two new request parameters allow_artificial_intelligence and allow_attachment_preview under recipient_permissions

New parameter added

"allow_artificial_intelligence": { "enabled": true }

New parameter added

"allow_attachment_preview": { "enabled": true }

Get Workflow User Permissions of Enterprise Package

From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview

New parameter added

"artificial_intelligence": { "enabled": true }

New parameter added

"attachment_preview": { "enabled": true }

Update Workflow User Permissions of Enterprise Package

From 10.0.4, SigningHub has introduced two new request parameters artificial_intelligence and attachment_preview under permissions

New parameter added

"artificial_intelligence": { "enabled": true }

New parameter added

"attachment_preview": { "enabled": true }

Get Enterprise Branding

10.0.3 (Get Enterprise Branding) 10.0.4 (Get Enterprise 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

Update Enterprise Branding

10.0.3 (Update Enterprise Branding) 10.0.4 (Update Enterprise 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

Reset Enterprise Branding

10.0.3 (Reset Enterprise Branding) 10.0.4 (Reset Enterprise 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

Get Enterprise Logs

10.0.3 (Get Enterprise Logs)	10.0.4 (Get Enterprise Logs)
From 10.0.4, SigningHub has added the new QUERY PARAMETERS -> module option's STAMPS to support search of Stamps.

Document Processing

Below are the APIs that are affected by the change.

Bulk Signing Pre Validation

10.0.3 (Bulk Signing Pre Validation) 10.0.4 (Bulk Signing Pre Validation)

From 10.0.4, SigningHub has added the new request object search_criteria to provide the advanced search criteria for the API. Also provided new response parameter for stamp existence.

New object added

"{"search_criteria": {"document_status": "ALL","package_name": "string", "package_id": 0, "recipient_from": "string", "recipient_to": "string","document_id": 0, "expiry": 0, "modified_from": "2019-08-24T14:15:22Z", "modified_to": "2019-08-24T14:15:22Z", "size_from": 0, "size_to": 0,"certified_documents": true,"form_fields": true,"attachments": true,"document_type": "ALL", "document_statuses": [],"owned_by": "ME_OTHERS", "smart_form": "string"}}"

New property added

"tasks": {"stamp": true }}"

"success_packages": [{"stamp": { "exists": true, "mandatory": true }]}"

Bulk Sign Packages

10.0.3 (Bulk Sign Packages) 10.0.4 (Bulk Sign Packages)

From 10.0.4, SigningHub has added the new request parameter stamp to provide the stamp information.

New property added

"stamp": {"id": 0, "height": 0.1 }}"

Pre Bulk Local Signing

10.0.3 (Pre Bulk Local Signing) 10.0.4 (Pre Bulk Local Signing)

From 10.0.4, SigningHub has added the new request parameter stamp to provide the stamp information.

New property added

"stamp": {"id": 0, "height": 0.1 }}"

Pre Bulk CSC Signing

10.0.3 (Pre Bulk CSC Signing) 10.0.4 (Pre Bulk CSC Signing)

From 10.0.4, SigningHub has added the new request parameter stamp to provide the stamp information.

New property added

"stamp": {"id": 0, "height": 0.1 }}"

Account Management

Below are the APIs that are affected by the change.

Get Account

From 10.0.4, SigningHub has introduced a new parameter in the service_plan > artificial_intelligence and service_plan > constraints > artificial_intelligence_tokens

New data added

service_plan > artificial_intelligence service_plan > constraints > artificial_intelligence_tokens

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 User Role

From 10.0.4, SigningHub has introduced a new response parameter allow_artificial_intelligence under user_setting
	New parameter added `"allow_artificial_intelligence": true`
From 10.0.4, SigningHub has introduced a new response parameters Stamps feature enables enterprise and personal users to create and manage stamps
	New response parameters added `"user_setting":{ "stamps": "true","stamps_rights": { "read": "true", "add": "true", "update": "true", "delete": "true" } ,"signature_fields":{"stamps":"true"} "enterprise_stamps":{"allowed":"string","values":"["string"]"}}` `"enterprise_setting":{ "stamps": "true","stamps_rights": { "read": "true", "add": "true", "update": "true", "delete": "true" }}`

Account Usage Statistics

From 10.0.4, SigningHub has introduced a new response parameter artificial_intelligence

New parameter added

"artificial_intelligence": { "consumed": "string", "allowed": "string" }

Get Enterprise Branding and Authentication Profile

10.0.3 (Get Enterprise Branding and Authentication Profile) 10.0.4 (Get Enterprise Branding and Authentication Profile)

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

Personal Settings

Below are the APIs that are affected by the change.

Get Notification Settings

From 10.0.4, SigningHub has introduced a new response parameter in the artificial_intelligence_tokens_limit_reached

New data added

artificial_intelligence_tokens_limit_reached

Update Notifications Settings

From 10.0.4, SigningHub has introduced a new request parameter artificial_intelligence_tokens_limit_reached under notification_setting

New parameter added

"artificial_intelligence_tokens_limit_reached": { "on_screen": { "enabled": true }, "email": { "enabled": true } }

Get Active Sessions

From 10.0.4, SigningHub has introduced a new url parameter pageNo and recordsPerPage to support paggination, client_name, active in the response parameter

New data added

client_name

New data added

active

Document Workflow

Below are the APIs that are affected by the change.

Get Workflow User Permissions

From 10.0.4, SigningHub has introduced two new response parameters in the artificial_intelligence and attachment_preview

New data added

artificial_intelligence

New data added

attachment_preview

Update Workflow User Permissions

From 10.0.4, SigningHub has introduced two new request parameters artificial_intelligence and attachment_preview under permissions

New parameter added

"artificial_intelligence": { "enabled": true }

New parameter added

"attachment_preview": { "enabled": true }

Get Workflow Details

From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under users > permission

New parameter added

"artificial_intelligence": { "enabled": true }

New parameter added

"attachment_preview": { "enabled": true }

Add Users to Workflow

From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under permission

New parameter added

"artificial_intelligence": { "enabled": true }

New parameter added

"attachment_preview": { "enabled": true }

Add Groups to Workflow

From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under permission

New parameter added

"artificial_intelligence": { "enabled": true }

New parameter added

"attachment_preview": { "enabled": true }

Add Placeholder to Workflow

From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under permission

New parameter added

"artificial_intelligence": { "enabled": true }

New parameter added

"attachment_preview": { "enabled": true }

Replicate Workflow

From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under users > permission

New parameter added

"artificial_intelligence": { "enabled": true }

New parameter added

"attachment_preview": { "enabled": true }

Generate Integration URL for Encrypted Data (Coding)

From 10.0.4, SigningHub has introduced a new feature Stamps feature enable to manage, and apply digital stamps to documents during signing workflows.

New sections added

Personal Stamps Enterprise Stamps

Template

Below are the APIs that are affected by the change.

Get Workflow User Permission (Template)

From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under permissions

New data added

artificial_intelligence

New data added

attachment_preview

Update Workflow User Permission (Template)

From 10.0.4, SigningHub has introduced two new request parameters artificial_intelligence and attachment_preview under permissions

New parameter added

"artificial_intelligence": { "enabled" : true }

New data added

"attachment_preview": { "enabled" : true }

Get Workflow Details (Template)

From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under users > permission

New parameter added

"artificial_intelligence": { "enabled": true }

New parameter added

"attachment_preview": { "enabled" : true }

Add Users to Workflow (Template)

From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under users > permission

New parameter added

"artificial_intelligence": { "enabled": true }

New parameter added

"attachment_preview": { "enabled" : true }

Add Placeholder to Workflow (Template)

From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under users > permission

New parameter added

"artificial_intelligence": { "enabled": true }

New parameter added

"attachment_preview": { "enabled" : true }

Add Groups to Workflow (Template)

From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under users > permission

New parameter added

"artificial_intelligence": { "enabled": true }

New parameter added

"attachment_preview": { "enabled" : true }

Get Personal/Enterprise Template Details

From 10.0.4, SigningHub has introduced two new response parameters artificial_intelligence and attachment_preview under users > permission

New parameter added

"artificial_intelligence": { "enabled": true }

New parameter added

"attachment_preview": { "enabled" : true }

Add TextBox Field (Template)

10.0.3 (Add TextBox Field (Template)) 10.0.4 (Add TextBox Field (Template))

From 10.0.4, SigningHub has added the new request parameter field_locale and new Arabic font support ADOBE_ARABIC for Date and Number field, and response parameters field_locale and font for Date and Number field.

New parameters added

"field_locale": "string"
"ADOBE_ARABIC": "string"

New response parameters added

"field_locale": "string"
"font": "object"

Update TextBox Field (Template)

10.0.3 (Update TextBox Field (Template)) 10.0.4 (Update TextBox Field (Template))

From 10.0.4, SigningHub has added the new request parameter field_locale and new Arabic font support ADOBE_ARABIC for Date and Number field.

New parameters added

"field_locale": "string"
"ADOBE_ARABIC": "string"

Get Document Fields (Template)

10.0.3 (Get Document Fields (Template)) 10.0.4 (Get Document Fields (Template))

From 10.0.4, SigningHub has added the new request parameter field_locale and new Arabic font support ADOBE_ARABIC for Date and Number field.

New parameters added

"field_locale": "string"
"ADOBE_ARABIC": "string"

From 10.0.4, SigningHub has introduced a new feature Stamps feature enable to manage, and apply digital stamps to documents during signing workflows.

New feature added

Stamps

Get SigningHub Admin Branding

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

New parameter added

status

Document Preparation

Below are the APIs that are affected by the change.

Add Textbox Field

10.0.3 (Add Textbox Field) 10.0.4 (Add Textbox Field)

From 10.0.4, SigningHub has added the new Arabic font support ADOBE_ARABIC for the Arabic Date and Number field, and response parameters field_locale and font for Date and Number field.

New parameter added

"ADOBE_ARABIC": "string"

New response parameters added

"field_locale": "string"
"font": "object"

Update Textbox Field

10.0.3 (Update Textbox Field) 10.0.4 (Update Textbox Field)

From 10.0.4, SigningHub has added the new Arabic font support ADOBE_ARABIC for the Arabic Date and Number field.

New parameter added

"ADOBE_ARABIC": "string"

Get Document Fields

10.0.3 (Get Document Fields) 10.0.4 (Get Document Fields)

From 10.0.4, SigningHub has added the new Arabic font support ADOBE_ARABIC for the Arabic Date and Number field.

New parameter added

"ADOBE_ARABIC": "string"

AutoPlace Fields

10.0.3 (AutoPlace Fields) 10.0.4 (AutoPlace Fields)

New parameter added

"field_locale": "string"
"ADOBE_ARABIC": "string"

New response parameters added

"field_locale": "string"
"font": "object"

New feature added

Stamps

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

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

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

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

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

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

New APIs
Updates in existing APIs

New APIs

Personal Settings	Get Account Enterprises Update Account Enterprise Download Import Personal Contact Template Get Hand Signature Draw For Web Get Hand Signature Draw For Mobile Get Initials For Draw Option
Enterprise Management	Download Import Enterprise Contact Template Add Enterprise Identity Verification Policy Update Enterprise Identity Verification Policy Get Enterprise Identity Verification Policies Get Enterprise Identity Verification Policy Delete Enterprise Identity Verification Policy Bulk Delete Enterprise Identity Verification Policies Get Enterprise AI Tools Get Enterprise AI Tool by ID Add Enterprise AI Tool Update Enterprise AI Tool Delete Enterprise AI Tool Create Enterprise AI Client Delete Enterprise AI Client Get Enterprise AI Client Update Enterprise AI Client
Document Workflow	Create Identity Verification Flow Get Identity Verification Flow Status Identity Verification Callback
Account Management	Get User Identity Verification Policies

Updates in existing APIs

Authentication

Below are the APIs that are affected by the change.

Authentication

10.0.4 (Authentication) 10.0.5 (Authentication)

From 10.0.5, SigningHub introduced new optional parameters enterpriseId and subject_token to enable token exchange when switching enterprises. The subject_token is used when SSL authentication is enabled, and in this case the grant type token-exchange is required. Additionally, the x-password header parameter was added to validate SSL authentication via password.

New parameters added:

"enterpriseId"
"subject_token"

New header parameter added:

"x-password"

SSO

10.0.4 (SSO) 10.0.5 (SSO)

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"

SSL Authentication

10.0.4 (SSL Authentication) 10.0.5 (SSL Authentication)

From 10.0.5, SigningHub introduced a new response header parameter subject_token which is obtained by providing a TLS .pfx file.

New response parameter added

"subject_token"

SSL Authentication

10.0.4 (Kerberos Authentication) 10.0.5 (Kerberos Authentication)

From 10.0.5, SigningHub introduced a new response parameter subject_token which contains the active directory user email and profile information.

New response parameter added

"subject_token"

10.0.4 (Pre Login Check) 10.0.5 (Pre Login Check)

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"

Account Management

Below are the APIs that are affected by the change.

Reset Password

10.0.4 (Reset Password) 10.0.5 (Reset Password)

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"

Set New Password

10.0.4 (Set New Password) 10.0.5 (Set New Password)

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"

Send Forgot Password Request

10.0.4 (Send Forgot Password Request) 10.0.5 (Send Forgot Password Request)

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

10.0.4 (Get Account)	10.0.5 (Get Account)
From 10.0.5, SigningHub introduced a new response body parameter, default to indicate whether an enterprise is the default. More over SigningHub has added support of ARTIFICIAL_INTELLIGENCE under features list and enterprise.ai_client are added. Both will be provided if ARTIFICIAL_INTELLIGENCE is allowed in the license.
	New response body parameter added `"default"` `"ARTIFICIAL_INTELLIGENCE"` `"enterprise.ai_client"`
From 10.0.5, SigningHub has added support of Identity Verification. For this we introduce following responses: New object for showing constraints in service plan New object for identity verification providers in service plan
	New response body parameter added `"identity_verifications"` `"identity_verification" : { "enable": true, providers: [] }`

Get User Role

From 10.0.5, SigningHub has introduced a new responses parameter identity_verification_policies, identity_verification_policies_rights under enterprise_setting and enterprise_identity_verification_policies under user_setting

New parameter added

"identity_verification_policies": true
"identity_verification_policies_rights": { "Read": true, "Add": true, "Update": true, "Delete": true }
"enterprise_identity_verification_policies": { "Allowed": "ALL", "Values": [] }

Account Usage Statistics

From 10.0.5, SigningHub has introduced a new response parameter identity_verification

New parameter added

"identity_verification": { "consumed": "string", "allowed": "string" }

Personal Settings

Below are the APIs that are affected by the change.

Remove Account

10.0.4 (Remove Account) 10.0.5 (Remove Account)

From 10.0.5, SigningHub introduced a new optional response header parameter, x-multi-enterprise-user to indicate whether a user belongs to multiple enterprises.

New response header parameter added

"x-multi-enterprise-user"

Get Profile

10.0.4 (Get Profile) 10.0.5 (Get Profile)

From 10.0.5, SigningHub introduced a new response body parameter, defualt to indicate whether an enterprise is the default.

New response body parameter added

"defualt"

Get Signature Settings

10.0.4 (Get Signature Settings) 10.0.5 (Get Signature Settings)

From 10.0.5, SigningHub introduced new response body parameters, draw_image and draw_image_url to provide information related to the draw signature image.

New response body parameters added

"appearance.hand_signature.web_browser.draw_image"
"appearance.hand_signature.web_browser.draw_image_url"
"appearance.hand_signature.mobile.draw_image"
"appearance.hand_signature.mobile.draw_image_url"
"appearance.initials.draw_image"
"appearance.initials.draw_image_url"

Update Signature Settings

10.0.4 (Update Signature Settings) 10.0.5 (Update Signature Settings)

From 10.0.5, SigningHub introduced new request body parameters, draw_image to provide information related to the draw signature image.

New request body parameters added

"appearance.signature.web.draw_image"
"appearance.signature.mobile.draw_image"
"appearance.initials.draw_image"

Update Hand Signature (Browser)

10.0.4 (Update Hand Signature (Browser)) 10.0.5 (Update Hand Signature (Browser))

From 10.0.5, SigningHub introduced a new request body parameter, draw_image to provide information related to the draw signature image.

New request body parameter added

"draw_image"

Update Initial Appearance

10.0.4 (Update Initial Appearance) 10.0.5 (Update Initial Appearance)

From 10.0.5, SigningHub introduced a new request body parameter, draw_image to provide information related to the draw signature image.

New request body parameter added

"draw_image"

Update Signature Appearance Mobile

10.0.4 (Update Signature Appearance Mobile) 10.0.5 (Update Signature Appearance Mobile)

From 10.0.5, SigningHub introduced a new request body parameter, draw_image to provide information related to the draw signature image.

New request body parameter added

"draw_image"

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

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

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

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

Enterprise Management

Below are the APIs that are affected by the change.

Get Role by ID

From 10.0.5, SigningHub has introduced a new response parameters ai_management under enterprise_settings. It will be provided if AI client is configured against the enterprise, feature is allowed in service plan, AI is allowed in the license.
	New response parameters added `"enterprise_settings": {"ai_management": {"enabled": true,"permissions": {"read": {"enabled": true,"editable": true},"add": {"enabled": true,"editable": true},"update": {"enabled": true,"editable": true},"delete": {"enabled": true,"editable": true}}}}`
From 10.0.5, SigningHub has introduced a new response parameters identity_verification_policies under enterprise_settings. Also, identity_verification_policies under document_settings that provide allowed policies.
	New response parameters added `"enterprise_settings": { "enabled": true, "permissions": { "read": { "enabled": true, "editable": true }, "add": { "enabled": true, "editable": true }, "update": { "enabled": true, "editable": true }, "delete": { "enabled": true, "editable": true }}}` `"document_settings": { "allowed": "ALL", "selected": []}`

Add Role

From 10.0.5, SigningHub has introduced a new response parameters ai_management under enterprise_settings. It will be provided if AI client is configured against the enterprise, feature is allowed in service plan, AI is allowed in the license.
	New response parameters added `"enterprise_settings": {"ai_management": {"enabled": true,"permissions": {"read": {"enabled": true,"editable": true},"add": {"enabled": true,"editable": true},"update": {"enabled": true,"editable": true},"delete": {"enabled": true,"editable": true}}}}`
From 10.0.5, SigningHub has introduced a new response parameters identity_verification_policies under enterprise_settings. Also, identity_verification_policies under document_settings that provide allowed policies.
	New response parameters added `"enterprise_settings": { "enabled": true, "permissions": { "read": { "enabled": true, "editable": true }, "add": { "enabled": true, "editable": true }, "update": { "enabled": true, "editable": true }, "delete": { "enabled": true, "editable": true }}}` `"document_settings": { "allowed": "ALL", "selected": []}`

Clone Role

From 10.0.5, SigningHub has introduced a new response parameters ai_management under enterprise_settings. It will be provided if AI client is configured against the enterprise, feature is allowed in service plan, AI is allowed in the license.
	New response parameters added `"enterprise_settings": {"ai_management": {"enabled": true,"permissions": {"read": {"enabled": true,"editable": true},"add": {"enabled": true,"editable": true},"update": {"enabled": true,"editable": true},"delete": {"enabled": true,"editable": true}}}}`
From 10.0.5, SigningHub has introduced a new response parameters identity_verification_policies under enterprise_settings. Also, identity_verification_policies under document_settings that provide allowed policies.
	New response parameters added `"enterprise_settings": { "enabled": true, "permissions": { "read": { "enabled": true, "editable": true }, "add": { "enabled": true, "editable": true }, "update": { "enabled": true, "editable": true }, "delete": { "enabled": true, "editable": true }}}` `"document_settings": { "allowed": "ALL", "selected": []}`

Update Role

From 10.0.5, SigningHub has introduced a new request parameters ai_management under enterprise_settings. It will be effective if AI client is configured against the enterprise, feature is allowed in service plan, AI is allowed in the license.

New request parameters added

"enterprise_settings": {"ai_management": {"enabled": true,"permissions": {"read": {"enabled": true,"editable": true},"add": {"enabled": true,"editable": true},"update": {"enabled": true,"editable": true},"delete": {"enabled": true,"editable": true}}}}

Get Enterprise Integrations

From 10.0.5, SigningHub has introduced a new response parameter lock_panels to provider information about lock panel.

New response parameters added

"lock_panels": false

Get Enterprise Integration by ID

From 10.0.5, SigningHub has introduced a new response parameter lock_panels scope_token_allowed to provider information about lock panel and the scope token allowed.

New response parameters added

"lock_panels": false
"scope_token_allowed": true

Add Enterprise Integration

From 10.0.5, SigningHub has introduced a new request parameter lock_panels scope_token_allowed to provider information about lock panel and the scope token allowed.

New response parameters added

"lock_panels": false
"scope_token_allowed": false

Update Enterprise Integration

From 10.0.5, SigningHub has introduced a new request parameter lock_panels scope_token_allowed to provider information about lock panel and the scope token allowed.
	New response parameters added `"lock_panels": false` `"scope_token_allowed": false`
From 10.0.5, SigningHub has introduced a new request parameters identity_verification_policies under enterprise_settings. Also, identity_verification_policies under document_settings that provide allowed policies.
	New request parameters added `"enterprise_settings": { "enabled": true, "permissions": { "read": { "enabled": true, "editable": true }, "add": { "enabled": true, "editable": true }, "update": { "enabled": true, "editable": true }, "delete": { "enabled": true, "editable": true }}}` `"document_settings": { "allowed": "ALL", "selected": []}`

Get Enterprise Notification Settings

From 10.0.5, SigningHub has introduced a new response parameter identity_verifications_limit_reached under notification_setting

New parameter added

"identity_verifications_limit_reached": { "on_screen": { "enabled": true, "editable": true }, "email": { "enabled": true, "editable": true }, "push": { "enabled": true, "editable": true } }

Update Enterprise Notifications Settings

From 10.0.5, SigningHub has introduced a new request parameter identity_verifications_limit_reached under notification_setting

New parameter added

"identity_verifications_limit_reached": { "on_screen": { "enabled": true }, "email": { "enabled": true } }

Get Enterprise User Consumed Statistics

From 10.0.5, SigningHub has introduced a new response parameter identity_verifications

New parameter added

"identity_verifications": { "allowed": "string", "consumed": "string", "serviceplan": { "allowed": "string" } }

Update Enterprise User Consumed Statistics

From 10.0.5, SigningHub has introduced a new request parameter identity_verifications

New parameter added

"identity_verifications": { "allowed": "string" }

Document Workflow

Below are the APIs that are affected by the change.

Generate Integration URL for Encrypted Data (Coding)

From 10.0.5, SigningHub has introduced a new parameter ENTERPRISE_ARTIFICIAL_INTELLIGENCE_TOOLS, ENTERPRISE_ARTIFICIAL_INTELLIGENCE_CLIENT and lock_panels. It will be effective if AI client is configured against the enterprise, feature is allowed in service plan, AI is allowed in the license. and the lock panels to lock panel.

New parameter added

"ENTERPRISE_ARTIFICIAL_INTELLIGENCE_TOOLS"
"ENTERPRISE_ARTIFICIAL_INTELLIGENCE_CLIENT"
"lock_panels": false

Integration Decrypt

New parameter added

"ENTERPRISE_ARTIFICIAL_INTELLIGENCE_TOOLS"
"ENTERPRISE_ARTIFICIAL_INTELLIGENCE_CLIENT"
"lock_panels": false

Get Workflow User Authentication (Document Opening)

From 10.0.5, SigningHub has introduced a new parameter identity_verification under authentication and authentication_signing.

New parameter added

"identity_verification": { "enabled": true, "identity_verification_policy": { "id": 0, "name": "string" } }

Update Workflow User Authentication (Document Opening)

From 10.0.5, SigningHub has introduced a new parameter identity_verification under authentication and authentication_signing.

New parameter added

"identity_verification": { "enabled": true, "identity_verification_policy": { "id": 0 } }

Get Workflow User Authentication (Document Opening) of Enterprise Package

From 10.0.5, SigningHub has introduced a new parameter identity_verification under authentication and authentication_signing.

New parameter added

"identity_verification": { "enabled": true, "identity_verification_policy": { "id": 0, "name": "string" } }

Update Workflow User Authentication (Document Opening) of Enterprise Package

From 10.0.5, SigningHub has introduced a new parameter identity_verification under authentication and authentication_signing.

New parameter added

"identity_verification": { "enabled": true, "identity_verification_policy": { "id": 0 } }

Get Workflow Details

From 10.0.5, SigningHub has introduced two new response parameters identity_verification under users > permission inside authentication and authentication_signing

New parameter added

"identity_verification": { "enabled": true, "identity_verification_policy": { "id": 0 } }

Replicate Workflow

From 10.0.5, SigningHub has introduced two new response parameters identity_verification under users > permission inside authentication and authentication_signing

New parameter added

"identity_verification": { "enabled": true, "identity_verification_policy": { "id": 0 } }

Document Package

Below are the APIs that are affected by the change.

Upload Document Base64

From 10.0.5, SigningHub has updated the response parameter certify for XML and DOCX documents.

updated parameter

"certify": { "enabled": false, "allowed_permissions": [], "default_permission": "" }

Upload Document

From 10.0.5, SigningHub has updated the response parameter certify for XML and DOCX documents.

updated parameter

"certify": { "enabled": false, "allowed_permissions": [], "default_permission": "" }

Multipart Document Upload

From 10.0.5, SigningHub has updated the response parameter certify for XML and DOCX documents.

updated parameter

"certify": { "enabled": false, "allowed_permissions": [], "default_permission": "" }

Get Attachments

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Upload Attachment

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Delete Attachment

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Download Attachment

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Download Attachment (base64)

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Download Document

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Download Document (Base64)

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Get Document Details

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Get Document Image

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Get Document Image (Base64)

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Get Document Thumbnail

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Get Document Thumbnail (Base64)

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Close Document Package

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Open Document Package

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Print Document

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Download Package

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Download-Package-Base64-10-0-5

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Merge Document

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

On Page Comments

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Template

Below are the APIs that are affected by the change.

Get Workflow User Authentication (Document Opening) (Template)

From 10.0.5, SigningHub has introduced new response parameters identity_verification under authentication and authentication_signing.

New parameter added

"identity_verification": { "enabled": true, "identity_verification_policy": { "id": 0, "name": "string" } }

Update Workflow User Authentication (Document Opening) (Template)

From 10.0.5, SigningHub has introduced a new parameter identity_verification under authentication and authentication_signing.

New parameter added

"identity_verification": { "enabled": true, "identity_verification_policy": { "id": 0 } }

Get Workflow Details (Template)

From 10.0.5, SigningHub has introduced two new response parameters identity_verification under users > permission inside authentication and authentication_signing

New parameter added

"identity_verification": { "enabled": true, "identity_verification_policy": { "id": 0 } }

Add Digital Signature Field (Template)

From 10.0.5, SigningHub has introduced new request parameter identity_verification under authentication_signing.

New parameter added

"identity_verification": { "enabled": true, "policy": { "id": 0 } }

Update Digital Signature Field (Template)

From 10.0.5, SigningHub has introduced new request parameter identity_verification under authentication_signing.

New parameter added

"identity_verification": { "enabled": true, "policy": { "id": 0 } }

Add In-person Field (Template)

From 10.0.5, SigningHub has introduced new request parameter identity_verification under authentication_signing.

New parameter added

"identity_verification": { "enabled": true, "policy": { "id": 0 } }

Update In-person Field (Template)

From 10.0.5, SigningHub has introduced new request parameter identity_verification under authentication_signing.

New parameter added

"identity_verification": { "enabled": true, "policy": { "id": 0 } }

Replicate In-person Field (Template)

From 10.0.5, SigningHub has introduced new response parameter identity_verification under authentication_signing.

New parameter added

"identity_verification": { "enabled": true, "policy": { "id": 0 } }

Get Document Fields (Template)

From 10.0.5, SigningHub has introduced new response parameter identity_verification under signature, electronic_signature and in_person_signature.

New parameter added

"identity_verification": { "enabled": true, "policy": { "id": 0, "name": "string" } }

Document Preparation

Below are the APIs that are affected by the change.

Add Digital Signature Field

From 10.0.5, SigningHub has introduced new request parameter identity_verification under authentication_signing.

New parameter added

"identity_verification": { "enabled": true, "policy": { "id": 0 } }

Update Digital Signature Field

From 10.0.5, SigningHub has introduced new request parameter identity_verification under authentication_signing.

New parameter added

"identity_verification": { "enabled": true, "policy": { "id": 0 } }

Add In-person Field

From 10.0.5, SigningHub has introduced new request parameter identity_verification under authentication_signing.

New parameter added

"identity_verification": { "enabled": true, "policy": { "id": 0 } }

Update In-person Field

From 10.0.5, SigningHub has introduced new request parameter identity_verification under authentication_signing.

New parameter added

"identity_verification": { "enabled": true, "policy": { "id": 0 } }

Replicate In-person Fields

From 10.0.5, SigningHub has introduced new response parameter identity_verification under authentication_signing.

New parameter added

"identity_verification": { "enabled": true, "policy": { "id": 0 } }

Get Document Fields

From 10.0.5, SigningHub has introduced new response parameter identity_verification under signature, electronic_signature and in_person_signature.

New parameter added

"identity_verification": { "enabled": true, "policy": { "id": 0, "name": "string" } }

Document Processing

Below are the APIs that are affected by the change.

Get Document Attachment Image

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Get Document Attachment Image (Base64)

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Get Document Attachment Metadata

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Gatekeeper Approve Document

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Approve Document

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Submit Document

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Fill Form Fields

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Save Package Form Fields

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Sign Document

From 10.0.5, SigningHub has introduced the x-identity-verification header parameter to support identity verification.

New header parameter added

"x-identity-verification": "string"

Pre Local Signing

From 10.0.5, SigningHub has introduced the x-identity-verification header parameter to support identity verification.

New header parameter added

"x-identity-verification": "string"

Pre EID Easy Signing

From 10.0.5, SigningHub has introduced the x-identity-verification header parameter to support identity verification.

New header parameter added

"x-identity-verification": "string"

Get Document Hash

From 10.0.5, SigningHub has introduced the x-identity-verification header parameter to support identity verification.

New header parameter added

"x-identity-verification": "string"

Embed Signature

From 10.0.5, SigningHub has introduced the x-identity-verification header parameter to support identity verification.

New header parameter added

"x-identity-verification": "string"

Sign Document via RSSP Directly

From 10.0.5, SigningHub has introduced the x-identity-verification header parameter to support identity verification.

New header parameter added

"x-identity-verification": "string"

Bulk Sign Packages

From 10.0.5, SigningHub has introduced the x-identity-verification and x-open-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

"x-open-identity-verification": "string"

Bulk Action Pre Validation

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Pre-Bulk CSC Signing

From 10.0.5, SigningHub has introduced the x-identity-verification and x-open-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

"x-open-identity-verification": "string"

Pre-Bulk Local Signing

From 10.0.5, SigningHub has introduced the x-identity-verification and x-open-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

"x-open-identity-verification": "string"

Artificial Intelligence

Below are the APIs that are affected by the change.

Artificial Intelligence (AI) Execute Feature

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

Artificial Intelligence (AI) Features

From 10.0.5, SigningHub has introduced the x-identity-verification header parameters to support identity verification.

New header parameter added

"x-identity-verification": "string"

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

New APIs
Updates in existing APIs

New APIs

Authentication	Verisec Authentication Verisec Authentication Status
Enterprise Management	Download Import Enterprise Library Template Download Import Enterprise Template (Template) Get Allowed Enterprise Roles
Template	Add Personal Template to Enterprise
Document Workflow	Pre Validate Workflow User

Updates in existing APIs

Account Management

Below are the APIs that are affected by the change.

Get Account

10.0.5 (Get Account) 10.0.6 (Get Account)

From 10.0.6, SigningHub has introduced a new response body parameter enterprise.warning_conformance that indicates whether non-PDF/A documents should surface a warning. The value is true when Warn about non PDF/A documents is enabled in enterprise advanced settings.

New response body parameter added

"enterprise.warning_conformance": true

Send Forgot Password Request

10.0.5 (Send Forgot Password Request)	10.0.6 (Send Forgot Password Request)
From version 10.0.6, SigningHub provides an option to configure a custom URL for password reset. A “Forgot/Reset Password URL” field has been added in SigningHub Admin under Password Settings. When configured, it is used as the base URL for the password reset process.

Get User Role

From 10.0.6, SigningHub has introduced a new response parameter enterprise_roles under user_setting. It will provide allowed enterprise roles.

New response parameters added

"enterprise_roles": { "Allowed": "string", "Values": [ "string" ]}

Enterprise Management

Below are the APIs that are affected by the change.

Get Enterprise Default Settings

10.0.5 (Get Enterprise Default Settings) 10.0.6 (Get Enterprise Default Settings)

From 10.0.6, SigningHub has introduced a new response object document_compliance with a warning flag, used to opt the enterprise into the non-PDF/A document warning.

New response parameter added

"document_compliance": { "warning": true }

Update Enterprise Default Settings

10.0.5 (Update Enterprise Default Settings) 10.0.6 (Update Enterprise Default Settings)

From 10.0.6, SigningHub has introduced a new optional request object document_compliance with a warning flag to enable or disable the non-PDF/A document warning at the enterprise level.

New request parameter added

"document_compliance": { "warning": true }

Reset Enterprise User Password

10.0.5 (Reset Enterprise User Password)	10.0.6 (Reset Enterprise User Password)
From version 10.0.6, SigningHub provides an option to configure a custom URL for password reset. A “Forgot/Reset Password URL” field has been added in SigningHub Admin under Password Settings. When configured, it is used as the base URL for the password reset process.

Get Roles

From 10.0.6, SigningHub has introduced a new query parameter id. It will be used to filter roles by ids.

New query parameter added

"id": "int"

Get Role by ID

From 10.0.6, SigningHub has introduced a new response parameter enterprise_roles_settings. It will provide allowed enterprise roles.

New response parameters added

"enterprise_roles_settings": { "enterprise_roles": { "allowed": "string", "selected": [{ "id": 0, "name": "string" }]}}

Add Role

From 10.0.6, SigningHub has introduced a new response parameter enterprise_roles_settings. It will provide allowed enterprise roles.

New response parameters added

"enterprise_roles_settings": { "enterprise_roles": { "allowed": "string", "selected": [{ "id": 0, "name": "string" }]}}

Clone Role

From 10.0.6, SigningHub has introduced a new response parameter enterprise_roles_settings. It will provide allowed enterprise roles.

New response parameters added

"enterprise_roles_settings": { "enterprise_roles": { "allowed": "string", "selected": [{ "id": 0, "name": "string" }]}}

Update Role

From 10.0.6, SigningHub has introduced a new request parameter enterprise_roles_settings. It will provide allowed enterprise roles.

New request parameters added

"enterprise_roles_settings": { "enterprise_roles": { "allowed": "string", "selected": [{ "id": 0, "name": "string" }]}}

Get Enterprise Branding and Authentication Profile

10.0.5 (Get Enterprise Branding and Authentication Profile) 10.0.6 (Get Enterprise Branding and Authentication Profile)

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

Get Enterprise Branding

10.0.5 (Get Enterprise Branding) 10.0.6 (Get Enterprise Branding)

New response parameter added

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

Update Enterprise Branding

10.0.5 (Update Enterprise Branding) 10.0.6 (Update Enterprise 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 Enterprise Branding

10.0.5 (Reset Enterprise Branding) 10.0.6 (Reset Enterprise Branding)

New response parameter added

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

Get SigningHub Admin Branding

10.0.5 (Get SigningHub Admin Branding) 10.0.6 (Get SigningHub Admin Branding)

New response parameter added

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

General

Below are the APIs that are affected by the change.

System Settings

10.0.5 (System Settings) 10.0.6 (System Settings)

From version 10.0.6, SigningHub provides an option to show or hide the “Can’t access your account?” option on the login screen.

New response parameter added

"hide_forgot_reset_password_option": false

10.0.5 (System Settings) 10.0.6 (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

"authentication_flow": POPUP

Template

Below are the APIs that are affected by the change.

Save Workflow as Template

10.0.5 (Save Workflow as Template) 10.0.6 (Save Workflow as Template)

From 10.0.6, SigningHub introduced new optional parameters scopes to enable save workflow as enterprise template. It supports only two values i.e. Personal and Enterprise.

New parameters added:

"scopes": ["Personal", "Enterprise"]

Authentication

Below are the APIs that are affected by the change.

Authentication

10.0.5 (Authentication) 10.0.6 (Authentication)

From 10.0.6, SigningHub introduced new response header parameter x-session-id that contains the current authenticated user session ID.

New response header parameter added:

"x-session-id"

SSO

10.0.5 (SSO) 10.0.6 (SSO)

From 10.0.6, SigningHub introduced new response header parameter x-session-id that contains the current authenticated user session ID.

New response header parameter added:

"x-session-id"

Logout/Device De-registration

10.0.5 (Logout/Device De-registration) 10.0.6 (Logout/Device De-registration)

From 10.0.6, SigningHub introduced new optional request header parameter x-session-id that contains the current authenticated user's session ID. If the Authorization header is provided, the user will be authenticated using the access token. If the Authorization header is not provided, the session ID can be used instead.

New request header parameter added:

"x-session-id"

Personal Settings

Below are the APIs that are affected by the change.

Change Password

10.0.5 (Change Password) 10.0.6 (Change Password)

From 10.0.6, SigningHub introduced new response header parameter x-session-id that contains the current authenticated user session ID.

New response header parameter added:

"x-session-id"

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

Workflow Management

Below are the APIs that are affected by the change.

Update Workflow User

10.0.5 (Update Workflow User)	10.0.6 (Update Workflow User)
From version 10.0.6, user_national_idis used to update the National ID of a guest user when National ID is allowed.
	`"user_national_id": "string"`

Update Workflow User of Enterprise Package

10.0.5 (Update Workflow User of Enterprise Package)	10.0.6 (Update Workflow User of Enterprise Package)
From version 10.0.6, user_national_idis used to update the National ID of a guest user when National ID is allowed.
	`"user_national_id": "string"`

SignalR

Document Package Hub

DocumentPackageHub is an ASP.NET Core SignalR hub that provides real-time communication capabilities for managing document packages. It enables clients to subscribe to and unsubscribe from package-specific groups, allowing for targeted real-time document redirection in case document is deleted by admin. The hub implements a group-based subscription model where clients connect with authentication tokens and subscribe to specific document package groups. All hub methods are protected by the JWT token.

Public Methods

ASYNC AUTHORIZED SubscribePackageGroup

Subscribes a client connection to a specific package group after performing comprehensive validation. The method validates authentication, user authorization, user existence, and folder item status before adding the client to the group.

                public async Task SubscribePackageGroup(long packageId, long folderId)
            

Parameters

Parameter	Type	Description
`packageId`	`long`	The unique identifier of the document package. Used to create the group name in format `Package:{packageId}`
`folderId`	`long`	Optional. The folder ID of selected folder in which document resides. This is used for Archive and Shared Space cases. Defaults to 0 if not provided.

Error Handling

Silent Failures: The method uses silent failures for validation errors.No exceptions are thrown to the client. Instead, validation failures are logged and the method returns without joining the group. This prevents connection disconnection and allows clients to retry.

If any validation fails, the method returns silently and logs a debug message. The client remains connected but is not added to the group.

ASYNC AUTHORIZED UnsubscribePackageGroup

Removes a client connection from a specific package group. This method is fault-tolerant and handles exceptions gracefully without throwing errors.

                public async Task UnsubscribePackageGroup(long packageId)
            

Parameters

Parameter	Type	Description
`packageId`	`long`	The unique identifier of the document package to unsubscribe from.

Behavior

Removes the client connection from the package group
Logs successful removal at debug level
Catches any exceptions and logs them without re-throwing

✓ Fault-Tolerant: This method is designed to be fault-tolerant.Any exceptions occurring during group removal are caught and logged silently. The method will never throw exceptions to the caller.

Security

Authentication Requirements

All hub methods require valid JWT Bearer authentication via the [Authorize] attribute.

Client must provide valid JWT access token via SignalR connection
Token must include user_id claim
Token must include role claim matching one of:
- TokenUserClaimRole.USER
- TokenUserClaimRole.CLIENT_SCOPE

Integration Examples

Client Connection (Angular)

import * as signalR from "@microsoft/signalr";const connection = new signalR.HubConnectionBuilder()    .withUrl("/documentPackageHub", {        accessTokenFactory: () => getAccessToken()    })    .withAutomaticReconnect()    .build();await connection.start();

Subscribe to Package

// Subscribe to package 12345 in folder 67890await connection.invoke(      "SubscribePackageGroup",    12345, // packageId    67890  // folderId);

Listen for Updates

// Register event handler for updatesconnection.on(      "PackageUpdated",    (data) => {        console.log("Package updated:", data);    });

Unsubscribe from Package

await connection.invoke(      "UnsubscribePackageGroup",    12345);

Group Naming Convention

Format: Package:{packageId}

When broadcasting messages to package groups from other services, use this format to ensure messages reach the correct subscribers. For example, to notify all clients subscribed to package 12345, broadcast to group Package:12345.

Troubleshooting

Client Not Joining Group

Symptom: Client calls SubscribePackageGroup but does not receive package updates.
Cause: One of the validation steps failed silently.

Solution: Check debug logs for specific failure reason:

Verify user is properly authenticated with valid JWT token
Check that token contains user_id claim with positive integer value
Confirm user exists in the system
Verify folder item exists and has PENDING status
Review debug logs for specific validation failure message

Connection Disconnects Immediately

Cause: Authentication token is invalid or expired.

Solution: Implement token refresh logic on the client side. Use SignalR's automatic reconnect feature with a token refresh strategy.

Messages Not Received After Subscription

Cause: Server may not be broadcasting to the correct group name.

Solution: Verify server-side code broadcasts to the correct group name format: Package:{packageId}

APIs Developer Guide

The APIs Developer Guide provides the information required to integrate with and use the SigningHub 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" : "한국"