The signing process can be configured using rules. Rules are defined in the rules attribute of the envelope and can have two scopes:
- Envelope scope – the rule is written as {ruleName} and applies to the whole envelope, i.e. to all processes in it.
- Process scope – the rule is written as {ruleName}.{signer} and applies only to the process whose processes[].signer equals {signer}. The dot is part of the key name itself. It does not denote a nested object or a JSON path. For example, “emailTo.user” is a single key placed directly in the rules object, not an emailTo object containing a user property.
For example, the following envelope sends the signature request to two different users:
"rules": {
"emailTo.user": "customer1@company.com",
"emailTo.user2": "customer2@company.com"
},
"processes": [
{ "signer": "user", ... },
{ "signer": "user2", ... }
]
Rules supporting the process scope #
Process scope is only useful for multi-round envelopes. In a single-round envelope there is only one process, so you can define rules globally without the signer suffix
| Rule | Process scope example |
|---|---|
| emailTo | “emailTo.user”: “customer1@company.com” |
| sendInfo | “sendInfo.user”: “https://example.com/info” |
| openOtpEmail | “openOtpEmail.user”: “customer1@company.com” |
| openOtpPhone | “openOtpPhone.user”: “+421905123456” |
| openOtpCode | “openOtpCode.user”: “1234” |
| signOtpEmail | “signOtpEmail.user”: “customer1@company.com” |
| signOtpPhone | “signOtpPhone.user”: “+421905123456” |
| signOtpCode | “signOtpCode.user”: “1234” |
| guiSignerName | “guiSignerName.user”: “John Doe” |
| guiSignerDate | “guiSignerDate.user”: “dd.MM.yyyy” |
| signAnywhereEnabled | “signAnywhereEnabled.user”: false |
| mouseSignature | “mouseSignature.user”: false |
List of rules: #
{
"rules": {
"emailFinal": "employer@company.com",
"emailFrom": "employer@anasoft.com",
"emailMessage": "E-mail additional message",
"emailTo": "customer@company.com",
"guiAutoEnvelopeSubmit": false,
"guiAutoSubmit": false,
"guiOneButton": false,
"guiOpenSignature": false,
"guiReadRequired" : true,
"guiRemoteQRCodeEnabled": false,
"guiRequestSignerName": false,
"guiSignatureNumber": 1,
"guiSignerName": "John Doe",
"guiSignerDate" : "dd.MM.yyyy HH:mm",
"lang": "en",
"mouseSignature": true,
"nameFrom": "Employer",
"notificationExpiration": true,
"openOtpCode": "1234",
"openOtpEmail": "customer@company.com",
"openOtpPhone": "+421905123456",
"resulturl": "https://signatus.com",
"sendInfo": "https://sts.signatus.sk/STSTest/info",
"signAnywhereEnabled": true,
"signOtpCode": "1234",
"signOtpEmail": "customer@company.com",
"signOtpPhone": "+421905123456",
"tagsToFields" : {}
}
}Rules description : #
| Rule name | Value | Description |
| emailFinal | Email to which signed documents will be delivered. It is possible to use multiple addresses separated by semicolons | |
| emailFrom | Sender email | Senders’ email. Mandatory if emailTo rule is used |
| emailMessage | message | Additional email message |
| emailTo | Signer email | Signers’ email to which signature request email will be delivered. |
| guiAutoEnvelopeSubmit | true | Automatically submits the envelope after the signing is completed |
| guiAutoSubmit | true | Automatically submits the document after the signing is completed |
| guiOneButton | true | Only one button is visible during the signing process |
| guiOpenSignature | true | Automatically opens the signature modal window when the document is loaded |
| guiReadRequired | true | If the document is mandatory to read (method : read) user have to scroll to the bottom of the document. Default is false . |
| guiRemoteQRCodeEnabled | false | Disable “Switch to mobile” functionality |
| guiRequestSignerName | true | Parameter for enabling the input for signer name |
| guiSignatureNumber | number | Specifies the exact number of signatures required in the document. |
| guiSignerName | Signer name | Predefined value for signer name, max 40 characters. If guiRequestSignerName is enabled, signer name can by changed by signer |
| guiSignerDate | date pattern or false | Date format to be displayed in the signature visualization : – false: The date will not be displayed. – date pattern: The date will be displayed using this specific format. – default: dd.MM.yyyy HH:mm |
| lang | sk, cs, en, ro, uk, pl, pt, hu | Language of GUI, email and SMS template: – sk : Slovak – cs : Czech – en : English – pl : Polish – ro : Romanian – uk : Ukrainian – pt : Portuguese – hu : Hungarian If the rule is not set, Slovak as a default language is used. |
| mouseSignature | false | Disable signing with the mouse. |
| nameFrom | Sender name | Senders’ name, that will be used in the email templates |
| notificationExpiration | true | Enable email reminder. Sends an email if the process is not signed and the expiration time occurs in 2 days. The email is sent to emailTo address |
| openOtpCode | code | The code that will secure access to the documents. |
| openOtpEmail | Signer email | Signers email to which the one-time password for accessing the document will be delivered. Per signatureReuqest only 3 OTP codes can be sent. After that signatureReuqest is blocked and new one must be created. Signer has 3 attempts to insert correct OTP, after that OTP is blocked and new OTP must be sent. |
| openOtpPhone | Signer phone | Signers’ phone number to which the one-time password for accessing the documents will be delivered. International phone format is required. Allowed country prefixes are: +43, +32, +359, +357, +420, +49, +45, +372, +34, +358, +33, +30, +385, +36, +353, +39, +371, +352, +370, +356, +31, +48, +351, +40, +46, +386, +421, +380 Assumption: to use SMS OTP, you must buy signature request package with SMS. Per signatureReuqest only 3 OTP codes can be sent. After that signatureReuqest is blocked and new one must be created. Signer has 3 attempts to insert correct OTP, after that OTP is blocked and new OTP must be sent. |
| resulturl | url | URL to redirect the browser after finishing the signing process |
| sendInfo | url | URL of the service where Signatus sends information after the envelope is finished. |
| signAnywhereEnabled | false | Disable sign anywhere function |
| signOtpCode | code | The code that will be used to sign the decuments |
| signOtpEmail | Signer email | Signers email to which the one-time password for signing the document will be delivered. OTP signature requires signature acrofield. Per signatureReuqest only 3 OTP codes can be sent. After that signatureReuqest is blocked and new one must be created. Signer has 3 attempts to insert correct OTP, after that OTP is blocked and new OTP must be sent. |
| signOtpPhone | Signer phone | Signers’ phone number to which the one-time password for signing the document will be delivered. OTP signature requires signature acrofield. International phone format is required. Allowed country prefixes are: +43, +32, +359, +357, +420, +49, +45, +372, +34, +358, +33, +30, +385, +36, +353, +39, +371, +352, +370, +356, +31, +48, +351, +40, +46, +386, +421, +380 Assumption: to use SMS OTP, you must buy signature request package with SMS. Per signatureReuqest only 3 OTP codes can be sent. After that signatureReuqest is blocked and new one must be created. Signer has 3 attempts to insert correct OTP, after that OTP is blocked and new OTP must be sent. |
| tagsToFields | Empty JSON Object | Converts tags in the document into AcroForm fields. The tag preparation process is described here. |