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: remote signature

Prev Next

For a person to sign a document in a workflow using the Validated ID remote method, the name, email address, and an SMS-capable phone number of the signer must be known.

This information is passed automatically by the workflow to Validated ID with the signature request. The signer receives an email with the link to the document, as well as an SMS message with a TAN that they use to trigger the signature.

This Validated ID signature method has the security level advanced.

With this method, the signer does not need to be registered with Validated ID.

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

The following methods are available for the remote signature:

  • AddNewDocumentRemote

    This method sends one file of a document for signing by one person. The signature is placed at one position.

  • AddNewDocumentMultiRemote

    This method sends one file of a document for signing by several people. The signatures are placed at several positions.

  • AddNewDocumentMultiPositionsRemote

    This method sends one file of a document for signing by one person. The signature is placed at several positions.

  • AddNewClippedDocumentRemote

    This method sends several files of a document for signing by one person. The signature is placed at several positions.

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

Method

Description

Files

Signers

Signature
positions

AddNewDocumentRemote

This method sends one file of a document for signing by one person. The signature is placed at one position.

1

1

1

AddNewDocumentMultiRemote

This method sends one file of a document for signing by several people. The signatures are placed at several positions.

1

several

several

AddNewDocumentPositionsRemote

This method sends one file of a document for signing by one person. The signature is placed at several positions.

1

1

several

AddNewClippedDocumentRemote

This method sends several files of a document for signing by one person. The signature is placed at several positions.

several

1

several

AddNewDocumentRemote

This method sends one file of a document for signing by one person. The signature is placed at one position.

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

Parameter

Category

Workflow variable type

Description

Values

Token (string)

General

Text

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

DateSignedFieldName (string)

Fields

Text

Defines an index field into 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 date or date/time field 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

Defines an index field into 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 in the index field when the signature for a document is declined (see SuccessStatusValue).

RejectionReasonFieldName (string)

optional

Fields

Text

Defines an index field into which the reason for the rejection is entered when a signer has declined 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 declined and is no longer available for signing.

ReminderFrequencyHours (int)

Process

Integer

Sends a reminder to the signer. The value defines the interval at which the reminder is sent. A common value is, for example, 24 hours.

ReminderMaxRetries (int)

Process

Integer

Defines how many reminders are sent in total at the interval of "ReminderFrequencyHours".

PostSigningAction (string)

Process

Text

Defines how the signed document is stored in DocuWare. Either the original document can be overwritten, or the signed document can be clipped to the front or back of the original document.

  • ClipBefore

  • ClipAfter

  • Replace

AllowSignatureDelegation (Boolean)

Process

Text

Defines whether the signer originally defined in the workflow can forward the document to another person for signing. The signature is thereby delegated to the new signer.

  • True

  • False

SendSignedDocument (Boolean)

Process

Text

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

  • True

  • False

IncludeReport (Boolean)

optional

Process

Text

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

  • True

  • False

FileCabinetId (string)

Document

Text

Defines, by 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

Defines the document to be signed by its DocID.

SectionNumber (int)

Position

Integer

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

  • 0 or 1 = first file in the document

  • -1 = last file

  • Other number = further files

PageNumber (int)

Position

Integer

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

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

  • 0 or 1 = first page of the file

  • -1 = last page

  • Other number = further pages

AnchorText (string)

Position

Text

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

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

AnchorTextOccurrence (int)

Position

Integer

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

  • 0 or 1 = first occurrence of the anchor text

  • -1 = last occurrence

  • Other number = further occurrences

PositionX (int)

Position

Integer

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

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

PositionY (int)

Position

Integer

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

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

SizeX (int)

Position

Integer

Defines the width of the signature image in millimeters.

SizeY (int)

Position

Integer

Defines the height of the signature image in millimeters.

SignerName (string)

Signer

Text

Defines the name of the signing user.

Not necessary if "SignerNameEditable" is enabled.

SignerNameEditable (Boolean)

Signer

Text

Defines whether the signer can change the name during signing.

SignerEmail (string)

Signer

Text

Defines the email address of the signing user.

SignerPhoneNumber (string)

Signer

Text

Defines the signer's phone number for two-factor authentication. The phone number must be able to receive SMS messages and must be specified in international number format (for example, +18455639045).

RecipientMayProvideNumber (boolean)

Signer

Text

Defines whether the signer can enter the phone number for two-factor authentication themselves.

SignerID (string)

Signer

Text

Defines an ID number (for example, an identity document number) of the signer.  

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

NumberIdRequired (string)

Signer

Text

Defines whether the "SignerId" is required, optional, or not required for the signature.

  • Mandatory

  • Optional

  • No

NumberIdEditable (boolean)

Signer

Text

Defines whether the signer can change the "SignerID".

TypeOfIdsAllowed (string)

Signer

Text

Defines which ID types are allowed. The ID types are specified in a comma-separated format.

The ID types are then displayed in a selection list if "TypeOfIDRequired" is set to "mandatory" or "optional".

TypeOfIdRequired (string)

Signer

Text

Defines whether selecting the ID type is required, optional, or not required in order to sign the document.

  • Mandatory

  • Optional

  • No

TypeOfIdEditable (boolean)

Signer

Text

Defines whether the signer can change the ID type.

IssuerName (string)

Signer

Text

Defines the display name for the sender of the notification email. If this value is empty, the name of the DocuWare organization is used by default.

EmailLanguage (string)

Signer

Text

Defines the language of the notification email and the signature website. If this value is empty, English is used by default.

br, ca, de, en, es, fr, gl, hu, it, nl, no, pl, pt, ro, zh

EmailSubject (string)

Signer

Text

Defines the subject of the notification email.

EmailMessage (string)

Signer

Text

Defines a text that is displayed in the content of the notification email.

AddNewDocumentMultiRemote

This method sends one file of a document for signing by several people. The signatures are placed at several positions.

  • The information about the signers and the signature positions in the document are contained in a list with separators. The separator is defined by a dedicated parameter.

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

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

  • The file cabinet is updated after all people have processed the document.

  • 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 identifies itself to the Signature Service with the token. The token is created when the Signature Service is registered and is sent by email.

DateSignedFieldName (string)

Fields

Text

Defines an index field into 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 date or date/time field 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

Defines an index field into 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

Defines an index field into which the reason for the rejection is entered when a signer has declined 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 declined and is no longer available for signing.

ReminderFrequencyHours (int)

Process

Integer

Sends a reminder to the signer. The value defines the interval at which the reminder is sent. A common value is, for example, 24 hours.

ReminderMaxRetries (int)

Process

Integer

Defines how many reminders are sent in total at the interval of "ReminderFrequencyHours".

PostSigningAction (string)

Process

Text

Defines how the signed document is stored in DocuWare. Either the original document can be overwritten, or the signed document can be clipped to the front or back of the original document.

  • ClipBefore

  • ClipAfter

  • Replace

AllowSignatureDelegation (Boolean)

Process

Text

Defines whether the signer originally defined in the workflow can forward the document to another person for signing. The signature is thereby delegated to the new signer.

  • True

  • False

SendSignedDocument (Boolean)

Process

Text

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

  • True

  • False

IncludeReport (Boolean)

optional

Process

Text

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

  • True

  • False

MultiValueSeparator (string)

Process

Text

Defines how multiple values in a parameter are separated from one another.

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

MultiSignerCount (int)

Process

Text

Number of signers

OrderedSignature (boolean)

Process

Text

Defines whether the signers are notified in a defined order or simultaneously.

The document in the DocuWare file cabinet is not updated until all signers have signed the document.

  • True

  • False

FileCabinetId (string)

Document

Text

Defines, by 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

Defines the document to be signed by its DocID.

SectionNumber (int)

Position

Integer

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

  • 0 or 1 = first file in the document

  • -1 = last file

  • Other number = further files

MultiPageNumber (string)

Position

Text

List of several "PageNumber" values separated by "MultiValueSeparator".
See the “AddNewDocumentRemote” method.

MultiAnchorText (string)

Position

Text

List of several "AnchorText" values separated by "MultiValueSeparator".
See the “AddNewDocumentRemote” method.

MultiAnchorTextOccurrence (string)

Position

Text

Anchor texts for several places where the document is to be signed.

See the “AddNewDocumentRemote” method.

MultiPositionX (string)

Position

Text

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

See the “AddNewDocumentRemote” method.

MultiPositionY (string)

Position

Text

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

See the “AddNewDocumentRemote” method.

MultiSizeX (string)

Position

Text

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

See the “AddNewDocumentRemote” method.

MultiSizeY (string)

Position

Text

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

See the “AddNewDocumentRemote” method.

MultiSignerName (string)

Signer

Text

List of several "SignerName" values separated by "MultiValueSeparator".

See the “AddNewDocumentRemote” method.

MultiSignerNameEditable (string)

Signer

Text

List of several "SignerNameEditable" values separated by "MultiValueSeparator".

See the “AddNewDocumentRemote” method.

MultiSignerEmail (string)

Signer

Text

List of several "SignerEmail" values separated by "MultiValueSeparator".

See the “AddNewDocumentRemote” method.

MultiSignerPhoneNumber (string)

Signer

Text

List of several "SignerPhoneNumber" values separated by "MultiValueSeparator".

See the “AddNewDocumentRemote” method.

RecipientMayProvideNumber (Boolean)

Signer

Text

Defines whether the signer can enter the phone number for two-factor authentication themselves.

MultiSignerID (string)

optional

Signer

Text

List of several "SignerId" values separated by "MultiValueSeparator".

See the “AddNewDocumentRemote” method.

MultiNumberIdRequired (string)

Signer

Text

List of several "NumberIdRequired" values separated by "MultiValueSeparator".

See the “AddNewDocumentRemote” method.

MultiNumberIdEditable (string)

Signer

Text

List of several "NumberIdEditable" values separated by "MultiValueSeparator".

See the “AddNewDocumentRemote” method.

MultiTypeOfIdsAllowed (string)

Signer

Text

List of several "TypeOfIdsAllowed" values separated by "MultiValueSeparator".

See the “AddNewDocumentRemote” method.

MultiTypeOfIdRequired (string)

Signer

Text

List of several "TypeOfIdRequired" values separated by "MultiValueSeparator".

See the “AddNewDocumentRemote” method.

MultiTypeOfIdEditable (string)

Signer

Text

List of several "TypeOfIdEditable" values separated by "MultiValueSeparator".

See the “AddNewDocumentRemote” method.

IssuerName (string)

Signer

Text

Defines the display name for the sender of the notification email. If this value is empty, the name of the DocuWare organization is used by default.

EmailLanguage (string)

Signer

Text

Defines the language of the notification email and the signature website. If this value is empty, English is used by default.

br, ca, de, en, es, eu, fi, fr, gl, hu, it, nl, no, pl, pt, ro, zh

EmailSubject (string)

Signer

Text

Defines the subject of the notification email.

EmailMessage (string)

Signer

Text

Defines a text that is displayed in the content of the notification email.

AddNewDocumentMultiPositionsRemote

This method sends one file of a document for signing by one person. The signature is placed at several positions.

  • The information about the signer and the signature positions in the document are contained in a list with separators. The separator is defined by a dedicated parameter.

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

  • In the list parameters, the order and number of the 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 identifies itself to the Signature Service with the token. The token is created when the Signature Service is registered and is sent by email.

DateSignedFieldName (string)

Fields

Text

Defines an index field into 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 date or date/time field 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

Defines an index field into 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

Defines an index field into which the reason for the rejection is entered when a signer has declined 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 declined and is no longer available for signing.

ReminderFrequencyHours (int)

Process

Integer

Sends a reminder to the signer. The value defines the interval at which the reminder is sent. A common value is, for example, 24 hours.

ReminderMaxRetries (int)

Process

Integer

Defines how many reminders are sent in total at the interval of "ReminderFrequencyHours".

PostSigningAction (string)

Process

Text

Defines how the signed document is stored in DocuWare. Either the original document can be overwritten, or the signed document can be clipped to the front or back of the original document.

  • ClipBefore

  • ClipAfter

  • Replace

AllowSignatureDelegation (Boolean)

Process

Text

Defines whether the signer originally defined in the workflow can forward the document to another person for signing. The signature is thereby delegated to the new signer.

  • True

  • False

SendSignedDocument (Boolean)

Process

Text

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

  • True

  • False

IncludeReport (Boolean)

optional

Process

Text

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

  • True

  • False

MultiValueSeparator (string)

Process

Text

Defines how multiple values in a parameter are separated from one another.

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

MultiSignatureCount (int)

Process

Number of signature positions

FileCabinetId (string)

Document

Text

Defines, by 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

Defines the document to be signed by its DocID.

SectionNumber (int)

Position

Integer

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

  • 0 or 1 = first file in the document

  • -1 = last file

  • Other number = further files

MultiPageNumber (string)

Position

Text

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

See the “AddNewDocumentRemote” method.

MultiAnchorText (string)

Position

Text

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

See the “AddNewDocumentRemote” method.

MultiAnchorTextOccurrence (string)

Position

Text

List of several "AnchorTextOccurrence" values separated by "MultiValueSeparator".

See the “AddNewDocumentRemote” method.

MultiPositionX (string)

Position

Text

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

See the “AddNewDocumentRemote” method.

MultiPositionY (string)

Position

Text

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

See the “AddNewDocumentRemote” method.

MultiSizeX (string)

Position

Text

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

See the “AddNewDocumentRemote” method.

MultiSizeY (string)

Position

Text

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

See the “AddNewDocumentRemote” method.

SignerName (string)

Signer

Text

Defines the name of the signing user.

Not necessary if "SignerNameEditable" is enabled.

SignerNameEditable (string)

Signer

Text

Defines whether the signer can change the name during signing.

SignerEmail (string)

Signer

Text

Defines the email address of the signing user.

SignerPhoneNumber (string)

Signer

Text

Defines the signer's phone number for two-factor authentication. The phone number must be able to receive SMS messages and must be specified in international number format (for example, +18455639045).

RecipientMayProvideNumber (Boolean)

Signer

Text

Defines whether the signer can enter the phone number for two-factor authentication themselves.

SignerID (string)

Signer

Text

Defines an ID number (for example, an identity document number) of the signer.  

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

NumberIdRequired (string)

Signer

Text

Defines whether the "SignerId" is required, optional, or not required for the signature.

NumberIdEditable (string)

Signer

Text

Defines whether the signer can change the "SignerID".

TypeOfIdsAllowed

Signer

Text

Defines which ID types are allowed. The ID types are specified in a comma-separated format.

The ID types are then displayed in a selection list if "TypeOfIDRequired" is set to "mandatory" or "optional".

TypeOfIdRequired

Signer

Text

Defines whether selecting the ID type is required, optional, or not required in order to sign the document.

TypeOfIdEditable

Signer

Text

Defines whether the signer can change the ID type.

IssuerName (string)

Signer

Text

Defines the display name for the sender of the notification email. If this value is empty, the name of the DocuWare organization is used by default.

EmailLanguage (string)

Signer

Text

Defines the language of the notification email and the signature website. If this value is empty, English is used by default.

br, ca, de, en, es, eu, fi, fr, gl, hu, it, nl, no, pl, pt, ro, zh

EmailSubject (string)

Signer

Text

Defines the subject of the notification email.

EmailMessage (string)

Signer

Text

Defines a text that is displayed in the content of the notification email.

AddNewClippedDocumentRemote

This method sends several files of a document for signing by one person. The signature is placed at several positions.

  • The information about the signer and the signature positions in the document are contained in a list with separators. The separator is defined by a dedicated parameter.

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

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

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

  • The signer signs all files at once with a single signature.

Parameter name

Category

Variable type in the workflow

Description

Values

Token (string)

General

Text

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

DateSignedFieldName (string)

Fields

Text

Defines an index field into 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 date or date/time field 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

Defines an index field into 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

Defines an index field into which the reason for the rejection is entered when a signer has declined 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 declined and is no longer available for signing.

ReminderFrequencyHours (int)

Process

Integer

Sends a reminder to the signer. The value defines the interval at which the reminder is sent. A common value is, for example, 24 hours.

ReminderMaxRetries (int)

Process

Integer

Defines how many reminders are sent in total at the interval of "ReminderFrequencyHours".

PostSigningAction (string)

Process

Text

Defines how the signed document is stored in DocuWare. Either the original document can be overwritten, or the signed document can be clipped to the front or back of the original document.

  • ClipBefore

  • ClipAfter

  • Replace

SendSignedDocument (Boolean)

Process

Text

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

  • True

  • False

IncludeReport (Boolean)

optional

Process

Text

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

  • True

  • False

MultiValueSeparator (string)

Process

Text

Defines how multiple values in a parameter are separated from one another.

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

FileCabinetId (string)

Document

Text

Defines, by 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

Defines the document to be signed by its DocID.

MultiSectionCount (int)

Process

Integer

Number of files of a DocuWare document to be signed

MultiSectionNumber (string)

Position

Text

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

See the “AddNewDocumentRemote” method.

MultiPageNumber (string)

Position

Text

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

See the “AddNewDocumentRemote” method.

MultiAnchorText (string)

Position

Text

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

See the “AddNewDocumentRemote” method.

MultiAnchorTextOccurrence (string)

Position

Text

List of several "AnchorTextOccurrence" values separated by "MultiValueSeparator".

See the “AddNewDocumentRemote” method.

MultiPositionX (string)

Position

Text

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

See the “AddNewDocumentRemote” method.

MultiPositionY (string)

Position

Text

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

See the “AddNewDocumentRemote” method.

MultiSizeX (string)

Position

Text

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

See the “AddNewDocumentRemote” method.

MultiSizeY (string)

Position

Text

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

See the “AddNewDocumentRemote” method.

SignerName (string)

Signer

Text

Defines the name of the signing user.

Not necessary if "SignerNameEditable" is enabled.

SignerNameEditable (string)

Signer

Text

Defines whether the signer can change the name during signing.

SignerEmail (string)

Signer

Text

Defines the email address of the signing user.

SignerPhoneNumber (string)

Signer

Text

Defines the signer's phone number for two-factor authentication. The phone number must be able to receive SMS messages and must be specified in international number format (for example, +18455639045).

RecipientMayProvideNumber (Boolean)

Signer

Text

Defines whether the signer can enter the phone number for two-factor authentication themselves.

SignerID (string)

Signer

Text

Defines an ID number (for example, an identity document number) of the signer.  

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

NumberIdRequired (string)

Signer

Text

Defines whether the "SignerId" is required, optional, or not required for the signature.

NumberIdEditable (string)

Signer

Text

Defines whether the signer can change the "SignerID".

TypeOfIdsAllowed

Signer

Text

Defines which ID types are allowed. The ID types are specified in a comma-separated format.

The ID types are then displayed in a selection list if "TypeOfIDRequired" is set to "mandatory" or "optional".

TypeOfIdRequired

Signer

Text

Defines whether selecting the ID type is required, optional, or not required in order to sign the document.

TypeOfIdEditable

Signer

Text

Defines whether the signer can change the ID type.

IssuerName (string)

Signer

Text

Defines the display name for the sender of the notification email. If this value is empty, the name of the DocuWare organization is used by default.

EmailLanguage (string)

Signer

Text

Defines the language of the notification email and the signature website. If this value is empty, English is used by default.

br, ca, de, en, es, eu, fi, fr, gl, hu, it, nl, no, pl, pt, ro, zh

EmailSubject (string)

Signer

Text

Defines the subject of the notification email.

EmailMessage (string)

Signer

Text

Defines a text that is displayed in the content of the notification email.

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