Documentation Index

Fetch the complete documentation index at: https://knowledgecenter.docuware.com/llms.txt

Use this file to discover all available pages before exploring further.

Validated ID: centralized signature

Prev Next

For a person to be able to sign a workflow document with the "Centralized" procedure from Validated ID, their name, email address, and an SMS-capable phone number must be known. The workflow automatically passes this information to Validated ID with the signature request. The signing person logs in to Validated ID and signs.

For the centralized signature, both the employee who requests the signature and the signer must work in the same company that has a contract with Validated ID. In addition, the signing person must also be registered with Validated ID.

With the centralized procedure from Validated ID, both an advanced and a qualified signature are possible. The difference is that for the qualified certificate, the signer must not only be registered with Validated ID but must also have completed a separate identification process.

Read general information on the service methods and parameters with Validated ID.

The following methods are available for the centralized signature:

  • AddNewDocument

    With this method, one file of a document is sent for signature by one person at a tablet. The signature is placed at one position.

  • AddNewDocumentMultiPositions

    With this method, one file of a document is sent for signature by one person at a tablet. The signature is placed at multiple positions.

  • AddNewClippedDocumentCentralized

    With this method, multiple files of a document are sent for signature at one tablet. The signature is placed at multiple positions.

For an overview, here are the same methods and information in table form:

Method

Description

Files

Signers

Signature positions

AddNewDocument

With this method, one file of a document is sent for signature by one person. The signature is placed at one position.

1

1

1

AddNewDocumentPositions

With this method, one file of a document is sent for signature by one person. The signature is placed at multiple positions.

1

1

multiple

AddNewClippedDocumentCentralized

With this method, multiple files of a document are sent for signature by one person. The signature is placed at multiple positions.

multiple

1

multiple

AddNewDocument

With this method, one file of a document is sent for signature by one person. The signature is placed at one position.

  • Parameters must be specified. Exceptions are marked as "optional".

Parameter name

Category

Variable type in the workflow

Description

Values

Token (string)

General

Text

The workflow uses the token to identify itself to the Signature Service. The token is created when the Signature Service is registered and is sent by email.

DateSignedFieldName (string)

Fields

Text

Specifies an index field in which the date of signing is entered. It can be a text, date, or date/time field.

If the field is a text field, the date is entered in UTC and displayed in DocuWare.

We recommend using a field of type Date or Date/Time so that the date and time are displayed in the local time zone and local format.

  • Text field

  • Date field

  • Date/time field

StatusFieldName (string)

Fields

Text

Specifies an index field in which the status of a signature is entered. It is filled with "SuccessStatusValue" or "FailureStatusValue". This field is ideal for letting the workflow continue after the signature.

SuccessStatusValue (string)

Fields

Text

Value that is set in the index field defined in "StatusFieldName" after a successful signature.

FailureStatusValue (string)

Fields

Text

Value that is set in the index field defined in "StatusFieldName" after a failed signature.

RejectionReasonFieldName (string)

optional

Fields

Text

Specifies an index field in which the rejection reason is entered if a signer has rejected the signature.

DaysBeforeExpiration (int)

Process

Integer

With a value of >0, sets a deadline in days for signing. If the deadline is exceeded, the document is considered rejected and is no longer available for signature.

PostSigningAction (string)

Process

Text

Specifies how the signed document is stored in DocuWare. Either the original document can be overwritten, or the signed document can be clipped in front of or behind the original document.

  • ClipBefore

  • ClipAfter

  • Replace

SendSignedDocument (Boolean)

Process

Text

Specifies whether the signed document is sent to the signer by email.

  • True

  • False

IncludeReport

(Boolean)

optional

Process

Text

Specifies whether, in addition to the signed document, a report with information about the signer and the signing process is attached to the document. This report is a separate PDF file.

FileCabinetId (string)

Document

Text

Specifies, by its GUID, the file cabinet in which the document to be signed is stored. The GUID is displayed in the file cabinet administration.

DocId (int)

Document

Integer

Specifies the document to be signed by its DocID.

SectionNumber (int)

Position

Integer

Specifies the file (section) of a clipped document that is to be signed.

  • 0 or 1 = first document in the stack

  • -1 = last document

  • Other digits = further documents

PageNumber (int)

Position

Integer

Specifies the page number in the document on which the signature is placed.

If an anchor text is used, the parameter specifies the page from which the anchor text is searched.

  • 0 or 1 = first page of the file

  • -1 = last page

  • Other number = further pages

AnchorText (string)

Position

Text

Specifies a text that is used as the reference point for the signature position.

If nothing is specified, the reference point is the top left corner of the page.

AnchorTextOccurrence (int)

Position

Integer

If the anchor text occurs several times in the document, this parameter specifies which occurrence is used to calculate the position.

  • 0 or 1 = first occurrence of the anchor text

  • -1 = last occurrence

  • Other digits = further occurrences

PositionX (int)

Position

Integer

Specifies the horizontal position of the signature. The reference line is the left page margin or (if an anchor text is used) the left edge of the found text.

Positive numbers are to the right of the reference line, negative numbers to the left. The values are in millimeters.

PositionY (int)

Position

Integer

Specifies the vertical position of the signature. The reference line is the top page margin or (if an anchor text is used) the top edge of the found text.

Positive numbers are below the reference line, negative numbers above. The values are in millimeters.

SizeX (int)

Position

Integer

Specifies the width of the signature image in millimeters.

SizeY (int)

Position

Integer

Specifies the height of the signature image in millimeters.

SignerName (string)

Signer

Text

Specifies the name of the signing user.

Not necessary if "SignerNameEditable" is activated.

SignerEmail (string)

Signer

Text

Specifies the email address of the signing user.

SignerID (string)

Signer

Text

Specifies an ID number (e.g. identity card number) of the signer.  

Required for the centralized signature and the company stamp, optional for remote signature and biometric signature.

Language

Signer

Text

Specifies the language of the website for the centralized signature and the language of the app for the biometric signature.

ca, de, en, es, eu, fr, it, iw, nl, pl, pt

AddNewDocumentMultiPositions

With this method, one file of a document is sent for signature by one person. The signature is placed at multiple positions.

  • The information about the signer and the signature positions in the document is contained in a list with separators. The separator is specified with its own parameter.

  • In the examples in the table, the comma is used as the separator (see parameter MultiValueSeparator).

  • In the list parameters, the order and the number of values separated by "MultiValueSeparator" must be identical.

  • Parameters must be specified. Exceptions are marked as "optional".

Parameter name

Category

Variable type in the workflow

Description

Values

Token (string)

General

Text

The workflow uses the token to identify itself to the Signature Service. The token is created when the Signature Service is registered and is sent by email.

DateSignedFieldName (string)

Fields

Text

Specifies an index field in which the date of signing is entered. It can be a text, date, or date/time field.

If the field is a text field, the date is entered in UTC and displayed in DocuWare.

We recommend using a field of type Date or Date/Time so that the date and time are displayed in the local time zone and local format.

  • Text field

  • Date field

  • Date/time field

StatusFieldName (string)

Fields

Text

Specifies an index field in which the status of a signature is entered. It is filled with "SuccessStatusValue" or "FailureStatusValue". This field is ideal for letting the workflow continue after the signature.

SuccessStatusValue (string)

Fields

Text

Value that is set in the index field defined in "StatusFieldName" after a successful signature.

FailureStatusValue (string)

Fields

Text

Value that is set in the index field defined in "StatusFieldName" after a failed signature.

DaysBeforeExpiration (int)

Process

Integer

With a value of >0, sets a deadline in days for signing. If the deadline is exceeded, the document is considered rejected and is no longer available for signature.

PostSigningAction (string)

Process

Text

Specifies how the signed document is stored in DocuWare. Either the original document can be overwritten, or the signed document can be clipped in front of or behind the original document.

  • ClipBefore

  • ClipAfter

  • Replace

SendSignedDocument (Boolean)

Process

Text

Specifies whether the signed document is sent to the signer by email.

  • True

  • False

IncludeReport

(Boolean)

optional

Process

Text

Specifies whether, in addition to the signed document, a report with information about the signer and the signing process is attached to the document. This report is a separate PDF file.

MultiValueSeparator (string)

Process

Text

Specifies how multiple values within a parameter are separated from each other.

Common separators are a comma, a caret ^ or a vertical bar |

MultiSignatureCount (int)

Process

Integer

Number of signature positions

FileCabinetId (string)

Document

Text

Specifies, by its GUID, the file cabinet in which the document to be signed is stored. The GUID is displayed in the file cabinet administration.

DocId (int)

Document

Integer

Specifies the document to be signed by its DocID.

SectionNumber (int)

Position

Integer

Specifies the file (section) of a clipped document that is to be signed.

  • 0 or 1 = first document in the stack

  • -1 = last document

  • Other digits = further documents

MultiPageNumber (string)

Position

Text

List of multiple "PageNumber" values separated by "MultiValueSeparator".

See method "AddNewDocument".

MultiAnchorText (string)

Position

Text

List of multiple "AnchorText" values separated by "MultiValueSeparator".

See method "AddNewDocument".

MultiAnchorTextOccurrence (string)

Position

Text

List of multiple "AnchorTextOccurence" values separated by "MultiValueSeparator".

See method "AddNewDocument".

MultiPositionX (string)

Position

Text

List of multiple "PositionX" values separated by "MultiValueSeparator".

See method "AddNewDocument".

MultiPositionY (string)

Position

Text

List of multiple "PositionY" values separated by "MultiValueSeparator".

See method "AddNewDocument".

MultiSizeX (string)

Position

Text

List of multiple "SizeX" values separated by "MultiValueSeparator".

See method "AddNewDocument".

MultiSizeY (string)

Position

Text

List of multiple "SizeY" values separated by "MultiValueSeparator".

See method "AddNewDocument".

SignerName (string)

Signer

Text

Specifies the name of the signing user.

Not necessary if "SignerNameEditable" is activated.

SignerEmail (string)

Signer

Text

Specifies the email address of the signing user.

SignerID (string)

Signer

Text

Specifies an ID number (e.g. identity card number) of the signer.  

Required for the centralized signature and the company stamp, optional for remote signature and biometric signature.

Language (string)

Signer

Text

Specifies the language of the website for the centralized signature and the language of the app for the biometric signature.

ca, de, en, es, eu, fr, it, iw, nl, pl, pt

AddNewClippedDocumentCentralized

With this method, multiple files of a document are sent for signature by one person. The signature is placed at multiple positions.

  • The information about the signer and the signature positions in the document is contained in a list with separators. The separator is specified with its own parameter.

  • In the examples in the table, the comma is used as the separator (see parameter MultiValueSeparator).

  • In the list parameters, the order and the number of values separated by "MultiValueSeparator" must be identical.

  • Parameters must be specified. Exceptions are marked as "optional".

  • The signer signs all files with one signature.

Parameter

Category

Workflow variable

Description

Values

Token (string)

General

Text

The workflow uses the token to identify itself to the Signature Service. The token is created when the Signature Service is registered and is sent by email.

DateSignedFieldName (string)

optional

Fields

Text

Specifies an index field in which the date of signing is entered. It can be a text, date, or date/time field.

If the field is a text field, the date is entered in UTC and displayed in DocuWare.

We recommend using a field of type Date or Date/Time so that the date and time are displayed in the local time zone and local format.

  • Text field

  • Date field

  • Date/time field

StatusFieldName (string)

Fields

Text

Specifies an index field in which the status of a signature is entered. It is filled with "SuccessStatusValue" or "FailureStatusValue". This field is ideal for letting the workflow continue after the signature.

SuccessStatusValue (string)

Fields

Text

Value that is set in the index field defined in "StatusFieldName" after a successful signature.

FailureStatusValue (string)

Fields

Text

Value that is set in the index field defined in "StatusFieldName" after a failed signature.

RejectionReasonFieldName (string)

Fields

Text

Specifies an index field in which the rejection reason is entered if a signer has rejected the signature.

DaysBeforeExpiration (int)

optional

Process

Integer

With a value of >0, sets a deadline in days for signing. If the deadline is exceeded, the document is considered rejected and is no longer available for signature.

PostSigningAction (string)

Process

Text

Specifies how the signed document is stored in DocuWare. Either the original document can be overwritten, or the signed document can be clipped in front of or behind the original document.

  • ClipBefore

  • ClipAfter

  • Replace

SendSignedDocument (Boolean)

Process

Text

Specifies whether the signed document is sent to the signer by email.

  • True

  • False

IncludeReport

(Boolean)

optional

Process

Text

Specifies whether, in addition to the signed document, a report with information about the signer and the signing process is attached to the document. This report is a separate PDF file.

  • True

  • False

MultiValueSeparator (string)

Process

Text

Specifies how multiple values within a parameter are separated from each other.

Common separators are a comma, a caret ^ or a vertical bar |

MultiSectionCount (int)

Process

Integer

Number of files of a DocuWare document to be signed

FileCabinetId (string)

Document

Text

Specifies, by its GUID, the file cabinet in which the document to be signed is stored. The GUID is displayed in the file cabinet administration.

DocId (int)

Document

Integer

Specifies the document to be signed by its DocID.

MultiSectionNumber (string)

Position

Text

List of multiple "SectionNumber" values separated by "MultiValueSeparator".

See method "AddNewDocument".

MultiPageNumber (string)

Position

Text

List of multiple "PageNumber" values separated by "MultiValueSeparator".

See method "AddNewDocument".

MultiAnchorText (string)

Position

Text

List of multiple "AnchorText" values separated by "MultiValueSeparator".

See method "AddNewDocument".

MultiAnchorTextOccurrence (string)

Position

Text

List of multiple "AnchorTextOccurence" values separated by "MultiValueSeparator".

See method "AddNewDocument".

MultiPositionX (string)

Position

Text

List of multiple "PositionX" values separated by "MultiValueSeparator".

See method "AddNewDocument".

MultiPositionY (string)

Position

Text

List of multiple "PositionY" values separated by "MultiValueSeparator".

See method "AddNewDocument".

MultiSizeX (string)

Position

Text

List of multiple "SizeX" values separated by "MultiValueSeparator".

See method "AddNewDocument".

MultiSizeY (string)

Position

Text

List of multiple "SizeY" values separated by "MultiValueSeparator".

See method "AddNewDocument".

SignerName (string)

Signer

Text

Specifies the name of the signing user.

Not necessary if "SignerNameEditable" is activated.

SignerEmail (string)

Signer

Text

Specifies the email address of the signing user.

SignerID (string)

Signer

Text

Specifies an ID number (e.g. identity card number) of the signer.  

Required for the centralized signature and the company stamp, optional for remote signature and biometric signature.

Language

Signer

Text

Specifies the language of the website for the centralized signature and the language of the app for the biometric signature.

ca, de, en, es, eu, fr, it, iw, nl, pl, pt

Supported versions: DocuWare Cloud + 7.14 + 7.13 + 7.12 + 7.11 + 7.10