Individual workflow
Overview
Individual workflows allow the
Document Owner to send exclusive copies of a document to be
electronically signed to multiple users with the use of a single
signing workflow.
Sample code
Prerequisites
Use Case
The Individual workflow type would
be useful to a school administrator that must send a letter to all
parents or a company secretary that must send a memo to all
employees. In this example a document will be uploaded and the
Individual workflow type will be applied to the workflow.
Process flow
At a high level, the Individual
signing workflow follows the following steps:
-
Prepare the workflow.
-
Share the document.
-
SigningHub sends an email to
every Signer notifying them that they have a document to sign.
-
Each Signer signs their
document.
-
After all Signers have signed
their document the workflow completes.
Requests
The following requests will upload a
document to Authenticate to SigningHub, create a package, set the
workflow type to Individual, upload a document and add the users and
a signature block.
After the document has been shared,
each signer will get an email with a notification that they have to
sign a document.
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 – Set the workflow type
|
Overview
|
|
Set the workflow type to Individual.
|
|
Online Documentation
|
|
https://manuals.ascertia.com/SigningHub-apiguide/default.aspx#pageid=1043.
|
|
Description
|
|
By setting the workflow type to
Individual, SigningHub will send an exclusive document to
each Signer to sign.
|
|
Parameters
|
|
The access_token is obtained
during Step 1 - Authenticate.
Workflow_type: set the value
to Individual.
Workflow_mode: set the value
to ME_AND_Others or ONLY_OTHERS.
Continue_on_decline: set
to false, else if one of the Signers declines to
sign the workflow will come to an end.
Message: the message
specified in this field will display as a pop-up message to the
Signer when they open the document.
|
Step 4 – 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 5 – Add
User to the workflow
|
Overview
|
|
Add the Signers 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 6 – Insert Signature Block on the document
|
Overview
|
|
Draw an electronic signature block
for the Signers on the document.
|
|
Online Documentation
|
|
https://manuals.ascertia.com/SigningHub-apiguide/default.aspx#pageid=1182.
|
|
Description
|
|
Only one electronic signature block
have to be drawn, since all Signers will receive their own copy of
the document to sign.
|
|
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,
each Signer will receive an email notification requesting them to
follow the link and sign the document.