Documentation Powered by Redocly

SigningHub API Guide

Download OpenAPI specification:Download

Welcome

Welcome to SigningHub, a high trust digital signing solution for all your paperless business transactions. It is ideal for those organisations that recognise the value of using cryptographic digital signatures to protect their users and their documents against unauthorised or accidental or fraudulent changes.


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

Main Tags
Most Popular Pages
➤ Welcome
➤ Prerequisites
➤ Access Tokens
➤ Quick Integration
➤ Updates
➤ SignalR
➤ APIs Developer Guide
➤ Appendix
➤ Authentication
➤ Account Management
➤ Add Package
➤ Upload Document
➤ Get Workflow Details
➤ Sign Document

PassKey Authentication

This section entails the web services for the Pass Key i.e. Create, Update, Delete Pass Key etc.

Create Passkey Challenge

This endpoint allows business applications to initiate a registration flow to create a pass key.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

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

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

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "errorMessage": "string",
  • "rp": {
    },
  • "user": {
    },
  • "challenge": "string",
  • "pubKeyCredParams": [
    ],
  • "timeout": 0,
  • "attestation": "None",
  • "authenticatorSelection": {
    },
  • "excludeCredentials": [
    ],
  • "extensions": {
    }
}

Create Passkey

This endpoint allows business applications to create a pass key.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

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

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

This object contains name for pass key and attestation object containing assertion response data from browser.

name
required
string [ 1 .. 100 ] characters

Name of user pass key

object (Fido2NetLib.AuthenticatorAttestationRawResponse)

Responses

Request samples

Content type
{
  • "name": "string",
  • "attestation_response": {
    }
}

Response samples

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

Get Passkeys

This endpoint allows business applications to fetch all pass keys belonging to a user.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

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

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Passkey

This endpoint allows business applications to update name of user pass key.

path Parameters
id
required
integer <int64>

Id of user pass key.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

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

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

Contains pass key name.

name
required
string [ 1 .. 100 ] characters

New name of pass key

Responses

Request samples

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

Response samples

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

Get Passkey by ID

This endpoint allows business applications to fetch user pass key by id belonging to a user.

path Parameters
id
required
integer <int64>

Id of user pass key

header Parameters
Authorization
required
string
Default: Bearer {access_token}

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

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

Responses

Response samples

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

Delete Passkey

This endpoint allows business applications to delete user pass key belonging to a user.

path Parameters
id
required
integer <int64>

Id of user pass key

header Parameters
Authorization
required
string
Default: Bearer {access_token}

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

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

Responses

Response samples

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

Login Passkey Challenge

This endpoint allows business applications to create a login challenge based on all available user pass keys.

query Parameters
user_email
string

User email in case of client credentials.

header Parameters
Authorization
required
string
Default: Bearer {access_token}

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

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

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "errorMessage": "string",
  • "challenge": "string",
  • "timeout": 0,
  • "rpId": "string",
  • "allowCredentials": [
    ],
  • "userVerification": "Required",
  • "extensions": {
    }
}