Use Cases

This section outlines common jSign use cases.

Note: For the API, the number of signed documents ("envelopes") you can send per month depends on the plan tier you are using.Refer to System Characteristics for file size limits.

Use Case One — Signing Medical Forms

This use case illustrates sending electronic health insurance forms for electronic signature.

  1. During the health insurance setup for a new patient, their demographic information, including their email address, is collected and captured within the Electronic Health Record (EHR) system in use by the medical care provider.

  2. Registration forms are sent to patient via the jSign system.

  3. Patient receives email with link. Patient connects to the jSign website and completes insurance forms. The patient signs where indicated (“Sign here”).

  4. The EHR system does a status check on pending document and determines that signature has been completed.

  5. The EHR system downloads signed insurance form and stores in patient record.

The signature request in this workflow is accomplished by sending an email with a signing link to the recipient. Clicking on the signing link allows the recipient to electronically sign the documents using the jSign website.

There are two options in the API that allow the patient to sign the forms. These signature request endpoints are:

  • Option 1: Documents submitted as a base64 encoded envelope. This endpoint is POST /v2.0/envelope/create.

  • Option 2: Upload an envelope of documents into jSign using the POST /v2.0/envelopes/upload_file endpoint and then creating a signable workflow with the uploaded file using the upload file request method in the POST /v2.0/envelopes/create_with_files endpoint.

For both of these options, the objects collected during these calls are:

Envelope Object Contains envelope basic details, including name, description and tags
Recipient Object

Signers information along with annotation coordinates, first and last names, email, signing order, message to be included in envelope, X/Y coordinates of the signature tabs with height and width information.
Observer Object

Observers information along with annotation coordinates, first and last names, email
Other Signing sequence (sequential, Parallel, or hybrid), expiration days, reminder email/reminder period, QR Code inclusion, GPS location of signer.

Use Case Two — Obtaining Envelope Signature Status

This use case illustrates how to collect the envelope signature status (to see whether the envelope has been signed and by whom).

The API user provides a envelope ID and calls the GET /v2.0/envelopes/{envelopeId}/details endpoint to obtain the envelope's current metadata. The objects collected during these calls include:

Envelope Object Contains envelope basic details, ID, name, description, created by, created date/time, signing due date, reminder period, envelope status
Recipient Object

Contains recipient information and recipient signed or declined document. Recipient status options include:

  • Sent - email notification sent to recipient

  • Viewed - recipient has viewed the documents via the jsign web site

  • Signed - recipient has signed the document

  • Declined - recipient has declined to sign the document

Use Case Three — Viewing Envelope Transaction History

This use case illustrates how to view the signing history of an envelope.

The API user provides an envelope ID and calls the GET /v2.0/envelopes/{envelopeId}/history endpoint to get the full signing history of a given envelope. The objects collected during these calls include:

Envelope Object Contains envelope basic detail, ID, name, history
Activity History

First and last name of activity performer, date and time, activity type and description

Use Case Four — Downloading Envelopes

This use case illustrates how to download signed or unsigned envelopes from jSign using the API.

The API user provides an envelope ID and indicates if only signed envelopes should be downloaded (a Boolean value: True, False). Using the GET /v2.0/envelopes/{envelopeId}/{documentId}/downloadendpoint the envelope or document is downloaded if the Boolean condition can be met. The objects collected during these calls include:

Envelope Object Contains envelope basic detail, ID, name, and the base64 encoded document

Use Case Five — Cancel a Signature Request

This use case illustrates how to cancel a signature request. This could be because the wrong envelope or document was sent for signature, the envelope has changed, or the signer's signature is no longer required.

The document creator provides a document ID and calls the POST /envelopes/{envelopeId}/cancel endpoint to cancel the signature request. The parameters passed as part of the request include:

Request Parameters Contains the cancel reason. Optional data collected includes the user's location (longitude and latitude), the user's agent, and the user's IP or MAC address.
Envelope Object The object returned is a message "Envelope cancelled successfully."

Use Case Six — Reminder a Signer to Sign an Envelope

This use case illustrates how to remind someone to sign an envelope. When an envelope is submitted for signature, the envelope will "expire" after a set number of days, meaning it will no longer be available for signature. To prevent expiration, a reminder period can be set, so that an automatic reminder will be sent to each signer before the expiration date.

The envelope creator provides an envelope ID and the signer's email address and calls the POST /v2.0/envelopes/{envelopeId}/remind_signer endpoint remind the signer about the request.

Envelope Object The object returned is a message "Reminder email sent."

Use Case Seven — Decline to Sign an Envelope

In some cases the person assigned to sign an envelope will decline this request.

Using the envelope ID and the POST /v2.0/envelopes/{envelopeId}/decline endpoint the assignment is rejected. As part of this call the reason for the rejection must be given. The objects collected during these calls include:

Envelope Object Contains basic document information such as the envelope ID, the final block hash generated when the envelope was created or submitted to jSign, the smart contact address, the signature types that were available for use, audit logs, activity type, the full blockchain transaction hash, the name of the user declining the request, the block chain number and wallet address.

Return to the top of this page.