Documentation Powered by Redocly

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

Account Management

This section entails the web services for the Account Management i.e. Register User, Set or Reset Password, Get Role etc.

Profile

APIs for managing user account information, preferences, roles, branding, and account configuration.

Get Enterprise Branding and Authentication Profile

Enterprise users can use this API to fetch branding and private authentication profile for their enterprise.

path Parameters
enterprise_url
required
string

Enterprise URL, to identify enterprise for which branding and authentication profile are to be fetched.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

OAuth access token obtained as a result of "Client Credentials Authentication" or "Password Authentication"

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-base64
string
Default: true

Responses

Response samples

Content type
application/json
{
  • "enterprise_id": 0,
  • "enterprise_name": "string",
  • "branding": {
    },
  • "authentication_profile": {
    }
}

Get User Electronic Seal Profiles

Business applications can use this service API to get a list of all the ADSS and CSC Electronic Seal profiles as configured the enterprise role.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Feedback

Business applications can use this service API to request feedback from a user who had just deleted their account. Feedback could be used by the business to determine areas of improvements, and help determine the reason for account deletion.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

OAuth access token obtained as a result of "Client Credentials Authentication"

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
feedBack
string or null
q
string or null

Responses

Request samples

Content type
{
  • "feedBack": "string",
  • "q": "string"
}

Response samples

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

Get All Service Plans

Business applications can use this service API for billing. We use a client credential token for registered service plans, whether they are ONLINE or NOBILLING, and a user credential token for upgradable service plans.

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

recordsPerPage
required
integer <int32>

Total number of records to be retrieved in a page.

query Parameters
id
integer <int32>
Default: 0

ID of the serivce plan

billing_type
string (Enumerations.ServicePlanBillingType)
Enum: "PAY_REGULARLY" "PAY_AS_YOU_GO" "ALL" "FREE_TRIAL"
type
string (Enumerations.ServicePlanType)
Enum: "INDIVIDUAL" "ENTERPRISE" "NONE"
sort-by
string (Enumerations.UpgradeServicePlanSortBy)
Enum: "NAME" "PRICE" "YEARLYPRICE" "SIGNATURES" "USERS" "STORAGE"
asc
boolean
Default: false
header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-search-text
string
Default: John Doe

Search text sent in headers for further filtration of the documents. Package id, name and document owner can be searched.
Furthermore, recommended value for search text parameter is in Base64 encoded format.

x-currency
string
Default: USD | EUR | GBP | BDT

Optional header to specify the currency for conversion. If not provided, the default currency is used. When supplied, the API applies the conversion rate based on the specified currency value.

x-total-records
string
Default: 10

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Register User Account

Business applications can use this service API to register a new user with either a Trial or an Online service plan. We utilize the billing response. We capture the billing based on the transaction key, whether it's a placeholder or a confirmed transaction.

This process depends on the service plan. If the service plan is online, then the billing response is mandatory.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
user_name
required
string non-empty

The name of the user to be registered.

user_email
required
string non-empty

The email Address of the user to be registered.

job_title
string or null

The job title of the user. (Optional)

company_name
string or null

The company name for the user. (Optional)

mobile_number
string or null

The mobile number of the user. (Optional)

country
string or null

The country name for the user. All values in the appendix - Country list are accepted. (Optional)

time_zone
string or null

The timezone name for the user. All values in the appendix - Timezone list are accepted. (Optional)

language
string or null

The language selected for the user. All values in the appendix - Language list are accepted. (Optional)

object (Models.RegisterInvitaion)

RegisterInvitaion

service_agreements
boolean

The service agreements user consent for account registration.

user_ra_id
string or null

The remote authorization ID of the user.

user_csc_id
string or null

The cloud Signature Consortium (CSC) user Id that will be required when signing(CSC) via client credential flow

marketing_emails
boolean

To receive promotional emails against marketing campaign, this must be set to true.

object (Custom.ServicePlanPaymentRequest)
user_national_id
string or null

National identity number of the user. This helps to identify users in the workflow

Responses

Request samples

Content type
{
  • "user_name": "string",
  • "user_email": "string",
  • "job_title": "string",
  • "company_name": "string",
  • "mobile_number": "string",
  • "country": "string",
  • "time_zone": "string",
  • "language": "string",
  • "invitation": {
    },
  • "service_agreements": true,
  • "user_ra_id": "string",
  • "user_csc_id": "string",
  • "marketing_emails": true,
  • "service_plan": {
    },
  • "user_national_id": "string"
}

Response samples

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

Get Account

Business applications can use this service API to get the account information of a logged in user.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json

Responses

Response samples

Content type
application/json
{
  • "user_id": 0,
  • "user_email": "string",
  • "user_name": "string",
  • "user_national_id": "string",
  • "job_title": "string",
  • "company_name": "string",
  • "mobile_number": "string",
  • "time_zone": "string",
  • "display_plan_upgrade_banner": true,
  • "language": "string",
  • "country": "string",
  • "created_on": "string",
  • "enabled": true,
  • "two_factor_authentication_enabled": true,
  • "fonts": [
    ],
  • "billing": {
    },
  • "service_plan": {
    },
  • "enterprise": {
    },
  • "last_login": "string",
  • "default": true,
  • "multiple_enterprise": true,
  • "invitations": 0
}

Get Basic Account

Business applications can use this service API to get the basic account information of a logged in user.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json

Responses

Response samples

Content type
application/json
{
  • "user_email": "string",
  • "user_name": "string",
  • "enterprise": {
    }
}

Get User Role

Business applications can use this service API to get the enterprise role and list of features of the application allowed by the enterprise admin.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-base64
string

True if response should have images in base64 format. False will only return the resource URLs in response.

Responses

Response samples

Content type
application/json
{
  • "role_name": "string",
  • "access_control": {
    },
  • "user_setting": {
    },
  • "enterprise_setting": {
    }
}

Security

APIs for managing account security, passwords, authentication settings, tokens, and device registrations.

Delete Refresh Token

Business applications can use this service API to delete refresh token of the current user.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json

Responses

Response samples

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

Reset Password

This API is specifically used by business applications to reset their account passwords. Access token can be used to reset password for a user. Authentication API will return new access token and refresh token in response when password is reset. Further API calls should be made using this new access/refresh token as previous access/refresh tokens are expired

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-enterprise-id
string
Default: 1

Provide an integer enterprise ID (for example, "1") to access that specified enterprise.

Request Body schema:
security_answer
string or null
user_new_password
string or null
user_email
string or null

Responses

Request samples

Content type
{
  • "security_answer": "string",
  • "user_new_password": "string",
  • "user_email": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "string",
  • "expires_in": 0,
  • "refresh_token": "string"
}

Send Forgot Password Request

Business applications can use this service API to send an email with instructions to reset a user’s password. SigningHub also provides an option to configure a custom URL. A field "Forgot / reset password URL" has been added in SigningHub Admin under Password Settings. When configured, it is used as the base URL for password reset.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

OAuth access token obtained as a result of "Client Credentials Authentication"

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-enterprise-id
string
Default: 1

Provide an integer enterprise ID (for example, "1") to access that specified enterprise.

Request Body schema:
user_email
required
string non-empty

Email address of user for which the forget password request is to be sent.

Responses

Request samples

Content type
{
  • "user_email": "string"
}

Response samples

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

Set New Password

This API is specifically used by business applications to change their account passwords. SigningHub requires a business application to change password on the following events:

  1. Password Expiry - When the account password has expired after a predefined time duration, i.e. as configured in their password policy.

  2. Enforce Password Change on First Login - When this option is configured in their password policy.

Query parameter "q" can be used to set a new password for a user. Authentication API call will return x-change-password response header when password reset required. The value of x-change-password can be used as "q" for this API

header Parameters
Authorization
required
string
Default: Bearer {access_token}

OAuth access token obtained as a result of "Client Credentials Authentication"

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
security_question
required
string non-empty

Security question that is to be set.

security_answer
required
string non-empty

Security answer that is to be set.

password
required
string non-empty

Password of the user that is to be set.

q
required
string non-empty

Query parameter that you received

Responses

Request samples

Content type
{
  • "security_question": "string",
  • "security_answer": "string",
  • "password": "string",
  • "q": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "string",
  • "expires_in": 0,
  • "refresh_token": "string"
}

Recover Password

Business application can use this API to send password recovery email to the user who's password recovery is needed.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

OAuth access token obtained as a result of "Client Credentials Authentication"

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
user_email
required
string non-empty

Email address of user who's password recovery is required

recovery_url
string or null

Optional : Url of password recovery page to get relevant information from end-user and use it to set new password

Responses

Request samples

Content type
{
  • "user_email": "string",
  • "recovery_url": "string"
}

Response samples

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

Get Account Password Policy

Business applications can use this service API to get the password policy for the account of a logged in user.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
user_email
required
string non-empty

Responses

Request samples

Content type
{
  • "user_email": "string"
}

Response samples

Content type
application/json
{
  • "number": true,
  • "special_character": true,
  • "upper_case": true,
  • "minimum_length": 0
}

Device Registration for Push Notification

This API can be used for registering mobile devices for sending push notifications.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
device_token
required
string non-empty

Token generated by the mobile apps. This token is used why sending push notifications from Google's Firebase Cloud Messaging.

os_type
required
string non-empty

Operating system that will handle the push notifications. Possible values are IOS and ANDROID.

Responses

Request samples

Content type
{
  • "device_token": "string",
  • "os_type": "string"
}

Response samples

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

Validate User

Business applications can use this service API to validate the user.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
email
required
string <email> non-empty

Email Address

Responses

Request samples

Content type
{
  • "email": "user@example.com"
}

Response samples

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

Configure Two-Factor Authentication

Business applications can use this service API to Register Two factor authentication of a logged in user.

path Parameters
packageId
required
integer <int64>
Default: 0

Default value = 0

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json

Responses

Response samples

Content type
application/json
{
  • "qrcode_base64": "string",
  • "account": "string",
  • "manual_key": "string",
  • "time_based": true,
  • "recovery_codes": [
    ]
}

Billing

APIs for managing subscriptions, service plans, payments, billing information, and transaction status.

Recurring Payment

Business applications can use this service API for recurring payment via billing by utilizing the billing ID. We capture the billing based on the transaction key, whether it is a placeholder or a confirmed transaction.

query Parameters
billing_id
string

For TAXAMO, the Billing ID will be the custom_id.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json

Responses

Response samples

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

Upgrade Service Plan

Business applications can use this service API to upgrade the service plan via billing by utilizing the billing ID. We capture the billing based on the transaction key, whether it is a placeholder or a confirmed transaction.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
name
string or null
billing_id
string or null
duration
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "billing_id": "string",
  • "duration": "string"
}

Response samples

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

Cancel Agreement

Business applications can use this service API to cancel the billing agreement by adding remarks. We capture the billing based on the transaction key, whether it is a placeholder or a confirmed transaction.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
remarks
required
string non-empty

Remarks for the cancel billing agreement

Responses

Request samples

Content type
{
  • "remarks": "string"
}

Response samples

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

Get User Billings

Business applications can use this service API to get user billings. A user who has permission to manage the billing in his role can get billings.

Search text sent in headers for further filtration of user billings. Search filters are "Amount", "CurrencyId", "Name", "EmailAddress".

Sorting filters are "Expiry Date", "Payment Type", "Payment Number", "VAT Amount", "Billing Model", "User Amount", "Date".

path Parameters
pageNo
required
integer <int32>

The page number to be retrieved.

recordsPerPage
required
integer <int32>

The total number of records to be retrieved in a page.

query Parameters
sort-by
string (Enumerations.UserBillingSortBy)
Enum: "VAT_AMOUNT" "USER_AMOUNT" "PAYMENT_TYPE" "PAYMENT_NUMBER" "BILLING_MODEL" "EXPIRY_DATE" "DATE"
asc
boolean
Default: false
header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-search-text
string
Default: IGpvaG5AYXNjZXJ0aWEuY29t

Search text if required. This is optional and without it the entire list is returned.
Furthermore, recommended value for search text parameter is in Base64 encoded format.

Responses

Response samples

Content type
application/json
{
  • "billing_id": 0,
  • "payment_method": "string",
  • "transaction_id": "string",
  • "reference_number": "string",
  • "type": "string",
  • "payment_number": 0,
  • "price": 0,
  • "paid_amount": 0,
  • "vat_amount": 0,
  • "currency": "string",
  • "vat_number": "string",
  • "expiry_date": "string",
  • "user_currency": "string",
  • "user_amount": 0,
  • "created_on": "string",
  • "remarks": "string",
  • "service_plan_name": "string",
  • "billing_model": "string",
  • "payment_type": "string",
  • "duration": "string",
  • "date": "string",
  • "user_email": "string",
  • "user_name": "string",
  • "phone_number": "string"
}

Get Billing Transaction Status

Business applications can use this service API with a client credentials token and user password to check the billing transaction status. If the billing transaction has succeeded, the response will be COMPLETED; otherwise, it will be IN PROGRESS.

path Parameters
transaction_id
required
string

The Transaction ID will be extracted from the Taxamo request as a KEY parameter.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json

Responses

Response samples

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

Initialize SslCommerz Request

Business applications can use this service API to initialize SslCommerz request.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
user_name
required
string [ 1 .. 255 ] characters

Provide user name for the sslcommerz

user_email
required
string [ 1 .. 255 ] characters

Provide user email for the sslcommerz

nonce
string or null

Provide nonce for the sslcommerz

object (Models.SslCommerzServicePlan)

SslCommerzServicePlan

Responses

Request samples

Content type
{
  • "user_name": "string",
  • "user_email": "string",
  • "nonce": "string",
  • "service_plan": {
    }
}

Response samples

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

Notifications

APIs for managing user notifications, push notification devices, and communication preferences.

Get Notifications

Business applications can use this service API to get the notifications of logged in user.

path Parameters
recordPerPage
required
integer <int32>
Default: 0

Total records for a page to be retrieved.

pageNo
required
integer <int32>
Default: 0

Number of page to be retrieved.

query Parameters
type
string (Helper.NotificationType)
Enum: "ALL" "ACCOUNT" "ENTERPRISE" "DOCUMENT"

Filter by type possible values are ALL, ACCOUNT, ENTERPRISE and DOCUMENT.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema: multipart/form-data
x-total-records
required
string <binary>
Default: ""

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

Responses

Response samples

Content type
application/json
{
  • "user_email": "string",
  • "user_name": "string",
  • "notifications": [
    ]
}

Get All Push Notification Devices

Business applications can use this service API to get registered push notification devices of the current user.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Delete All Push Notification Devices

Business applications can use this service API to delete registered push notification devices of the current user.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
device_tokens
Array of strings or null

Token generated by the mobile apps. This token is used sending push notifications from Google's Firebase Cloud Messaging.

Responses

Request samples

Content type
{
  • "device_tokens": [
    ]
}

Response samples

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

Statistics

APIs for retrieving account usage metrics, activity logs, and document-related statistics.

Get User Activity Logs

Business applications can use this service API to get the list of actions performed by a user.

path Parameters
pageNo
required
integer <int32>

Page number, according the division of records per page.

recordsPerPage
required
integer <int32>

Number of records that are needed to be fetched in one request.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-total-records
string
Default: 10

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

x-search-text
string
Default: John Doe

Search text sent in headers for further filtration of the documents. Package id, name and document owner can be searched.
Furthermore, recommended value for search text parameter is in Base64 encoded format.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get User Activity Logs

Business applications can use this API to Get User Activity.

path Parameters
pageNo
required
integer <int32>

Page no

recordPerPage
required
integer <int32>

Record per page

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-total-records
string
Default: 10

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

x-search-text
string
Default: John Doe

Search text sent in headers for further filtration of the documents. Package id, name and document owner can be searched.
Furthermore, recommended value for search text parameter is in Base64 encoded format.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Account Usage Statistics

Business applications can use this service API to get the account usage statistics.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json

Responses

Response samples

Content type
application/json
{
  • "storage": {
    },
  • "signature": {
    },
  • "advanced_electronic_signatures": {
    },
  • "high_trust_advanced_signatures": {
    },
  • "qualified_electronic_signatures": {
    },
  • "electronic_seals": {
    },
  • "advanced_electronic_seals": {
    },
  • "qualified_electronic_seals": {
    },
  • "simple_electronic_signatures": {
    },
  • "workflow": {
    },
  • "template": {
    },
  • "user": {
    },
  • "artificial_intelligence": {
    },
  • "identity_verification": {
    }
}

Documents Statistics

Business applications can use this service API to get the documents count with respect to their statuses.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
x-folder-id
string
Default: 0

Specify the folder ID, for retrieving the folder items, when a shared space folder is involved.

x-source
string
Default: Library

This is the identification of the source of the document from where the document is uploaded, e.g. "My App".

Responses

Response samples

Content type
application/json
{
  • "draft": 0,
  • "pending": 0,
  • "shared": 0,
  • "signed": 0,
  • "approved": 0,
  • "declined": 0,
  • "completed": 0,
  • "updated": 0,
  • "archived": 0
}

Invitations

APIs for managing account invitations, invitation responses, and onboarding activities.

Resend Activation Email

Business applications can use this service API to resend the activation email.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

OAuth access token obtained as a result of "Client Credentials Authentication"

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
user_email
required
string non-empty

Email address of user that is to be activated.

Responses

Request samples

Content type
{
  • "user_email": "string"
}

Response samples

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

Get Account Invitations

Business applications can use this service API to get a list of invitations from different enterprises.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

OAuth access token obtained as a result of "Client Credentials Authentication"

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
user_email
string or null

Responses

Request samples

Content type
{
  • "user_email": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Accept Account Invitation

Business applications can use this service API to accept an invitation and reject all the other invitations.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
enterprise_name
required
string non-empty

Name of the enterprise whose invitation is to be accepted.

Responses

Request samples

Content type
{
  • "enterprise_name": "string"
}

Response samples

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

Reject All Account Invitations

Business applications can use this service API to reject all the invitations from different accounts.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json

Responses

Response samples

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

Accept / Reject Invitations

Business applications can use this service API to accept/reject an invitations.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
Array of objects or null (Models.InvitaionAcceptRejectDetailRequest)

Accept invitaions

Array of objects or null (Models.InvitaionAcceptRejectDetailRequest)

Reject invitaions

Responses

Request samples

Content type
{
  • "accept": [
    ],
  • "reject": [
    ]
}

Response samples

Content type
application/json
{
  • "success": [
    ],
  • "failure": [
    ]
}

Identity & Verification

APIs for managing user identities, identity verification policies, and identity-related operations.

Get User Identity Verification Policies

Business applications can use this service API to get a list of identity verification polices as configured the enterprise role.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of successful authentication via "Password" or "Scope". If "Scope Authentication" was used, then this service will be performed for the user on behalf of the business application.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Identity for a User

SigningHub application relies on email addresses of the user to uniquely identify them as a user. If client system do not want the email address to be used frequently, they can attach another identity to the user using the following API.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The OAuth access token obtained as a result of successful authentication via the "password" grant type.

Content-Type
required
string
Default: application/json
Accept
required
string
Default: application/json
Request Body schema:
user_email
required
string non-empty

Email of the user for whom another identity is provided.

name
string or null

Authentication profile name

key
required
string non-empty

A key name stored in the database to be used as an identity. It can be CERT, RUT, VO_ID and IdentityProviderUniqueId

value
required
string non-empty

Value of the identity key stored in the database which later can be used to verify the user while authentication.

Responses

Request samples

Content type
{
  • "user_email": "string",
  • "name": "string",
  • "key": "string",
  • "value": "string"
}

Response samples

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