The biometric signature from Validated ID combines a personal identity check by an employee with the capture of dynamic handwriting data (e.g. pressure and speed) on a tablet. These characteristics are stored for later verification and give the procedure the security level advanced.
An employee at the company reception desk checks the signer's identity in person. The employee confirms the identity by entering the signer's name in the form of a workflow task. The information is sent to a tablet, on which the signer signs the document. Biometric data such as the writing pressure is stored for possible later verification.
This signature procedure from Validated ID has the security level “advanced”.
With this procedure, the signer does not need to register with Validated ID.
Read general information on the service methods and parameters with Validated ID.
The following methods are available for the biometric signature:
AddNewDocumentBiometric
This method sends one file of a document to a tablet for signing. The signature is applied at one position.
AddNewDocumentMultiPositionsBiometric
This method sends one file of a document to a tablet for signing. The signature is applied at multiple positions.
AddNewClippedDocumentBiometric
With this method, multiple files of a document are sent to a tablet for signing. The signature is applied at multiple positions.
For an overview, here you find the same methods and information in table form:
Method | Description | Files | Signers | Signature positions |
|---|---|---|---|---|
AddNewDocumentBiometric | This method sends one file of a document to a tablet for signing. The signature is applied at one position. | 1 | 1 | 1 |
AddNewDocumentPositionsBiometric | This method sends one file of a document to a tablet for signing. The signature is applied at multiple positions. | 1 | 1 | multiple |
AddNewClippedDocumentBiometric | With this method, multiple files of a document are sent to a tablet for signing. The signature is applied at multiple positions. | multiple | 1 | multiple |
AddNewDocumentBiometric
This method sends one file of a document to a tablet for signing by one person. The signature is applied at one position.
Parameters must be specified. Exceptions are marked as "optional".
Parameter | 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 | Fields | Text | Defines 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. |
|
StatusFieldName (string) | Fields | Text | Defines an index field in which the status of a signature is entered. The field 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 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 signing. | |
PostSigningAction (string) | Process | Text | Defines how the signed document is stored in DocuWare: either the original document is overwritten, or the signed document is clipped to the front or to the back of the original document. |
|
SendSignedDocument (Boolean) | Process | Text | Defines whether the signed document is sent to the signer by email. |
|
IncludeReport (Boolean) optional | Process | Text | Defines whether, in addition to the signed document, a report with information on the signer and the signing process is attached to the document. This report is a separate PDF file. |
|
FileCabinetId (string) | Document | Text | Defines, based on the 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 based on the DocID. | |
SectionNumber (int) | Position | Integer | Defines the file (section) of a clipped document that is to be signed. |
|
PageNumber (int) | Position | Integer | Defines the page number in the document on which the signature is placed. If an anchor text is used, this parameter defines the page from which the anchor text is searched. |
|
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 several times in the document, this parameter defines which occurrence is used to calculate the position. |
|
PositionX (int) | Position | Integer | Defines 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 | Defines 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 it. 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 required 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. | |
SignerID (string) | Signer | Text | Defines an ID number (e.g. ID card 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 permitted. The ID types are specified in a comma-separated format. The ID types are then displayed in a select list if "TypeOfIDRequired" is set to "mandatory" or "optional". | |
TypeOfIdRequired | Signer | Text | Defines whether a selection of the ID type is required, optional, or not required to sign the document. | |
TypeOfIdEditable | Signer | Text | Defines whether the signer can change the ID type. | |
DeviceName (string) | Signer | Text | Defines the name of the device used for signing with the biometric signature. | |
Language | Signer | Text | Defines 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 |
AddNewDocumentMultiPositionsBiometric
This method sends one file of a document to a tablet for signing by one person. The signature is applied at multiple positions.
The information on the signature positions in the document is contained in a delimited list. The delimiter is defined with a separate parameter.
In the examples in the table, the comma is used as the delimiter (see the MultiValueSeparator parameter).
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. | |
FileCabinetId (string) | Document | Text | GUID of the file cabinet in which the document to be signed is stored | |
DocId (int) | Document | Integer | ID of the document to be signed | |
DateSignedFieldName | Fields | Text | Defines 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. |
|
StatusFieldName (string) | Fields | Text | Defines an index field in which the status of a signature is entered. The field 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 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 signing. | |
PostSigningAction (string) | Process | Text | Defines how the signed document is stored in DocuWare: either the original document is overwritten, or the signed document is clipped to the front or to the back of the original document. |
|
SendSignedDocument (Boolean) | Process | Text | Defines whether the signed document is sent to the signer by email. |
|
IncludeReport (Boolean) optional | Process | Text | Defines whether, in addition to the signed document, a report with information on the signer and the signing process is attached to the document. This report is a separate PDF file. |
|
MultiValueSeparator (string) | Process | Text | Defines how multiple values within one parameter are separated from each other. Common delimiters are a comma, a caret ^, or a vertical bar | | |
MultiSignatureCount (int) | Process | Integer | Number of signature positions | |
FileCabinetId (string) | Document | Text | Defines, based on the 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 based on the DocID. | |
SectionNumber (int) | Position | Integer | Defines the file (section) of a clipped document that is to be signed. |
|
MultiPageNumber (string) | Position | Text | List of multiple "PageNumber" values separated by "MultiValueSeparator". | |
MultiAnchorText (string) | Position | Text | List of multiple "AnchorText" values separated by "MultiValueSeparator". See the “AddNewDocumentBiometric” method. | |
MultiAnchorTextOccurrence (string) | Position | Text | List of multiple "AnchorTextOccurence" values separated by "MultiValueSeparator". See the “AddNewDocumentBiometric” method. | |
MultiPositionX (string) | Position | Text | List of multiple "PositionX" values separated by "MultiValueSeparator". See the “AddNewDocumentBiometric” method. | |
MultiPositionY (string) | Position | Text | List of multiple "PositionY" values separated by "MultiValueSeparator". See the “AddNewDocumentBiometric” method. | |
MultiSizeX (string) | Position | Integer | List of multiple "SizeX" values separated by "MultiValueSeparator". See the “AddNewDocumentBiometric” method. | |
MultiSizeY (int) | Position | Integer | List of multiple "SizeY" values separated by "MultiValueSeparator". See the “AddNewDocumentBiometric” method. | |
SignerName (string) | Signer | Text | Defines the name of the signing user. Not required 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. | |
SignerID (string) | Signer | Text | Defines an ID number (e.g. ID card 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 permitted. The ID types are specified in a comma-separated format. The ID types are then displayed in a select list if "TypeOfIDRequired" is set to "mandatory" or "optional". | |
TypeOfIdRequired | Signer | Text | Defines whether a selection of the ID type is required, optional, or not required to sign the document. | |
TypeOfIdEditable | Signer | Text | Defines whether the signer can change the ID type. | |
DeviceName (string) | Signer | Text | Defines the name of the device used for signing with the biometric signature. | |
Language | Signer | Text | Defines 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 |
AddNewClippedDocumentBiometric
With this method, multiple files of a document are sent to a tablet for signing. The signature is applied at multiple positions.
The information on the signature positions in the document is contained in a delimited list. The delimiter is defined with a separate parameter.
In the examples in the table, the comma is used as the delimiter (see the MultiValueSeparator parameter).
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 at the same time with a single signature.
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 | Fields | Text | Defines 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. |
|
StatusFieldName (string) | Fields | Text | Defines an index field in which the status of a signature is entered. The field 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 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 signing. | |
PostSigningAction (string) | Process | Text | Defines how the signed document is stored in DocuWare: either the original document is overwritten, or the signed document is clipped to the front or to the back of the original document. |
|
SendSignedDocument (Boolean) | Process | Text | Defines whether the signed document is sent to the signer by email. |
|
IncludeReport (Boolean) optional | Process | Text | Defines whether, in addition to the signed document, a report with information on the signer and the signing process is attached to the document. This report is a separate PDF file. |
|
MultiValueSeparator (string) | Process | Text | Defines how multiple values within one parameter are separated from each other. Common delimiters 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 | Defines, based on the 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 based on the DocID. | |
MultiSectionNumber (string) | Position | Text | List of multiple "SectionNumber" values separated by "MultiValueSeparator". See the “AddNewDocumentBiometric” method. | |
MultiPageNumber (string) | Position | Text | List of multiple "PageNumber" values separated by "MultiValueSeparator". See the “AddNewDocumentBiometric” method. | |
MultiAnchorText (string) | Position | Text | List of multiple "AnchorText" values separated by "MultiValueSeparator". See the “AddNewDocumentBiometric” method. | |
MultiAnchorTextOccurrence (string) | Position | Text | List of multiple "AnchorTextOccurence" values separated by "MultiValueSeparator". See the “AddNewDocumentBiometric” method. | |
MultiPositionX (string) | Position | Text | List of multiple "PositionX" values separated by "MultiValueSeparator". See the “AddNewDocumentBiometric” method. | |
MultiPositionY (string) | Position | Text | List of multiple "PositionY" values separated by "MultiValueSeparator". See the “AddNewDocumentBiometric” method. | |
MultiSizeX (string) | Position | Text | List of multiple "SizeX" values separated by "MultiValueSeparator". See the “AddNewDocumentBiometric” method. | |
MultiSizeY (string) | Position | Text | List of multiple "SizeY" values separated by "MultiValueSeparator". See the “AddNewDocumentBiometric” method. | |
SignerName (string) | Signer | Text | Defines the name of the signing user. Not required if "SignerNameEditable" is enabled. | |
SignerNameEditable (string) | Signer | Text | Defines whether the signer can change the name during signing. | |
SignerEmail (string) | Signer | Text | Email address of the signing user | |
SignerID (string) | Signer | Text | Defines an ID number (e.g. ID card 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 permitted. The ID types are specified in a comma-separated format. The ID types are then displayed in a select list if "TypeOfIDRequired" is set to "mandatory" or "optional". | |
TypeOfIdRequired | Signer | Text | Defines whether a selection of the ID type is required, optional, or not required to sign the document. | |
TypeOfIdEditable | Signer | Text | Defines whether the signer can change the ID type. | |
DeviceName | Signer | Text | Defines the name of the device used for signing with the biometric signature. | |
Language (string) | Signer | Text | Language of the email and of the page on which the document is signed. If this value is empty, it defaults to en (English). | ca, de, en, es, eu, fr, it, iw, nl, pl, pt |