RightSignature

Document Workflows

The RightSignature API currently supports two document-based electronic signature workflows:

Reusable Templates

Clone the signer fields and base file from a pre-existing Template, pre-fill data (optional), and send the Document for signature. This workflow requires a Reusable Template to first be built using the RightSignature web application.

  1. POST to /public/v1/reusable_templates/:id/send_document to create a clone of the Template and specify the Document attributes and recipients.
  2. RightSignature will deliver a Document signing link to the designated email(s).

Sending Requests (One-off Documents)

Use text anchors to customize signer fields on your base file, pre-fill data (optional), and send the Document for signature.

  1. Create Text Tags (see below) on the Document base file to designate the location of each signer field.
  2. POST to /public/v1/sending_requests to create a Sending Request. This call will specify the Document attributes and recipients, but the file will be uploaded to RS separately.
  3. PUT to the upload_url returned in the Sending Request response to upload the Document base file, complete with Text Tags.
  4. POST to /public/v1/sending_requests/:id/uploaded to trigger the processing of the uploaded base file.
  5. RightSignature will deliver a Document signing link to the designated email(s).

Each text anchor is contained between opening and closing square brackets “[ ]” with the following format:

FORMAT: Combination of possible values in a Text Tag:

[ {c,d,i,t}:{a-z}:{o,r} ]

FIRST ARGUMENT: Describes the type of field:
  • s = signature
  • c = check box
  • d = date field
  • i = initials field
  • t = text field
SECOND ARGUMENT: Designates to whom the field is assigned using A through Z in alphabetical order to correspond to the Document’s recipients:
  • a = first document signer
  • b = second document signer
  • c = third document signer
  • etc
THIRD ARGUMENT: Designates the field as either required or optional:
  • o = optional
  • r = required
NOTE: Spaces and underscores are ignored between the square brackets.
EXAMPLE: A Text Field for the first document signer, that is required.

[       t:a:r       ]

Example input file:
Example output file: