Skip to content

Database download methods

The document reader requires a document database of templates.

Runtime download

Usually this file is downloaded in runtime and since it's a large file can take sometime to finish, depending on the user internet. This download will happen in the first run and everytime the database is outdated.

There are two ways to download this file: - By default, the download will happen in the beginning of the document reader - You can trigger this download at anytime in your app by calling the enrolment facade method:

enrolment.startDatabaseUpdate(object: RegulaDatabaseListener {
  override fun onDownloadProgressChanged(progress: Int) {
    Log.i("RegulaDBUpdate", "progress = {$progress}")
  }

  override fun onReady() {
    Log.i("RegulaDBUpdate", "Regula Database updated")
  }

  override fun unableToPrepareDatabase(error: String?) {
    Log.i("RegulaDBUpdate", "error = $error")
  }
})

func startUpdateDatabase(progressHandler: ((Progress) -> Void)?, completion: @escaping (Result<Void, DocumentReaderError>) -> Void)

With this method you can start the download at anytime decreasing the loading time of the document reader.

If you need to stop listening for the download progress, you can remove the callback at anytime by calling the method:

override fun removeDatabaseUpdateListener() {
    enrolment.removeDatabaseUpdateListener(yourListener)
}

At this time it is not possible to remove handlers during the process. They will be automatically removed when the download is completed successfully or in error.

Bundled option

It's also possible to pre-bundle the database into your own application in order to speed document reader init time. Keep in mind that the final apk size will increase significantly using this method.

In order to bundle the database into your application you will need to:

  1. Download the appropriate database:
    • change <your_db> for the appropriate value (example: Full, Passports)
    • check the compatible version (currently 6.1)
    • use the 'url' link to download the database
  2. Depending on your platform, complete the remaining step:

Add the downloaded database file to the app/src/main/assets/Regula folder of the project.

Add the downloaded database file to the desired project's target.

Everytime there's a new version available, Mobile ID SDK will still download the newest version and replace it, so this method requires to manually update the source often in order to be effective.