Add signers using e-mail

Overview

This feature allows you to add a signer using only their e-mail address and name. This can be handy when you want to send a document to a person whom you don't have their personal number. You can also use a generic e-mail address like [email protected] and let the receiver decide who has to sign the document.

NOTE! The e-mail notification will contain a link that will give the receiver access to the document without logging in to Signing Workflow. The user is only authenticated when signing the document. Therefore it is essential to check the signatures when the signing order is completed.

Configuration

This feature needs a certificate to create a JWT which is embedded in the link that gives the receiver access to the document. The JWT is validated when the user is using the link to access the document.

You can use the same certificate that is configured for credentials.privatePkcs12.

Add or edit the following in the config.json file.

{
  "addUserViaEmail": {
    "enabled": true,
    "jwtExpireAfter": "P7D",
    "jwtSigningCertificatePassword": "secretPassword",
    "jwtSigningCertificatePath": "C:/certificates/credentials.pfx"
  }
}

Editing this configuration requires a restart.

An information box will be visible on the right hand side in the UI that can be configured by updating the frontend translation files, strings.json, like this:

"select_approvers": {
  "email": {
    "infoTitle": "This is my info title",
    "infoMsg": "This text should be visible in the UI.",
    "email": "Set an e-mail address",
    "err": "A user with this e-mail has already been added.",
    "errMsg": "E-mail addresses must be unique.",
    "firstName": "Set first name",
    "lastName": "Set surname",
    "placeholder": "Add users via e-mail address",
    "warning": "Signers has been added via e-mail"
  }
}

The infoMsg value will be added as a bullet list and to add multiple values in the list, we can separate the list using ;.

"select_approvers": {
  "email": {
    "infoTitle": "This is my info title",
    "infoMsg": "This is one bullet;This is another",
    "email": "Set an e-mail address",
    "err": "A user with this e-mail has already been added.",
    "errMsg": "E-mail addresses must be unique.",
    "firstName": "Set first name",
    "lastName": "Set surname",
    "placeholder": "Add users via e-mail address",
    "warning": "Signers has been added via e-mail"
  }
}

This will be displayed like this:

Using Automation API

Set the source field to "EMAIL" when using the automation API to create an order.

firstName, lastName and mail are mandatory.

The following is an example when adding a signer using e-mail address.

{
  "source": "EMAIL",
  "attributes": {
    "firstName": {
      "editable": false,
      "value": "Soccer"
    },
    "lastName": {
      "editable": false,
      "value": "Team"
    },
    "mail": {
      "editable": false,
      "value": "[email protected]"
    }
  },
  "priorityGroup": 1
}
Click to copy