Documentation Powered by Redocly

SigningHub Admin API Guide

Download OpenAPI specification:Download

Welcome

Welcome to SigningHub, a high trust digital signing solution for all your paperless business transactions. It is ideal for those organisations that recognise the value of using cryptographic digital signatures to protect their users and their documents against unauthorised or accidental or fraudulent changes.
Browse through the API content by selecting the relevant pages from the left panel. To quickly find specific web service information, enter search criteria in the search box on top left.

More about SigningHub
To know more about SigningHub, explore the following links:
  • Go to  SigningHub Knowledge Base to view all the relevant information of SigningHub.
  • Visit the Ascertia Community Portal to find answers to contact SigningHub support staff through the  Live Chat provision .  Our support staff may be occupied with other priority tasks so live chat is offered on an "as available" basis. 
Intended Readership
This guide is intended for developers who will integrate SigningHub into their respective web applications using the RESTful web services, and user interface offered by SigningHub. It is assumed that the reader has a basic knowledge of REST, Java, C#, HTML, JavaScript, HTTP and TLS/SSL. There is no Software Developers Kit (SDK) for the integration, instead the integration uses HTML Forms and JSON so that integration is simple from any language including .Net, Java, PHP etc.

Main Tags
Most Popular Pages
➤ Welcome
➤ Prerequisites
➤ Access Token
➤ Updates
➤ APIs Developer Guide
➤ Appendix
➤ Authentication
➤ Service Plans
➤ Account Management
➤ Billing Management
➤ Access Control
➤ Operator Logs
➤ Advanced Reports

Reports

The Report Module provides real-time statistical reports on Service Plans, Accounts, and Billing.

Registration Reports

APIs for retrieving and exporting user registration statistics and registration trends.

Get Monthly Registrations Statistics

Business applications can use this service API to get monthly registrations statistics. An admin, who has permissions to manage reports in his role, can get registration statistics.

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

recordPerPage
required
integer <int32>

Total number of records to be retrieved in a page.

query Parameters
from
string

From of the monthly registrations statistics, and the expected value in format YYYY-MM.

to
string

To of the monthly registrations statistics, and the expected value in format YYYY-MM.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

x-total-records
string
Default: 212

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export Monthly Registrations Statistics

Business applications can use this service API to export monthly account registrations statistics data. An admin, who has permissions to manage reports in his role, can export login statistics.

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

recordPerPage
required
integer <int32>

Total number of records to be retrieved in a page.

query Parameters
from
string

From of the monthly registrations statistics, and the expected value in format YYYY-MM.

to
string

To of the monthly registrations statistics, and the expected value in format YYYY-MM.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

x-total-records
string
Default: 212

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

Responses

Response samples

Content type
application/json
"string"

Login Reports

APIs for retrieving and exporting user login statistics and authentication activity trends.

Get Monthly Logins Statistics

Business applications can use this service API to get monthly logins statistics. An admin, who has permissions to manage reports in his role, can get login statistics.

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

recordPerPage
required
integer <int32>

Total number of records to be retrieved in a page.

query Parameters
from
string

From of the monthly logins statistics, and the expected value in format YYYY-MM.

to
string

To of the monthly logins statistics, and the expected value in format YYYY-MM.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

x-total-records
string
Default: 212

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export Monthly Logins Statistics

Business applications can use this service API to export monthly logins statistics data. An admin, who has permissions to manage reports in his role, can export login statistics.

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

recordPerPage
required
integer <int32>

Total number of records to be retrieved in a page.

query Parameters
from
string

From of the monthly logins statistics, and the expected value in format YYYY-MM.

to
string

To of the monthly logins statistics, and the expected value in format YYYY-MM.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

x-total-records
string
Default: 212

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

Responses

Response samples

Content type
application/json
"string"

Workflow Reports

APIs for retrieving and exporting workflow processing statistics and workflow activity trends.

Get Monthly Workflows Statistics

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

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

recordPerPage
required
integer <int32>

Total number of records to be retrieved in a page.

query Parameters
from
string

From of the monthly workflows statistics, and the expected value in format YYYY-MM.

to
string

To of the monthly workflows statistics, and the expected value in format YYYY-MM.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

x-total-records
string
Default: 212

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export Monthly Workflows Statistics

Business applications can use this service API to export workflow statistics data. An admin, who has permissions to manage reports in his role, can export workflow statistics.

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

recordPerPage
required
integer <int32>

Total number of records to be retrieved in a page.

query Parameters
from
string

From of the monthly workflows statistics, and the expected value in format YYYY-MM.

to
string

To of the monthly workflows statistics, and the expected value in format YYYY-MM.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

x-total-records
string
Default: 212

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

Responses

Response samples

Content type
application/json
"string"

Signature Reports

APIs for retrieving and exporting signature statistics, signing activity, signature usage analytics, and signing server information.

Get Monthly Signatures Statistics

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

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

recordPerPage
required
integer <int32>

Total number of records to be retrieved in a page.

query Parameters
from
string

From of the monthly signatures statistics, and the expected value in format YYYY-MM.

to
string

To of the monthly signatures statistics, and the expected value in format YYYY-MM.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

x-total-records
string
Default: 212

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Signature Statistics

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

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

recordPerPage
required
integer <int32> [ 1 .. 2147483647 ]

Total number of records to be retrieved in a page.

enterpriseId
integer <int32>

Id of the enterprise.

query Parameters
from-date
string <date-time>

From date of the signatures statistics, the value is expected to follow ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00.

to-date
string <date-time>

To date of the signatures statistics, the value is expected to follow ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00.

asc
boolean
Default: false

Order the result set by ascending or descending. Default value is false.

sort-by
string
Default: "advanced_electronic_signature"

Sort by of the signatures statistics, possible values are total,electronic_signature, electronic_seal, advanced_electronic_seal, qualified_electronic_seal, advanced_electronic_signature, high_trust_advanced_signature, qualified_electronic_signature, inperson. The default value is advanced_electronic_signature.

signing-server
integer <int32> [ 0 .. 2147483647 ]

An optional signing server ID for which statistics are to be retrieved. The signing server ID is provided by the Get Signature Signing Servers API. If the ID is set to 0, data for all signing servers will be fetched.

header Parameters
x-search-text
string
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

x-total-records
string
Default: 212

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

x-search-text
string
Default: test@email.com

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export Monthly Signatures Statistics

Business applications can use this service API to export user signatures statistics data. An admin, who has permissions to manage reports in his role, can export user signature statistics.

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

recordPerPage
required
integer <int32>

Total number of records to be retrieved in a page.

query Parameters
from
string

From of the monthly signatures statistics, and the expected value in format YYYY-MM.

to
string

To of the monthly signatures statistics, and the expected value in format YYYY-MM.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

x-total-records
string
Default: 212

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

Responses

Response samples

Content type
application/json
"string"

Export Signatures Statistics

Business applications can use this service API to export signatures statistics. An admin, who has permissions to manage reports in his role, can export signature statistics.

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

recordPerPage
required
integer <int32> [ 1 .. 2147483647 ]

Total number of records to be retrieved in a page.

enterpriseId
required
integer <int32>

Id of the enterprise.

query Parameters
from-date
string <date-time>

From date of the signatures statistics, the value is expected to follow ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00.

to-date
string <date-time>

To date of the signatures statistics, the value is expected to follow ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00.

asc
boolean
Default: false

Order the result set by ascending or descending. Default value is false.

sort-by
string
Default: "advanced_electronic_signature"

Sort by of the signatures statistics, possible values are total, electronic_signature, electronic_seal, advanced_electronic_seal, qualified_electronic_seal, advanced_electronic_signature, high_trust_advanced_signature, qualified_electronic_signature, inperson. The default value is advanced_electronic_signature.

signing-server
integer <int32> [ 0 .. 2147483647 ]

An optional signing server ID for which statistics are to be retrieved. The signing server ID is provided by the Get Signature Signing Servers API. If the ID is set to 0, data for all signing servers will be fetched.

header Parameters
x-search-text
string
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

x-total-records
string
Default: 212

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

x-search-text
string
Default: test@email.com

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

Responses

Response samples

Content type
application/json
"string"

Get Signatures TimeLine

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

query Parameters
type
string (Models.DocumentActionSignatureType)
Enum: "E_SIGNATURE" "ELECTRONIC_SEAL" "ADVANCED_ELECTRONIC_SIGNATURE" "IN_PERSON" "ALL_SIGNATURES" "HIGH_TRUST_ADVANCED" "QUALIFIED_ELECTRONIC_SIGNATURE" "ADVANCED_ELECTRONIC_SEAL" "QUALIFIED_ELECTRONIC_SEAL"

Type of the signatures timeline, possible values are ALL_SIGNATURES, E_SIGNATURE, ELECTRONIC_SEAL, ADVANCED_ELECTRONIC_SEAL, QUALIFIED_ELECTRONIC_SEAL, ADVANCED_ELECTRONIC_SIGNATURE, HIGH_TRUST_ADVANCED, QUALIFIED_ELECTRONIC_SIGNATURE, IN_PERSON. The default value is E_SIGNATURE.

duration
string (Models.PlotByTime)
Enum: "DAILY" "WEEK" "MONTH" "YEAR"

Plot by time of the signature timeline, possible values are DAILY, WEEK, MONTH, YEAR

from-date
string <date-time>

From date of the signature timeline. The format of the date is yyyy-MM-dd.

to-date
string <date-time>

To date of the signature timeline. The format of the date is yyyy-MM-dd.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Top Ten Signatures Users

Business applications can use this service API to get top ten signatures users. An admin, who has permissions to manage reports in his role, can get top ten signature statistics.

query Parameters
from-date
string <date-time>

From date of the top ten billing users. The format of the date is yyyy-MM-dd.

to-date
string <date-time>

To date of the top ten billing users. The format of the date is yyyy-MM-dd.

type
string (Models.DocumentActionSignatureType)
Enum: "E_SIGNATURE" "ELECTRONIC_SEAL" "ADVANCED_ELECTRONIC_SIGNATURE" "IN_PERSON" "ALL_SIGNATURES" "HIGH_TRUST_ADVANCED" "QUALIFIED_ELECTRONIC_SIGNATURE" "ADVANCED_ELECTRONIC_SEAL" "QUALIFIED_ELECTRONIC_SEAL"

Type of the signatures timeline, possible values are ALL_SIGNATURES, E_SIGNATURE, ELECTRONIC_SEAL, ADVANCED_ELECTRONIC_SEAL, QUALIFIED_ELECTRONIC_SEAL, ADVANCED_ELECTRONIC_SIGNATURE, HIGH_TRUST_ADVANCED, QUALIFIED_ELECTRONIC_SIGNATURE, IN_PERSON. The default value is E_SIGNATURE.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Responses

Response samples

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

Get Signatures Statistics By Types

Business applications can use this service API to get signature statistics by types. An admin, who has permissions to manage reports in his role, can get signature statistics by types.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Request Body schema:
object (Threading.WaitHandle)

Responses

Request samples

Content type
{
  • "WaitHandle": {
    }
}

Response samples

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

Get Signatures Usage Statistics

Business applications can use this service API to get signatures usage statistics. An admin, who has permissions to manage reports in his role, can get signature usage statistics.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Request Body schema:
object (Threading.WaitHandle)

Responses

Request samples

Content type
{
  • "WaitHandle": {
    }
}

Response samples

Content type
application/json
{
  • "allowed_signatures": 0,
  • "allowed_electronic_signatures": 0,
  • "consumed_signatures": 0,
  • "consumed_electronic_signatures": 0
}

Get Signature Signing Servers

This service API allows business applications to retrieve the list of available signing servers. An administrator with permission to manage reports can use this API to obtain the signing server details.

path Parameters
enterpriseId
required
integer <int32>

Optional enteprise id

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Responses

Response samples

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

SMS Reports

APIs for retrieving and exporting SMS usage statistics and messaging activity reports.

Get Users SMS Usage Statistics

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

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

recordPerPage
required
integer <int32>

Total number of records to be retrieved in a page.

query Parameters
from-date
string <date-time>

From date of the sms usage statistics, the value is expected to follow ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00.

to-date
string <date-time>

To date of the sms usage statistics, the value is expected to follow ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00.

asc
boolean
Default: false

Order the result set by ascending or descending.

sort-by
string
Default: "sms_count"

Sort the result by possible values are sms_count and enterprise_name and the default column is sms_count.

header Parameters
x-search-text
string
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

x-total-records
string
Default: 212

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

x-search-text
string
Default: test@email.com

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export Sms Usage Statistics

Business applications can use this service API to export sms usage statistics data. An admin, who has permissions to manage reports in his role, can export sms usage statistics.

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

recordPerPage
required
integer <int32>

Total number of records to be retrieved in a page.

query Parameters
from-date
string <date-time>

From date of the sms usage statistics, the value is expected to follow ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00.

to-date
string <date-time>

To date of the sms usage statistics, the value is expected to follow ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00.

asc
boolean
Default: false

Order the result set by ascending or descending.

sort-by
string
Default: "sms_count"

Sort the result by possible values are sms_count and enterprise_name and the default column is sms_count.

header Parameters
x-search-text
string
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

x-total-records
string
Default: 212

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

x-search-text
string
Default: test@email.com

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

Responses

Response samples

Content type
application/json
"string"

Billing Reports

APIs for retrieving and exporting billing analytics, billing timelines, revenue statistics, and user billing insights.

Get Billings Statistics

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

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

recordPerPage
required
integer <int32>

Total number of records to be retrieved in a page.

query Parameters
from
string

From of the billings statistics, and the expected value in format YYYY-MM.

to
string

To of the billings statistics, and the expected value in format YYYY-MM.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

x-total-records
string
Default: 212

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Billings Detail

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

query Parameters
from
required
string

From of the billings statistics, and the expected value in format YYYY-MM.

type
string (Enumerations.BillingPaymentType)
Enum: "new_revenues" "recurring_revenue" "payments_revenue"

Getting the payment details by possible values are mentioned above.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Billings TimeLine

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

query Parameters
type
string (Enumerations.PaymentNumber)
Enum: "ALLPAYMENTS" "NEWPAYMENTS" "RECURRING"

Action of the billing timeline, possible values are ALLPAYMENTS, NEWPAYMENTS, RECURRING.

duration
string (Models.PlotByTime)
Enum: "DAILY" "WEEK" "MONTH" "YEAR"

Plot by time of the billing timeline, possible values are DAY, WEEK, MONTH, YEAR

from-date
string <date-time>

From date of the billings timeline. The format of the date is yyyy-MM-dd.

to-date
string <date-time>

To date of the billings timeline. The format of the date is yyyy-MM-dd.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Top Ten Billings Users

Business applications can use this service API to get top ten billing users. An admin, who has permissions to manage reports in his role, can get top ten billing users.

query Parameters
from-date
string <date-time>

From date of the top ten billings users. The format of the date is yyyy-MM-dd.

to-date
string <date-time>

To date of the top ten billings users. The format of the date is yyyy-MM-dd.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Responses

Response samples

Content type
application/json
{
  • "individual_users": [
    ],
  • "enterprise_users": [
    ]
}

Export Billings Statistics

Business applications can use this service API to export billing statistics. An admin, who has permissions to manage reports in his role, can export billing statistics.

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

recordPerPage
required
integer <int32>

Total number of records to be retrieved in a page.

query Parameters
from
string

From of the billings statistics, and the expected value in format YYYY-MM.

to
string

To of the billings statistics, and the expected value in format YYYY-MM.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Service Plan Reports

APIs for retrieving and exporting service plan usage statistics and subscription analytics.

Get Service Plans Statistics

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

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export Service Plans Statistics

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

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Responses

Response samples

Content type
application/json
"string"

Document Reports

APIs for retrieving and exporting document statistics, document activity timelines, document statuses, and usage analytics.

Get Documents statistics

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

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

recordPerPage
required
integer <int32>

Total number of records to be retrieved in a page.

enterpriseId
required
integer <int32>

Id of the enterprise.

query Parameters
from-date
string <date-time>

From date of the documents statistics, the value is expected to follow ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00.

to-date
string <date-time>

To date of the documents statistics, the value is expected to follow ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00.

asc
boolean
Default: false

Order the result set by ascending or descending. Default value is false.

sort-by
string
Default: "Uploaded"

Sort by of the documents statistics, possible values are UPLOADED, SHARED, SIGNED, DECLINED, APPROVED, SUBMITTED, DISKSPACE. The default value is UPLOADED.

header Parameters
x-search-text
string
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

x-total-records
string
Default: 212

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

x-search-text
string
Default: test@email.com

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export Documents Statistics

Business applications can use this service API to export documents statistics. An admin, who has permissions to manage reports in his role, can export documents statistics.

path Parameters
pageNo
required
integer <int32>

Page number to be retrieved.

recordPerPage
required
integer <int32>

Total number of records to be retrieved in a page.

enterpriseId
required
integer <int32>

Id of the enterprise.

query Parameters
from-date
string <date-time>

From date of the documents statistics, the value is expected to follow ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00.

to-date
string <date-time>

To date of the documents statistics, the value is expected to follow ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00.

asc
boolean
Default: false

Order the result set by ascending or descending. Default value is false.

sort-by
string
Default: "Uploaded"

Sort by of the documents statistics, possible values are UPLOADED, SHARED, SIGNED, DECLINED, APPROVED, SUBMITTED, DISKSPACE. The default value is UPLOADED.

header Parameters
x-search-text
string
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

x-total-records
string
Default: 212

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

Responses

Response samples

Content type
application/json
"string"

Get Documents TimeLine

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

query Parameters
type
string (Models.DocumentActionType)
Enum: "UPLOADED" "SHARED" "SIGNED" "DECLINED" "APPROVED" "UPDATED"

Action of the documents timeline, possible values are ALLPAYMENTS, NEWPAYMENTS, RECURRING.

duration
string (Models.PlotByTime)
Enum: "DAILY" "WEEK" "MONTH" "YEAR"

Plot by time of the billing timeline, possible values are DAILY, WEEK, MONTH, YEAR

from-date
string <date-time>

From date of the billing timeline. The format of the date is yyyy-MM-dd.

to-date
string <date-time>

To date of the billing timeline. The format of the date is yyyy-MM-dd.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Top Ten Documents Users

Business applications can use this service API to get top ten documents users. An admin, who has permissions to manage reports in his role, can get top ten documents users.

query Parameters
from-date
string <date-time>

From date of the top ten document users. The format of the date is yyyy-MM-dd.

to-date
string <date-time>

To date of the top ten document users. The format of the date is yyyy-MM-dd.

type
string (Models.DocumentActionTypeForUser)
Enum: "UPLOADED" "SHARED" "SIGNED" "DECLINED" "APPROVED" "UPDATED" "DISKSPACE"

Type of the top ten documents users, possible values are UPLOADED, SHARED, SIGNED, DECLINED, APPROVED, UPDATED, DISKSPACE. The default value is SHARED.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Responses

Response samples

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

Get Documents Statuses

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

header Parameters
Authorization
required
string
Default: Bearer {access_token}

The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action.

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

Client IP address, typically set by reverse proxy or load balancer

Accept-Language
string

Preferred language (e.g., en-US, ar-SA)

Responses

Response samples

Content type
application/json
{
  • "document_status": "string",
  • "count": 0
}