Android Release Notes

10.3.1

  • Fix insecure object serialization on fragments

10.3.0

  • Changed initialize() to return a deferred result (allow partners to handle errors)

  • Update to Compose Fragment and remove ComposeView

10.2.7

  • Fixed upload bug to retry in case a job already exists but zip was not uploaded

  • Changed MLKit download modules to throw an exception explicitly if download fails

10.2.6

  • Make document captured image confirmation to be optional

10.2.5

  • Fixed a bug where prep upload would not work for previously attempted API requests

10.2.4

Fixed

  • Job status history full data parsing causing a crash during polling

Changed

  • Removed SmileID.setEnvironment() since the API Keys are no longer shared between environments

10.2.3

  • Handle invalid resource IDs

  • Fix fileSavePath not initialized error (missing smile_config.json file)

  • Add missing ActionResult responses

10.2.2

  • Fixed a bug where the BiometricKycViewModel would succeed but use the default error message as it was not being updated when changing state

  • Fixed a bug where SmileID.submitJob would not work for previously attempted API requests

10.2.1

  • Wrap Composables in a Surface for additional background color customization

  • Add metadata support

10.2.0

  • Added an optional "Strict Mode" to SmartSelfie Enrollment and Authentication to achieve better pass rates. Set useStrictMode=true to enable this new, streamlined UI and associated active liveness tasks

10.1.7

  • Fixed a bug where some failed authentication requests were incorrectly handled

  • Fixed a bug where errors with no code were not being handled correctly

  • Fixed a bug on Selfie and Document capture success screen where the message was wrong

  • Fixed a bug where liveness files were missing on document verification jobs

10.1.6

  • Update generic errors with actual platform errors

10.1.5

  • Fixed a bug where MLKit initialization would sometimes fail due to Application Context

  • Verify SDK for Google Play SDK Console

10.1.4

  • Increase network call timeout to 120 seconds

  • Fixed a bug where invalid file paths were returned and retries did not work

  • Update to K2 (aka Kotlin 2.0.0)

  • Update Compose BOM to 2024.05.00

  • Update AndroidX to 1.13.1

  • Update Activity to 1.9.0

  • Update Fragment to 1.7.1

  • Update Datastore to 1.1.1

  • Update Sentry to 7.9.0

10.1.2

  • Better error message when the device is low on storage

  • Fixed a bug where Gallery selection of document images did not work in some cases

10.1.1

  • Fixed a bug where Document Capture would occasionally fail

  • Optimize Bitmap processing for less memory usage and improved quality

  • Fixed a bug where Document Verification would get stuck on the processing screen

10.1.0

  • Added an Offline Mode, enabled by calling SmileID.setAllowOfflineMode(true). If a job is attempted while the device is offline, and offline mode has been enabled, the UI will complete successfully and the job can be submitted at a later time by calling SmileID.submitJob(jobId)

  • Improved SmartSelfie Enrollment and Authentication times by moving to a synchronous API endpoint

  • Made KEY_RESULT constants in Fragments internal to remove a footgun where the constant was easily confused with KEY_REQUEST

  • Improved back button behavior on image confirmation and processing dialogs

  • Fixed a bug where network retries would occasionally fail

  • Bump Compose BOM to 2024.04.00

10.0.4

  • Bump CameraX to 1.3.0

  • Removed cameraConfig from PrepUploadResponse

  • Fixed a bug where, in some cases, logs may not be printed

  • Removed the Skip Button from Back of ID Capture

  • Added instructionsHeroImage as a new parameter to DocumentCaptureScreen

  • Added heroImage as a new parameter to DocumentCaptureInstructionsScreen

  • Updated Document Verification hero images

10.0.3

  • Exposed individual components as Composables

  • Fixed missing allowNewEnroll in Document Verification Fragment

10.0.2

  • Added allowNewEnroll on SmartSelfie, BiometricKYC, DocV and EnhancedDocV

10.0.1

Fixed

  • Marked kotlinx-collections-immutable as an api dependency

10.0.0

Fixed

  • Made code nullable on SmileIDException.Details

Changed

  • Bump Kotlin to 1.9.21

  • Bump Sentry to 7.0.0

Removed

  • Removed model_parameters from PrepUploadRequest

10.0.0-beta14

Added

  • Added missing showInstructions on some Composables

  • Added missing proguard rule and updated consumer rules

  • Added missing parameters on Fragments

Fixed

  • Fixed crash when duplicate images are attempted to be zipped

  • Fixed a bug where some attributes passed in were not respected

  • Fixed a bug when attempting to parcelize SmileIDException

Changed

  • Bump Kotlin to 1.9.20

  • Bump Compose BOM to 2023.10.01

  • Bump AndroidX Activity to 1.8.1

  • Bump AndroidX Fragment to 1.6.2

  • Bump AndroidX Navigation to 2.7.5

  • Bump Sentry to 6.33.1

  • Bump Coil to 2.5.0

  • Changed the OKHTTP call timeout to 60 seconds

  • Rename partnerParams to extraPartnerParams

10.0.0-beta13

Added

  • Added extras as optional params on all job types

  • Added allowAgentMode option on Document Verification and Enhanced Document Verification

10.0.0-beta12

Fixed

  • Fixed a bug where the document preview showed a black box for some older devices

10.0.0-beta11

Fixed

  • Fixed retry document submission on failed document submission

  • Fixed missing entered key in BiometricKYC

10.0.0-beta10

Added

  • Added jobId on SmartSelfieEnrollmentFragment and SmartSelfieAuthenticationFragment

  • Added showInstructions on SmartSelfieEnrollmentFragment

Fixed

  • Fix bug where showAttirubtion was not respected on the Consent Denied screen

Changed

  • Increased selfie capture resolution to 640px

  • Bump Sentry to 6.32.0

  • Bump OkHttp to 4.12.0

10.0.0-beta09

Added

  • Added missing colorScheme and typography parameters on SmileID.BvnConsentScreen

  • Added option to set callback URL using setCallbackUrl(callbackUrl: URL?) method

  • Added EnhancedDocumentVerification support

  • Added Modifier parameter to all Composables

Fixed

  • Updated KDocs with missing parameter descriptions

  • Fix Broken Country Selection on EnhancedKYC and BiometricKYC

  • Update Window Insets to avoid content being drawn under system insets

Changed

  • Show the normal consent screen as part of BVN Verification

  • The parameters of BvnConsentScreen have been updated to support inclusion of the consent screen

  • Bump Compose BOM to 2023.09.02

  • Bump AGP to 8.1.2

  • Bump Sentry to 6.30.0

10.0.0-beta08

Added

  • Global Document Verification support

  • BVN Consent Screen

  • Dependency on org.jetbrains.kotlinx:kotlinx-collections-immutable

Fixed

  • Expose Compose Material 3 as an api dependency

  • A bug where all results were being parsed to JobResult.Entry

Changed

  • Made *Result classes JSON serializable

  • Renamed DocVJobStatusResponse to DocumentVerificationJobStatusResponse

  • Renamed getDocVJobStatus to getDocumentVerificationJobStatus

  • Renamed pollDocVJobStatus to pollDocumentVerificationJobStatus

  • New sealed interface hierarchy for JobResult

    • Renamed DocVEntry to DocumentVerificationJobResult.Entry

    • Renamed JobResult.Entry to SmartSelfieJobResult.Entry

    • Renamed BiometricKycEntry to BiometricKycJobResult.Entry

    • JobResult.Entry is now an interface for all job types

  • Bump Sentry to 6.29.0

  • Bump Compose BOM to 2023.09.01

  • Bump AndroidX Core to 1.12.0

  • Bump AndroidX Lifecycle to 2.6.2

  • Bump AndroidX Navigation to 2.7.2

Removed

  • Removed Document model, so you now pass countryCode and documentType as separate params in SmileID.DocumentVerification

  • filename property from PrepUploadRequest, as it is no longer required

10.0.0-beta07

Added

  • Detection of bad lighting for Document Verification

  • Detection of unfocused states for Document Verification

  • Document detection for Document Verification

Fixed

  • Fix a Document Verification bug where selfie wasn't captured when also capturing the back of an ID

  • Fixed a bug where the document bounding box border was slightly offset from document cutout

  • Fixed a bug where the wrong ImageType was being specified for back of ID images

Changed

  • resultCodes, codes, and BankCode.codes are all now Strings in order to maintain leading 0s

  • Include liveness images for Document Verification jobs, if selfie capture was not bypassed

  • Slightly zoom in on the document capture preview and confirmation

  • Kotlin 1.9.10

  • Bump Compose BOM to 2023.08.00

  • Bump CameraX to 1.2.3

  • Bump AndroidX Navigation to 2.7.1

10.0.0-beta06

Fixed

  • Added OkHttp as an api dependency

  • Updated LoadingButton visibility modifier

Changed

  • Switch from Java 17 to Java 11 to support Flutter

  • Allow passing in a custom Config instance to SmileID.initialize

  • Bump coroutines to 1.7.3

  • Bump Sentry to 6.28.0

  • Bump AndroidX Fragment to 1.6.1

10.0.0-beta05

Added

  • Add helper functions which return a Flow of the latest JobStatus for a Job until it is complete

  • Add a JobStatusResponse interface

  • Enhanced KYC Async API endpoint

Fixed

  • Fixed a bug where id_info was not included in Document Verification network requests

Changed

  • Kotlin 1.9

  • Updated API key exception error message to be actionable

  • SmileID.useSandbox getter is now publicly accessible

  • Bump Sentry to 6.25.2

Removed

  • Removed polling from SmartSelfie Authentication, Document Verification, and Biometric KYC. The returned SmileIDResults will now contain only the immediate result of job status without waiting for job completion

10.0.0-beta04

Added

  • Biometric KYC Fragment

  • Made IdInfo Parcelable

  • Option to disable Instructions Screen on Document Verification and SmartSelfie™

  • Smile ID Attribution

Fixed

  • Fixed bug where Document Captures were incorrectly cropped

  • Marked selfieFile as a required field in the returned DocumentVerificationResult

Changed

  • Updated KDocs

  • Rename ImageType enums to indicate PNGs are no longer supported

  • Bump Gradle to 8.2.1

  • Bump Coroutines to 1.7.2

  • Bump Sentry to 6.25.0

10.0.0-beta03

Added

  • Biometric KYC

  • Document Verification

  • Debounce Selfie Capture directive changes to allow user time to read the directions

  • Set Release property on Sentry for release tracking

  • Products Config API call

  • Services API call

Fixed

  • Fix crash on network retries

  • Don't report IDE Jetpack Compose Preview crashes to Sentry

Changed

  • Breaking: Renamed SmartSelfie Registration to SmartSelfie Enrollment

  • Breaking: Removed "Screen" suffix from SmartSelfie Composables

  • Tweak selfie progress indicator animation

  • Minor update to default colours to add contrast

  • Submit colour liveness images instead of greyscale

  • Update SmartSelfie™ directives copy to be more succinct

  • Changed the order of arguments in Composables to ensure required arguments come first and so that Modifier is the first optional argument

  • Compile against API level 34

  • Bump Gradle to 8.0.2

  • Bump Kotlin to 1.8.22

  • Bump AndroidX Activity to 1.7.2

  • Bump AndroidX Fragment to 1.6.0

  • Bump Compose BOM to 2023.06.01

  • Bump Camposer to 0.2.2

  • Bump Sentry to 6.24

10.0.0-beta02

Added

  • Add Biometric KYC data models

  • Initial Document Verification screens

Fixed

  • Only allow a single face to be in frame for a SmartSelfie™ capture

Changed

  • Bump Sentry to 6.21.0

10.0.0-beta01

  • Initial Release

  • SmartSelfie™ Authentication and Registration

  • Enhanced KYC

  • Theming

  • Networking

PreviousRelease NotesNextiOS Release Notes

Last updated