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
  • Document fields configuration

Document fields configuration

Additional document fields configuration

Document data example :

{
	"allowedFields": {
		"SIGNATURE": [
			"SC_signature"
		],
		"TEXT": [
			"TO_text",
			"TC_text"
		]
	},
	"fieldConfig": [
		{
			"name": "TC_text",
			"value": "New value"
		},
		{
			"name": "TO_text",
			"value": "New readonly value",
			"readOnly": true
		}
	],
	"ignoreRequired": [
		"SIGNATURE"
	],
	"fieldsBeforeSigning": "keep"
}

Document data description

NameValueDescription
allowedFieldsJSON ObjectConfiguration of which AcroFields will be allowed during signing.
allowedFields.keyStringAcrofield type. Allowed values :
– TEXT,
– CHECKBOX
– SIGNATURE
– RADIO
– COMBOBOX
allowedFields.valueJSON ArrayAcroField names
fieldConfigJSON ArrayArray of JSON object that describe, how the value will be set to acrofield, and and read only possibility
fieldConfig.nameStringAcroField name
fieldConfig.valueStringAcrofield value
fieldConfig.readOnlybooleanAcroField read only flag
ignoreRequiredJSON ArrayArray of strings that describes, which type of acrofields are not required to be fill in. Allowed values :
– TEXT,
– CHECKBOX
– SIGNATURE
– RADIO
– COMBOBOX
fieldsBeforeSigningStringPDF acrofields manipulation before pdf signing
– flatten : acrofields are destroyed
– readOnly : acrofields are set to read only mode
– keep : acrofields mode are not changed

Default : flatten
Updated on 07/05/2026
RulesIntegration Resources & API Documentation
  • Documentation
    • Mobile App – Signatus
    • Web App – Signatus 2 API
    • Web App – OKdokument API
    • Web App – OKdokument
  • Contact Us
Proudly powered by WordPress