Migration Guide

When migrating from version 1 to version 2 the most notable change (depicted in the table below) is the reduction in the number of configuration settings. We have reduced the need to configure many aspects of the web library's behavior and instead have chosen suitable values that produce the best performance. This simplification as well as changing how the document types and steps are configured are the changes your team should be aware of when upgrading.

Configuration Setting	Version 1	Version 2
allowSubmitWithWarnings		X
autoContinue	X	X
autoStart		X
capturingMode	X
chunkPublicPath		X
clickGuidlines	X
displayParsedData	X
documentTypes		X
el	X	X
enableFlash	X
enableGeolocation	X
enableLimitation	X
enableMobileLimitation	X
fixFrontOrientAfterUpload	X	X
isShowDocumentTypeSelect		X
isShowGuidelinesButton	X
isShowManualSwitchButton	X
isShowVersion	X
language		X
licenseKey	X	x
minPDFframes	X
modalPosition		X
networkUrl	X	X
parsePDF	X
parseMRZ	X
playPreviewAnimations		X
priority	X
processingImageFormat		X
realFaceMode	X	X
resizeUploadedImage	X	X
showForceCapturingBtn	X
showPreviewForOneStep	X
showSubmitBtn	X	X
steps	X
strictAllowedTypes	X
tapBackSide	X
tapFace	X
tapOnVideo	X
types	X
useCDN	X	X

The differences are highlighted below with a sample of each configuration side by side.

Version 2 Configuration

Version 2 combines the types array and the steps array, which were used in version 1, into a new array that configures both. This change allows more explicitly configured steps per document type.

documentTypes: [
    {
      type: "ID",
      steps:[
        { type: 'front', name: 'Document Front',
          mode: { uploader: true, video: true },
          autocaptureDelay: 0,
          enableDesktopNotification: true },
        { type: 'pdf', name: 'Document PDF417 Barcode', mode: { uploader: true, video: true } },
        { type: 'face', name: 'Face', mode: { uploader: false, video: true } }
      ]},
    {
      type: "Passport",
      steps:[
        { type: 'mrz', name: 'Passport Front' },
        { type: 'face', name: 'Face' }
      ]},
  ]

Version 1 Configuration

Version 1 has two separate settings for the document types and the steps for the end user to complete before making a submission.

     steps: [
              { type: 'front', name: 'Front Scan' },
              { type: 'face', name: 'Selfie' },
          ],
      types: ['ID','Passport'],