For the complete documentation index, see llms.txt. This page is also available as Markdown.

QR code scanning

Users can scan the QR code from a printed document, the scanner will generate a URL e.g. https://beta.web.signinghub.com/document/27a8095c-6fc4-4888-9b8a-b0a52f2c7eaa which will display a screen with document name and two options "View Document", "Verify Signature".


Screen Details

Elements
Description

Document

The name of the document what has been scanned.

View Document

By clicking on this button, you will be shown a read-only view of the document.

Verify Signature

By clicking on this button, you will be shown the verification results for all the digital signatures that exist in the document.


  1. Scroll down to your page footer and select your desired language from the language drop down. The system interface will change as per the selected language.

  2. Document Access Security is not applicable for QR Code scanned documents.

  3. QR Code scanned document information is accessible once the QR Code has become a part of the document.

  4. For the best QR Code scanning experience, use the default size of 120 * 120. The user can decrease or increase the size of the QR Code as per their requirement. In case of a QR Codes lesser in size than 50 * 50, the scanning experience might be affected.


QR Code Document Access via API

SigningHub provides APIs that allow external applications to retrieve and display documents associated with a scanned QR code. The process consists of obtaining an access token, validating the QR code, retrieving document information, and downloading document images or verification details.


Step 1: Obtain a Client Credentials Access Token

Obtain a Client Credentials (CC) access token before calling any QR code APIs.

API

Request Body

Parameter
Description

client_id

Client application identifier.

client_secret

Client application secret.

grant_type

Must be set to client_credentials.

Response

Include the returned access token in the Authorization header of the next API request.


Step 2: Validate the QR Code

After scanning the QR code, extract the q parameter from the QR code URL and exchange it for a QR Code access token.

API

Headers

Request Body

Parameter
Description

token

The q parameter extracted from the scanned QR code URL.

Response

If the QR code is valid, the API returns a QR Code access token. This token is referred to as <qr_code_access_token> in the following steps and must be included in the Authorization header of all subsequent QR Code APIs.


Step 3: Retrieve QR Code Information

Retrieve the package and document information associated with the QR code.

API

Headers

Where <qr_code_access_token> is the access token returned by the POST /v4/links/qr-code/decrypt API in Step 2.

Response

Returns the package information along with the associated document details, including:

  • Package ID

  • Package Name

  • Document ID

  • Document Name

  • Number of Pages

  • Document Dimensions

  • Document Token

  • Verification Status


Step 4: Retrieve Document Images

Retrieve individual document pages as images.

API

Path Parameters

Parameter
Description

PackageId

Package identifier returned by the QR Code Information API.

DocumentId

Document identifier.

PageNo

Page number to retrieve.

WidthHeight

Desired image dimensions (for example, 800x1131).

Headers

Where <qr_code_access_token> is the access token returned by the POST /v4/links/qr-code/decrypt API in Step 2.

Response

Returns the requested document page as an image that can be displayed by the client application.


Step 5: Retrieve Document Verification Information

Retrieve the document's signature verification details.

API

Path Parameters

Parameter
Description

PackageId

Package identifier returned by the QR Code Information API.

DocumentId

Document identifier.

Headers

Where <qr_code_access_token> is the access token returned by the POST /v4/links/qr-code/decrypt API in Step 2.

Response

Returns the document verification and signature validation details, including signer information, signature status, signing time, certificate information, timestamp details, and signature properties.


Last updated

Was this helpful?