Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

Please note that you will need an active, dynamic and enrolled biometric server profile for the following configurations. For more information about the biometric server please do not hesitate to contact us.

Please also note the following preconditions:

  • Biometric server
  • Feature flag ("BiometricSignature")
  • Native component (Device Driver, Kiosk, sign on phone, ...)

Please also note: In order to be able to verify signatures it is necessary to collect six signatures in the biometric server. For more information please have a look at: SIGNificant Biometric Server (restricted access)

The Story Image RemovedThe Story 

Charly wants to open a new bank account. In order to be able to guarantee that Charly and no one else  signs future signatures, Charly has to sign six times to collect them in order to use those six signature to verify future signatures from Charly. This ensure that even if Charly does not sign directly in the bank, his signatures, which are digitally signed, are verified with the collected six signatures to check if Charly signed the document.

...

Info

Please note that the signature will not be verified if the value for "IsBio" is set to false!


Furthermore, the "uidBiometricServerUserId" must be set. The uid is the user id which can be found in the biometric server profile:

Code Block
languagejava
themeEclipse
"uidBiometricServerUserId": "##your user id##string",

Please also see the following configuration which shows where to place those two attributes:

Code Block
languagejava
themeEclipse
 "AllowedSignatureTypes": [{
    "Biometric": {
             {"BiometricVerification": true,
            "AllowBiometricStoringOnly": true,
        "IsBioStoreSignedResponseWithoutBioData": falsetrue,
            "AllowSkipBiometricVerification": true,
        "uidBiometricServerUserId": "##your user id##string",
            "SignaturePositioning": "WithinField",
        "AllowSkipBiometricVerificationPreferred": true,
        "StampImprintConfiguration": {
            "AllowBiometricStoringOnlyDisplayExtraInformation": true,
            "DisplayEmail": true,
            "SignedResponseWithoutBioDataDisplayTransactionId": true,
            "DisplayTransactionToken": true,
            "IdDisplayPhoneNumber": "dfbb1510-c2d4-4639-802c-e3946a1fa201"true,
            "UseCustomStampImprint": true,
            "DiscriminatorTypeDisplayIp": "SigTypeBiometricSignature"true,
            "DisplayName": true,
            "PreferredDisplaySignatureDate": falsetrue,
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
  "FontName": "string",
                    "DisplayEmail"FontSizeInPt": true,0
        }
              "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontFamily": "Times New Roman",
                      "FontSize": 11.0,
                      "OverrideLegacyStampImprint": false,
                      "DisplayTransactionId": true,
                      "DisplayTransaktionToken": true,
                      "DisplayPhoneNumber": true
                    },
                    "SignaturePluginConfigurationId": ""
                  }
                ],
                "UseTimestamp": false,
                "IsRequired": true,
                "Id": "1#XyzmoDuplicateIdSeperator#Signature_935a5cbb-148e-af78-0ac4-310f1181c984",
                "DisplayName": "",
                "DocRefNumber": 1,
                "DiscriminatorType": "Signature"
              }
            ]
          }
        },

In this configuration you can also find three more attributes to configure the settings of biometric verification:

  • AllowSkipBiometricVerification (to allow to skip the biometric verification)
  • AllowBiometricStoringOnly (to allow to store the biometric signature without verification process)
  • SignedResponseWithoutBioData

Please also see the following complete workstep configuration:

}
},

In this configuration you can also find three more attributes to configure the settings of biometric verification:

  • AllowSkipBiometricVerification (to allow to skip the biometric verification)
  • AllowBiometricStoringOnly (to allow to store the biometric signature without verification process)
  • StoreSignedResponseWithoutBioData

Please also see the following complete workstep configuration:

Code Block
languagejava
themeEclipse
{
    "Documents": [{
Code Block
languagejava
themeEclipse
{
  "SspFileIds": [
    "##your file id##"
  ],
  "SendEnvelopeDescription": {
  "Name": "test",
  "EmailSubject": "Please sign the enclosed envelope",
  "EmailBody": "Dear #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease sign the envelope #EnvelopeName#\n\nEnvelope will expire at #ExpirationDate#",
  "DisplayedEmailSender": "",
  "EnableReminders": true,
  "FirstReminderDayAmount": 5,
  "RecurrentReminderDayAmount": 3,
  "BeforeExpirationDayAmount": 3,
  "ExpirationInSecondsAfterSending": 2419200,
  "CallbackUrl": "",
  "StatusUpdateCallbackUrl": "",
  "LockFormFieldsAtEnvelopeFinish": true,
  "Steps": [
    {
      "OrderIndex": 1,
      "Recipients": [
        {
          "Email": "##EMAIL##",
          "FirstName": "##NAME##",
          "LastName": "##NAME##",
          "LanguageCode": "en",
          "EmailBodyExtra": "",
          "DisableEmail": false,
          "AddAndroidAppLink": false,
          "AddIosAppLink": false,
          "AddWindowsAppLink": false,
          "AllowDelegation": true,
          "AllowAccessFinishedWorkstep": false,
          "SkipExternalDataValidation": false,
          "AuthenticationMethods": []
        }
      ],
      "EmailBodyExtra": "",
      "RecipientType": "Signer",
      "WorkstepConfiguration": {
        "WorkstepLabel": "test",
        "SmallTextZoomFactorPercent": 100,
        "FinishAction": {
          "ServerActions": [],
          "ClientActions": []
        },
        "ReceiverInformation": {
          "UserInformation": {
            "FirstName": "##NAME##",
            "LastName": "##NAME##",
            "EMail": "##EMAIL##"
          },
          "TransactionCodePushPluginData": []
        },
        "SenderInformationFileId": {
          "UserInformation": {"20f35fe5-1234-1234-847d-02ece578ad88",
            "FirstNameDocumentNumber": "##NAME##",
1
        }
    ],
    "LastNameName": "##NAME##Test",
            "EMailActivities": "##EMAIL##"[{
           } "Action": {
        },
        "TransactionCodeConfigurationsSign": [],{
        "SignatureConfigurations": [],
            "ViewerPreferencesRecipientConfiguration": {
          "FinishWorkstepOnOpen": false,
              "VisibleAreaOptionsContactInformation": {
              "AllowedDomain": "",
              "EnabledEmail": false"johndoe@sample.com",
          }
          },
        "ResourceUrisGivenName": {"John",
          "DelegationUri": "https://demo.esignanywhere.net/Resource/Delegate"
           },
        "AuditingToolsConfigurationSurname": {"Doe",
           "WriteAuditTrail": true
        },
        "PolicyLanguageCode": {
"EN"
              "GeneralPolicies": {
          }    "AllowSaveDocument": true,
            "AllowSaveAuditTrail": true,
            "AllowRotatingPages": false,
        },
       "AllowAppendFileToWorkstep": false,
            "AllowAppendTaskToWorkstepElements": false,
{                 "AllowEmailDocument": true,
            "AllowPrintDocument": true,
            "AllowFinishWorkstep": true,
            "AllowRejectWorkstep": true,
            "AllowRejectWorkstepDelegationSignatures": true,[{
            "AllowUndoLastAction": true,
            "AllowColorizePdfForms": false,
            "AllowAdhocPdfAttachmentsTaskConfiguration": false,{
            "AllowAdhocSignatures": false,
            "AllowAdhocStampings": false,
            "AllowAdhocFreeHandAnnotationsOrderDefinition": false,{
              "AllowAdhocTypewriterAnnotations": false,
            "AllowAdhocPictureAnnotations": false,
            "AllowAdhocPdfPageAppendingOrderIndex": false,0
             "AllowReloadOfFinishedWorkstep": true
            },
          "WorkstepTasks": {}
            "PictureAnnotationMinResolution": 0,
            "PictureAnnotationMaxResolution": 0,
      },
      "PictureAnnotationColorDepth": "Color16M",
            "SequenceMode": "NoSequenceEnforced",
            "PositionUnitsElementId": "PdfUnitssample sig biometric",
            "ReferenceCorner": "Lower_Left",
                    "TasksRequired": [true,
                {
                "PositionPageDocumentNumber": 1,
                "Position": {
                  "PositionXDisplayName": 51.0 "Sign here",
                  "PositionY": 607.0
             "AllowedSignatureTypes": {
  },
                "Size": {
                  "HeightBiometric": 80.0,{
                  "Width": 190.0
                  },
                "AdditionalParametersBiometricVerification": [true,
                    {
                    "KeyAllowBiometricStoringOnly": "enabled"true,
                     "Value": "1"
                   "StoreSignedResponseWithoutBioData": }true,
                    {
                    "KeyAllowSkipBiometricVerification": "completed"true,
                     "Value": "0"
                  }"BiometricServerUserId": "string",
                   {
                     "KeySignaturePositioning": "reqWithinField",
                    "Value": "1"
                    "Preferred": }true,
                   {
                     "KeyStampImprintConfiguration": "positioning",{
                    "Value": "intersectsWithField"
                    "DisplayExtraInformation": }true,
                   {
                     "KeyDisplayEmail": "fd"true,
                     "Value": ""
                  }"DisplayTransactionId": true,
                  {
                      "KeyDisplayTransactionToken": "fd_dateformat"true,
                    "Value": "dd-MM-yyyy HH:mm:ss"
                    "DisplayPhoneNumber": }true,
                    {
                    "KeyUseCustomStampImprint": "fd_timezone"true,
                    "Value": "datetimeutc"
                    "DisplayIp": true,
        }
                ],
                "AllowedSignatureTypesDisplayName": [true,
                    {
                    "IsBioDisplaySignatureDate": true,
                    "uid": "##your user id##",
                    "AllowSkipBiometricVerificationFontName": true"string",
                    "AllowBiometricStoringOnly": true,
                    "SignedResponseWithoutBioDataFontSizeInPt": true,
       0
              "Id": "dfbb1510-c2d4-4639-802c-e3946a1fa201",
                    "DiscriminatorType": "SigTypeBiometricSignature",
     }
               "Preferred": false,
                    "StampImprintConfiguration": {}
                      "DisplayExtraInformation": true,
             },
         "DisplayEmail": true,
                      "DisplayIpFieldDefinition": true,{
                        "DisplayName": true,
           "Position": {
          "DisplaySignatureDate": true,
                      "FontFamily": "Times New Roman",
    "PageNumber": 1,
                 "FontSize": 11.0,
                      "OverrideLegacyStampImprintX": false100,
                       "DisplayTransactionId": true,
                 "Y": 200
        "DisplayTransaktionToken": true,
                      "DisplayPhoneNumber": true
    },
                },
                    "SignaturePluginConfigurationIdSize": ""{
                  }
                ],
      "Width": 100,
         "UseTimestamp": false,
                "IsRequired": true,
                "IdHeight": "1#XyzmoDuplicateIdSeperator#Signature_935a5cbb-148e-af78-0ac4-310f1181c984",70
                "DisplayName": "",
                   "DocRefNumber": 1, }
                "DiscriminatorType": "Signature"
                }
                  ]
          }
                        },]
        "Navigation": {
          "HyperLinks": [] },
          "Links": [],
          "LinkTargetsSigningGroup": []
"firstSigner"
          }
      },
      "DocumentOptions": [
      }
        }, {
            "DocumentReferenceAction": "1",
{
                "IsHiddenSendCopy": false{
        }
      ],
      "UseDefaultAgreementsRecipientConfiguration": true{
       },
    {
      "OrderIndex": 2,
      "RecipientsContactInformation": [{
        {
          "Email": "##EMAIL##",
          "FirstNameEmail": "##NAME##johndoe@sample.com",
          "LastName": "##NAME##",
          "LanguageCode": "en",
          "EmailBodyExtraGivenName": "John",
          "DisableEmail": false,
           "AddAndroidAppLink": false,
          "AddIosAppLinkSurname": false"Doe",
          "AddWindowsAppLink": false,
          "AllowDelegation": false,
          "SkipExternalDataValidationLanguageCode": false,"EN"
          "AuthenticationMethods": []
        }
      ],}
      "EmailBodyExtra": "",
      "RecipientType": "Cc",
      "DocumentOptions": [],
 }
           "UseDefaultAgreements": false
    }
  ],
   "AddFormFields": {
    "Forms": {}
  },
  "OverrideFormFieldValues": {
    "Forms": {}
  },
  "AttachSignedDocumentsToEnvelopeLog": false
}
  ]  
}

With this configuration set the signing will be verified. If the signature does not match the others the signature will be rejected! Please see the next figure:

Image RemovedSignature Verification FailedImage Added