SigningHub Admin API Guide
Download OpenAPI specification:Download
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.
-
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.
This guide is intended for developers who will integrate SigningHub into their respective web 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.
Most Popular Pages
Authentication
Service Plans
Account Management
Billing Management
Access Control
Operator Logs
Advanced Reports
-
Obtain an TLS PFX –
The Admin requires TLS authentication. This .pfx file is used in the authentication request to SigningHub. You’ll typically install it in your server/application environment (e.g., certificate store, keystore, or as a .pfx file with private key).
-
Authenticate with PFX (Get Subject Token) – Call the Admin authentication endpoint using the TLS .pfx file. The service returns a subject token, which represents the authenticated PFX identity.
The subject token is a temporary security token that represents the authenticated identity of your PFX. This token on its own cannot be used for API calls — it must be exchanged for an access token.
-
Create an API Key
– set a client ID, and generate an API Key in SigningHub, using the Configuration menu > Integrations screen. Note the Clinet ID and Client Secret. See details, how to configure an API key.
-
Exchange Subject Token for Access Token – Call the Admin token endpoint with the required parameters (grant_type and subject_token). The client_id and client_secret must be Base64-encoded and passed using Basic Authorization. The response includes an OAuth 2.0 bearer access token.
-
Use Access Token in API Calls – Include the bearer token in the
Authorizationheader of all Admin API requests
This section provides information of supported tokens by SigningHub.
- PFX Token - Base64-encoded client ID and client secret are used for authentication by passing a subject token obtained through TLS client authentication with a .pfx file. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The PFX must belong to a SigningHub Administrator authorized to perform this action.
10.0.3 | Following are the APIs that have been affected by the changes:
New APIs
Base64-encoded client ID and client secret are used for authentication by passing a subject token obtained through TLS client authentication with a .pfx file. Upon successful validation of the certificate, a secure access token (e.g., JWT - JSON Web Token) is generated and returned. This token must be included in the Authorization header of all subsequent API requests to authorize access. The .pfx file used must belong to a SigningHub Administrator who is authorized to perform authentication and token generation operations.
Authentication
This API is used to obtain a subject token by passing a TLS .pfx file
header Parameters
| 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
- 200
- 500
{- "subject_token": "string"
}Password Authentication
This API is used to obtain access token by using grant_type, subject_token along with basic authorization contain encoded client ID and client secret.
header Parameters
| x-password | string A parameter representing the user's password is required in the response. The user must provide the password in the request header. |
| Authorization required | string Default: Basic {encoded_value} The client_id and client_secret are concatenated with a colon (:), then Base64-encoded. The resulting value is included in the Authorization header with the Basic prefix |
| 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: multipart/form-data
| subject_token | string A token that identify the authenticated user obtain from Authentication. |
| grant_type | string Define the OAuth 2.0 grant type. Default is "token-exchange". |
Responses
Response samples
- 200
- 403
- 500
{- "access_token": "string",
- "token_type": "string",
- "expires_in": 0
}Set New Password
Business applications can use this service API to set a new password for admin.
header Parameters
| x-subject-token | string A token that identify the authenticated user obtain from Authentication. |
| Authorization required | string Default: Basic {encoded_value} The client_id and client_secret are concatenated with a colon (:), then Base64-encoded. The resulting value is included in the Authorization header with the Basic prefix |
| 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:
| new_password | string or null new_password |
Responses
Request samples
- Payload
{- "new_password": "string"
}Response samples
- 200
- 403
- 500
{- "access_token": "string",
- "token_type": "string",
- "expires_in": 0
}Forgot Password
Business applications can use this service API to send an email to recover password.
header Parameters
| x-subject-token | string A token that identify the authenticated user obtain from Authentication. |
| Authorization required | string Default: Basic {encoded_value} The client_id and client_secret are concatenated with a colon (:), then Base64-encoded. The resulting value is included in the Authorization header with the Basic prefix |
| 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
- 200
- 403
- 500
{- "message": "string"
}Decrypt URL
Business applications can use this service API to decrpt url received in email.
header Parameters
| x-subject-token | string A token that identify the authenticated user obtain from Authentication. |
| Authorization required | string Default: Basic {encoded_value} The client_id and client_secret are concatenated with a colon (:), then Base64-encoded. The resulting value is included in the Authorization header with the Basic prefix |
| 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:
| q | string or null query data string |
Responses
Request samples
- Payload
{- "q": "string"
}Response samples
- 200
- 403
- 500
[- {
- "number": true,
- "special_character": true,
- "upper_case": true,
- "minimum_length": 0
}
]Reset Password
Business applications can use this service API to reset password.
header Parameters
| x-subject-token | string A token that identify the authenticated user obtain from Authentication. |
| Authorization required | string Default: Basic {encoded_value} The client_id and client_secret are concatenated with a colon (:), then Base64-encoded. The resulting value is included in the Authorization header with the Basic prefix |
| 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:
| new_password | string or null new_password |
Responses
Request samples
- Payload
{- "new_password": "string"
}Response samples
- 200
- 403
- 500
{- "message": "string"
}Logout
Business applications can call this API when a user logout from the application. This API call will update the user activity.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| 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
- 200
- 401
- 500
{- "message": "string"
}The Dashboard is the default landing screen after login, providing a centralized view of key system information such as product details, license status, instance and host system data, administrator information, and database details.
Get Admin Dashboard Data
Business applications can use this service API to get the dashboard's data.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 500
{- "product": {
- "name": "string",
- "version": "string",
- "build": "string"
}, - "instance": {
- "start_time": "string"
}, - "database": {
- "name": "string",
- "port": "string",
- "user": "string",
- "provider": "string"
}, - "admin": {
- "login_time": "string",
- "name": "string",
- "email": "string"
}, - "host_system": {
- "host_address": "string",
- "os_name": "string"
}, - "license": {
- "company_name": "string",
- "type": "string",
- "renewal_period": "string",
- "expiry_date": "string",
- "company": {
- "address": "string",
- "email_address": "string",
- "fax_no": "string",
- "name": "string",
- "phone_no": "string"
}, - "product": {
- "name": "string",
- "version": "string"
}, - "modules": [
- {
- "count": "string",
- "name": "string",
- "status": "string",
- "sub_modules": [
- {
- "name": "string",
- "status": "string"
}
]
}
]
}
}Designed and developed a comprehensive System Settings module to centrally manage global application configurations, feature toggles, and administrative controls.
Get System Settings
Business applications can use this service API to get system settings. An admin who has permission to manage global settings in his role can read system settings.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "attribute_choices": [
- {
- "key": "string",
- "value": "string"
}
], - "default_value": "string",
- "validation_rule": {
- "required": true,
- "min_length": 0,
- "max_length": 0,
- "min": 0,
- "max": 0
}, - "attribute_name": "string",
- "attribute_value": "string",
- "field_type": "string",
- "group_name": "string",
- "sort_order": 0
}
]Update System Settings
Business applications can use this service API to update global setting for the users. An admin who has permission to manage Global Settings in his role can update global settings.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| setting_section required | string non-empty The section where settings need to be updated. |
Array of objects or null (SystemSettingsRequest) system_settings |
Responses
Request samples
- Payload
{- "setting_section": "string",
- "system_settings": [
- {
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "message": "string"
}The Connectors Module allows administrators to configure and manage integrations with third-party services, enabling secure and efficient connectivity between SigningHub and external platforms.
Get Connectors
Business applications can use this service API to get connectors. An admin who has permission to manage connectors in his role can get connectors.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "connector_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string",
- "connector_id": "string",
- "field_type": "string",
- "type": 0,
- "vault_key": true
}
], - "id": 0,
- "identifier": "string",
- "for_adss": true,
- "name": "string",
- "provider": "string",
- "purposes": [
- "string"
], - "status": true,
- "type": "string",
- "created_on": "2019-08-24T14:15:22Z"
}
]Add Connector
Business applications can use this service API to add a connector. An admin who has permission to manage connectors in his role can add new connectors.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 100 ] characters The name of the connector. |
| provider required | string non-empty The provider will be fetched from the "Get Providers" API. |
| identifier | string or null This will contain the simplified name of the provider (attribute_name) in the "Get Providers" API. |
| status | boolean True, if the status of the connector is enabled. |
required | Array of objects (ConnectorDetailRequest) connector details |
Responses
Request samples
- Payload
{- "name": "string",
- "provider": "string",
- "identifier": "string",
- "status": true,
- "connector_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string",
- "field_type": "string",
- "type": 0,
- "vault_key": true
}
]
}Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0,
- "created_on": "2019-08-24T14:15:22Z"
}Get Basic Connectors
Business applications can use this service API to get the basic connectors. An administrator does not need the connector's "read" permission to retrieve the basic connectors.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 500
[- {
- "id": 0,
- "name": "string",
- "status": true,
- "for_adss": true,
- "type": "string",
- "provider": "string",
- "purposes": [
- "string"
], - "created_on": "2019-08-24T14:15:22Z"
}
]Get Connector by ID
Business applications can use this service API to get a connector by ID. An admin who has permission to manage connectors in his role can get the connector.
path Parameters
| id required | integer <int64> The ID of the connector. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
{- "connector_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string",
- "connector_id": "string",
- "field_type": "string",
- "type": 0,
- "vault_key": true
}
], - "id": 0,
- "identifier": "string",
- "for_adss": true,
- "name": "string",
- "provider": "string",
- "purposes": [
- "string"
], - "status": true,
- "type": "string",
- "created_on": "2019-08-24T14:15:22Z"
}Update Connector
Business applications can use this service API to update a connector. An admin who has permission to manage connectors in his role can update a connector.
path Parameters
| id required | integer <int64> The ID of the connector. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| status | boolean True, if the status of the connector is enabled. |
required | Array of objects (ConnectorDetailRequest) connector_detail |
Responses
Request samples
- Payload
{- "status": true,
- "connector_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string",
- "field_type": "string",
- "type": 0,
- "vault_key": true
}
]
}Response samples
- 400
- 401
- 403
- 404
- 500
{- "message": "string"
}Delete Connector
Business applications can use this service API to delete a connector. An admin who has permission to manage connectors in his role can delete a connector.
path Parameters
| id required | integer <int64> The ID of the connector. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 400
- 401
- 403
- 404
- 500
{- "message": "string"
}Get Certificate Info
Business applications can use this service API to get the certificate info. For admin, there is no need for any permission to retrieve the certificate info.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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: multipart/form-data
| file (binary Stream) required | string <binary> Default: "" This is the file in the raw binary format. |
Responses
Response samples
- 200
- 401
- 500
[- {
- "certificate_base64": "string",
- "certificate_cn": "string"
}
]Get Certificate (Base64)
Business applications can use this service API to get the certificate (base64). For admin, there is no need for any permission to retrieve the certificate.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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: multipart/form-data
| file (binary Stream) required | string <binary> Default: "" This is the file in the raw binary format. |
Responses
Response samples
- 200
- 401
- 500
[- "string"
]Get SAML Connector IDP
Business applications can use this service API to get SAML connector IDP. For admin, there is no need for any permission to retrieve the SAML connector IDP.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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: multipart/form-data
| file (binary Stream) required | string <binary> Default: "" This is the file in the raw binary format. |
Responses
Response samples
- 200
- 401
- 500
{- "http_post_login_url": "string",
- "http_redirect_login_url": "string",
- "http_post_logout_url": "string",
- "http_redirect_logout_url": "string",
- "certificate_subject": "string",
- "certificate_raw_data": "string"
}Send Message
Business applications can use this service API to send messages to users. For admin, there is no need for any permission to send SMS.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| mobile_number | string or null The mobile number to send message. |
| name | string or null The name of the SMS connector. |
| provider required | string non-empty The provider will be SMS. |
required | Array of objects (SendMessageConnectorDetailRequest) connector_detail |
Responses
Request samples
- Payload
{- "mobile_number": "string",
- "name": "string",
- "provider": "string",
- "connector_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string",
- "type": 0
}
]
}Response samples
- 400
- 401
- 500
{- "message": "string"
}Export SAML Data
Business applications can use this service API to export SAML data for users. For admin, there is no need for any permission to export SAML data.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name | string or null The name of the SAML connector. |
Responses
Request samples
- Payload
{- "name": "string"
}Response samples
- 200
- 400
- 401
- 404
- 500
"string"Authentication profiles provide the ways through which the end users may authenticate themselves to SigningHub. In addition to the conventional email/ password based authentication, SigningHub also allows the authentication facility through different external Identity Providers (IdP) i.e. Active Directory, Google, Linked-in, Salesforce, SSL Client, Office 365, Active Directory Federation Services (ADFS) etc.
Get Authentication Profiles
Business applications can use this service API to get authentication profiles. An admin, who has permissions to manage authentication profiles in his role, can get authentication profiles.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "description": "string",
- "sort_order": 0,
- "private": true,
- "status": true,
- "created_on": "string",
- "profile_detail": [
- {
- "id": 0,
- "attribute_name": "string",
- "attribute_value": "string",
- "profile_detail_value": [
- {
- "id": 0,
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}
]
}
]Add Authentication Profile
Business applications can use this service API to add an authentication profile. An admin, who has permissions to manage authentication profiles in his role, can add new authentication profile.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 255 ] characters Name of the authentication profile |
| description | string or null <= 255 characters Description of the authentication profile |
| sort_order | integer or null <int32> [ 1 .. 9999 ] Sort Order of the authentication profile |
| private | boolean Private of the authentication profile |
| status | boolean Status of the authentication profile |
Array of objects or null (ProfileDetailRequest) Details of the authentication profile |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "sort_order": 1,
- "private": true,
- "status": true,
- "profile_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string",
- "profile_detail_value": [
- {
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}
]
}Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "id": 0,
- "created_on": "string"
}Get Basic Authentication Profiles
Business applications can use this service API to get basic authentication profiles. For admin, there is no need of any permission to retrieve basic authentication profiles.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 500
[- {
- "id": 0,
- "name": "string"
}
]Get Authentication Profile by ID
Business applications can use this service API to get an authentication profile by id. An admin, who has permissions to manage authentication profiles in his role, can get authentication profile.
path Parameters
| id required | integer <int64> Id of the authentication profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "name": "string",
- "description": "string",
- "sort_order": 0,
- "private": true,
- "status": true,
- "created_on": "string",
- "profile_detail": [
- {
- "id": 0,
- "attribute_name": "string",
- "attribute_value": "string",
- "profile_detail_value": [
- {
- "id": 0,
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}
]
}Delete Authentication Profile
Business applications can use this service API to delete an authentication profile. An admin, who has permissions to manage authentication profiles in his role, can delete authentication profile.
path Parameters
| id required | integer <int64> Id of the authentication profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 404
- 500
{- "message": "string"
}Update Authentication Profile
Business applications can use this service API to update an authentication profile. An admin, who has permissions to manage authentication profiles in his role, can update authentication profile.
path Parameters
| id required | integer <int64> Id of the authentication profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 255 ] characters Name of the authentication profile |
| description | string or null <= 255 characters Description of the authentication profile |
| sort_order | integer or null <int32> [ 1 .. 9999 ] Sort Order of the authentication profile |
| private | boolean Private of the authentication profile |
| status | boolean Status of the authentication profile |
Array of objects or null (ProfileDetailRequest) Details of the authentication profile |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "sort_order": 1,
- "private": true,
- "status": true,
- "profile_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string",
- "profile_detail_value": [
- {
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}
]
}Response samples
- 401
- 403
- 404
- 422
- 500
{- "message": "string"
}Certification profiles specify the ADSS Certification Server profile configured for SigningHub, which is used to generate certified asymmetric key pairs for server-side signing. Depending on business requirements, you can manage multiple certification profiles to offer various types of certificates to end users—such as public CA certificates, local CA certificates, certificates with custom validity periods, or certificates for qualified signatures.
Get Certification Profiles
Business applications can use this service API to get certification profiles. An admin, who has permissions to manage certification profiles in his role, can get certification profiles.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "description": "string",
- "status": true,
- "created_on": "string",
- "profile_detail": [
- {
- "id": 0,
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}
]Add Certification Profile
Business applications can use this service API to add certification profile. An admin, who has permissions to manage certification profiles in his role, can add new certification profile.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 255 ] characters Name of the certification profile |
| description | string or null <= 255 characters Description of the certification profile |
| status | boolean Status of the certification profile |
Array of objects or null (CertificationProfileDetailRequest) Details of the certification profile |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "status": true,
- "profile_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "id": 0,
- "created_on": "string"
}Get Basic Certification Profiles
Business applications can use this service API to get basic certification profiles. For admin, there is no need of any permission to retrieve basic certification profiles.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 500
[- {
- "id": 0,
- "name": "string"
}
]Get Certification Profile by ID
Business applications can use this service API to get certification profile. An admin, who has permissions to manage certification profiles in his role, can get certification profile.
path Parameters
| id required | integer <int64> Id of the certification profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "name": "string",
- "description": "string",
- "status": true,
- "created_on": "string",
- "profile_detail": [
- {
- "id": 0,
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Delete Certification Profile
Business applications can use this service API to delete certification profile. An admin, who has permissions to manage certification profiles in his role, can delete certification profile.
path Parameters
| id required | integer <int64> Id of the certification profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 404
- 500
{- "message": "string"
}Update Certification Profile
Business applications can use this service API to update certification profile. An admin, who has permissions to manage certification profiles in his role, can update certification profile.
path Parameters
| id required | integer <int64> Id of the certification profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 255 ] characters Name of the certification profile |
| description | string or null <= 255 characters Description of the certification profile |
| status | boolean Status of the certification profile |
Array of objects or null (CertificationProfileDetailRequest) Details of the certification profile |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "status": true,
- "profile_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Response samples
- 400
- 401
- 403
- 404
- 422
- 500
{- "message": "string"
}Signing profile identifies the ADSS Signing Server profile that has been configured for SigningHub, to create the document signatures. Based on the business requirements, you can manage multiple signing profiles to offer different formats of digital signatures to your end users (i.e. PAdES-B-LT or PAdES-B-LTA signatures, signing method, hashing algorithm, etc.)
Get Signing Profiles
Business applications can use this service API to get signing profiles. An admin, who has permissions to manage Signing Profiles in his role, can read signing profiles.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "description": "string",
- "status": true,
- "created_on": "string",
- "profile_detail": [
- {
- "id": 0,
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}
]Add Signing Profile
Business applications can use this service API to add signing profile. An admin, who has permissions to manage signing profiles in his role, can add new signing profile.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 255 ] characters Name of the signing profile |
| description | string or null <= 255 characters Description of the signing profile |
| status | boolean Status of the signing profile |
Array of objects or null (SigningProfileDetailRequest) Details of the signing profile |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "status": true,
- "profile_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "id": 0,
- "created_on": "string"
}Get Basic Signing Profiles
Business applications can use this service API to get basic signing profiles. For admin, there is no need of any permission to retrieve basic signing profiles.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 500
[- {
- "id": 0,
- "name": "string"
}
]Get Signing Profile by ID
Business applications can use this service API to get a signing profile. An admin, who has permissions to manage signing profiles in his role, can read signing profile.
path Parameters
| id required | integer <int64> Id of the signing profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "name": "string",
- "description": "string",
- "status": true,
- "created_on": "string",
- "profile_detail": [
- {
- "id": 0,
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Delete Signing Profile
Business applications can use this service API to delete signing profile. An admin, who has permissions to manage Signing Profiles in his role, can delete signing profile.
path Parameters
| id required | integer <int64> Id of the signing profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 404
- 500
{- "message": "string"
}Update Signing Profile
Business applications can use this service API to update signing profile for Users. An admin, who has permissions to manage signing profiles in his role, can update signing profile.
path Parameters
| id required | integer <int64> Id of the signing profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 255 ] characters Name of the signing profile |
| description | string or null <= 255 characters Description of the signing profile |
| status | boolean Status of the signing profile |
Array of objects or null (SigningProfileDetailRequest) Details of the signing profile |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "status": true,
- "profile_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Response samples
- 400
- 401
- 403
- 404
- 422
- 500
{- "message": "string"
}Electronic Seal profiles define the CSC and ADSS Signing Server profiles configured for SigningHub to generate electronic seals. Based on business requirements, you can manage multiple electronic seal profiles to provide different formats of electronic seals to end users—such as PAdES-B-LT or PAdES-B-LTA signatures. The Electronic Seal Profiles is only available if the Electronic Seal module is enabled in the license.
Get Electronic Seal Profiles
Business applications can use this service API to get electronic seal profiles. An admin, who has permissions to manage electronic seal profiles in his role, can get electronic seal profiles.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "description": "string",
- "status": true,
- "created_on": "string",
- "profile_detail": [
- {
- "id": 0,
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}
]Add Electronic Seal Profile
Business applications can use this service API to add electronic seal profile. An admin, who has permissions to manage electronic seal profiles in his role, can add new electronic seal profile.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 255 ] characters Name of the electronic seal profile |
| description | string or null <= 255 characters Description of the electronic seal profile |
| status | boolean Status of the electronic seal profile |
Array of objects or null (ElectronicSealProfileDetailRequest) Details of the electronic seal profile |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "status": true,
- "profile_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "id": 0,
- "created_on": "string"
}Get Basic Electronic Seal Profiles
Business applications can use this service API to get basic electronic seal profiles. For admin, there is no need of any permission to retrieve basic electronic seal profiles.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 500
[- {
- "id": 0,
- "name": "string"
}
]Get Electronic Seal Profile By ID
Business applications can use this service API to get electronic seal profile by id. An admin, who has permissions to manage electronic seal profiles in his role, can get electronic seal profile.
path Parameters
| id required | integer <int64> Id of the electronic seal profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "name": "string",
- "description": "string",
- "status": true,
- "created_on": "string",
- "profile_detail": [
- {
- "id": 0,
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Delete Electronic Seal Profile
Business applications can use this service API to delete electronic seal profile. An admin, who has permissions to manage electronic seal profiles in his role, can delete electronic seal profile.
path Parameters
| id required | integer <int64> Id of the electronic seal profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 404
- 500
{- "message": "string"
}Update Electronic Seal Profile
Business applications can use this service API to update electronic seal profile. An admin, who has permissions to manage electronic seal profiles in his role, can update electronic seal profile.
path Parameters
| id required | integer <int64> Id of the electronic seal profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 255 ] characters Name of the electronic seal profile |
| description | string or null <= 255 characters Description of the electronic seal profile |
| status | boolean Status of the electronic seal profile |
Array of objects or null (ElectronicSealProfileDetailRequest) Details of the electronic seal profile |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "status": true,
- "profile_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Response samples
- 400
- 401
- 403
- 404
- 422
- 500
{- "message": "string"
}Verification profile identifies the ADSS Verification Server profile that has been configured for SigningHub, to verify the document signatures. Based on the business requirements, you can manage multiple verification profiles to offer different types of verification services to your end users.
Get Verification Profiles
Business applications can use this service API to get verification profiles. An admin, who has permissions to manage verification profiles in his role, can get verification profiles.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "description": "string",
- "status": true,
- "created_on": "string",
- "profile_detail": [
- {
- "id": 0,
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}
]Add Verification Profile
Business applications can use this service API to add verification profile. An admin, who has permissions to manage verification profiles in his role, can add new verification profile.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 255 ] characters Name of the verification profile |
| description | string or null <= 255 characters Description of the verification profile |
| status | boolean Status of the verification profile |
required | Array of objects (VerificationProfileDetailRequest) Details of the verification profile |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "status": true,
- "profile_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "id": 0,
- "created_on": "string"
}Get Basic Verification Profiles
Business applications can use this service API to get basic verification profiles. For admin, there is no need of any permission to retrieve basic verification profiles.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 500
[- {
- "id": 0,
- "name": "string"
}
]Get Verification Profile
Business applications can use this service API to get verification profile by id. An admin, who has permissions to manage verification profiles in his role, can get verification profile.
path Parameters
| id required | integer <int64> Id of the verification profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "name": "string",
- "description": "string",
- "status": true,
- "created_on": "string",
- "profile_detail": [
- {
- "id": 0,
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Delete Verification Profile
Business applications can use this service API to delete verification profile. An admin, who has permissions to manage verification profiles in his role, can delete verification profile.
path Parameters
| id required | integer <int64> Id of the verification profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 404
- 500
{- "message": "string"
}Update Verification Profile
Business applications can use this service API to update verification profile. An admin, who has permissions to manage verification profiles in his role, can update verification profile.
path Parameters
| id required | integer <int64> Id of the verification profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 255 ] characters Name of the verification profile |
| description | string or null <= 255 characters Description of the verification profile |
| status | boolean Status of the verification profile |
required | Array of objects (VerificationProfileDetailRequest) Details of the verification profile |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "status": true,
- "profile_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Response samples
- 400
- 401
- 403
- 404
- 422
- 500
{- "message": "string"
}Virtual ID profiles enable the virtual management of SigningHub users and their associated certificates. SigningHub supports CSP-based Virtual ID profiles, which reference the ADSS CSP Service (Cryptographic Service Provider).
Get Virtual ID Profiles
Business applications can use this service API to get virtual id profiles. An admin, who has permissions to manage virtual id profiles in his role, can get virtual id profiles.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "description": "string",
- "status": true,
- "created_on": "string",
- "profile_detail": [
- {
- "id": 0,
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}
]Add Virtual ID Profile
Business applications can use this service API to add virtual id profile. An admin, who has permissions to manage virtual id profiles in his role, can add new virtual id profile.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 255 ] characters Name of the virtual id profile |
| description | string or null <= 255 characters Description of the virtual id profile |
| status | boolean Status of the virtual id profile |
Array of objects or null (VirtualProfileDetailRequest) Details of the virtual id profile |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "status": true,
- "profile_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "id": 0,
- "created_on": "string"
}Get Basic Virtual ID Profiles
Business applications can use this service API to get basic virtual id profiles. For admin, there is no need of any permission to retrieve basic virtual id profiles.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 500
[- {
- "id": 0,
- "name": "string"
}
]Get Virtual ID Profile
Business applications can use this service API to get virtual id profile by id. An admin, who has permissions to manage virtual id profiles in his role, can get virtual id profile.
path Parameters
| id required | integer <int64> Id of the virtual id profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "name": "string",
- "description": "string",
- "status": true,
- "created_on": "string",
- "profile_detail": [
- {
- "id": 0,
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Delete Virtual ID Profile
Business applications can call this API to delete the virtual id profile. An admin, who has permissions to manage virtual id profiles in his role, can delete virtual id profile.
path Parameters
| id required | integer <int64> Id of the virtual id profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 404
- 500
{- "message": "string"
}Update Virtual ID Profile
Business applications can use this service API to update virtual id profile. An admin, who has permissions to manage virtual id profiles in his role, can update virtual id profile.
path Parameters
| id required | integer <int64> Id of the virtual id profile. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 255 ] characters Name of the virtual id profile |
| description | string or null <= 255 characters Description of the virtual id profile |
| status | boolean Status of the virtual id profile |
Array of objects or null (VirtualProfileDetailRequest) Details of the virtual id profile |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "status": true,
- "profile_detail": [
- {
- "attribute_name": "string",
- "attribute_value": "string"
}
]
}Response samples
- 400
- 401
- 403
- 404
- 422
- 500
{- "message": "string"
}The Service Agreements Module lets administrators configure custom Terms of Service and Privacy Policy, ensuring user consent across all SigningHub platforms during key actions like login, registration, and account deletion.
Get Service Agreements
Business applications can use this service API to get the service agreements. An admin who has permission to manage the service agreements in his role can get service agreements.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "description": "string",
- "terms_of_service": "string",
- "terms_of_service_url": "string",
- "privacy_policy": "string",
- "privacy_policy_url": "string",
- "active": true,
- "created_on": "2019-08-24T14:15:22Z"
}
]Add Service Agreement
Business applications can use this service API to add a service agreement. An admin who has permission to manage service agreements in his role can add a new service agreement.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 255 ] characters The name of the service agreement. |
| description | string or null <= 255 characters The description of the service agreement. |
| terms_of_service | string or null The content of the service agreement. |
| terms_of_service_url | string or null The url of the service agreement. |
| privacy_policy | string or null The privacy policy of the service agreement. |
| privacy_policy_url | string or null The privacy policy url of the service agreement. |
| active | boolean True, if the status of the service agreement is active. |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "terms_of_service": "string",
- "terms_of_service_url": "string",
- "privacy_policy": "string",
- "privacy_policy_url": "string",
- "active": true
}Response samples
- 201
- 400
- 401
- 403
- 500
{- "id": 0,
- "created_on": "2019-08-24T14:15:22Z"
}Get Service Agreement by ID
Business applications can use this service API to get a service agreement by ID. An admin who has permission to manage service agreements in his role can get a service agreement.
path Parameters
| id required | integer <int64> The ID of the service agreement. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "name": "string",
- "description": "string",
- "terms_of_service": "string",
- "terms_of_service_url": "string",
- "privacy_policy": "string",
- "privacy_policy_url": "string",
- "active": true
}Update Service Agreement
Business applications can use this service API to update a service agreement. An admin who has permission to manage service agreements in his role can update a service agreement.
path Parameters
| id required | integer <int64> The ID of the service agreement. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 255 ] characters The name of the service agreement. |
| description | string or null <= 255 characters The description of the service agreement. |
| terms_of_service | string or null The content of the service agreement. |
| terms_of_service_url | string or null The url of the service agreement. |
| privacy_policy | string or null The privacy policy of the service agreement. |
| privacy_policy_url | string or null The privacy policy url of the service agreement. |
| active | boolean True, if the status of the service agreement is active. |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "terms_of_service": "string",
- "terms_of_service_url": "string",
- "privacy_policy": "string",
- "privacy_policy_url": "string",
- "active": true
}Response samples
- 400
- 401
- 403
- 404
- 422
- 500
{- "message": "string"
}Delete Service Agreement
Business applications can use this service API to delete a service agreement. An admin who has permission to manage the service agreements in his role can delete a service agreement.
path Parameters
| id required | integer <int64> The ID of the service agreement. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 400
- 401
- 403
- 404
- 500
{- "message": "string"
}The License Module stores licensing information for users, providing a centralized configuration point for all license-dependent modules.
Get License Constraints
Business applications can use this service API to get license constraints. An admin, who has permissions to manage license in his role, can get license allowed and consumed stats.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "module": "string",
- "count": {
- "allowed": 0,
- "consumed": 0
}
}
]Validate License Expiry
Business applications can use this service API to validate license expiry. An admin, who has permissions to manage license in his role, can get license status.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 500
{- "message": "string"
}Download License
Business applications can use this service API to download license. An admin, who has permissions to manage license in his role, can download license.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
"string"Update License
Business applications can use this service API to update license and accept the file in the raw binary format. An admin, who has permissions to manage license in his role, can update license.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| 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) |
| Content-Type required | string Default: application/octet-stream |
Request Body schema: application/octet-stream
Schema not providedResponses
Response samples
- 400
- 401
- 403
- 500
{- "message": "string"
}Download Base64 License
Business applications can use this service API to download base64 license. An admin, who has permissions to manage license in his role, can download base64 license.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
"string"Update Base64 License
Business applications can use this service API to update base64 license. An admin, who has permissions to manage license in his role, can update license base64.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| license_base64 required | string non-empty License Base64 |
Responses
Request samples
- Payload
{- "license_base64": "string"
}Response samples
- 400
- 401
- 403
- 500
{- "message": "string"
}The Branding Module stores system-level branding information for the application. Administrators can configure company logos (e.g., product logo and favicon) and customize the color scheme for elements such as the page header, dialog headers, action buttons, scrollbars, selected menu options, right panels, list headers, document background, right panel headers, and progress bars. They can also customize error message content, including images and text.
Get Branding
Business applications can use this service API to get authentication profiles. An admin, who has permissions to manage authentication profiles in his role, can get authentication profiles.
header Parameters
| x-base64 | string Default base64 header is true. |
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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-base64 | string Default: true The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 401
- 403
- 500
{- "branding": {
- "logo": "string",
- "logo_url": "string",
- "favicon": "string",
- "favicon_url": "string",
- "background_image": {
- "web": {
- "image": "string",
- "image_url": "string"
}, - "mobile": {
- "image": "string",
- "image_url": "string"
}
}, - "colors": {
- "level_1": "string",
- "level_2": "string",
- "level_3": "string",
- "level_4": "string",
- "level_5": "string",
- "level_6": "string",
- "level_7": "string",
- "level_8": "string",
- "level_9": "string",
- "level_10": "string",
- "level_11": "string",
- "level_12": "string",
- "level_13": "string",
- "level_14": "string",
- "level_15": "string"
}, - "slider_items": [
- {
- "id": 0,
- "content": "string",
- "order": 0,
- "web": {
- "image": "string",
- "image_url": "string"
}
}
]
}, - "default_branding": {
- "logo": "string",
- "favicon": "string",
- "background_image": {
- "web": {
- "image": "string",
- "image_url": "string"
}, - "mobile": {
- "image": "string",
- "image_url": "string"
}
}, - "colors": {
- "level_1": "string",
- "level_2": "string",
- "level_3": "string",
- "level_4": "string",
- "level_5": "string",
- "level_6": "string",
- "level_7": "string",
- "level_8": "string",
- "level_9": "string",
- "level_10": "string",
- "level_11": "string",
- "level_12": "string",
- "level_13": "string",
- "level_14": "string",
- "level_15": "string"
}, - "slider_items": [
- {
- "id": 0,
- "content": "string",
- "order": 0,
- "web": {
- "image": "string",
- "image_url": "string"
}
}
]
}
}Update Branding
Business applications can use this service API to update branding. An admin, who has permissions to manage branding in his role, can update branding.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| logo required | string non-empty Base64 string of the logo image of the application. |
| favicon required | string non-empty Base64 encoded string of the favicon image. |
required | object (BackgroundImage) |
required | object (BrandingColors) BrandingColors |
Array of objects or null (SliderItem) Base64 encoded string of the slider images |
Responses
Request samples
- Payload
{- "logo": "string",
- "favicon": "string",
- "background_image": {
- "web": {
- "image": "string",
- "image_url": "string"
}, - "mobile": {
- "image": "string",
- "image_url": "string"
}
}, - "colors": {
- "level_1": "string",
- "level_2": "string",
- "level_3": "string",
- "level_4": "string",
- "level_5": "string",
- "level_6": "string",
- "level_7": "string",
- "level_8": "string",
- "level_9": "string",
- "level_10": "string",
- "level_11": "string",
- "level_12": "string",
- "level_13": "string",
- "level_14": "string",
- "level_15": "string"
}, - "slider_items": [
- {
- "id": 0,
- "content": "string",
- "order": 0,
- "web": {
- "image": "string",
- "image_url": "string"
}
}
]
}Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "content": "string",
- "order": 0,
- "web": {
- "image": "string",
- "image_url": "string"
}
}
]Get Logo
Business applications can use this service API to get logo.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
"string"Get Favicon
Business applications can use this service API to get favicon.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
"string"Reset Branding
Business applications can use this service API to reset branding. An admin, who has permissions to manage branding in his role, can reset branding.
header Parameters
| x-base64 | string Default base64 header is true. |
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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-base64 | string Default: true |
Responses
Response samples
- 200
- 401
- 403
- 500
{- "logo": "string",
- "logo_url": "string",
- "favicon": "string",
- "favicon_url": "string",
- "background_image": {
- "web": {
- "image": "string",
- "image_url": "string"
}, - "mobile": {
- "image": "string",
- "image_url": "string"
}
}, - "colors": {
- "level_1": "string",
- "level_2": "string",
- "level_3": "string",
- "level_4": "string",
- "level_5": "string",
- "level_6": "string",
- "level_7": "string",
- "level_8": "string",
- "level_9": "string",
- "level_10": "string",
- "level_11": "string",
- "level_12": "string",
- "level_13": "string",
- "level_14": "string",
- "level_15": "string"
}, - "slider_items": [
- {
- "id": 0,
- "content": "string",
- "order": 0,
- "web": {
- "image": "string",
- "image_url": "string"
}
}
]
}The Instance Module stores information about application instances installed via the installer and displays a list of all applications deployed using it.
Get Instances
Business applications can use this service API to get Instances. An admin, who has permissions to manage instances in his role, can get instances.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "machine_name": "string",
- "service_address": "string",
- "type": "string",
- "version": "string",
- "status": "string",
- "created_on": "string"
}
]Get Instance by ID
Business applications can use this service API to get an instance by id. An admin, who has permissions to manage instances in his role, can get instance.
path Parameters
| id required | integer <int32> Id of the instance. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
{- "id": 0,
- "machine_name": "string",
- "service_address": "string",
- "type": "string",
- "version": "string",
- "status": "string",
- "created_on": "string"
}Update Instance
Business applications can use this service API to update an instance. An admin, who has permissions to manage instances in his role, can update instance.
path Parameters
| id required | integer <int32> Id of the instance. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| machine_name required | string [ 1 .. 255 ] characters Name of the machine hosting the instance. |
| service_address required | string [ 1 .. 255 ] characters The service address (URL) where the instance is hosted. |
Responses
Request samples
- Payload
{- "machine_name": "string",
- "service_address": "string"
}Response samples
- 401
- 403
- 404
- 500
{- "message": "string"
}Delete Instance
Business applications can use this service API to delete an instances. An admin, who has permissions to manage instances in his role, can delete instance.
path Parameters
| id required | integer <int32> Id of the instance. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 404
- 500
{- "message": "string"
}Get Instance Status
Business applications can use this service API to get an instance status. An admin, who has permissions to manage instances in his role, can get instance status.
path Parameters
| id required | integer <int32> Id of the instance. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
{- "status": "string"
}The System Integration Module enables system administrators to configure system-wide integrations. These integrations are available for use by all enterprises and users across the system.
Get System Integrations
Business applications can use this service API to get the system integrations. An admin who has permission to manage the system integrations in his role can get system integrations.
path Parameters
| pageNo required | integer <int32> Page number to be retrieved. |
| records required | integer <int32> Total number of records to be retrieved in a page. |
query Parameters
| sort-by | string (SystemIntegrationSortBy) Enum: "CLIENT_ID" "ACTIVE" "CREATED_ON" |
| asc | boolean Default: false |
header Parameters
| x-search-text | string |
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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-search-text | string Default: John doe 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. |
| x-total-records | string Default: 212 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "client_id": "string",
- "client_secret": "string",
- "validity_period": "string",
- "valid_from": "2019-08-24T14:15:22Z",
- "valid_to": "2019-08-24T14:15:22Z",
- "active": true,
- "created_on": "2019-08-24T14:15:22Z"
}
]Get System Integration by ID
Business applications can use this service API to get the system integration. An admin who has permission to manage the system integration in his role can get system integration.
path Parameters
| id required | integer <int64> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
{- "id": 0,
- "client_id": "string",
- "client_secret": "string",
- "validity_period": "string",
- "valid_from": "2019-08-24T14:15:22Z",
- "valid_to": "2019-08-24T14:15:22Z",
- "active": true,
- "created_on": "2019-08-24T14:15:22Z"
}Update System Integration
path Parameters
| id required | integer <int64> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| client_id required | string non-empty Client id of system integration |
| validity_period required | string non-empty Validity period of integration, possible values are CUSTOM, THREE_MONTHS, SIX_MONTHS, TWELVE_MONTHS, EIGHTEEN_MONTHS, TWENTY_FOUR_MONTHS |
| valid_from | string or null Validity start date (Only required when validity period is CUSTOM) |
| valid_to | string or null Validity end date (Only required when validity period is CUSTOM) |
| active | boolean Status of system integration |
Responses
Request samples
- Payload
{- "client_id": "string",
- "validity_period": "string",
- "valid_from": "string",
- "valid_to": "string",
- "active": true
}Response samples
- 200
- 401
- 403
- 500
{- "validity_period": "string",
- "valid_from": "2019-08-24T14:15:22Z",
- "valid_to": "2019-08-24T14:15:22Z"
}Delete System Integration
path Parameters
| id required | integer <int64> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 500
{- "message": "string"
}Add System Integration
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| client_id required | string non-empty Client id of system integration |
| validity_period required | string non-empty Validity period of integration, possible values are CUSTOM, THREE_MONTHS, SIX_MONTHS, TWELVE_MONTHS, EIGHTEEN_MONTHS, TWENTY_FOUR_MONTHS |
| valid_from | string or null Validity start date (Only required when validity period is set to CUSTOM) |
| valid_to | string or null Validity end date (Only required when validity period is set to CUSTOM) |
| active | boolean Status of system integration |
Responses
Request samples
- Payload
{- "client_id": "string",
- "validity_period": "string",
- "valid_from": "string",
- "valid_to": "string",
- "active": true
}Response samples
- 200
- 401
- 403
- 500
{- "id": 0,
- "client_secret": "string",
- "validity_period": "string",
- "valid_from": "2019-08-24T14:15:22Z",
- "valid_to": "2019-08-24T14:15:22Z",
- "created_on": "2019-08-24T14:15:22Z"
}Create Client Secret
path Parameters
| id required | integer <int64> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
{- "client_secret": "string"
}service plan information enables users to select and configure plans based on their needs. It supports both enterprise and individual users by allowing the selection of appropriate service plans and setting up related billing configurations
Get Service Plans
Business applications can use this service API to get service plans. An admin, who has permissions to manage service plans in his role, can get service plans.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "created_on": "string",
- "start_date": "string",
- "end_date": "string",
- "features": [
- "string"
], - "type": "string",
- "public": true,
- "deprecated": true,
- "constraints": {
- "users": {
- "count": 0
}, - "signatures": {
- "count": 0,
- "advanced_electronic_signature": {
- "count": 0
}, - "high_trust_advanced_signature": {
- "count": 0
}, - "qualified_electronic_signature": {
- "count": 0
}, - "electronic_seal": {
- "count": 0
}, - "advanced_electronic_seal": {
- "count": 0
}, - "qualified_electronic_seal": {
- "count": 0
}
}, - "simple_electronic_signatures": {
- "count": 0
}, - "storage": {
- "count": 0
}, - "workflows": {
- "count": 0
}, - "upload_size": {
- "count": 0
}, - "templates": {
- "count": 0
}
}, - "level_of_assurance": {
- "allowed": [
- "string"
], - "default": [
- "string"
]
}, - "certify_options": {
- "allowed": [
- "string"
], - "default": "string"
}, - "pdf_a_compliancy": true,
- "auto_delete_document": {
- "enabled": true,
- "duration": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}, - "email_document": {
- "enabled": true,
- "workflow_evidence_report": true
}
}, - "add_unique_identifier": true,
- "signature_pad": {
- "enabled": true,
- "server": "string"
}, - "signature_appearances": [
- "string"
], - "signing_servers": [
- {
- "key_location": "string",
- "order": 0,
- "signing_profile": {
- "id": 0,
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "advanced_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "high_trust_advanced_signature": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "qualified_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "signature_appearances": {
- "signature_appearance": "string",
- "signature_appearance_logo": "string"
}, - "csp": {
- "enabled": true,
- "virtual_profile": {
- "id": 0,
- "name": "string"
}, - "auto_delete_certificates": true
}
}
], - "electronic_seal_servers": [
- {
- "electronic_seal_profile": {
- "id": 0,
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}
}
], - "verification_profile": {
- "id": 0,
- "name": "string"
}, - "require_password": true,
- "authentication_profile": {
- "allowed": [
- {
- "id": 0,
- "name": "string"
}
], - "default": {
- "id": 0,
- "name": "string"
}
}, - "evidence_report": {
- "type": "string",
- "delete_document_logs": true
}, - "one_time_password": {
- "email_otp": {
- "enabled": true
}, - "sms_otp": {
- "enabled": true,
- "server": "string"
}, - "otp_length": 0,
- "otp_expiry": 0,
- "otp_retry_interval": 0
}, - "time_based_one_time_password": true,
- "smtp_server": {
- "enabled": true,
- "server": "string"
}, - "sms_notification": {
- "enabled": true,
- "server": "string"
}, - "auto_delete_user": {
- "enabled": true,
- "inactive_days": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}
}, - "billing": {
- "payment_type": "string",
- "mode": "string",
- "monthly": {
- "enabled": true,
- "price": "string"
}, - "yearly": {
- "enabled": true,
- "price": "string"
}, - "auto_reset_constraints": true,
- "price": "string"
}
}
]Add Service Plan
Business applications can use this service API to add service plan. An admin, who has permissions to manage service plans in his role, can add service plan.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 100 ] characters Name of the service plan |
| type required | string (ApiPlanType) Enum: "INDIVIDUAL" "ENTERPRISE" |
| start_date | string or null <date-time> Date on which the service plan expiry has started |
| end_date | string or null <date-time> Date on which the service plan expiry has ended |
| features required | Array of strings (ApiPlanFeatures) Items Enum: "ALLOW_FORM_FIELDS" "ALLOW_REVIEWER" "ALLOW_ATTACHMENTS" "ALLOW_INITIALS_FIELDS" "ALLOW_INPERSON_FIELDS" "ALLOW_INTEGRATION" "ALLOW_BULK_SIGNING" "SERVICE_PLAN_FEATURE_CLOUD_DRIVES" "ALLOW_EDITOR" "ALLOW_SEND_A_COPY" "ALLOW_ELECTRONIC_SEAL" "ALLOW_DOCUMENTS_ARCHIVE" "ALLOW_SMART_FORM" List of features available in the service plan. Possible values are mentioned above. ALLOW_ELECTRONIC_SEAL and ALLOW_INTEGRATION can be added only to the "Enterprise" service plan. |
| public required | boolean True, if service plan is public |
required | object (ServicePlanConstraintRequest) ServicePlanConstraintRequest |
required | object (ServicePlanLevelOfAssuranceRequest) ServicePlanLevelOfAssuranceRequest |
object (ServicePlanCertifyOptionRequest) ServicePlanCertifyOptionRequest | |
| pdf_a_compliancy required | boolean True, If PDF Compliant |
object (ServicePlanAutoDeleteDocumentRequest) ServicePlanAutoDeleteDocumentRequest | |
| add_unique_identifier required | boolean True, If to add a unique identifier field in the document header. |
object (SignaturePadResponse) SignaturePadResponse | |
| signature_appearances required | Array of strings Signature appearances, possible values are COMPANY_LOGO, HAND_SIGNATURE, DETAILED_SIGNATURE. |
required | Array of objects (ServicePlanSigningServerRequest) Signing Servers |
Array of objects or null (ServicePlanElectronicSealServerRequest) Electronic Seal Signing Servers that can be added to the "Enterprise" service plan. | |
required | object (ServicePlanProfileRequest) ServicePlanProfileRequest |
| require_password | boolean Indicates whether a password is required during user registration |
object (ServicePlanAuthenticationProfileRequest) ServicePlanAuthenticationProfileRequest | |
required | object (ServicePlanEvidenceReportRequest) ServicePlanEvidenceReportRequest |
object (ServicePlanOneTimePasswordRequest) ServicePlanOneTimePasswordRequest | |
| time_based_one_time_password required | boolean True if TOTP are enabled for the service plan. |
object (ServicePlanSmtpServerRequest) ServicePlanSmtpServerRequest | |
object (ServicePlanSmsNotificationRequest) ServicePlanSmsNotificationRequest | |
object (ServicePlanAutoDeleteUserRequest) ServicePlanAutoDeleteUserRequest | |
object (ServicePlanBillingRequest) ServicePlanBillingRequest |
Responses
Request samples
- Payload
{- "name": "string",
- "type": "INDIVIDUAL",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "features": [
- "ALLOW_FORM_FIELDS"
], - "public": true,
- "constraints": {
- "signatures": {
- "count": 0,
- "advanced_electronic_signature": {
- "count": 0
}, - "high_trust_advanced_signature": {
- "count": 0
}, - "qualified_electronic_signature": {
- "count": 0
}, - "electronic_seal": {
- "count": 0
}, - "advanced_electronic_seal": {
- "count": 0
}, - "qualified_electronic_seal": {
- "count": 0
}
}, - "simple_electronic_signatures": {
- "count": 0
}, - "storage": {
- "count": 0
}, - "workflows": {
- "count": 0
}, - "upload_size": {
- "count": 0
}, - "templates": {
- "count": 0
}, - "users": {
- "count": 0
}
}, - "level_of_assurance": {
- "allowed": [
- "ADVANCED_ELECTRONIC_SIGNATURE"
], - "default": [
- "ADVANCED_ELECTRONIC_SIGNATURE"
]
}, - "certify_options": {
- "allowed": [
- "NO_CHANGES_ALLOWED"
], - "default": "NO_CHANGES_ALLOWED"
}, - "pdf_a_compliancy": true,
- "auto_delete_document": {
- "enabled": true,
- "duration": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}, - "email_document": {
- "enabled": true,
- "workflow_evidence_report": true
}
}, - "add_unique_identifier": true,
- "signature_pad": {
- "enabled": true,
- "server": "string"
}, - "signature_appearances": [
- "string"
], - "signing_servers": [
- {
- "key_location": "SERVER",
- "order": 1,
- "signing_profile": {
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "advanced_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "high_trust_advanced_signature": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "qualified_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "signature_appearances": {
- "signature_appearance": "string",
- "signature_appearance_logo": "string"
}, - "csp": {
- "enabled": true,
- "virtual_profile": {
- "name": "string"
}, - "auto_delete_certificates": true
}
}
], - "electronic_seal_servers": [
- {
- "electronic_seal_profile": {
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}
}
], - "verification_profile": {
- "name": "string"
}, - "require_password": true,
- "authentication_profile": {
- "allowed": [
- {
- "name": "string"
}
], - "default": {
- "name": "string"
}
}, - "evidence_report": {
- "type": "BASIC",
- "delete_document_logs": true
}, - "one_time_password": {
- "email_otp": {
- "enabled": true
}, - "sms_otp": {
- "enabled": true,
- "server": "string"
}, - "otp_length": 0,
- "otp_expiry": 0,
- "otp_retry_interval": 0
}, - "time_based_one_time_password": true,
- "smtp_server": {
- "enabled": true,
- "server": "string"
}, - "sms_notification": {
- "enabled": true,
- "server": "string"
}, - "auto_delete_user": {
- "enabled": true,
- "inactive_days": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}
}, - "billing": {
- "mode": "ONLINE",
- "payment_type": "string",
- "monthly": {
- "enabled": true,
- "price": 0
}, - "yearly": {
- "enabled": true,
- "price": 0
}, - "auto_reset_constraints": true,
- "price": 0
}
}Response samples
- 201
- 400
- 401
- 403
- 404
- 422
- 500
{- "id": 0,
- "created_on": "string"
}Get Service Plan by ID
Business applications can use this service API to get service plan. An admin, who has permissions to manage service plans in his role, can get service plan.
path Parameters
| id required | integer <int32> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "name": "string",
- "created_on": "string",
- "start_date": "string",
- "end_date": "string",
- "features": [
- "string"
], - "type": "string",
- "public": true,
- "deprecated": true,
- "constraints": {
- "users": {
- "count": 0
}, - "signatures": {
- "count": 0,
- "advanced_electronic_signature": {
- "count": 0
}, - "high_trust_advanced_signature": {
- "count": 0
}, - "qualified_electronic_signature": {
- "count": 0
}, - "electronic_seal": {
- "count": 0
}, - "advanced_electronic_seal": {
- "count": 0
}, - "qualified_electronic_seal": {
- "count": 0
}
}, - "simple_electronic_signatures": {
- "count": 0
}, - "storage": {
- "count": 0
}, - "workflows": {
- "count": 0
}, - "upload_size": {
- "count": 0
}, - "templates": {
- "count": 0
}
}, - "level_of_assurance": {
- "allowed": [
- "string"
], - "default": [
- "string"
]
}, - "certify_options": {
- "allowed": [
- "string"
], - "default": "string"
}, - "pdf_a_compliancy": true,
- "auto_delete_document": {
- "enabled": true,
- "duration": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}, - "email_document": {
- "enabled": true,
- "workflow_evidence_report": true
}
}, - "add_unique_identifier": true,
- "signature_pad": {
- "enabled": true,
- "server": "string"
}, - "signature_appearances": [
- "string"
], - "signing_servers": [
- {
- "key_location": "string",
- "order": 0,
- "signing_profile": {
- "id": 0,
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "advanced_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "high_trust_advanced_signature": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "qualified_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "signature_appearances": {
- "signature_appearance": "string",
- "signature_appearance_logo": "string"
}, - "csp": {
- "enabled": true,
- "virtual_profile": {
- "id": 0,
- "name": "string"
}, - "auto_delete_certificates": true
}
}
], - "electronic_seal_servers": [
- {
- "electronic_seal_profile": {
- "id": 0,
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}
}
], - "verification_profile": {
- "id": 0,
- "name": "string"
}, - "require_password": true,
- "authentication_profile": {
- "allowed": [
- {
- "id": 0,
- "name": "string"
}
], - "default": {
- "id": 0,
- "name": "string"
}
}, - "evidence_report": {
- "type": "string",
- "delete_document_logs": true
}, - "one_time_password": {
- "email_otp": {
- "enabled": true
}, - "sms_otp": {
- "enabled": true,
- "server": "string"
}, - "otp_length": 0,
- "otp_expiry": 0,
- "otp_retry_interval": 0
}, - "time_based_one_time_password": true,
- "smtp_server": {
- "enabled": true,
- "server": "string"
}, - "sms_notification": {
- "enabled": true,
- "server": "string"
}, - "auto_delete_user": {
- "enabled": true,
- "inactive_days": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}
}, - "billing": {
- "payment_type": "string",
- "mode": "string",
- "monthly": {
- "enabled": true,
- "price": "string"
}, - "yearly": {
- "enabled": true,
- "price": "string"
}, - "auto_reset_constraints": true,
- "price": "string"
}
}Update Service Plan
Business applications can use this service API to update service plan. An admin, who has permissions to manage service plans in his role, can update service plan.
path Parameters
| id required | integer <int32> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 100 ] characters Name of the service plan |
| start_date | string or null <date-time> Date on which the service plan expiry has started |
| end_date | string or null <date-time> Date on which the service plan expiry has ended |
| features required | Array of strings (ApiPlanFeatures) Items Enum: "ALLOW_FORM_FIELDS" "ALLOW_REVIEWER" "ALLOW_ATTACHMENTS" "ALLOW_INITIALS_FIELDS" "ALLOW_INPERSON_FIELDS" "ALLOW_INTEGRATION" "ALLOW_BULK_SIGNING" "SERVICE_PLAN_FEATURE_CLOUD_DRIVES" "ALLOW_EDITOR" "ALLOW_SEND_A_COPY" "ALLOW_ELECTRONIC_SEAL" "ALLOW_DOCUMENTS_ARCHIVE" "ALLOW_SMART_FORM" List of features available in the service plan, possible values are mentioned above.ALLOW_ELECTRONIC_SEAL and ALLOW_INTEGRATION can be updated only to the "Enterprise" service plan. |
| public | boolean True, if service plan is public |
| deprecated | boolean or null Deprecated: Default value for this parameter set to false |
required | object (ServicePlanConstraintRequest) ServicePlanConstraintRequest |
required | object (ServicePlanLevelOfAssuranceRequest) ServicePlanLevelOfAssuranceRequest |
object (ServicePlanCertifyOptionRequest) ServicePlanCertifyOptionRequest | |
| pdf_a_compliancy | boolean True, If PDF Compliant |
object (ServicePlanAutoDeleteDocumentRequest) ServicePlanAutoDeleteDocumentRequest | |
| add_unique_identifier | boolean True, If to add a unique identifier field in the document header. |
object (SignaturePadResponse) SignaturePadResponse | |
| signature_appearances required | Array of strings Signature appearances, possible values are COMPANY_LOGO, HAND_SIGNATURE, DETAILED_SIGNATURE. |
required | Array of objects (ServicePlanSigningServerRequest) Signing Servers |
Array of objects or null (ServicePlanElectronicSealServerRequest) Electronic Seal Signing Servers that can be updated to the "Enterprise" service plan. | |
required | object (ServicePlanProfileRequest) ServicePlanProfileRequest |
| require_password | boolean Indicates whether a password is required during user registration |
object (ServicePlanAuthenticationProfileRequest) ServicePlanAuthenticationProfileRequest | |
required | object (ServicePlanEvidenceReportRequest) ServicePlanEvidenceReportRequest |
object (ServicePlanOneTimePasswordRequest) ServicePlanOneTimePasswordRequest | |
| time_based_one_time_password | boolean True if TOTP are enabled for the service plan. |
object (ServicePlanSmtpServerRequest) ServicePlanSmtpServerRequest | |
object (ServicePlanSmsNotificationRequest) ServicePlanSmsNotificationRequest | |
object (ServicePlanAutoDeleteUserRequest) ServicePlanAutoDeleteUserRequest | |
object (ServicePlanBillingRequest) ServicePlanBillingRequest |
Responses
Request samples
- Payload
{- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "features": [
- "ALLOW_FORM_FIELDS"
], - "public": true,
- "deprecated": true,
- "constraints": {
- "signatures": {
- "count": 0,
- "advanced_electronic_signature": {
- "count": 0
}, - "high_trust_advanced_signature": {
- "count": 0
}, - "qualified_electronic_signature": {
- "count": 0
}, - "electronic_seal": {
- "count": 0
}, - "advanced_electronic_seal": {
- "count": 0
}, - "qualified_electronic_seal": {
- "count": 0
}
}, - "simple_electronic_signatures": {
- "count": 0
}, - "storage": {
- "count": 0
}, - "workflows": {
- "count": 0
}, - "upload_size": {
- "count": 0
}, - "templates": {
- "count": 0
}, - "users": {
- "count": 0
}
}, - "level_of_assurance": {
- "allowed": [
- "ADVANCED_ELECTRONIC_SIGNATURE"
], - "default": [
- "ADVANCED_ELECTRONIC_SIGNATURE"
]
}, - "certify_options": {
- "allowed": [
- "NO_CHANGES_ALLOWED"
], - "default": "NO_CHANGES_ALLOWED"
}, - "pdf_a_compliancy": true,
- "auto_delete_document": {
- "enabled": true,
- "duration": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}, - "email_document": {
- "enabled": true,
- "workflow_evidence_report": true
}
}, - "add_unique_identifier": true,
- "signature_pad": {
- "enabled": true,
- "server": "string"
}, - "signature_appearances": [
- "string"
], - "signing_servers": [
- {
- "key_location": "SERVER",
- "order": 1,
- "signing_profile": {
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "advanced_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "high_trust_advanced_signature": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "qualified_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "signature_appearances": {
- "signature_appearance": "string",
- "signature_appearance_logo": "string"
}, - "csp": {
- "enabled": true,
- "virtual_profile": {
- "name": "string"
}, - "auto_delete_certificates": true
}
}
], - "electronic_seal_servers": [
- {
- "electronic_seal_profile": {
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "name": "string"
}
]
}
}
], - "verification_profile": {
- "name": "string"
}, - "require_password": true,
- "authentication_profile": {
- "allowed": [
- {
- "name": "string"
}
], - "default": {
- "name": "string"
}
}, - "evidence_report": {
- "type": "BASIC",
- "delete_document_logs": true
}, - "one_time_password": {
- "email_otp": {
- "enabled": true
}, - "sms_otp": {
- "enabled": true,
- "server": "string"
}, - "otp_length": 0,
- "otp_expiry": 0,
- "otp_retry_interval": 0
}, - "time_based_one_time_password": true,
- "smtp_server": {
- "enabled": true,
- "server": "string"
}, - "sms_notification": {
- "enabled": true,
- "server": "string"
}, - "auto_delete_user": {
- "enabled": true,
- "inactive_days": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}
}, - "billing": {
- "mode": "ONLINE",
- "payment_type": "string",
- "monthly": {
- "enabled": true,
- "price": 0
}, - "yearly": {
- "enabled": true,
- "price": 0
}, - "auto_reset_constraints": true,
- "price": 0
}
}Response samples
- 400
- 401
- 403
- 404
- 422
- 500
{- "message": "string"
}Delete Service Plan
Business applications can use this service API to delete the service plan. An admin, who has permissions to manage service plans in his role, can delete the service plan.
path Parameters
| id required | integer <int32> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 404
- 500
{- "message": "string"
}Clone Service Plan
Business applications can use this service API to clone service plan. An admin, who has permissions to manage service plans in his role, can clone service plan.
path Parameters
| id required | integer <int32> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 100 ] characters Name of the service plan that is to be added. |
| public required | boolean True, if the service plan is marked as public. |
| deprecated | boolean or null Deprecated: Default value for this parameter set to false |
Responses
Request samples
- Payload
{- "name": "string",
- "public": true,
- "deprecated": true
}Response samples
- 201
- 401
- 403
- 404
- 422
- 500
{- "id": 0,
- "name": "string",
- "created_on": "string",
- "start_date": "string",
- "end_date": "string",
- "features": [
- "string"
], - "type": "string",
- "public": true,
- "deprecated": true,
- "constraints": {
- "users": {
- "count": 0
}, - "signatures": {
- "count": 0,
- "advanced_electronic_signature": {
- "count": 0
}, - "high_trust_advanced_signature": {
- "count": 0
}, - "qualified_electronic_signature": {
- "count": 0
}, - "electronic_seal": {
- "count": 0
}, - "advanced_electronic_seal": {
- "count": 0
}, - "qualified_electronic_seal": {
- "count": 0
}
}, - "simple_electronic_signatures": {
- "count": 0
}, - "storage": {
- "count": 0
}, - "workflows": {
- "count": 0
}, - "upload_size": {
- "count": 0
}, - "templates": {
- "count": 0
}
}, - "level_of_assurance": {
- "allowed": [
- "string"
], - "default": [
- "string"
]
}, - "certify_options": {
- "allowed": [
- "string"
], - "default": "string"
}, - "pdf_a_compliancy": true,
- "auto_delete_document": {
- "enabled": true,
- "duration": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}, - "email_document": {
- "enabled": true,
- "workflow_evidence_report": true
}
}, - "add_unique_identifier": true,
- "signature_pad": {
- "enabled": true,
- "server": "string"
}, - "signature_appearances": [
- "string"
], - "signing_servers": [
- {
- "key_location": "string",
- "order": 0,
- "signing_profile": {
- "id": 0,
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "advanced_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "high_trust_advanced_signature": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "qualified_electronic_signature": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "signature_appearances": {
- "signature_appearance": "string",
- "signature_appearance_logo": "string"
}, - "csp": {
- "enabled": true,
- "virtual_profile": {
- "id": 0,
- "name": "string"
}, - "auto_delete_certificates": true
}
}
], - "electronic_seal_servers": [
- {
- "electronic_seal_profile": {
- "id": 0,
- "name": "string"
}, - "electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "advanced_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}, - "qualified_electronic_seal": {
- "enabled": true,
- "capacities": [
- {
- "id": 0,
- "name": "string",
- "level_of_assurance": "string",
- "key_protection": "string"
}
]
}
}
], - "verification_profile": {
- "id": 0,
- "name": "string"
}, - "require_password": true,
- "authentication_profile": {
- "allowed": [
- {
- "id": 0,
- "name": "string"
}
], - "default": {
- "id": 0,
- "name": "string"
}
}, - "evidence_report": {
- "type": "string",
- "delete_document_logs": true
}, - "one_time_password": {
- "email_otp": {
- "enabled": true
}, - "sms_otp": {
- "enabled": true,
- "server": "string"
}, - "otp_length": 0,
- "otp_expiry": 0,
- "otp_retry_interval": 0
}, - "time_based_one_time_password": true,
- "smtp_server": {
- "enabled": true,
- "server": "string"
}, - "sms_notification": {
- "enabled": true,
- "server": "string"
}, - "auto_delete_user": {
- "enabled": true,
- "inactive_days": 0,
- "notify": {
- "enabled": true,
- "duration": 0
}
}, - "billing": {
- "payment_type": "string",
- "mode": "string",
- "monthly": {
- "enabled": true,
- "price": "string"
}, - "yearly": {
- "enabled": true,
- "price": "string"
}, - "auto_reset_constraints": true,
- "price": "string"
}
}Get Basic Service Plans
Business applications can use this service API to get service plans. An admin, who has permissions to manage service plans in his role, can get service plans.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 500
[- {
- "id": 0,
- "name": "string",
- "price": 0,
- "status": true,
- "type": "string",
- "public": true,
- "yearly": true,
- "monthly": true,
- "require_password": true,
- "deprecated": true
}
]The Account Module facilitates the creation and administration of both individual and enterprise SigningHub users, serving as the central hub for all user-related data and operations.
Get Accounts
Business applications can use this service API to get the accounts. An admin who has permission to manage the account in his role can get the accounts.
path Parameters
| pageNo required | integer <int32> Page number to be retrieved. |
| records required | integer <int32> Total number of records to be retrieved in a page. |
query Parameters
| asc | boolean True, if the parameter to order the result set is ascending. |
| sort-by | string A parameter to specify the sorting criteria for the result set. The parameter will contain created_on | user_name | country | enterprise_name | service_plan. The default is created_on. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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-search-text | string Default: John Doe 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. |
| x-user-name | string Default: John Doe The name of the account user to be searched. |
| x-user-email | string Default: john.doe@ascertia.com The email of the account user to be searched. |
| x-common-name | string Default: John Doe The common name of the account user to be searched. |
| x-enterprise-name | string Default: Ascertia The name of enterprise by which the account is to be searched. |
| x-billing-mode | string Default: ONLINE The billing mode will contain ONLINE | OFFLINE. It is optional if developers intend to ignore the billing mode. |
| x-payment-type | string Default: PAY_REGULARLY The payment type will contain PAY_REGULARLY | PAY_AS_YOU_GO. |
| x-service-plan-type | string Default: INDIVIDUAL The type of service plan by which the account is to be searched. The type will contain INDIVIDUAL | ENTERPRISE | NONE. |
| x-service-plan | string Default: Basic Individual The name of service plan to be searched. |
| x-activated | string Default: Activated The status of the user will contain REGISTERED | ACTIVATED |
| x-enabled | string Default: False Account enabled possible values are True (ALLOW_ACCESS) | False (DENY_ACCESS) |
| x-from | string Default: 2017-01-01 The date value in the 8601 format from which onwards the account is to be searched. |
| x-to | string Default: 2017-01-27 The date value in the 8601 format until which the account is to be searched. |
| x-country | string Default: United States The country of the account user to be searched. |
| x-national-id | string Default: NID123 The national ID of the account user to be searched. |
| x-accounts | string Default: ENTERPRISE The type of the account user to be searched. The type will contain ALL | ENTERPRISE | INDIVIDUAL | INACTIVE | LOCKED | DORMANT | USER_FEEDBACK | GUEST | MARK_DELETED. |
| x-last-activity | string Default: 1 The number of days since the last activity of the account user to be searched. |
| x-total-records | string Default: 212 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
[- {
- "user_id": 0,
- "user_name": "string",
- "user_email": "string",
- "service_plan": {
- "id": 0,
- "passowrd_required": true,
- "name": "string",
- "type": "string"
}, - "enterprise_id": 0,
- "enterprise_name": "string",
- "country": "string",
- "created_on": "2019-08-24T14:15:22Z",
- "enterprise": true,
- "enterprise_owner": true,
- "feedBack": "string",
- "is_dormant": true,
- "is_locked": true,
- "activated": "string",
- "enabled": true,
- "workspace_id": "string"
}
]Get Account by ID
Business applications can use this service API to get an account by ID. An admin who has permission to manage the account in his role can get an account by ID.
path Parameters
| id required | integer <int64> The user's ID. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
{- "billing_enabled": true,
- "ra_enable": true,
- "csp_enable": true,
- "csc_enable": true,
- "user": {
- "user_id": 0,
- "name": "string",
- "user_email": "string",
- "common_name": "string",
- "enterprise_id": 0,
- "enterprise_name": "string",
- "country": "string",
- "mobile_number": "string",
- "job_titles": "string",
- "company_name": "string",
- "ra_id": "string",
- "csc_id": "string",
- "csp_id": "string",
- "nid": "string",
- "language": "string",
- "activated": "string",
- "enabled": true,
- "dormant": true,
- "billing_status": true,
- "last_accessed_on": "string",
- "created_on": "string",
- "created_by": "string",
- "modified_on": "string",
- "modified_by": "string",
- "enterprise_owner": true,
- "enterprise": true,
- "enterprise_owner_email": "string",
- "enterprise_owner_name": "string",
- "enterprise_owner_phone": "string",
- "enterprise_support_email": "string"
}, - "service_plan": {
- "id": 0,
- "name": "string"
}, - "usage_statistics": {
- "user": {
- "consumed": 0,
- "allowed": 0
}, - "signatures": {
- "consumed": 0,
- "allowed": 0
}, - "advanced_electronic_signatures": {
- "consumed": 0,
- "allowed": 0
}, - "high_trust_advanced_signatures": {
- "consumed": 0,
- "allowed": 0
}, - "qualified_electronic_signatures": {
- "consumed": 0,
- "allowed": 0
}, - "electronic_seals": {
- "consumed": 0,
- "allowed": 0
}, - "advanced_electronic_seals": {
- "consumed": 0,
- "allowed": 0
}, - "qualified_electronic_seals": {
- "consumed": 0,
- "allowed": 0
}, - "simple_electronic_signatures": {
- "consumed": 0,
- "allowed": 0
}, - "workflows": {
- "consumed": 0,
- "allowed": 0
}, - "templates": {
- "consumed": 0,
- "allowed": 0
}, - "storage": {
- "consumed": 0,
- "allowed": 0
}
}
}Delete Account by ID
Business applications can use this service API to delete account by id. An admin, who has permissions to manage account in his role, can delete account by id.
path Parameters
| id required | integer <int64> Id of the user. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 400
- 401
- 403
- 404
- 500
{- "message": "string"
}Update Account
Business applications can use this service API to update account. An admin, who has permissions to manage account in his role, can update account.
path Parameters
| id required | integer <int64> Id of the user. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| user_name required | string [ 1 .. 255 ] characters user name |
| common_name | string or null <= 255 characters common name |
| user_email required | string [ 1 .. 255 ] characters user email |
| mobile_number | string or null <= 15 characters mobile number |
| job_title | string or null <= 255 characters job title |
| company_name | string or null <= 255 characters company name |
| ra_id | string or null <= 255 characters User ID of the user registered in SAM service inside SigningHub Engine (ADSS Server). |
| national_id | string or null <= 255 characters national id |
| csc_id | string or null <= 255 characters Cloud Signature Consortium (CSC) user Id that will be required when signing(CSC) via client credential flow |
| csp_id | string or null <= 255 characters csp id |
| country | string or null country |
| language | string or null language |
| enabled | boolean User's access level possible values are True (ALLOW_ACCESS) | False (DENY_ACCESS) |
Responses
Request samples
- Payload
{- "user_name": "string",
- "common_name": "string",
- "user_email": "string",
- "mobile_number": "string",
- "job_title": "string",
- "company_name": "string",
- "ra_id": "string",
- "national_id": "string",
- "csc_id": "string",
- "csp_id": "string",
- "country": "string",
- "language": "string",
- "enabled": true
}Response samples
- 400
- 401
- 403
- 404
- 422
- 500
{- "message": "string"
}Get Account by Email
Business applications can use this service API to get an account by email. An admin who has permission to manage the account in his role can get an account by email.
path Parameters
| emailAddress required | string The user’s email address. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
{- "billing_enabled": true,
- "ra_enable": true,
- "csp_enable": true,
- "csc_enable": true,
- "user": {
- "user_id": 0,
- "name": "string",
- "user_email": "string",
- "common_name": "string",
- "enterprise_id": 0,
- "enterprise_name": "string",
- "country": "string",
- "mobile_number": "string",
- "job_titles": "string",
- "company_name": "string",
- "ra_id": "string",
- "csc_id": "string",
- "csp_id": "string",
- "nid": "string",
- "language": "string",
- "activated": "string",
- "enabled": true,
- "dormant": true,
- "billing_status": true,
- "last_accessed_on": "string",
- "created_on": "string",
- "created_by": "string",
- "modified_on": "string",
- "modified_by": "string",
- "enterprise_owner": true,
- "enterprise": true,
- "enterprise_owner_email": "string",
- "enterprise_owner_name": "string",
- "enterprise_owner_phone": "string",
- "enterprise_support_email": "string"
}, - "service_plan": {
- "id": 0,
- "name": "string"
}, - "usage_statistics": {
- "user": {
- "consumed": 0,
- "allowed": 0
}, - "signatures": {
- "consumed": 0,
- "allowed": 0
}, - "advanced_electronic_signatures": {
- "consumed": 0,
- "allowed": 0
}, - "high_trust_advanced_signatures": {
- "consumed": 0,
- "allowed": 0
}, - "qualified_electronic_signatures": {
- "consumed": 0,
- "allowed": 0
}, - "electronic_seals": {
- "consumed": 0,
- "allowed": 0
}, - "advanced_electronic_seals": {
- "consumed": 0,
- "allowed": 0
}, - "qualified_electronic_seals": {
- "consumed": 0,
- "allowed": 0
}, - "simple_electronic_signatures": {
- "consumed": 0,
- "allowed": 0
}, - "workflows": {
- "consumed": 0,
- "allowed": 0
}, - "templates": {
- "consumed": 0,
- "allowed": 0
}, - "storage": {
- "consumed": 0,
- "allowed": 0
}
}
}Get Saved Searches
Business applications can use this service API to get the saved searches. An admin who has permission to manage the account in his role can get the saved searches.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
[- {
- "criteria": {
- "user_name": "string",
- "user_email": "string",
- "common_name": "string",
- "enterprise_name": "string",
- "billing_mode": "string",
- "payment_type": "string",
- "service_plan_name": "string",
- "activated": true,
- "enabled": true,
- "created_on_from": "string",
- "created_on_to": "string",
- "country": "string",
- "national_id": "string",
- "last_accessed_days": "string"
}, - "id": 0,
- "default": true,
- "operator_name": "string",
- "search_name": "string"
}
]Save Search
Business applications can use this service API to save a search. An admin who has permission to manage the account in his role can save a search.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| user_name | string or null <= 255 characters The name of the user is a criterion in the search filter that will be used to filter accounts. |
| user_email | string or null <= 255 characters The email of the user is a criterion in the search filter that will be used to filter accounts. |
| common_name | string or null <= 255 characters The common name of the user is a criterion in the search filter that will be used to filter accounts. |
| enterprise_name | string or null <= 255 characters The name of the enterprise to which the user belongs is a criterion in the search filter that will be used to filter accounts. |
| billing_mode | string or null <= 255 characters The billing mode is a criterion in the search filter that will be used to filter accounts. It will contain ONLINE_BILLING | OFFLINE_BILLING | NO_BILLING | NO_BILLING_TRIAL. |
| payment_type | string or null <= 255 characters The payment type is a criterion in the search filter that will be used to filter accounts. It will contain NONE | PAY_REGULARLY | PAY_AS_YOU_GO. |
| service_plan_name | string or null <= 100 characters The name of the service plan is a criterion in the search filter that will be used to filter accounts. |
| activated | boolean or null If the status of the user is activated. true (ACTIVATED) | false REGISTERED |
| enabled | boolean or null True, if the access level of the user is allowed. Possible values are false (DENY_ACCESS) | true (ALLOW_ACCESS) |
| created_on_from | string or null The from date is a criterion in the search filter that will be used to filter accounts. The value is expected to follow the ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields, the hh:mm:ss +00 can be ignored. |
| created_on_to | string or null The to date is a criterion in the search filter that will be used to filter accounts. The value is expected to follow the ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields, the hh:mm:ss +00 can be ignored. |
| country | string or null <= 255 characters The country of the user is a criterion in the search filter that will be used to filter accounts. All values in the appendix - Country list are accepted. |
| national_id | string or null <= 255 characters The national ID number of the user is a criterion in the search filter that will be used to filter accounts. |
| last_accessed_days | string or null [ 1 .. 9999 ] The number of days since the user last accessed accounts is a criterion in the search filter that will be used to filter accounts. |
| search_name required | string [ 1 .. 200 ] characters The name of the search filter. |
Responses
Request samples
- Payload
{- "user_name": "string",
- "user_email": "string",
- "common_name": "string",
- "enterprise_name": "string",
- "billing_mode": "string",
- "payment_type": "string",
- "service_plan_name": "string",
- "activated": true,
- "enabled": true,
- "created_on_from": "string",
- "created_on_to": "string",
- "country": "string",
- "national_id": "string",
- "last_accessed_days": "string",
- "search_name": "string"
}Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0
}Get Saved Search by ID
Business applications can use this service API to get a saved search by ID. An admin who has permission to manage the account in his role can get a saved search by ID.
path Parameters
| id required | integer <int64> The ID of the saved search. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
{- "criteria": {
- "user_name": "string",
- "user_email": "string",
- "common_name": "string",
- "enterprise_name": "string",
- "billing_mode": "string",
- "payment_type": "string",
- "service_plan_name": "string",
- "activated": true,
- "enabled": true,
- "created_on_from": "string",
- "created_on_to": "string",
- "country": "string",
- "national_id": "string",
- "last_accessed_days": "string"
}, - "id": 0,
- "default": true,
- "operator_name": "string",
- "search_name": "string"
}Update Saved Search
Business applications can use this service API to update a saved search. An admin who has permission to manage the account in his role can update a saved search.
path Parameters
| id required | integer <int64> ID of the saved search. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| user_name | string or null <= 255 characters The name of the user is a criterion in the search filter that will be used to filter accounts. |
| user_email | string or null <= 255 characters The email of the user is a criterion in the search filter that will be used to filter accounts. |
| common_name | string or null <= 255 characters The common name of the user is a criterion in the search filter that will be used to filter accounts. |
| enterprise_name | string or null <= 255 characters The name of the enterprise to which the user belongs is a criterion in the search filter that will be used to filter accounts. |
| billing_mode | string or null <= 255 characters The billing mode is a criterion in the search filter that will be used to filter accounts. It will contain ONLINE_BILLING | OFFLINE_BILLING | NO_BILLING | NO_BILLING_TRIAL. |
| payment_type | string or null <= 255 characters The payment type is a criterion in the search filter that will be used to filter accounts. It will contain NONE | PAY_REGULARLY | PAY_AS_YOU_GO. |
| service_plan_name | string or null <= 100 characters The name of the service plan is a criterion in the search filter that will be used to filter accounts. |
| activated | boolean or null If the status of the user is activated. true (ACTIVATED) | false REGISTERED |
| enabled | boolean or null True, if the access level of the user is allowed. Possible values are false (DENY_ACCESS) | true (ALLOW_ACCESS) |
| created_on_from | string or null The from date is a criterion in the search filter that will be used to filter accounts. The value is expected to follow the ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields, the hh:mm:ss +00 can be ignored. |
| created_on_to | string or null The to date is a criterion in the search filter that will be used to filter accounts. The value is expected to follow the ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields, the hh:mm:ss +00 can be ignored. |
| country | string or null <= 255 characters The country of the user is a criterion in the search filter that will be used to filter accounts. All values in the appendix - Country list are accepted. |
| national_id | string or null <= 255 characters The national ID number of the user is a criterion in the search filter that will be used to filter accounts. |
| last_accessed_days | string or null [ 1 .. 9999 ] The number of days since the user last accessed accounts is a criterion in the search filter that will be used to filter accounts. |
| search_name required | string [ 1 .. 200 ] characters The name of the search filter. |
Responses
Request samples
- Payload
{- "user_name": "string",
- "user_email": "string",
- "common_name": "string",
- "enterprise_name": "string",
- "billing_mode": "string",
- "payment_type": "string",
- "service_plan_name": "string",
- "activated": true,
- "enabled": true,
- "created_on_from": "string",
- "created_on_to": "string",
- "country": "string",
- "national_id": "string",
- "last_accessed_days": "string",
- "search_name": "string"
}Response samples
- 400
- 401
- 403
- 404
- 422
- 500
{- "message": "string"
}Delete Saved Search
Business applications can use this service API to delete a saved search. An admin who has permission to manage the account in his role can delete a saved search.
path Parameters
| id required | integer <int64> ID of the saved search. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 404
- 500
{- "message": "string"
}Get Enterprise Users
Business applications can use this service API to get the enterprise users. An admin who has permission to manage the account in his role can get the enterprise users.
path Parameters
| enterpriseid required | integer <int64> The ID of the enterprise. |
| pageNo required | integer <int32> Page number to be retrieved. |
| records required | integer <int32> Total number of records to be retrieved in a page. |
header Parameters
| x-search-text | string |
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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-search-text | string Default: John Doe 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. |
| x-total-records | string Default: 212 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "user_id": 0,
- "name": "string",
- "email_address": "string",
- "enterprise_id": 0
}
]Get Account Alerts
Business applications can use this service API to get account alerts. An admin who has permissions to manage the account in his role can get account alerts.
path Parameters
| user_id required | integer <int64> The user's ID. |
| pageNo required | integer <int32> The page number to be retrieved. |
| records required | integer <int32> The total number of records to be retrieved in a page. |
query Parameters
| asc | boolean True, if the parameter to order the result set is ascending. |
| sort-by | string A parameter to specify the sorting criteria for the result set. The parameter will contain created_on | type. The default value is created_on. |
header Parameters
| x-search-text | string |
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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-search-text | string Default: John Doe 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. |
| x-total-records | string Default: 212 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
[- {
- "module": "string",
- "action": "string",
- "detail": "string",
- "info_key": "string",
- "info_value": "string",
- "created_on": "2019-08-24T14:15:22Z"
}
]Reset Usage Statistics
Business applications can use this service API to reset statistics. An admin, who has permissions to manage account in his role, can reset usage statistics.
path Parameters
| user_id required | integer <int64> Id of the user. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 400
- 401
- 403
- 404
- 500
{- "message": "string"
}Get User Activity by User ID
Business applications can use this service API to get the user activity by ID. An admin who has permission to manage the account in his role can get the user activity by user ID.
path Parameters
| user_id required | integer <int64> The user’s ID for the activity which needs to be retrieved. |
| pageNo required | integer <int32> The page number to be retrieved. |
| records required | integer <int32> The total number of records to be retrieved in a page. |
query Parameters
| asc | boolean True, if the parameter to order the result set is ascending. |
| sort-by | string A parameter to specify the sorting criteria for the result set. The parameter will contain created_on. |
header Parameters
| x-search-text | string |
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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-search-text | string Default: John Doe 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. |
| x-total-records | string Default: 212 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
[- {
- "module": "string",
- "action": "string",
- "information": [
- {
- "Key": "string",
- "Value": "string"
}
], - "detail": [
- {
- "data": [
- { }
], - "key": "string",
- "value": "string",
- "visible": true,
- "order": 0
}
], - "agent": "string",
- "type": "DOCUMENT",
- "id": 0,
- "created_on": "2019-08-24T14:15:22Z",
- "dst_offset": "string",
- "info_key": "string",
- "package_name": "string"
}
]Check Existing User
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
{- "message": "string"
}Unlock User Account
path Parameters
| id required | integer <int64> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 500
{- "message": "string"
}Get Account Billing
Business applications can use this service API to get the account billings. An admin who has permission to manage the account in his role can get the account billing.
path Parameters
| user_id required | integer <int64> The ID of the user. |
| pageNo required | integer <int32> The page number to be retrieved. |
| records required | integer <int32> The total number of records to be retrieved in a page. |
query Parameters
| asc | boolean True, if the parameter to order the result set is ascending. |
| sort-by | string A parameter to specify the sorting criteria for the result set. The parameter will contain date, payment_number, amount and user_amount. |
header Parameters
| x-search-text | string |
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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-search-text | string Default: John Doe 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. |
| x-total-records | string Default: 212 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
[- {
- "date": "2019-08-24T14:15:22Z",
- "service_plan": {
- "id": 0,
- "name": "string"
}, - "payment_type": "string",
- "payment_number": 0,
- "type": "string",
- "billing_model": "string",
- "system_currency": "string",
- "user_currency": "string",
- "price": "string",
- "user_amount": "string",
- "vat_amount": "string",
- "vat_number": "string",
- "transaction_id": "string",
- "reference_number": "string",
- "next_payment_date": "2019-08-24T14:15:22Z",
- "remarks": "string"
}
]Delete Bulk Account
Business applications can use this service API to delete bulk accounts. An admin, who has permissions to manage account in his role, can delete bulk accounts.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
Ids of the users.
Responses
Request samples
- Payload
[- 0
]Response samples
- 200
- 400
- 401
- 403
- 404
- 500
[- {
- "Id": 0,
- "ErrorMessage": "string"
}
]Update Guest Account
Business applications can use this service API to update guest user name. An admin, who has permissions to manage account in his role, can update guest user name.
path Parameters
| id required | integer <int64> Id of the user. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| user_name required | string [ 1 .. 255 ] characters user name |
Responses
Request samples
- Payload
{- "user_name": "string"
}Response samples
- 400
- 401
- 403
- 404
- 500
{- "message": "string"
}Export Accounts
Business applications can use this service API to export the accounts to an Excel file. An admin who has permission to manage the account in his role can export the accounts.
path Parameters
| pageNo required | integer <int32> The page number to be retrieved. |
| records required | integer <int32> The total number of records to be retrieved in a page. |
query Parameters
| asc | boolean True, if the parameter to order the result set is ascending. |
| sort-by | string A parameter to specify the sorting criteria for the result set. The parameter will contain created_on | user_name | country | enterprise_name | service_plan. The default is created_on. |
header Parameters
object (AccountHeaderRequest) | |
| x-search-text | string |
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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-search-text | string Default: John Doe 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. |
| x-total-records | string Default: 212 The total number of records found with the provided search criteria. |
| x-user-name | string Default: John Doe The name of the account user to be searched. |
| x-user-email | string Default: john.doe@ascertia.com The email of the account user to be searched. |
| x-common-name | string Default: John Doe The common name of the account user to be searched. |
| x-enterprise-name | string Default: Ascertia The name of enterprise by which the account is to be searched. |
| x-billing-mode | string Default: ONLINE The billing mode will contain ONLINE | OFFLINE. It is optional if developers intend to ignore the billing mode. |
| x-payment-type | string Default: PAY_REGULARLY The payment type will contain PAY_REGULARLY | PAY_AS_YOU_GO. |
| x-service-plan-type | string Default: INDIVIDUAL The type of service plan by which the account is to be searched. The type will contain INDIVIDUAL | ENTERPRISE | NONE. |
| x-service-plan | string Default: Basic Individual The name of service plan to be searched. |
| x-activated | string Default: True The status of the user will contain REGISTERED | ACTIVATED |
| x-enabled | string Default: True Account enabled possible values are True (ALLOW_ACCESS) | False (DENY_ACCESS) |
| x-from | string Default: 2017-05-01 The date value in the 8601 format from which onwards the account is to be searched. |
| x-to | string Default: 2017-05-22 The date value in the 8601 format until which the account is to be searched. |
| x-country | string Default: United States The country of the account user to be searched. |
| x-accounts | string Default: ENTERPRISE The type of the account user to be searched. The type will contain ALL | ENTERPRISE | INDIVIDUAL | INACTIVE | LOCKED | DORMANT | USER_FEEDBACK | GUEST | MARK_DELETED. |
| accept-language | string Default: en-US Language code in which data is required to export. If no value is provided, then default language will be used. The supported keys are en-US, nl-NL, es-ES, es-LA, fr-FR, de-DE, ar-AE, tr-TR, lv-LV, nb-NO, el-GR, hi-IN, id-ID, ja-JP, pt-Pt, pt-BR, ro-RO, ru-RU, sr-CR, th-TH, vi-VN, it-IT, fi-FI, et-ET, pl-PL, sv-SE, da-DK, ar-DZ, hu-HU, ka-KA, zh-CN, zh-TW. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
"string"Mark Account as Dormant
Business applications can use this service API to mark account as dormant. An admin, who has permissions to manage account in his role, can mark account as dormant.
path Parameters
| userId required | integer <int64> ID of the user. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 400
- 401
- 403
- 404
- 500
{- "message": "string"
}Archive Account
Business applications can use this service API to archive account. An admin, who has permissions to manage account in his role, can archive account. The archive option is available only if it is enabled in the license and in the global settings
path Parameters
| userId required | integer <int64> ID of the user. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 400
- 401
- 403
- 404
- 500
{- "message": "string"
}Reset Account Password
Business applications can use this service API to reset password. An admin, who has permissions to manage account in his role, can reset account password.
path Parameters
| user_id required | integer <int64> The ID of the user who can reset his/her password. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 404
- 500
{- "message": "string"
}Change User Service Plan
Applications can call this API update a user's service plan. This requires SigningHub Administrator permission.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| user_email required | string non-empty Email address of the account owner. |
| service_plan required | string non-empty New Service Plan name, which is to be assigned to the user. |
| enterprise_name | string or null <= 255 characters The enterprise name in the case of changing from an individual to an enterprise service plan. |
Responses
Request samples
- Payload
{- "user_email": "string",
- "service_plan": "string",
- "enterprise_name": "string"
}Response samples
- 400
- 401
- 403
- 404
- 500
{- "message": "string"
}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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| service_plan_id | integer <int32> The id of service plan |
| user_name required | string [ 1 .. 255 ] characters Name of user that is to be registered. |
| common_name required | string [ 1 .. 255 ] characters Name of user that is to be registered. |
| user_email required | string [ 1 .. 255 ] characters Email Address of the user to be registered. |
| job_title | string or null <= 255 characters Job title of the user. (Optional) |
| company_name | string or null <= 255 characters Company name for the user. (Optional) |
| enterprise_name | string or null <= 255 characters Enterprise name, If service plan type is enterprise. |
| mobile_number | string or null <= 255 characters Mobile number of the user. (Optional) |
| country | string or null Country name for the user. All values in the appendix - Country list are accepted. (Optional) |
| language | string or null Language selected for the user. All values in the appendix - Language list are accepted. For example en-US |
| user_csp_id | string or null The user CSP id to identify the user. |
| user_ra_id | string or null The remote authorisation user id. |
| national_id | string or null The user national id. |
| security_answer | string or null <= 255 characters The answer to the security answer, required during new user registration. |
| security_question | string or null <= 255 characters The answer to the security question, required during new user registration. |
| send_activation_email | boolean Indicates whether to send an activation email to the user's registration email address upon account creation. |
| send_registration_email | boolean Indicates whether to send registration email to the user's registration email address upon account creation. |
| csc_id | string or null Cloud Signature Consortium (CSC) user Id that will be required when signing(CSC) via client credential flow |
| password | string or null <= 255 characters The unique password set by the user during registration for securing their account. |
| confirm_password | string or null <= 255 characters The confirm password set by the user during registration for securing their account. |
Responses
Request samples
- Payload
{- "service_plan_id": 0,
- "user_name": "string",
- "common_name": "string",
- "user_email": "string",
- "job_title": "string",
- "company_name": "string",
- "enterprise_name": "string",
- "mobile_number": "string",
- "country": "string",
- "language": "string",
- "user_csp_id": "string",
- "user_ra_id": "string",
- "national_id": "string",
- "security_answer": "string",
- "security_question": "string",
- "send_activation_email": true,
- "send_registration_email": true,
- "csc_id": "string",
- "password": "string",
- "confirm_password": "string"
}Response samples
- 200
- 201
- 400
- 403
- 500
{- "message": "string"
}Get Admin Account Signing Certificates
path Parameters
| userId required | integer <int64> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "capacity_name": "string",
- "certificate_alias": "string",
- "certificate_dn": "string",
- "level_of_assurance": "string",
- "key_protection_option": "string",
- "default": true,
- "custom": true
}
]Add User Signing Certificate
path Parameters
| userId required | integer <int64> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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: multipart/form-data
| capacity_name required | string <= 100 characters Its termed as Capacity Name basically friendly name of certificate that could consist of Letters and numbers |
| certificate_alias required | string <= 255 characters Unique Guid Id |
| default | boolean Default signing certificate |
| level_of_assurance required | string Possible values are ADVANCED_ELECTRONIC_SIGNATURE, HIGH_TRUST_ADVANCED, QUALIFIED_ELECTRONIC_SIGNATURE |
| key_protection_option required | string Key protection options, possible values are USER_PASSWORD, REMOTE_AUTHORISATION |
| file_stream required | string <binary> Stream of certificate |
Responses
Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0
}Get User Signing Certificate by ID
path Parameters
| userId required | integer <int64> |
| userCertificateId required | integer <int64> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
{- "id": 0,
- "capacity_name": "string",
- "certificate_alias": "string",
- "certificate_dn": "string",
- "level_of_assurance": "string",
- "key_protection_option": "string",
- "default": true,
- "custom": true
}Update User Signing Certificates
path Parameters
| userId required | integer <int64> |
| userCertificateId required | integer <int64> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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: multipart/form-data
| capacity_name required | string <= 100 characters Its termed as Capacity Name basically friendly name of certificate that could consist of Letters and numbers |
| certificate_alias required | string <= 255 characters Unique Guid Id |
| default | boolean Default signing certificate |
| level_of_assurance required | string Possible values are ADVANCED_ELECTRONIC_SIGNATURE, HIGH_TRUST_ADVANCED, QUALIFIED_ELECTRONIC_SIGNATURE |
| file_stream | string <binary> Stream of certificate |
Responses
Response samples
- 400
- 401
- 403
- 404
- 422
- 500
{- "message": "string"
}Delete User Signing Certificates
path Parameters
| userId required | integer <int64> |
| userCertificateId required | integer <int64> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 500
{- "message": "string"
}Add User Signing Certificate with base64
path Parameters
| userId required | integer <int64> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| capacity_name required | string [ 1 .. 100 ] characters Its termed as Capacity Name basically friendly name of certificate that could consist of Letters and numbers |
| certificate_alias required | string [ 1 .. 255 ] characters Unique Guid Id |
| default | boolean Default signing certificate |
| level_of_assurance required | string non-empty Possible values are ADVANCED_ELECTRONIC_SIGNATURE, HIGH_TRUST_ADVANCED, QUALIFIED_ELECTRONIC_SIGNATURE |
| key_protection_option required | string non-empty Key protection options, possible values are USER_PASSWORD, REMOTE_AUTHORISATION |
| certificate required | string non-empty Base64 of certificate |
Responses
Request samples
- Payload
{- "capacity_name": "string",
- "certificate_alias": "string",
- "default": true,
- "level_of_assurance": "string",
- "key_protection_option": "string",
- "certificate": "string"
}Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0
}Update User Signing Certificates Base64
path Parameters
| userId required | integer <int64> |
| userCertificateId required | integer <int64> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| capacity_name required | string [ 1 .. 100 ] characters Its termed as Capacity Name basically friendly name of certificate that could consist of Letters and numbers |
| certificate_alias required | string [ 1 .. 255 ] characters Unique Guid Id |
| default | boolean Default signing certificate |
| level_of_assurance required | string non-empty Possible values are ADVANCED_ELECTRONIC_SIGNATURE, HIGH_TRUST_ADVANCED, QUALIFIED_ELECTRONIC_SIGNATURE |
| certificate | string or null Base64 of certificate |
Responses
Request samples
- Payload
{- "capacity_name": "string",
- "certificate_alias": "string",
- "default": true,
- "level_of_assurance": "string",
- "certificate": "string"
}Response samples
- 400
- 401
- 403
- 404
- 422
- 500
{- "message": "string"
}Revoke User Signing Certificates
path Parameters
| userId required | integer <int64> |
| userCertificateId required | integer <int64> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 500
{- "message": "string"
}The Billing Module manages and stores billing information for users, providing a centralized view of all billing-related data and transactions.
Get Billings
Business applications can use this service API to get billings. An admin who has permission to manage the billing in his role can get billings.
path Parameters
| pageNo required | integer <int32> The page number to be retrieved. |
| records required | integer <int32> The total number of records to be retrieved in a page. |
query Parameters
| agreement-id | string The agreement ID for WorldPay and the customer ID for Stripe. |
| billing-type | string The billing type will contain ONLINE_BILLING | OFFLINE_BILLING | NO_BILLING | NO_BILLING_TRIAL. |
| user-email | string <= 255 characters The email address of the billable user. |
| enterprise-name | string <= 255 characters The name of the billable user's enterprise. |
| failed-payments | boolean True, if the online payment records that failed due to any technical reason will be displayed. |
| date-from | string <date-time> The date from which the billing will be retrieved. The value is expected to follow the ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields, the hh:mm:ss +00 can be ignored. |
| asc | boolean True, if the parameter to order the result set is ascending. |
| autoreset | boolean True, if the billing will be auto reset. |
| payment-mode | string <= 255 characters The payment mode will contain MONTHLY | YEARLY. |
| payment-type | string <= 255 characters The payment type will contain PAY_REGULARLY | PAY_AS_YOU_GO. |
| service-plan-id | integer <int64> The ID of the service plan. |
| service-plan-name | string The name of the service plan. |
| sort-by | string A parameter to specify the sorting criteria for the result set. The parameter values include: created_on | performed_by | user_name | enterprise_name | service_plan_name | payment_type | user_amount | expiry_date. |
| date-to | string <date-time> Date until which the billing is to be retrieved. The value is expected to follow the ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields, the hh:mm:ss +00 can be ignored. |
| transaction-id | string The transaction ID for WorldPay and the charge ID for Stripe. |
| transaction-type | string The transaction type will contain FIRST | RECURRENT. |
| user-name | string <= 255 characters The name of the billable user. |
header Parameters
| x-search-text | string |
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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-search-text | string Default: John 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. |
| x-total-records | string Default: 212 The total number of records found with the provided search criteria. |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "user_id": 0,
- "enterprise_id": 0,
- "billing_details_id": 0,
- "user_email": "string",
- "user_name": "string",
- "performed_by": "string",
- "date": "2019-08-24T14:15:22Z",
- "currency_id": "string",
- "amount": "string",
- "user_amount": "string",
- "vat_amount": "string",
- "vat_number": "string",
- "payment_number": 0,
- "type": "string",
- "payment_type": "string",
- "duration": "string",
- "user_status": "string",
- "created_on": "2019-08-24T14:15:22Z",
- "enterprise_name": "string",
- "expiry_date": "2019-08-24T14:15:22Z",
- "service_plan_id": 0,
- "service_plan_name": "string"
}
]Get Billing Details
Business applications can use this service API to get the billing details. An admin who has permission to manage the billing in his role can get the billing details.
path Parameters
| id required | integer <int64> The billing ID. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
{- "billing_model": "string",
- "ipaddress": "string",
- "payment_number": 0,
- "reference_number": "string",
- "remarks": "string",
- "transaction_id": "string",
- "user_agent": "string",
- "vat_amount": "string",
- "vat_number": "string",
- "provider": "string",
- "type": "string"
}Get Saved Searches
Business applications can use this service API to get the saved billing searches. An admin who has permission to manage the billing in his role can get the saved searches.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "criteria": {
- "action_type": "string",
- "user_name": "string",
- "user_email": "string",
- "agreement_id": "string",
- "transaction_id": "string",
- "enterprise_name": "string",
- "service_plan_id": "string",
- "service_plan_name": "string",
- "billing_type": "string",
- "payment_type": "string",
- "payment_mode": "string",
- "date_from": "string",
- "date_to": "string"
}, - "id": 0,
- "default": true,
- "operator_name": "string",
- "search_name": "string"
}
]Billing Save Search
Business applications can use this service API to save a search filter. An admin who has permission to manage the billing in his role can save a search filter.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| action_type | string or null The action type. The possible values for “Action Type” are “WORLDPAY_RECURRENT_PAYMENT_FAILURE”, “WORLDPAY_AGREEMENT_TERMINATED” and “ALL_TRANSACTION” |
| agreement_id | string or null The agreement ID of the save search criteria. |
| billing_type | string or null The billing type of the account. The possible values for “Billing type” are “ONLINE_BILLING”, “OFFLINE_BILLING”, “NO_BILLING”, and “NO_BILLING_TRIAL”. |
| date_from | string or null The date from which to search onwards. |
| date_to | string or null The date up till which to search. |
| user_email | string or null The email address for the save search criteria. |
| enterprise_name | string or null The name of the enterprise for the save search criteria. |
| payment_mode | string or null The payment mode. The possible values for “Payment Mode” are “MONTHLY”, and “YEARLY”. |
| payment_type | string or null The payment type. The possible values for the “Payment Type” are “PAY_REGULARLY”, and “PAY_AS_YOU_GO”. |
| search_name | string or null The name of the save search. |
| service_plan_id | integer or null <int64> The service plan ID. |
| service_plan_name | string or null The name of the service plan. |
| transaction_id | string or null The transaction ID of the save search criteria. |
| user_name | string or null The name of the user. |
Responses
Request samples
- Payload
{- "action_type": "string",
- "agreement_id": "string",
- "billing_type": "string",
- "date_from": "string",
- "date_to": "string",
- "user_email": "string",
- "enterprise_name": "string",
- "payment_mode": "string",
- "payment_type": "string",
- "search_name": "string",
- "service_plan_id": 0,
- "service_plan_name": "string",
- "transaction_id": "string",
- "user_name": "string"
}Response samples
- 201
- 400
- 401
- 403
- 500
{- "id": 0
}Update Save Search
Business applications can use this service API to save a search filter. An admin who has permission to manage the billing in his role can update a search filter.
path Parameters
| id required | integer <int32> |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| action_type | string or null The action type. The possible values for “Action Type” are “WORLDPAY_RECURRENT_PAYMENT_FAILURE”, “WORLDPAY_AGREEMENT_TERMINATED” and “ALL_TRANSACTION” |
| agreement_id | string or null The agreement ID of the save search criteria. |
| billing_type | string or null The billing type of the account. The possible values for “Billing type” are “ONLINE_BILLING”, “OFFLINE_BILLING”, “NO_BILLING”, and “NO_BILLING_TRIAL”. |
| date_from | string or null The date from which to search onwards. |
| date_to | string or null The date up till which to search. |
| user_email | string or null The email address for the save search criteria. |
| enterprise_name | string or null The name of the enterprise for the save search criteria. |
| payment_mode | string or null The payment mode. The possible values for “Payment Mode” are “MONTHLY”, and “YEARLY”. |
| payment_type | string or null The payment type. The possible values for the “Payment Type” are “PAY_REGULARLY”, and “PAY_AS_YOU_GO”. |
| search_name | string or null The name of the save search. |
| service_plan_id | integer or null <int64> The service plan ID. |
| service_plan_name | string or null The name of the service plan. |
| transaction_id | string or null The transaction ID of the save search criteria. |
| user_name | string or null The name of the user. |
Responses
Request samples
- Payload
{- "action_type": "string",
- "agreement_id": "string",
- "billing_type": "string",
- "date_from": "string",
- "date_to": "string",
- "user_email": "string",
- "enterprise_name": "string",
- "payment_mode": "string",
- "payment_type": "string",
- "search_name": "string",
- "service_plan_id": 0,
- "service_plan_name": "string",
- "transaction_id": "string",
- "user_name": "string"
}Response samples
- 400
- 401
- 403
- 500
{- "message": "string"
}Delete Saved Search
Business applications can use this service API to delete the billing search filter. An admin who has permission to manage the billing in his role can delete the billing search filter.
path Parameters
| id required | integer <int64> The ID of the search filter. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 404
- 500
{- "message": "string"
}Get User Information
Business applications can use this service API to get user information. An admin who has permission to manage the billing in his role can get the user information.
query Parameters
| emailAddress | string |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
{- "id": 0,
- "name": "string",
- "dormant": true,
- "agreement_id": "string",
- "service_plan": {
- "id": 0,
- "name": "string",
- "monthly": true,
- "yearly": true,
- "price": 0,
- "yearly_price": 0,
- "payment_type": "string"
}
}Get Transaction Logs
Business applications can use this service API to get the transaction logs. An admin who has permission to manage the billing in his role can get the transaction logs.
path Parameters
| pageNo required | integer <int32> The page number to be retrieved. |
| records required | integer <int32> The total number of records to be retrieved in a page. |
query Parameters
string The email for the search criteria. | |
| user-name | string The username for the search criteria. |
| enterprise-name | string The name of the enterprise for the search criteria. |
| service-plan-id | integer <int32> The service plan ID for the search criteria. |
| service-plan-type | integer <int32> The type of service plan by which the account is to be searched. The possible values for “Service Plan Type” are “INDIVIDUAL”, “ENTERPRISE”, and “NONE”. |
| payment-type | string The payment type for the search criteria. The possible values for the “Payment Type” are “PAY_REGULARLY”, and “PAY_AS_YOU_GO”. |
| billing-type | string The billing type of the account. The possible values for “Billing type” are “1 = ONLINE_BILLING”, “2 = OFFLINE_BILLING”, “3 = NO_BILLING”, and “4 = NO_BILLING_TRIAL”. |
| reason | string The billing reason for the search criteria. |
| performed-by | string The “performed by” for the search criteria. |
| date_from | string The “From” date for the search criteria. |
| date-to | string The “To” date for the search criteria. |
| agreement-id | string The agreement id for the search criteria. |
| transaction-id | string The transaction id for the search criteria. |
| action-type | string The action type. The possible values for “Action Type” are “WORLDPAY_RECURRENT_PAYMENT_FAILURE”, and “WORLDPAY_AGREEMENT_TERMINATED”. |
| payment-type-criteria | string The payment type for the search criteria. |
| sort-column | string The column sort for the search criteria. |
| asc | boolean The asc flag for the search criteria. The default value of the asc flag is false. |
header Parameters
| x-search-text | string |
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
[- {
- "id": 0,
- "created_on": "2019-08-24T14:15:22Z",
- "user_email": "string",
- "info_key": "string",
- "info_value": "string",
- "performed_by": "string",
- "reason": "string",
- "enterprise_id": 0,
- "enterprise_name": "string",
- "service_plan_name": "string",
- "service_plan_id": "string",
- "user_id": 0,
- "user_name": "string",
- "user_status": "string",
- "user_currency": "string",
- "paid": "string"
}
]Get Transaction Log Details
Business applications can use this service API to get the transaction log details. An admin who has permission to manage the billing in his role can get the transaction log details.
path Parameters
| id required | integer <int64> The ID of the transaction log. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
{- "data": [
- { }
], - "Key": "string",
- "Value": "string",
- "Visible": true,
- "Order": 0,
- "certificate_base64": "string",
- "Type": "string",
- "processed_state": "string"
}Export Billing Data
Business applications can use this service API to export the billing data in an Excel file. An admin who has permission to manage the billing in his role can export the billing data.
path Parameters
| pageNo required | integer <int32> |
| records required | integer <int32> |
query Parameters
| asc | boolean True, if the parameter to order the result set is ascending. |
| sort-by | string A parameter to specify the sorting criteria for the result set. The parameter will contain created_on | user_name | country | enterprise_name | service_plan. The default is created_on. |
| agreement-id | string The agreement ID for WorldPay and the customer ID for Stripe. |
| billing-type | string The billing type will contain ONLINE_BILLING | OFFLINE_BILLING | NO_BILLING | NO_BILLING_TRIAL. |
| user-email | string <= 255 characters The email address of the billable user. |
| enterprise-name | string <= 255 characters The name of the billable user's enterprise. |
| failed-payments | boolean True, if the online payment records that failed due to any technical reason will be displayed. |
| date-from | string <date-time> The date from which the billing will be retrieved. The value is expected to follow the ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields, the hh:mm:ss +00 can be ignored. |
| asc | boolean True, if the parameter to order the result set is ascending. |
| autoreset | boolean True, if the billing will be auto reset. |
| payment-mode | string <= 255 characters The payment mode will contain MONTHLY | YEARLY. |
| payment-type | string <= 255 characters The payment type will contain PAY_REGULARLY | PAY_AS_YOU_GO. |
| service-plan-id | integer <int64> The ID of the service plan. |
| service-plan-name | string The name of the service plan. |
| sort-by | string A parameter to specify the sorting criteria for the result set. The parameter values include: created_on | performed_by | user_name | enterprise_name | service_plan_name | payment_type | user_amount | expiry_date. |
| date-to | string <date-time> Date until which the billing is to be retrieved. The value is expected to follow the ISO 8601 format. Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields, the hh:mm:ss +00 can be ignored. |
| transaction-id | string The transaction ID for WorldPay and the charge ID for Stripe. |
| transaction-type | string The transaction type will contain FIRST | RECURRENT. |
| user-name | string <= 255 characters The name of the billable user. |
header Parameters
| x-search-text | string |
| Accept-Language | string |
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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) |
| accept-language | string Default: en-US Language code in which data is required to export. If no value is provided, then default language will be used. The supported keys are en-US, nl-NL, es-ES, es-LA, fr-FR, de-DE, ar-AE, tr-TR, lv-LV, nb-NO, el-GR, hi-IN, id-ID, ja-JP, pt-Pt, pt-BR, ro-RO, ru-RU, sr-CR, th-TH, vi-VN, it-IT, fi-FI, et-ET, pl-PL, sv-SE, da-DK, ar-DZ, hu-HU, ka-KA, zh-CN, zh-TW. |
Responses
Response samples
- 200
- 401
- 403
- 500
"string"Add Manual Billing
Business applications can use this service API to add manual billing. An admin who has permission to manage the billing in his role can add manual billing.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| agreement_id | string or null |
| duration required | string non-empty |
| account_owner_email required | string [ 1 .. 255 ] characters |
| remarks required | string non-empty |
| sp_amount required | number <double> |
| service_plan_name required | string non-empty |
| price | number or null <double> |
| transaction_id required | string non-empty |
| user_currency required | string non-empty |
Responses
Request samples
- Payload
{- "agreement_id": "string",
- "duration": "string",
- "account_owner_email": "string",
- "remarks": "string",
- "sp_amount": 0,
- "service_plan_name": "string",
- "price": 0,
- "transaction_id": "string",
- "user_currency": "string"
}Response samples
- 201
- 400
- 401
- 403
- 500
{- "billing_id": 0
}The Access Control Module manages role-based access with fine-grained authorization, allowing read, add/edit, and delete permissions across modules and submodules. Operators can add, edit, and delete role-based administrators to delegate and control restricted access within SigningHub based on administrative requirements.
Get Operators
Business applications can use this service API to get operators. An admin, who has permissions to manage operators in his role, can read operators.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "email": "string",
- "mobile_number": "string",
- "certificate_cn": "string",
- "certificate_base64": "string",
- "status": true,
- "role": {
- "role_id": 0,
- "role_name": "string"
}, - "picture": "string",
- "created_on": "string"
}
]Add Operator
Business applications can use this service API to add operator for Users. An admin who has permissions to manage Operators in his role, can add new operator.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 255 ] characters Name |
| email required | string [ 1 .. 255 ] characters Email address |
| mobile_number | string or null <= 15 characters Mobile Number |
| certificate_base64 required | string non-empty Certificate string int base64 format |
required | object (OperatorRoleRequest) OperatorRoleRequest |
| status | boolean True, if the operator status is active and possible values are True and False |
Responses
Request samples
- Payload
{- "name": "string",
- "email": "string",
- "mobile_number": "string",
- "certificate_base64": "string",
- "role": {
- "role_id": 0
}, - "status": true
}Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0,
- "created_on": "string"
}Get Operator by ID
Business applications can use this service API to get operator. An admin, who has permissions to manage operator in his role, can read operator.
path Parameters
| id required | integer <int64> Id of the operator. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "name": "string",
- "email": "string",
- "mobile_number": "string",
- "certificate_cn": "string",
- "certificate_base64": "string",
- "status": true,
- "role": {
- "role_id": 0,
- "role_name": "string"
}, - "picture": "string",
- "created_on": "string"
}Update Operator
Business applications can use this service API to update operator. An admin, who has permissions to manage operators in his role, can update operator.
path Parameters
| id required | integer <int64> Id of the operator. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 255 ] characters Name |
| mobile_number | string or null <= 15 characters Mobile Number |
| certificate_base64 | string or null Certificate string in base64 format |
required | object (OperatorRoleRequest) OperatorRoleRequest |
| status | boolean True, if the operator status is active and possible values are True and False |
Responses
Request samples
- Payload
{- "name": "string",
- "mobile_number": "string",
- "certificate_base64": "string",
- "role": {
- "role_id": 0
}, - "status": true
}Response samples
- 400
- 401
- 403
- 404
- 422
- 500
{- "message": "string"
}Delete Operator
Business applications can use this service API to delete operator. An admin, who has permissions to manage operators in his role, can delete operator.
path Parameters
| id required | integer <int64> Id of the operator. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 400
- 401
- 403
- 404
- 500
{- "message": "string"
}Get Operator Certificate
Business applications can use this service API to get operator certificate. An admin, who has permissions to manage operator certificates in his role, can read operator certificate.
path Parameters
| id required | integer <int64> Id of the operator. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
"string"Get Roles
Business applications can use this service API to get roles. An admin, who has permissions to manage roles in his role, can read roles.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "description": "string",
- "operators_count": 0,
- "created_on": "string"
}
]Add Role
Business applications can use this service API to add role. An admin, who has permissions to manage Roles in his role, can add new role.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 100 ] characters Name |
| description | string or null <= 255 characters Description |
required | Array of objects (AdministratorRoleDetailRequest) Details of the role |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "role_detail": [
- {
- "attribute_name": "string",
- "read": true,
- "add_update": true,
- "delete": true
}
]
}Response samples
- 201
- 400
- 401
- 403
- 422
- 500
{- "id": 0,
- "created_on": "string"
}Get Role Operators
Business applications can use this service API to get role operators. An admin, who has permissions to manage roles in his role, can read role operators.
path Parameters
| id required | integer <int64> Id of the role. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
[- {
- "name": "string",
- "email": "string"
}
]Get Role by ID
Business applications can use this service API to get a role for Users. An admin, who has permissions to manage roles in his role, can read role.
path Parameters
| id required | integer <int64> Id of the role. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "name": "string",
- "description": "string",
- "role_detail": [
- {
- "attribute_name": "string",
- "read": true,
- "add_update": true,
- "delete": true
}
]
}Update Role
Business applications can use this service API to update role. An admin, who has permissions to manage roles in his role, can update role.
path Parameters
| id required | integer <int64> Id of the role. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string [ 1 .. 255 ] characters Name |
| description | string or null Description |
Array of objects or null (AdministratorRoleDetailRequest) Details of the role |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "role_detail": [
- {
- "attribute_name": "string",
- "read": true,
- "add_update": true,
- "delete": true
}
]
}Response samples
- 400
- 401
- 403
- 404
- 422
- 500
{- "message": "string"
}Delete Role
Business applications can use this service API to delete role. An admin, who has permissions to manage roles in his role, can delete role.
path Parameters
| id required | integer <int32> Id of the role. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 400
- 401
- 403
- 404
- 500
{- "message": "string"
}The Log Module records each operator action with timestamps and detailed information, ensuring a comprehensive and effective audit trail.
Get Admin Activities
Business applications can use this service API to get an administrator logs.
path Parameters
| page required | integer <int32> Page number to be retrieved. |
| records required | integer <int32> Total number of records to be retrieved in a page. |
query Parameters
| asc | boolean Default: false Order the result set by ascending or descending |
| sort-by | string Default: "created_on" Sort the result by created_on |
header Parameters
| x-search-text | string |
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 500
[- {
- "id": 0,
- "administrator_email": "string",
- "administrator_name": "string",
- "action": "string",
- "module": "string",
- "information": [
- {
- "key": "string",
- "value": "string"
}
], - "detail": [
- {
- "Key": "string",
- "Value": "string"
}
], - "created_on": "string",
- "ip_address": "string",
- "agent": "string",
- "agent_detail": "string",
- "sub_module": "string"
}
]Get Operator Logs
Business applications can use this service API to get an operator logs.
path Parameters
| page required | integer <int32> Page number to be retrieved. |
| records required | integer <int32> Total number of records to be retrieved in a page. |
query Parameters
| name | string The name of the administrator who performed the activity. |
string The email of the administrator who performed the activity. | |
| module | string The module in which the action was performed , and possible values are ADMIN_ACTIVITY_MODULE_ACCOUNTS, ADMIN_ACTIVITY_MODULE_PROFILE, ADMIN_ACTIVITY_MODULE_CONFIGURATIONS, ADMIN_ACTIVITY_MODULE_SERVICE_PLAN,ADMIN_ACTIVITY_MODULE_BILLINGS, ADMIN_ACTIVITY_MODULE_ACCESS_CONTROL, MAIN_REPORTS |
| date-from | string The start date for filtering logs (format: YYYY-MM-DD). |
| date-to | string The end date for filtering logs (format: YYYY-MM-DD). |
| activity | string The activity performed by the administrator, and possible values are ADMIN_ACTIVITY_ADDED, COMMON_ACTIVITY_CLONED, ADMIN_ACTIVITY_DELETED, ADMIN_ACTIVITY_UPDATED, ADMIN_ACTIVITY_RESET_SERVICE_PLAN, LOGGED_OUT, LOGGED_IN, ADMIN_ACTIVITY_DOWNLOADED, ADMIN_ACTIVITY_CHANGE_PASSWORD, LOG_ACTIVITY_ACTION_RESET_BRANDING, LOG_REQUESTED_PASSWORD_CHANGE, ADMIN_ACTIVITY_MODULE_PASSWORD_UPDATE, ADMIN_ACTIVITY_USER_ACCOUNT_UNLOCKED, ADMIN_ACTIVITY_PUBLISH_CHANGES, COMMON_REVOKE, ADMIN_ACTIVITY_DORMANT, ADMIN_ACTIVITY_ARCHIVED |
| sort-by | string Specifies the column to sort the results set by created_on and administrator_email and the default column is "created_on". |
| asc | boolean Determines the sorting order of the result set.
|
header Parameters
| x-search-text | string The search text is header and optional parameter; if omitted, the entire list is returned. it is recommended to provide the search text in Base64-encoded format. |
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "administrator_email": "string",
- "administrator_name": "string",
- "action": "string",
- "module": "string",
- "information": [
- {
- "key": "string",
- "value": "string"
}
], - "detail": [
- {
- "Key": "string",
- "Value": "string"
}
], - "created_on": "string",
- "ip_address": "string",
- "agent": "string",
- "agent_detail": "string",
- "sub_module": "string"
}
]Get Operator Log Details
Business applications can use this service API to get an operator log details.
path Parameters
| id required | integer <int64> The ID of the operator log. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 404
- 500
[- {
- "display_header_key": "string",
- "display_key": "string",
- "field_name": "string",
- "field_type": "string",
- "translate": true,
- "value_after": "string",
- "value_before": "string",
- "audit_detail": [
- {
- "display_key": "string",
- "field_name": "string",
- "value_after": "string",
- "value_before": "string"
}
]
}
]Get Operator Log Searches
Business applications can use this service API to get an operator log searches.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "default": true,
- "operator_name": "string",
- "search_name": "string",
- "criteria": {
- "name": "string",
- "email": "string",
- "module": "string",
- "date_from": "string",
- "date_to": "string",
- "activity": "string",
- "sort_by": "string",
- "asc": true,
- "start": 0,
- "end": 0
}
}
]Add Operator Log Search
Business applications can use this service API to add an operator log search.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| search_name required | string [ 1 .. 200 ] characters Search. |
required | object (OperatorLogSearcheCriteriaRequest) OperatorLogSearcheCriteriaRequest |
Responses
Request samples
- Payload
{- "search_name": "string",
- "criteria": {
- "name": "string",
- "email": "string",
- "module": "string",
- "date_from": "string",
- "date_to": "string",
- "activity": "string",
- "sort_by": "string",
- "asc": true,
- "start": 0,
- "end": 0
}
}Response samples
- 200
- 400
- 401
- 403
- 422
- 500
{- "id": 0,
- "created_on": "string"
}Delete Operator Log Search
Business applications can use this service API to delete an operator log search.
path Parameters
| id required | integer <int64> The ID of the operator log search. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 404
- 500
{- "message": "string"
}Update Operator Log Search
Business applications can use this service API to update an operator log search.
path Parameters
| id required | integer <int64> The Id of the operator log search. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| search_name required | string [ 1 .. 200 ] characters Search. |
required | object (OperatorLogSearcheCriteriaRequest) OperatorLogSearcheCriteriaRequest |
Responses
Request samples
- Payload
{- "search_name": "string",
- "criteria": {
- "name": "string",
- "email": "string",
- "module": "string",
- "date_from": "string",
- "date_to": "string",
- "activity": "string",
- "sort_by": "string",
- "asc": true,
- "start": 0,
- "end": 0
}
}Response samples
- 400
- 401
- 403
- 404
- 422
- 500
{- "message": "string"
}Advanced Power BI reporting by integrating workspace-level reports into the application, utilizing embed tokens to securely render interactive reports within iframes.
Get Workspaces
Business applications can use this service API to get the power bi reports. An admin who has permission to manage the account and advanced resports in his role can get the accounts.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "id": "string",
- "name": "string"
}
]Update Workspace
Business applications can use this service API to update the power bi reports. An admin who has permission to manage the account and advanced resports in his role can update the reports setting.
path Parameters
| enterpriseId required | integer <int64> The enterprise id of the user. |
| workspaceId required | string The workspace ID. Pass a valid workspace ID to assign the user to a workspace. Pass nothing to unassign the user's workspace. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 401
- 403
- 500
{- "message": "string"
}Get Power BI Reports
Business applications can use this service API to get the power bi reports. An admin who has permission to manage the account and advanced resports in his role can get the reports.
path Parameters
| workspaceId required | string The workspace id. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
{- "id": "string",
- "name": "string"
}Get PowerBI Embed Token
Business applications can use this service API to generate an embed token for securely embedding Power BI reports. An admin with the necessary permissions to manage the account and access advanced reports can request an embed token. This token enables authorized users to view reports within the application
path Parameters
| workspaceId required | string This is the workspace ID. |
| reportId required | string This is the report ID. |
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
{- "token": "string"
}The Report Module provides real-time statistical reports on Service Plans, Accounts, and Billing.
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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
[- {
- "month": "string",
- "registered_accounts": 0,
- "activated_accounts": 0,
- "inactive_accounts": 0,
- "deleted_accounts": 0
}
]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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
"string"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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
[- {
- "month": "string",
- "activated_accounts": 0,
- "never_login": 0,
- "login_once": 0,
- "login_2_to_5": 0,
- "login_greater_5": 0
}
]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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
"string"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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
[- {
- "month": "string",
- "activated_accounts": 0,
- "never_shared": 0,
- "shared_once": 0,
- "shared_2_to_5": 0,
- "shared_greater_5": 0
}
]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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
"string"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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
[- {
- "month": "string",
- "activated_accounts": 0,
- "never_signed": 0,
- "signed_once": 0,
- "signed_2_to_5": 0,
- "signed_greator_5": 0
}
]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> 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. |
header Parameters
| x-search-text | string |
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
[- {
- "signatures_statistics": [
- {
- "user_id": 0,
- "user_name": "string",
- "user_email": "string",
- "enterprise_id": 0,
- "enterprise": true,
- "total": 0,
- "electronic_signature": 0,
- "electronic_seal": 0,
- "advanced_electronic_seal": 0,
- "qualified_electronic_seal": 0,
- "advanced_electronic_signature": 0,
- "high_trust_advanced_signature": 0,
- "qualified_electronic_signature": 0,
- "inperson": 0
}
], - "signatures_statistics_count": {
- "total_electronic_signature": 0,
- "total_electronic_seal": 0,
- "total_advanced_electronic_seal": 0,
- "total_qualified_electronic_seal": 0,
- "total_advanced_electronic_signature": 0,
- "total_high_trust_advanced_signature": 0,
- "total_qualified_electronic_signature": 0,
- "total_inperson": 0
}
}
]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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
"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> 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. |
header Parameters
| x-search-text | string |
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
"string"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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
[- {
- "user_name": "string",
- "user_email": "string",
- "enterprise_name": "string",
- "sms_count": "string"
}
]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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
"string"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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
[- {
- "month": "string",
- "new_payments": 0,
- "new_revenues": 0,
- "recurring_payments": 0,
- "recurring_revenue": 0,
- "payments": 0,
- "payments_revenue": 0,
- "total_vat": 0
}
]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 (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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
[- {
- "agreement_id": "string",
- "account": "string",
- "enterprise_name": "string",
- "amount": 0,
- "currency": "string",
- "conversion_rate": 0,
- "converted_amount": 0
}
]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 (PaymentNumber) Enum: "ALLPAYMENTS" "NEWPAYMENTS" "RECURRING" Action of the billing timeline, possible values are ALLPAYMENTS, NEWPAYMENTS, RECURRING. |
| duration | string (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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "action": "string",
- "group_key": "string",
- "count": 0
}
]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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
{- "individual_users": [
- {
- "user_name": "string",
- "email_address": "string",
- "amount": "string",
- "currency": "string"
}
], - "enterprise_users": [
- {
- "user_name": "string",
- "email_address": "string",
- "amount": "string",
- "currency": "string"
}
]
}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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
[- {
- "month": "string",
- "new_payments": 0,
- "new_revenues": 0,
- "recurring_payments": 0,
- "recurring_revenue": 0,
- "payments": 0,
- "payments_revenue": 0,
- "total_vat": 0
}
]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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "registered_accounts": 0
}
]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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
"string"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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
[- {
- "documents_statistics": [
- {
- "user_id": 0,
- "user_name": "string",
- "user_email": "string",
- "enterprise_id": 0,
- "enterprise": true,
- "uploaded": 0,
- "shared": 0,
- "signed": 0,
- "declined": 0,
- "approved": 0,
- "updated": 0,
- "diskSpace": 0
}
], - "documents_statistics_count": {
- "total_uploaded": 0,
- "total_shared": 0,
- "total_signed": 0,
- "total_declined": 0,
- "total_approved": 0,
- "total_submitted": 0,
- "total_disk_space": 0
}
}
]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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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. |
| accept-language | string Default: en-US Language code in which data is required to export. If no value is provided, then default language will be used. The supported keys are en-US, nl-NL, es-ES, es-LA, fr-FR, de-DE, ar-AE, tr-TR, lv-LV, nb-NO, el-GR, hi-IN, id-ID, ja-JP, pt-Pt, pt-BR, ro-RO, ru-RU, sr-CR, th-TH, vi-VN, it-IT, fi-FI, et-ET, pl-PL, sv-SE, da-DK, ar-DZ, hu-HU, ka-KA, zh-CN, zh-TW. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
"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 (DocumentActionType) Enum: "UPLOADED" "SHARED" "SIGNED" "DECLINED" "APPROVED" "UPDATED" Action of the documents timeline, possible values are ALLPAYMENTS, NEWPAYMENTS, RECURRING. |
| duration | string (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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "action": "string",
- "group_key": "string",
- "count": 0
}
]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 (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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
{- "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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
{- "document_status": "string",
- "count": 0
}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 (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 (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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
[- {
- "action": "string",
- "group_key": "string",
- "count": 0
}
]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 (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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 403
- 500
{- "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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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 (WaitHandle) |
Responses
Request samples
- Payload
{- "WaitHandle": {
- "Handle": { },
- "SafeWaitHandle": { }
}
}Response samples
- 200
- 401
- 403
- 500
{- "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} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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 (WaitHandle) |
Responses
Request samples
- Payload
{- "WaitHandle": {
- "Handle": { },
- "SafeWaitHandle": { }
}
}Response samples
- 200
- 401
- 403
- 500
{- "allowed_signatures": 0,
- "allowed_electronic_signatures": 0,
- "consumed_signatures": 0,
- "consumed_electronic_signatures": 0
}It includes functionality to retrieve the currently logged-in operator's details, update operator profile information, and change the operator's password. These APIs are essential for maintaining and managing user session integrity and personal settings.
Get Operator
Business applications can use this service API to retrieve the logged-in operator. An administrator with access control management permissions in their role can also retrieve the logged-in operator.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 403
- 500
{- "id": 0,
- "name": "string",
- "email": "string",
- "status": 0,
- "mobile_number": "string",
- "picture": "string",
- "is_password_generated": true,
- "role": {
- "id": 0,
- "name": "string",
- "description": "string",
- "status": 0,
- "details": [
- {
- "add_update": true,
- "attribute_name": "string",
- "delete": true,
- "read": true
}
]
}
}Update Operator
Business applications can use this service API to update the logged-in operator. For admin, there is no need of any role permission to update the operator.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| name required | string non-empty The name of the operator. |
| picture | string or null The picture of the operator. |
| mobile_number | string or null The mobile number of the operator. |
Responses
Request samples
- Payload
{- "name": "string",
- "picture": "string",
- "mobile_number": "string"
}Response samples
- 400
- 401
- 403
- 500
{- "message": "string"
}Change Password
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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:
| old_password required | string non-empty old password |
| new_password required | string non-empty new password |
Responses
Request samples
- Payload
{- "old_password": "string",
- "new_password": "string"
}Response samples
- 401
- 403
- 500
{- "message": "string"
}Get Providers
Business applications can use this service API to get providers. For admin, there is no need for any permission to get providers.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 401
- 500
[- {
- "id": 0,
- "attribute_name": "string",
- "for_adss": 0,
- "attribute_key": "string",
- "status": true,
- "purposes": [
- "string"
], - "connection_provider_parameter": [
- {
- "id": 0,
- "connection_provider_id": 0,
- "attribute_key": "string",
- "attribute_value": "string",
- "field_type": "string",
- "sort_order": 0,
- "type": 0,
- "attribute_choices": [
- {
- "Key": "string",
- "Value": "string"
}
]
}
], - "connection_provider_detail": [
- {
- "id": 0,
- "connection_provider_id": 0,
- "purpose": "string",
- "type": "string",
- "identifier": "string"
}
]
}
]Get CSP Header
Business applications can use this service API to get admin csp header. For admin, there is no need for get admin csp header.
header Parameters
| 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
- 200
- 500
"string"It includes endpoints to retrieve branding assets such as logos, supported languages for multilingual functionality, a list of countries for regional settings, and available time zones to support time-based configurations across different regions.
Get Branding Logos
Business applications can use this service API to branding logos. For admin, there is no need for any permission to retrieve branding logos.
header Parameters
| 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
- 200
- 500
{- "logo": "string",
- "favicon": "string"
}Get Languages
Business applications can use this service API to get languages. For admin, there is no need for any permission to retrieve languages.
header Parameters
| 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
- 200
- 500
{- "languages": [
- {
- "key": "string",
- "value": "string"
}
]
}Get Countries
Business applications can use this service API to get countries. For admin, there is no need for any permission to retrieve countries.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 500
{- "country": [
- {
- "key": "string",
- "value": "string"
}
]
}Get Time Zones
Business applications can use this service API to get time zones. For admin, there is no need for any permission to retrieve time zones.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 500
{- "timezone": [
- {
- "key": "string",
- "value": "string"
}
]
}Get Appearances
Business applications can use this service API to get appearances.
header Parameters
| Authorization required | string Default: Bearer {access_token} Base64-encoded client certificate used for authentication. Upon successful validation, a token (e.g., JWT) is generated and returned to authorize subsequent API requests. 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
- 200
- 400
- 401
- 500
{- "name": "string",
- "base64": "string"
}Country List
The key/value pairs for country references that SigningHub recognizes. These are used in various API calls.
"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" : "한국"