In-person signing
Overview
In-person signing allows for a
Meeting Host to log into SigningHub and let an In-Person Signer (that
does not have a SigningHub account) sign a document. The Meeting Host
may or not be a signer too.
In this example a document will be
uploaded to SigningHub, an electronic signature block will be placed
for the Meeting Host and an In-Person signature block will be placed
on the document for the second Signer.
Sample code
Prerequisites
Use Case
In-person signing works well for
investment and insurance brokers who often see clients while they are
not in the office.
In-person signing will allow the
broker to meet the client and let them sign documents like indemnity
forms, terms and agreements, etc while they are in a meeting.
For this example, it is assumed that
a third-party system like a CRM generated a document that requires an
in-person signature. The document is shared on SigningHub. The
Meeting Host will meet the second Signer and during the meeting both
of them will sign the document.
Process flow
At a high level, In-Person signing
follows the following steps:
-
Prepare the workflow.
-
Share the document.
-
The Meeting Hosts logs into
SigningHub.
-
The In-Person Signer signs the
document.
-
The Meeting Host signs the
document.
Request
The following requests must be
called to share a document with a Meeting Host and a second Signer.
After the document has been shared, the Meeting Host will have to log
into SigningHub to host the signing meeting.
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 authentication
parameters will be supplied by LAWtrust.
Contact
LAWtrust to get access to the testing environment.
|
|
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 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://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 User to the workflow
|
Overview
|
|
Add the Meeting Host as 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 on the document
|
Overview
|
|
Draw an electronic signature block
for Meeting Host on the document.
|
|
Online Documentation
|
|
https://manuals.ascertia.com/SigningHub-apiguide/default.aspx#pageid=1182.
|
|
Description
|
|
Add an electronic signature block
that the Meeting Host will sign during the In-Person signing
session.
|
|
Parameters
|
|
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
"ELECTRONIC_SIGNATURE".
|
Step 6 – Insert In-Person Signature Block on
the document
|
Overview
|
|
Draw an In-Person signature block
for the second Signer on the document.
|
|
Online Documentation
|
|
https://manuals.ascertia.com/SigningHub-apiguide/default.aspx#pageid=1182.
|
|
Description
|
|
The In-Person signer will sign this
block.
|
|
Parameters
|
|
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
"ELECTRONIC_SIGNATURE".
|
Step 7 – Share document
After the document has been shared,
the Meeting Host will receive an email from SigningHub requesting
them to sign the document.
The Meeting Host can now log into
SigningHub.
The In-Person Signer will sign the
In-Person signature block and then the Meeting Host can sign their
signature block.