Skip to main content

Verifai Android SDK 6​

V6 Summary​

  • The main Verifai Core and Verifai NFC flows now use the Verifai API to process the result of the scan.
    • Once the Core or NFC modules finish a scan it will be uploaded to the Verifai API for further processing. Once this process finishes the web hook (that you configured) will be called and the result can be retrieved.
    • The Liveness Check continues to use a local result processing mechanism. This will be updated in the fitter to also use the Verifai API.
    • The result objects have been updated and provide some simple default result information.
  • The local processing start functions have been renamed to startLocal.
    • These provide a local processing solution like in versions pre 6.0.0.
    • There are also new local processing result objects.
  • When starting a scan there are 2 modules you can use.
    • Call the start function from the Core module if you only need a basic scan.
    • If you also need an NFC scan then call the start function in the NFC module. The NFC module will take care of doing a Core scan as well. So it is no longer necessary to call the Core module before doing an NFC scan, the NFC start or startLocal functions will take care of everything.
  • The result objects have been simplified and a lot of values have been renamed for clarity.
  • Every module now has its own configuration object that can be passed to the module before starting, to configure properties of the flow, like data handling or data saving.

The Android SDK major version has increased from 4 to 6 to be the same as its iOS counterpart.

6.0.0​

Changes:

  • Core

    • VerifaiConfiguration has been renamed CoreConfiguration. -enablePostCropping has been renamed to enableCropping.
      • requireMRZContents has been renamed to requireMrz.
      • readMRZContents has been removed.
      • documentFiltersAutoCreateValidators has been renamed to autoCreateValidators.
      • enableManual has been renamed to enableManualFlow.
    • Added CoreResult object with some preliminary result information when using the Verifai API.
    • Wherever present any mention of licence has been renamed to license.
    • In the VerifaiMrzModel object the firstName and lastName values have been removed. Please use givenNames and surname.
    • Some values in the instruction screen and scan help settings have been renamed (instructionScreenConfiguration):
    • documentChooserTabBarInstruction screen has been renamed to documentPickerInstruction. The defaultMode instruction screen type has been renamed to defaultScreen.
      • The customLocal instruction screen type has been renamed to custom.
      • The customWeb instruction screen type has been renamed to web.
      • mp4FileName has been renamed to mp4VideoResource.
      • titleText has been renamed to title.
      • headerText has been renamed to header.
      • continueButtonLabelText has been renamed to ContinueButtonLabel.
    • Validators:
      • AllowLists/BlockList has been renamed to Allowlist/Blocklist.
      • drivingLicenceValidator has been deleted from Android.
      • mrzCorrectValidator has been deleted from Android.

  • NFC

    • Added NFCConfiguration object.
      • Use this object to setup instruction screens, screen help and data retrieval settings.
      • nfcAvailable has been renamed to isNfcSupported.
      • retrieve/download photo has been renamed to retrieveFaceImage.
    • VerifaiNFCResult has been renamed to LocalNfcResult.
      • mrzMatch has been renamed to isMrzMatch.
      • dataGroupHashesValid has been renamed to areDataChecksumsValid.
      • bacSuccess has been removed. Use bacStatus to check for a successful BAC attempt.
      • activeAuthenticationSuccess has been removed. Use activeAuthenticationStatus to check how the active authentication test went.
      • chipAuthenticationSuccess has been removed. Use chipAuthenticationStatus to check how the chip authentication check went.
      • documentSignatureCorrect has been renamed to isDocumentSignatureCorrect.
      • documentCertificateValid has been renamed to isDocumentCertificateValid.
      • signingCertificateMatchesWithParent (ex isCountrySignatureCorrect) has been renamed to countrySignatureStatus.
      • photo has been renamed to faceImage.
      • dataGroupHashesValid has been renamed to areDataChecksumsValid.
      • In VerifaiBacStatus the randomFailed enum value has been removed.
      • The following properties have been removed:
        • dataGroups
        • documentCertificate
        • dataGroupHashes
        • sodHashes
        • sodData
        • aaDigestAlgorithm
        • chipAuthenticationOid
        • scanCompleted
      • Added NfcResult object with some preliminary result information when using the Verifai API.

  • Liveness

    • Added LivenessCheckConfiguration object to configure the Liveness Check module. Here you can set the check result paths and dismiss / skip button behaviour.
    • In the start function requirements has been renamed to livenessChecks.
    • angle/faceAngleRequirement has been renamed faceAngle + added a default min angle.
    • duration has been renamed to numberOfSeconds.
    • resultUrl has been renamed to resultPath.
    • automaticChecksPassed has been renamed to allChecksPassed.
    • resultBlock has been renamed to listeners.
    • screenInstructions has been renamed to instructions.
    • matches has been renamed to match.