Skip to content

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

Core API Services - Signatus 2

  • Rules
  • Document fields configuration

Use Cases - Signatus 2

View Categories
  • Home
  • Documentation
  • Web App - Signatus 2 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
Rules
  • Documentation
    • Mobile App – Signatus
    • Web App – Signatus 2 API
    • Web App – OKdokument API
    • Web App – OKdokument
  • Contact Us
Proudly powered by WordPress