Sign with Advanced Electronic signature
Overview
The sample workflow will send a PDF document to SigningHub for manual signing with an Advance Electronic signature.
The process for signing with an
Advanced Electronic signature and a digital signature is similar. The
difference is how the Signer was enrolled on SigningHub. The
compliance requirement to issue an Advanced Electronic signature is a
face-to-face identification of the Signer.
To get an Advanced Electronic
signature, please contact LAWtrust: info@lawtrust.co.za or sales@lawtrust.co.za.
For a discussion on the difference
between electronic signatures and digital signatures, see the LAWtrust
article.
Prerequisites
In order for the Signer to sign the document with a digital certificate, the user must pass through the LAWtrust face-to-face enrolment process and be issued with a SigningHub account.
As part of the SigningHub account creation process, an Advanced Electronic certificate will be issued to the Signer.
Use Case
In South Africa, the ECT Act governs Advanced Electronic signatures. Advanced Electronic signatures are considered to carry the highest trust of all electronic and digital signatures.
According to South African law, if they are signed electronically, the user must sign these documents with an Advanced Electronic signature:
-
Documents containing
suretyships.
-
Assignment
or exclusive licensing agreements.
-
Documents
used for pension fund administration.
-
Credit
Agreements.
-
Where
there is a legal requirement for the document, signature, or
statement to be notarised, acknowledged, verified or made under
oath.
-
Any
document where a signature is required by law, for the transaction
to be valid.
-
Certification
of documents as true copies of the original.
-
Notarisation
of documents required by law.
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 with an Advanced Electronic signature.
-
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 will share a document with one Signer. The digital signing
process will be completely automated.
Step 1 – Authenticate
|
Overview
|
|
Authenticate to SigningHub.
|
|
Online Documentation
|
|
https://uatweb.signinghub.co.za/manuals/signinghub/api-guide/v3/1010.htm
|
|
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. The package acts as an envelope that contains the documents
to sign and the workflow rules.
|
|
Online Documentation
|
|
https://uatweb.signinghub.co.za/manuals/signinghub/api-guide/v3/1020.htm
|
|
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 package 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://uatweb.signinghub.co.za/manuals/signinghub/api-guide/v3/1022.htm
|
|
Description
|
|
Upload the document that must be
digitally signed.
|
|
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://uatweb.signinghub.co.za/manuals/signinghub/api-guide/v3/1047.htm
|
|
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 during the next 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.
If additional security is specified, the user will now have to enter a password or 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://uatweb.signinghub.co.za/manuals/signinghub/api-guide/v3/1182.htm
|
|
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 for the first Signer.
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 parameter placement is used to position the signature block relative to the search_text.
The dimension parameter controls the size of the signature block.
The Order parameter corresponds to the
Signer’s order in which he/she must sign. Set the value to 1.
Set Field_type to
"DIGITAL_SIGNATURE".
|
Step 6 – Share document
Step 6.1 – Signer signs the document
|
Overview
|
|
The signer logs into SigningHub and
manually signs the document.
This is a manual step performed by
the user and as such there is no requests to call.
To programmatically sign a document,
see the sample: One Signer
workflow.
|
|
Online Documentation
|
|
https://manuals.ascertia.com/SigningHubv7/1164.htm
|
|
Description
|
|
The Signer manually signs the
document.
|
|
Parameters
|
|
N/A
|
Step 7 – Get document status (Optional)
|
Overview
|
|
Set the workflow status.
|
|
Online Documentation
|
|
https://uatweb.signinghub.co.za/manuals/signinghub/api-guide/v3/1044.htm
|
|
Description
|
|
The document status request
retrieves the document’s current status.
Developers can use this request to
periodically retrieve a document’s status.
While the workflow is not complete, the document's status is 'Pending'.
After the last Signer signs, the document the status will change to '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://uatweb.signinghub.co.za/manuals/signinghub/api-guide/v3/1045.htm
|
|
Description
|
|
Optionally, a forensic report (Workflow completion report), is available for download.
The forensic report contains an
audit trail of all the actions that happened during the signing
workflow.
To protect the audit trail against tampering, the forensic report is digitally signed.
|
|
Parameters
|
|
Provide the package_id of the
forensic report to download.
|
Step 10 –
Delete document