Simple
workflow (with digital signature)
Overview
For the sample workflow, a PDF
document will be sent to SigningHub for manual signing with a digital
signature.
The API will be used to send the
document to SigningHub and configure the workflow. The Signer will
then sign the document by logging into SigningHub and manually
signing the document with a digital signature.
A digital signature is a subset of
electronic signatures that is protected with a digital certificate
that ties the signer’s identity to a digital identity.
For a discussion on the difference
between electronic signatures and digital signatures see the LAWtrust
article.
Sample code
Download the Postman sample code.
Download the accompanying sample code documentation.
Prerequisites
In order for the Signer to sign the
document with a digital certificate the user must pass through the
LAWtrust enrolment process and be issued with a SigningHub account.
As part of the SigningHub account
creation process, a digital certificate will be issued to the Signer.
The sample code in this example can be downloaded here.
Use Case
Digital Signatures issued by
LAWtrust are considered to carry high trust.
LAWtrust supports two types of
public trust digital signatures:
LAWtrust’s public trusted
certificates is on the Adobe Approved Trust List (AATL). Documents
signed by LAWtrust’s
SigningHub solution can automatically be recognised by Adobe Reader.
To find out more about the different
types of signatures and which one is right for your organisation,
please contact LAWtrust for more information: info@lawtrust.co.za.
Process flow
At a high level, the sample code
will perform the following steps:
-
Prepare the workflow.
-
Share the document.
-
SigningHub sends email
notification to Signer.
-
Signers logs into SigningHub
and signs the document.
-
Third-party application checks
the document status.
-
Third-party downloads signed
document.
-
Third-party downloads the
Workflow Evidence report.
-
Deletes the document.
Requests
The following requests must be
called to share a document with one Signer. The digital signing
process will be completely automated.
Step 1 – Authenticate
|
Overview
|
|
Authenticate to SigningHub.
|
|
Online Documentation
|
|
https://manuals.ascertia.com/SigningHub-apiguide/default.aspx#pageid=1010.
|
|
Description
|
|
Authenticate to SigningHub, to start
transacting with SigningHub.
The required parameters will be
supplied by LAWtrust.
Contact
the LAWtrust Sales department for access.
|
|
Parameters
|
|
The scope parameter tells the
system who the Document Owner is. Use the email address of the
Document Owner to identify the owner.
If this parameter is not set, the
integration account used to authenticate to SigningHub will be
considered to be the Document Owner.
Take note of the access_token
returned by the server. The access_token will be needed in
subsequent requests.
|
Step 2 – Add Package
|
Overview
|
|
Create a package to upload documents
to.
|
|
Online Documentation
|
|
https://manuals.ascertia.com/SigningHub-apiguide/default.aspx#pageid=1020.
|
|
Description
|
|
The first step to creating a
workflow on SigningHub is to create a package. This step tells the
system what the name of the pack is that you want to create.
A package can contain one or more
documents.
|
|
Parameters
|
|
The access_token is obtained
during Step 1 - Authenticate.
Take note of the package_id
returned by the server. The package_id will be needed in
the subsequent requests.
|
Step 3 – Upload document
|
Overview
|
|
Upload a document to the package
created in the previous step.
|
|
Online Documentation
|
|
https://manuals.ascertia.com/SigningHub-apiguide/default.aspx#pageid=1022.
|
|
Description
|
|
Upload the document that must be
digitally signed to the system.
|
|
Parameters
|
|
The access_token is obtained
during Step 1 - Authenticate.
The document_id returned by
the server will be needed in requests pertaining to the uploaded
document.
|
Step 4 – Add Signer 1 to the workflow
|
Overview
|
|
Add a signer to the workflow.
|
|
Online Documentation
|
|
https://manuals.ascertia.com/SigningHub-apiguide/default.aspx#pageid=1047.
|
|
Description
|
|
Add the name and email address of
the person that must sign the document.
|
|
Parameters
|
|
The access_token is obtained
during Step 1 - Authenticate.
The package_id is obtained
during Step 2 – Create Package.
Signing_order specifies the
Signer’s order to sign. The order number will be required in the
following steps. For the first signer, set the value to 1.
Set the field email_notification
to true. If the parameter value is true, SigningHub will
send an email with a link to the document to the Signer. If the
signer clicks on the document, the document will be opened in
SigningHub and displayed to the user.
Unless specified, the user will not
be prompted to enter a password or an OTP to view the document.
See the sample code Password
protect access to a document or OTP protect access to a
document for an example on how to protect access to a
document.
|
Step 5 – Insert signature block 1
|
Overview
|
|
Draw a signature block for signer 1
on the document.
|
|
Online Documentation
|
|
https://manuals.ascertia.com/SigningHub-apiguide/default.aspx#pageid=1182.
|
|
Description
|
|
Add the name and email address of
the first person that must sign the document.
|
|
Parameters
|
|
This request will draw a signature
block on the document where the first signer’s signature must be
placed.
This request will look for the text
specified in the field search_text in the document and
place the signature block on the document.
The field placement can be
used to position the signature block relative to the search_text.
The size of the signature block can
be controlled with the dimension field.
Order corresponds to the
Signer’s order in which he / she must sign. Set the value to 1.
Field_type must be set to
"DIGITAL_SIGNATURE".
|
Step 6 – Share document
Step 6.1 – Signer signs the document
Step 7 – Get document status (Optional)
|
Overview
|
|
Set the workflow status.
|
|
Online Documentation
|
|
https://manuals.ascertia.com/SigningHub-apiguide/default.aspx#pageid=1044.
|
|
Description
|
|
The document status request
retrieves the document’s current status.
Developers can use this request to
periodically retrieve a document’s status.
The document status will be
‘Pending’ until all the Signers have digitally signed the
document. After calling the document’s status will be
‘Completed’.
|
|
Parameters
|
|
N/A
|
Step 8 – Download document
Step 9 – Download Workflow Evidence report
(Optional)
|
Overview
|
|
Download the forensic Workflow
Evidence Report document.
|
|
Online Documentation
|
|
https://manuals.ascertia.com/SigningHub-apiguide/default.aspx#pageid=1045.
|
|
Description
|
|
A forensic report (Workflow
completion report) can be downloaded optionally.
The forensic report contains an
audit trail of all the actions that happened during the signing
workflow.
The forensic report has been
digitally signed to proof that the audit trail has not been
tampered should a dispute arise later on.
|
|
Parameters
|
|
Provide the package_id of the
forensic report to download.
|
Step 10 –
Delete document