Document variables

Property	Type	Description
ALLOWED_TYPES	String	The type of certificates that can sign the document
ALLOW_ANNOTATIONS	Boolean	@Since: 1.10.5 Defines if annotations are enabled for this document (by default notifications are enabled)
ALLOW_NONQC	Boolean	If non qualified certificates can sign or not the document
ARTIFACT_NAME	String	Friendly name of the document
AUTO_REMOVE	Boolean	Defines if the document should be automatically removed from the repository once it reaches a final state
AUTO_SUBMIT	Boolean	Defines if the document auto submits when completes the submission requisites
BRAND	String	Defines the branding name of the document.(link: CSS Folder)
CHANNEL	String	@Since: 1.11.0 Assigns a channel to all sessions opening this document. Used in analytics information. See: Analytics - process integration
DISPOSABLE	Boolean	Defines if the document should be automatically deleted after a session is created to access it
DOCUMENT_TYPE	String	@Since: 1.11.0 Assigns a document type to the document. Used in analytics information. See: Analytics - process integration
INTERACTABLE_BOOKMARKS	Boolean	Defines if the document can be interacted through the bookmarks tab
ISSUERS	String	The certificate issuers that can sign the document (various issuers splited by commas expected)
LOCALE	String	Language locale to be applied (i.e. en-us)
OTP_PROVIDER	String	OTP Provider used for a given artifact or field
PARENT	String	Unique identifier of the parent process of the artifact
PDF_PASSWORD	String	Password to decrypt an encrypted PDF. If this variable is not set when uploading a password encrypted PDF (or if the password is incorrect), an error is returned.
PLUGIN_TEMPLATE	String	Signature Plugin Template for Handwritten signature on artifact
QR	Boolean	Defines if QR codes at top left of screen are enabled
REJECT_JS	Boolean	Defines if the document should be rejected or not if it contains any embedded Javascript.
SHOW_NOTICE	String	Notice to be displayed on web page when opening the document (as a popup)
SIGN_DELETE_CONTRAINT	Boolean	Defines if the document requires the signatures to be deleted in the reverse order they were added
SIGN_LOCATION	String	The signing location to be applied to this document’s signatures
SIGN_METHODS	String	Defines what sign methods are allowed on this specific document. This variable accepts a list of values from the following list (HANDWRITTEN,SMARTCARD,OTP,CLICKTOSIGN,TRANSCRIPTION,TFA)
SIGN_REASON	String	The signing reason to be applied to this document’s signatures
SIGNATURE_USERNAME	String	Sets an username to be used in signatures on a non-authenticated session

Property

Type

Description

ALLOWED_TYPES

String

The type of certificates that can sign the document

ALLOW_ANNOTATIONS

Boolean

@Since: 1.10.5
Defines if annotations are enabled for this document (by default notifications are enabled)

ALLOW_NONQC

Boolean

If non qualified certificates can sign or not the document

ARTIFACT_NAME

String

Friendly name of the document

AUTO_REMOVE

Boolean

Defines if the document should be automatically removed from the repository once it reaches a final state

AUTO_SUBMIT

Boolean

Defines if the document auto submits when completes the submission requisites

BRAND

String

Defines the branding name of the document.(link: CSS Folder)

CHANNEL

String

@Since: 1.11.0
Assigns a channel to all sessions opening this document. Used in analytics information. See: Analytics - process integration

DISPOSABLE

Boolean

Defines if the document should be automatically deleted after a session is created to access it

DOCUMENT_TYPE

String

@Since: 1.11.0
Assigns a document type to the document. Used in analytics information. See: Analytics - process integration

INTERACTABLE_BOOKMARKS

Boolean

Defines if the document can be interacted through the bookmarks tab

ISSUERS

String

The certificate issuers that can sign the document (various issuers splited by commas expected)

LOCALE

String

Language locale to be applied (i.e. en-us)

OTP_PROVIDER

String

OTP Provider used for a given artifact or field

PARENT

String

Unique identifier of the parent process of the artifact

PDF_PASSWORD

String

Password to decrypt an encrypted PDF. If this variable is not set when uploading a password encrypted PDF (or if the password is incorrect), an error is returned.

PLUGIN_TEMPLATE

String

Signature Plugin Template for Handwritten signature on artifact

Boolean

Defines if QR codes at top left of screen are enabled

REJECT_JS

Boolean

Defines if the document should be rejected or not if it contains any embedded Javascript.

SHOW_NOTICE

String

Notice to be displayed on web page when opening the document (as a popup)

SIGN_DELETE_CONTRAINT

Boolean

Defines if the document requires the signatures to be deleted in the reverse order they were added

SIGN_LOCATION

String

The signing location to be applied to this document’s signatures

SIGN_METHODS

String

Defines what sign methods are allowed on this specific document. This variable accepts a list of values from the following list (HANDWRITTEN,SMARTCARD,OTP,CLICKTOSIGN,TRANSCRIPTION,TFA)

SIGN_REASON

String

The signing reason to be applied to this document’s signatures

SIGNATURE_USERNAME

String

Sets an username to be used in signatures on a non-authenticated session