You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+17Lines changed: 17 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,22 @@
1
1
# Changelog
2
2
All notable changes to this project will be documented in this file.
3
+
## [3.0.0] - 2023-02-27
4
+
### Added
5
+
- New language support for Arabic, Dutch, French, German, Italian, Russian, Spanish and Turkish
6
+
- New session statuses for UNSUPPORTED_CONFIGURATION and MANDATORY_DOCUMENT_NOT_PROVIDED
7
+
- New alternative version of the facecapture module without an embedded AI model, which is ~20 MB smaller in size
8
+
9
+
### Changed
10
+
- General improvements and bug fixes
11
+
- Updated Kotlin version to 1.6.21
12
+
13
+
### Migrating from 2.x.x
14
+
- Update the version of the Yoti SDK dependencies in your build.gradle file
15
+
- Update your project's Kotlin version to 1.6 or newer
16
+
- OPTIONAL: If you use yoti-sdk-facecapture, consider the new alternative yoti-sdk-facecapture-unbundled, without an embedded AI model, ~20 MB smaller in size (see README for details)
17
+
- OPTIONAL: If you want to avoid situations where our SDK would be shown in a different language than the one your app is using, you need to declare the languages your app supports (see README for details)
18
+
- OPTIONAL: Handle the new session status codes outlined above and in the README
Copy file name to clipboardExpand all lines: README.md
+51-7Lines changed: 51 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ You have setup the Yoti Doc Scan SDK on your backend, you can find the documenta
26
26
27
27
Minimum Android version supported: 21
28
28
29
-
Currently targeting Android version: 30
29
+
Currently targeting Android version: 32
30
30
31
31
Note: we are using libraries from Android Jetpack. If you are still using the original Android Support Libraries you may encounter some issues when trying to use our SDK.
32
32
We strongly recommend you to migrate your app to the new Androidx libraries: https://developer.android.com/jetpack/androidx/migrate
@@ -55,19 +55,34 @@ Add modules you require to your build.gradle:
As you can see above, there are two options to add the `facecapture` module to your app:
74
+
-`yoti-sdk-facecapture` embeds an AI model for face detection.
75
+
-`yoti-sdk-facecapture-unbundled` will manage the download of the AI model via Google Play Services the first time you start using the AI model and thus is ~20 MB smaller in size. Additionally, you can add the following metadata to your `AndroidManifest.xml` to get the model downloaded as soon as the app is installed:
Also you will need to add the following to your app-level build.gradle file, inside your Android block:
72
87
73
88
```groovy
@@ -184,12 +199,41 @@ class MainActivity : AppCompatActivity() {
184
199
| 5004 | Unexpected internal error | No |
185
200
| 5005 | Unexpected document scanning error | No |
186
201
| 5006 | Unexpected liveness error | No |
202
+
| 5008 | Unsupported configuration | No |
187
203
| 5009 | Storage Error: could not read/write on device app cache | No |
188
204
| 6000 | Document Capture dependency not found error | No |
189
205
| 6001 | Liveness Zoom dependency not found error | No |
190
206
| 6002 | Supplementary document dependency not found error | No |
191
207
| 6003 | Face Capture dependency not found error | No |
208
+
| 7000 | The user does not have the required documents to complete the session | No |
209
+
192
210
211
+
## Supported languages
212
+
Our SDK supports the 9 languages listed in the table below:
213
+
214
+
Language | Code
215
+
:-- | :--
216
+
Arabic | ar
217
+
Dutch | nl
218
+
English (default) | en
219
+
French | fr
220
+
German | de
221
+
Italian | it
222
+
Russian | ru
223
+
Spanish | es
224
+
Turkish | tr
225
+
226
+
The default language we use is English, meaning that if your app supports any extra languages matching the one from the phone's settings, the SDK will fallback to English.
227
+
228
+
If your app does not support one or more languages from the above table and the phone is set to such a language, in order to avoid situations where our SDK would be shown in a different language than the one your app is using, you need to declare the languages your app supports. You can achieve this by adding the following to your `app/build.gradle` file:
229
+
```
230
+
android {
231
+
defaultConfig {
232
+
resConfigs "en", "es", "it" // order does not matter, just add all your supported languages here
233
+
}
234
+
}
235
+
```
236
+
Apart from helping you avoid issues such as the one outlined above, this will strip away all language related resources except for those in the specified list. Thus, you avoid resource contamination and it makes your app smaller in size.
193
237
194
238
## Customisation
195
239
You can customise the appearance of the screens of the SDK by overriding some of the colours.
0 commit comments