Skip to content

Upgrade Guide

richardsimongreen edited this page Jul 25, 2024 · 59 revisions

Upgrading to the latest SDK version

Upgrading to earlier SDK versions

For details on upgrading to earlier SDK versions, consult the following:

Generally upgrading iProov SDK over the version supplied by our Partner

This situation is in consideration of a partner library wrapping the iProov SDK in their own SDK to be consumed by an end-integrator app.

It is possible to use gradle to force a newer dependency of iProov SDK in the end-integrator app even when the partner library has an older version. There are many ways to do this, but just adding iProov SDK as a dependency in the app should suffice, as long as it is the same major version. This then allows the end-integrator to benefit from fixes released by iProov sooner than through the Partner.

However, we discovered that a problem exists in 8.x of our SDK such that normally non-breaking additions to the Options would prevent this from happening, which did happen in 8.4.0. This issue will be fixed in the next major release 9.0.0.

For example, version 8.3.2 was created as a hot-fix patch to include features of 8.4.1 without the additional to Options in that version. To use this version you will need to change the repository to the following (since hot-fixes are not on the master branch):

dependencies {
    implementation('com.iproov.sdk:iproov:8.3.2')
}

repositories {
    maven { url 'https://raw.githubusercontent.com/iProov/android/patch832/maven/' }
}

IMPORTANT Don't forget to remove this all when consuming the new Partner SDK.

Upgrading to a new pinned certificate patch version

Please look at this page about updating for use past Dec 2024

Clone this wiki locally