Skip to content

  • Documentation
    • Mobile App – Signatus
    • Web App – Signatus 2 API
    • Web App – OKdokument API
    • Web App – OKdokument
  • Contact Us

1. API concept

  • Overview
  • 1.1 Supported web browsers
  • 1.2 Supported languages
  • 1.3 How to prepare document for signature
  • 1.4 How to use acrofields
  • 1.5 How to use pre-defined signature fields
  • 1.6 Document states
  • 1.7 Storing and deleting documents
  • 1.8 OKDokument API call list
  • 1.9 QR code
  • 1.10 Email and SMS
  • 1.11 Dictionary

2. Core API services

  • Authorization
  • Create signature request
  • Upload
  • Open document
  • Information about signing completion
  • Result URL
  • Download document
  • Delete document
  • Rules
  • Document fields configuration
  • Integration Resources & API Documentation

3. Additional API services

  • List of the documents
  • Document Info
  • Update Signature Request
  • Delete Signature Request
  • Signature Request Counter
  • Upload document

4. Use cases

  • Overview
  • 4.1 Example 1: Simple one-round signing
  • 4.2 Example 2: One-round signing with redirect url
  • 4.3 Example 3: One-round signing with send info
  • 4.4 Example 4: Multi-Round Signing

5. Configuration of the signing process

  • Overview
  • 5.1 One-round signing with simple PDF
  • 5.2 Multi-round signing with simple PDF
  • 5.3  One-round signing with PDF with tags
  • 5.4 Multi-round signing with PDF with tags
  • 5.5 One-round signing with PDF with signature acrofields
  • 5.6 Multi-round signing with PDF with signature acrofields
  • 5.7 Accessing document after inserting OTP
  • 5.8 Sign document with OTP
  • 5.9 Email
  • 5.10 QR code

6. Examples

  • Postman examples
View Categories
  • Home
  • Documentation
  • Web App - OKdokument API
  • 2. Core API services
  • Rules

Rules

The signing process can be configured using rules

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",
		"sendInfo.user": "https://sts.signatus.sk/STSTest/info",
		"signAnywhereEnabled": true,
		"signOtpCode": "1234",
		"signOtpEmail": "customer@company.com",
		"signOtpPhone": "+421905123456"
	}
}

Rules description : #

Rule nameValueDescription
emailFinalemailEmail to which signed documents will be delivered. It is possible to use multiple addresses separated by semicolons
emailFromSender emailSenders’ email. Mandatory if emailTo rule is used
emailMessagemessageAdditional email message
emailToSigner emailSigners’ email to which signature request email will be delivered.
guiAutoEnvelopeSubmittrueAutomatically submits the envelope after the signing is completed
guiAutoSubmittrueAutomatically submits the document after the signing is completed
guiOneButtontrueOnly one button is visible during the signing process
guiOpenSignaturetrueAutomatically opens the signature modal window when the document is loaded
guiReadRequiredtrueIf the document is mandatory to read (method : read) user have to scroll to the bottom of the document. Default is false .
guiRemoteQRCodeEnabledfalseDisable “Switch to mobile” functionality
guiRequestSignerNametrueParameter for enabling the input for signer name
guiSignatureNumbernumberSpecifies the exact number of signatures required in the document.
guiSignerNameSigner namePredefined value for signer name, max 40 characters. If guiRequestSignerName is enabled, signer name can by changed by signer
guiSignerDatedate pattern or falseDate 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, huLanguage 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.
mouseSignaturefalseDisable signing with the mouse.
nameFromSender nameSenders’ name, that will be used in the email templates
notificationExpirationtrueEnable 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
openOtpCodecodeThe code that will secure access to the documents.
openOtpEmailSigner emailSigners 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.
openOtpPhoneSigner phoneSigners’ 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.
resulturlurlURL to redirect the browser after finishing the signing process
sendInfourlURL of the service where Signatus sends information after the envelope is finished.
sendInfo.userurlURL of the service where Signatus sends information after the process is finished.
signAnywhereEnabledfalseDisable sign anywhere function
signOtpCodecodeThe code that will be used to sign the decuments
signOtpEmailSigner emailSigners 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.
signOtpPhoneSigner phoneSigners’ 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.
Updated on 07/05/2026
Delete documentDocument fields configuration
Table of Contents
  • List of rules:
  • Rules description :
  • Documentation
    • Mobile App – Signatus
    • Web App – Signatus 2 API
    • Web App – OKdokument API
    • Web App – OKdokument
  • Contact Us
Proudly powered by WordPress