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.
-
Visit the Ascertia Community Portal to find answers to contact SigningHub support staff through the
Live Chat provision
.
Our
support staff may be occupied with other priority tasks so live chat is offered on
an "as available" basis.
This guide is intended for developers who will integrate SigningHub into their respective web applications using the RESTful web services, and user interface offered by SigningHub. It is assumed that the reader has a basic knowledge of REST, Java, C#, HTML, JavaScript, HTTP and TLS/SSL. There is no Software Developers Kit (SDK) for the integration, instead the integration uses HTML Forms and JSON so that integration is simple from any language including .Net, Java, PHP etc.
| Main Tags | Most Popular Pages |
|---|---|
|
➤
Welcome
➤ Prerequisites ➤ Access Token ➤ Updates ➤ APIs Developer Guide ➤ Appendix |
➤
Authentication
➤ Service Plans ➤ Account Management ➤ Billing Management ➤ Access Control ➤ Operator Logs ➤ Advanced Reports |
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} The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Responses
Response samples
- 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} The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| 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 (Models.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} The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Responses
Response samples
- 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} The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Responses
Response samples
- 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} The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Responses
Response samples
- 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} The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
Request Body schema:
| 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 (Models.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"
}