For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Watch this repo to be notified when new versions of the android SDK are available.
We are continually releasing fixes and updates which improve the end user experience. We recommend staying up-to-date with releases to make sure you are taking advantage of the latest functionality and improvements.
Best practices for keeping the Android SDK updated
Keeping your SDK up to date is essential for ensuring your app remains secure, performant, and compatible with the latest Android versions and Persona features. Here are a few best practices we recommend:
⏱ Schedule regular updates as part of your sprint or release cycle — aim for monthly or quarterly.
Note: The Android SDK is distributed via Maven. This GitHub repo exists only to provide changelogs and release tracking.
📓 Read the changelog thoroughly to catch new features, deprecations, and breaking changes.
✅ Test safely in your CI/CD pipeline—include functional, performance, and security tests before production deploy.
Adopting these habits reduces surprises and keeps your release process smooth.
Changes
[v2.42.0] - 2026-05-19
Added
Added File Upload Component in UI Step
Changed
Updated the selfie instructions animation so the preview matches the pose sequence the user is about to perform.
Fixed
Limit the number of retries to 3 when a network error occurs to prevent flow from getting stuck.
Fixed NFC scanning sheet styling issues.
Fixed a few rare crashes that can occur when scanning an NFC chip.
[v2.41.0] - 2026-05-06
Added
Added support for phone number silent network authentication during government ID and selfie flows.
Changed
Updated the inquiry footer background and Persona logo colors to match the latest brand specs in light and dark modes.
Fixed
Reduced UI flickering in certain edge cases.
[v2.40.0] - 2026-04-30
Added
Added support for link buttons.
Added optional shareToken parameter on Inquiry.fromTemplate(...), Inquiry.fromTemplateVersion(...), Inquiry.fromInquiry(...), and Inquiry.fromOneTimeLinkCode(...) builders to support redeeming share tokens via the inquiry client.
Added government_id_nfc_scan_front_opened and government_id_nfc_scan_back_opened as local image assets.
Fixed
Fixed NFC reading getting stuck during ID/Passport scan.
Fixed client/server desync during government id autoclassification.
Changed
Style redesigned selfie screens based on SST (server sided theming)
Updated government ID NFC lottie animations.
Updated the Persona branding logo shown in the inquiry footer to the current brand wordmark.
Updated the selfie step instructions and processing animations.
Breaking change The processing animation used in the Selfie step has been changed from raw/pi2_id_scan_loading to raw/pi2_selfie_processing. If you were overriding this resource locally you will need to add a new resource named pi2_selfie_processing to the raw resource folder.
[v2.39.0] - 2026-04-21
Fixed
Fixed a bug where the capture button in the selfie/government ID step did not become disabled once tapped.
[v2.38.0] - 2026-04-16
Added
Added assets/ folder lookup for locally bundled Lottie animations. The SDK now checks assets/ (with original casing) between res/raw/ and the network URL fallback.
Show a red box over certain UI elements when they are focused to improve accessibility. This should only impact keyboard users.
SDK is now available on Maven Central, including snapshot versions during pre-release.
Added support for changing the background color of the country selector on phone number inputs.
Added file too large error message for document step.
[v2.36.0] - 2026-04-03
Changed
Disallow “force dark theme” on the default Inquiry theme to prevent possible contrast issues.
Updated the default fill color for a few icons to reflect currently branding. This only affects icons that are not overwritten with colors from a theme template.
Radio buttons now use the text highlight color if available. They will continue to fall back to the default text color otherwise.
[v2.35.4] - 2026-04-01
This is a technical release of v2.35.3.
[v2.35.3] - 2026-04-01
Fixed
Fixed a bug where bottom sheets sometimes do not fully expand.
[v2.35.2] - 2026-03-30
Fixed
Minor internal bug fixes.
[v2.35.1] - 2026-03-27
Fixed
Fixed an issue where requests to Google Wallet will fail.
[v2.35.0] - 2026-03-27
Added
Added ACCESS_NETWORK_STATE and READ_BASIC_PHONE_STATE permissions to the SDK manifest.
Fixed
Fixed a visual bug where the intensity indicator on the selfie step was wrong.
[v2.34.0] - 2026-03-24
Added
Added failure_default_icon as a local image asset.
Added support for video recording when auto-classification is enabled for Government ID flow
Added support for NFC tips button on the main screen instead of the navigation bar.
Fixed
Fixed a rare crash that can occur when the cancel dialog is shown.
Fixed a bug where the button for the NFC tips bottom sheet may not appear.
Fixed a bug where the NFC component will not auto-transition to the next step if the component is nested with another component.
Fixed a bug where the help button was always visible in inline mode.
[v2.33.1] - 2026-03-11
Changed
Increase the number of attempts to connect with the camera to improve camera compatibility across devices.
Fixed
Fixed a bug where some inquiry settings are not applied when an inquiry is launched via session token.
Fixed a bug where a valid selfie camera could not be found even if one exists.
Fixed a bug where the government ID step would not try to recover from a recoverable error when video capture is enabled.
[v2.33.0] - 2026-03-09
Added
Added support for enabling watermark text overlay for selfie and gov-id flows
Added support for icon styles for government ID step’s ID selector.
Fixed
Fixed a crash when processing camera image buffers.
Fixed a bug where we retry endlessly on 409 errors.
[v2.32.3] - 2026-03-03
Fixed
Fixed a bug where some features were not being enabled when they should be if an inquiry is launched by a one time link or an inquiry token with a session token.
Fixed a bug where some configuration options are not picked up if an inquiry is launched via an inquiry token and a session token.
[v2.32.2] - 2026-02-24
Added
Added support for automatic torch enablement during video flows.
Changed
Updated inquiry-advanced-customizations-impl gov ID hint and success pill styling to match selfie redesign.
Fixed
Fixed NFC scanning issues seen on few other passports.
Fixed a crash when launching an inquiry as a dynamic feature module.
Fixed a bug where integrity checks do not run in certain circumstances.
[v2.32.1] - 2026-02-17
Fixed
Fixed an issue with selfie redesign when activity is killed and restarted.
[v2.32.0] - 2026-02-09
Added
Added .styleVariant(StyleVariant?) to InquiryBuilder and InquiryTemplateBuilder to override automatic handling of light/dark mode. Use StyleVariant.LIGHT or StyleVariant.DARK.
Changed
Updated inquiry-advanced-customizations-impl to match latest UI specs.
Fixed
Fixed a bug where auto-capture stops working when activity is killed and recreated.
[v2.31.0] - 2026-02-02
Changed
Bumped up kotlin version to 2.1.21
Bumped up ksp version to 2.1.21-2.0.2
Removed kotlinx-datetime dependency
Updated inquiry-advanced-customizations-impl to match latest UI specs.
[v2.30.4] - 2026-01-26
Fixed
Fixed a crash when the width or height of a hosted image is set to “auto”.
Fixed a bug where sometimes a transition happens twice when it should only happen once.
[v2.30.3] - 2026-01-20
Fixed
Fixed a bug where the capture method recorded is sometimes incorrect for Government ID steps.
[v2.30.2] - 2026-01-08
Fixed
Fixed a bug where manual capture will not work in the redesigned Selfie flow.
[v2.30.1] - 2026-01-08
Fixed
Fixed a bug where spacers will not work in horizontal stacks.
Fixed a bug with 3rd party digital ID integrations.
[v2.30.0] - 2025-12-16
Changed
Dynamically register NFC broadcast receiver only when NFC scanning screen is visible.
Fixed
Fixed a crash when the NFC scanner screen is open when the app is killed and restored.
Fixed a bug where the NFC scanner will not submit the correct NFC data if the scanner screen is killed and restored.
Fixed a bug where sometimes multiple NFC scanner screens can be shown.
Add workaround for devices with bad camera sensor data with certain resolutions.
Removed
Breaking Change Removed InquiryBuilder.themeSetId. This method was erroneously added, it can only be passed on inquiry creation and thus only valid on InquiryTemplateBuilder.
[v2.29.1] - 2025-12-03
Fixed
Fixed size attribute being ignored for image hosted components.
[v2.29.0] - 2025-11-24
Added
Added support for an inquiry’s redirect_uri which allows the sdk to redirect upon completion. You can set the redirect URI when creating an inquiry or in your inquiry template’s configuration.
1
Inquiry.fromTemplate(templateId)
2
.redirectUri("http://example.com")
3
.build()
[v2.27.0] - 2025-11-13
Added
Added troubleshooting tips to NFC step
Added progress bar to NFC scanning sheet
Changed
The check animation at the end of the capture in old selfie flows now respects the color that is sent from the server. Note that this means it will no longer be green by default and will instead use your primary icon stroke color defined on your theme.
Changed cancel modal to stack buttons vertically to allow more space to fit longer localized strings.
Fixed
Fixed incorrect overlay is being used for government ID back side capture.
Fixed a bug where GPS requirements are lost on step transition in certain cases.
Fixed a bug where the document step will misbehave if resumed when the file upload limit is 1.
[v2.26.0] - 2025-11-06
Added
Added support for Mdoc component with Google Wallet.
Fixed
Fixed a crash during phone number silent network authentication.
[v2.25.5] - 2025-10-31
Fixed
Fixed NFC scanning sheet layout issue.
Fixed an issue where NFC scanning remained active even after an error dialog appeared.
[v2.25.4] - 2025-10-30
Fixed
Fixed checkbox styling issue
Fixed a rare crash on the government ID step if the user cancels the inquiry flow immediately after pressing submit.
[v2.25.3] - 2025-10-24
Added
Added an animation to the camera loading for government id captures.
Fixed
Fixed a bug where the webRTC connection would not fully shut down if the inquiry was cancelled while the capture screen was showing.
Fix a back transition issue on the government id step when WebRTC is on.
[v2.25.2] - 2025-10-20
Added
Added support for a short capture tips blurb section below the government id capture feed.
[v2.25.1] - 2025-10-16
Fixed
Fixed memory leak after a selfie inquiry is finished.
[v2.25.0] - 2025-10-10
Fixed
Fixed a visual bug where back captures of gov id images would appear to be slightly cutoff during end user review.
Added
Added sna-impl module that supports Phone Number Silent Network Authentication verification.
Added support for credit card collection.
[v2.24.0] - 2025-09-26
Added
Added onEventListener to Inquiry.
Fixed
Fixed a crash if the Inquiry activity is killed and recreated.
[v2.23.0] - 2025-09-24
Added
Added support for the “address auto-complete method” attribute on address components.
Fixed
Fixed a potential crash in the document step.
[v2.22.2] - 2025-09-16
Fixed
Fixed a bug where the wrong background color was sometimes applied on document steps while in dark mode.
Fixed a bug where the SDK does not send GPS information even if it’s required by the template.
[v2.22.1] - 2025-09-08
Fixed
Changed the SDK to return a SessionTokenError instead of a generic NetworkError if a step transition fails due to an invalid session token.
[v2.22.0] - 2025-09-03
Added
Added Integration Step to support 3rd party integration flows.
Changed
Bumped up the compile SDK from 35 to 36
Bumped up the AGP version from 8.7.3 to 8.9.1
Bumped up androidx.browser:browser library from 1.8.0 to 1.9.0
Disable the switch camera button in the Selfie V1 design for left and right pose capture.
Changed the previews on the selfie review screen to be mirrored horizontally so that previews match the labels.
Fixed
Fix a bug where a transition animation would play when “Verify with Reusable Persona” is clicked but declined.
Fix a bug where selfie capture video recording errors after the app is backgrounded and then brought to the foreground again.
Fix a bug where pressing back on the selfie capture screen will not transition to the instructions screen.
Fix a memory leak on the selfie step.
Apply the correct background color to the government ID NFC modal and the error modal.
Fix a bug where the government ID NFC modal text can be cut off.
[v2.21.1] - 2025-09-24
Fixed
Fixed a potential crash in the document step.
[v2.21.0] - 2025-07-30
Added
Added country picker to Phone Number Input component
Fixed
Fix a crash when upload fails on the government ID step.
Fix a rare crash in the ID NFC scan screen when the app is killed and recreated.
Fix check box being editable even when transitioning to the next UI step.
Fix a minor padding issue with the Selfie V1 design.
Fix a bug where NFC would error on certain days of the month.
Fix a visual bug where errors are not cleared on the address component when they are resolved.
[v2.20.0] - 2025-07-03
Added
Added support for Selfie V1 design.
Fixed
Fix a crash when upload fails on the government ID step.
[v2.19.0] - 2025-07-01
Added
Added support for 16kb page sizes.
Changed
Greatly increased the maximum number of UI components on a UI step before a TransactionTooLargeException exception is hit when the Activity is killed. The approximate increase is about 3x, from ~45 components to a theoretical ~135 components.
Fixed
Fix a crash that can occur after NFC is done scanning when SDK is used within a dynamic feature module.
[v2.18.1] - 2025-06-23
Fixed
Fixed malformed session token returned by InquiryEvent.StartEvent.
[v2.18.0] - 2025-06-20
Added
Added support for downloading and using custom fonts at runtime.
Changed
Breaking change InquiryEvent.StartEvent no longer indicates when an Inquiry is created. Instead the event is fired whenever an Inquiry session is created.
Fixed
Fixed a bug where the wrong background color was being applied to focused elements in input select component dropdowns.
Ensure files created by SDK are deleted once the inquiry completes.
[v2.17.3] - 2025-06-06
Changed
No longer show the add document button if the file limit is reached in a document verification.
[v2.17.2] - 2025-05-23
Fixed
Fixed an issue where localization overrides are not applied correctly when auto-classification is on.
Fixed a crash in the document step when used within a react native project.
[v2.17.1] - 2025-05-15
Fixed
We will now apply theme colors to the default document prompt screen page buttons and image.
Fixed a race condition where a document is not uploaded when there are two or more document steps in an inquiry flow.
[v2.17.0] - 2025-04-30
Changed
Optimized the Sentinel SDK size (~300kb after optimization) by changing module structures.
[v2.16.4] - 2025-04-29
Added
Added support for disabled and errored styles from the server for input select components.
Changed
Modify how component field values are sent up when Reusable Personas is used.
[v2.16.3] - 2025-04-22
Changed
Send component field values of the current screen when Reusable Personas is used.
Fixed
Fixed a bug where auto-capture sometimes would not work on a valid MRZ code.
Fixed a crash when launching an inquiry as a dynamic feature module.
[v2.16.2] - 2025-04-14
Fixed
Fixed a bug where InlineInquiryScreen.goBack() would crash if handleBackPress is set to false.
[v2.16.1] - 2025-04-11
Added
Added .handleBackPress(_) to InlineInquiryBuilder to control whether the inquiry screen should handle back presses when launched inline.
Fixed
Fixed a crash in the document step if the depending project also depends on kotlin-reflect.
Fixed a rare crash on the government ID preview screen.
[v2.16.0] - 2025-04-09
Added
Added .accountReferenceId(_) method to SentinelEvent.Builder for Sentinel SDK. Use this to link a sentinel transaction to an account.
Changed
Update dependencies.
Bumped Kotlin version to version 2.0.21.
Fixed
Fixed a race condition in the document step that can lead to a crash in rare cases.
[v2.15.3] - 2025-04-02
Fixed
Fixed a bug where transitions fail when using a one-time-link code.
[v2.15.2] - 2025-04-01
Fixed
Fixed an issue where the guide image on the government ID capture screen would shrink over time.
[v2.15.1] - 2025-03-31
Changed
Updated some dependencies to their latest patch version to resolve some bugs.
Fixed
Fixed an issue where chevrons would not render in government id type select components on UI steps.
[v2.15.0] - 2025-03-18
Changed
RoutingCountry enum, and InquiryTemplateBuilder.routingCountry(string), InquiryBuilder.routingCountry(string) methods marked as deprecated. These will be fully removed as a breaking change in a coming release, please remove usage now to avoid compilation issues in future.
Hide the hint box on the government ID capture screen if the hint text is empty.
Fixed
Fixed a bug where UI elements are disabled during background polling when they should not be.
[v2.14.4] - 2025-04-14
Fixed
Fixed a bug where InlineInquiryScreen.goBack() would crash if handleBackPress is set to false.
[v2.14.3] - 2025-04-11
Added
Added .handleBackPress(_) to InlineInquiryBuilder to control whether the inquiry screen should handle back presses when launched inline.
Fixed
Fixed a rare crash on the government ID preview screen.
[v2.14.2] - 2025-03-13
Changed
Networking optimizations.
[v2.14.1] - 2025-03-11
Added
Added support for vertical alignment on processing screens.
Added support for auto submit on UI step button components.
[v2.14.0] - 2025-03-10
Changed
Updated the SDK to be compatible for use within an on-demand dynamic feature module.
Fixed
Fixed a rare crash when uploading files in the government ID step.
[v2.13.4] - 2025-02-25
Changed
Inquiries launched in inline mode will no longer automatically remove themselves once the inquiry is complete. It is the responsibility of the implementor to clean up after the inquiry is done.
Changed Sentinel SDK’s API/public interface to Kotlin instead of Java.
Fixed
Fixed a rare crash that can occur at the end of an inquiry.
[v2.13.3] - 2025-02-21
Added
Added support in the Sentinel SDK for Java applications.
[v2.13.2] - 2025-02-20
Changed
Changed government ID auto-classification’s manual classification fallback screen to automatically select the country/ID type if there is only one option.
Fixed
Fixed a bug where checkbox text were not correctly aligned with the checkbox.
[v2.13.1] - 2025-02-11
Fixed
Fixed a crash that occurred on the final steps of inquiries that are “complete” steps rather than “ui” steps.
[v2.13.0] - 2025-02-03
Added
Added the ability for the server to instruct the client to use fallback mode automatically. To use this, either pass in FallbackMode.defer to the .fallbackMode function on the InquiryTemplate builder, or pass in a valid fallback inquiry id (starts with iqfs) and a valid fallback session token (using the .sessionToken function) on the Inquiry builder.
Changed
Improve page transition performance for UI steps.
[v2.12.17] - 2024-12-19
Added
Added support for selfie previews.
Added support for selfie auto-capture customization.
Added support for selfie manual-capture customization.
Fixed
Fixed a minor issue with the Sentinel SDK.
[v2.12.16] - 2024-12-17
Added
Published the Sentinel SDK.
[v2.12.15] - 2024-12-05
Fixed
Fixed a rare issue where the document file select picker might launch multiple times.
[v2.12.14] - 2024-11-27
Changed
Updated the layout for the government ID capture screen to handle smaller screens better.
Updated the layout for the selfie capture screen to handle smaller screens better.
Fixed
Fixed a rare crash when loading custom fonts.
Fixed a bug where a custom font cannot be found.
Fixed a bug where applying a theme when launching an inquiry in inline mode will change the theme of the host activity’s context.
[v2.12.13] - 2024-11-25
Fixed
Fixed a bug where changes to an input select component does not trigger a render update.
[v2.12.12] - 2024-11-15
Changed
Inquiries launched inline will apply the given theme (if any) to the inquiry fragment.
Cancel modal will dismiss if “Cancel” is selected.
Fixed
Fixed an rare/improbable crash in the selfie step.
[v2.12.11] - 2024-10-25
Added
Added an option to use simulated government ID NFC data in sandbox mode to make testing in sandbox mode easier. This option is on by default. The option can be changed by long pressing on the sandbox button.
Added network error logging for diagnostic purposes.
Changed
Update AGP to 8.3.2 and Gradle to 8.7
Update dependencies.
Now returning SessionTokenError for ErrorCode when inquiry is unauthorized.
Fixed
Fixed a bug where a loading indicator is not shown on the submit button if the submit button is nested within a component group.
Fixed a bug where a loading indicator is not shown if the submit button is hidden. In this case, a loading indicator is shown on all components that support it (eg. other buttons).
Fixed a bug where UI steps with government ID NFC will not auto-submit if the submit button is nested within a component group.
[v2.12.10] - 2024-09-30
Fixed
Fixed a bug where the camera preview on the selfie step will not load on certain devices.
[v2.12.9] - 2024-09-27
Fixed
Fixed a class name collision issue when the Inquiry SDK is used with other 3rd party libraries.
[v2.12.8] - 2024-09-13
Added
Added support for header icons specified by the server on the government ID select screen.
[v2.12.7] - 2024-09-09
Added
Added support for field types Choices and MultiChoices.
Added an error dialog when using government ID NFC but the device does not have a NFC reader.
[v2.12.6] - 2024-09-04
Fixed
Fixed a bug where the initial spinner will not spin when using certain versions of Lottie.
[v2.12.5] - 2024-08-29
Added
Added support for collecting GPS data
Added event logs when inquiry is launched inline.
[v2.12.4] - 2024-08-22
Fixed
Fixed a bug where the create reusable Persona sheet would stick around after it dismisses.
Fixed a rare crash that can occur on UI step screens if the app is killed and restored.
Fixed a bug where the government ID NFC hint text is cut off in certain cases.
[v2.12.3] - 2024-08-06
Added
Added options to the inline inquiry builder to toggle whether inline inquiries can control the system UI.
Changed
Updated the design of the government ID NFC bottom sheet.
Marked inline inquiry API as experimental.
Fixed
Style government ID NFC bottom sheet based on SST (server sided theming)
Support markdown on texts for permissions related dialogs.
Fixed a crash that can occur if an inquiry flow errors while the app is in the background.
[v2.12.2] - 2024-07-19
Added
Added support for launching inquiries inline (i.e. within a fragment).
Fixed
Fixed an issue with rendering document icon.
Fixed an issue where the permission dialog overlaps with system UI.
[v2.12.1] - 2024-07-18
This is a technical release of v2.12.0.
[v2.12.0] - 2024-07-01
Added
Added support for Card Access Number authentication for NFC scanning.
Added support for rendering Persona option assets.
Changed
Bumped the server API version.
Added support for the international DB component.
Fixed
Fixed an issue where stroke/fill color overrides were not correctly applied to certain illustrations used in the government ID step.
Fixed an issue where the review capture image flickers.
[v2.11.6] - 2024-04-29
Fixed
Fixed an issue where custom hint assets from the server on pdf417 scans on the government id capture page were not being applied.
Fixed an issue where address autocomplete does not pop up sometimes
Changed
Changed the scan NFC card button to show a progress indicator when transitioning to the next step.
[v2.11.5] - 2024-04-15
Added
Updated internal fallback mode API
[v2.11.4] - 2024-04-11
Fixed
Make sure the header button color from the server is applied on gov id review screens.
[v2.11.3] - 2024-04-09
Added
Added the ability to color the back and cancel buttons on the capture screens via the server.
Changed
Improved the messaging for NFC related errors.
Fixed
Fixed several NFC related bugs.
[v2.11.2] - 2024-04-05
Added
Added ability to configure via the server which data groups are read during an nfc scan.
[v2.11.1] - 2024-04-02
Added
Added the ability to set custom assets via the server for the verification processing animation.
Added the ability to control the layout axis of the buttons on the review captured government id screen via the server.
Added the ability to add optional titles on government id and selfie capture screens.
Added the ability to customize the selfie verification processing loading animation via the server.
Changed
Changes the style of the processing screen when auto-classification is enabled.
[v2.11.0] - 2024-03-27
Added
Added a selfie flow type configurable_poses which randomizes the capturing order of selfie poses.
Added support for auto-classification for government ID steps.
[v2.10.19] - 2024-03-15
Added
Added a stricter condition for autocapture when strict selfie flag is on
Fixed
Fixed a layout bug on the selfie start page where vertical margins were not being applied to text views.
[v2.10.18] - 2024-03-06
Fixed
Fixed an issue where the camera preview for government ID would be cropped if the sweep animation is disabled.
[v2.10.17] - 2024-03-05
Fixed
Addressed an issue with our beta fallback service.
[v2.10.16] - 2024-03-04
Added
Added a way to forcibly cancel all running inquiries within an application by calling Inquiry.cancelRunningInquiries().
[v2.10.15] - 2024-02-28
Fixed
Fixed an issue where the buttons in the review capture screen for government ID steps are in the wrong location.
[v2.10.14] - 2024-02-27
Added
Added a toggle to have the SDK consume any unhandled exceptions via consumeExceptions() on InquiryTemplateBuilder or InquiryBuilder.
Fixed
Fixed an issue where using reusable Personas to complete parts of the inquiry does not work.
[v2.10.13] - 2024-02-20
Fixed
Fixed an issue where the capture button would overlap with other UI elements on devices with small screens.
Fixed an issue where the capture tips modal sometimes appears behind the navigation bar.
Fixed a crash that can occur in the government ID or selfie step if the cancel modal is shown and the app is backgrounded.
[v2.10.12] - 2024-01-23
Added
Added support for the auto-complete flag for reusable Personas.
Added a new graphic for the passport NFC flow.
[v2.10.11] - 2024-01-10
Added
Added highlighted background color for selected item in input select list component.
Added support for localization overrides on government id capture feed instructions.
Support server-side asset configurations for selfie, government ID and document steps.
Support disabled for input select and input multi select.
Support hidden for stack, QRCode, and spacer component.
Support max rows for text area component.
Changed
Added additional default assets for gov id upload flows.
Fixed
Fixed an issue with the navigation bar color on Android API levels 27 to 29 (inclusive).
Fixed an issue in Government ID step where tapping back from the capture screen would cause minor UI issues.
[v2.10.10] - 2023-12-15
Added
Added checkbox group component, which has multi-select feature.
Added support for reusable Personas.
Fixed
Fixed a rare crash when sending users to the NFC settings page. This can happen if NFC is disabled and the user is going through the passport NFC flow.
Fixed some minor cosmetic issues with bottom sheets.
Introduced a workaround for a bug introduced in Lottie 6.2.0 that was causing a crash on the government id capture screen.
[v2.10.9] - 2023-11-27
Added
Added the ability to stream government id and selfie verifications via WebRTC.
Added advanced mask support for MaskedTextInput components.
Added search bar for countries select in GovID
Added support for markdown in checkboxes and radio buttons.
Fixed
Fixed an issue where address auto-complete would not be expanded if there are fields prefilled.
Fixed an issue where the address suggestion dropdown is shown even if no suggestions are available.
Fixed the behaviour of automatically filling in literals for mask text component, following the mask format
Handle out-of-space errors gracefully. An error will be returned by the SDK when the device runs out of disk space.
Improve performance and load times of UI steps, especially on lower end devices.
Prefixed some resources with “pi2” to avoid naming collisions.
[v2.10.8] - 2023-11-02
Fixed
Fixed a crash when using a custom government ID camera preview overlay.
[v2.10.7] - 2023-10-27
Fixed
Fixed an issue where video capture would not be able to find a suitable camera even if one is available.
Fixed an issue where the cancel bottom sheet would not be anchored to the bottom.
Fixed an issue where the address component would not expand.
Fixed an edge case where the manual capture button will not show up when it should.
[v2.10.6] - 2023-10-23
Added
Added the component text area, that will resize automatically when there is multiple lines of text
Fixed
Fixed an issue where users are not asked to enable the microphone permission if they permanently reject the permission. This only applies to video capture flows.
Changed
Display content edge-to-edge.
[v2.10.5] - 2023-10-05
Fixed
Workaround an issue with MLKit when used as a dynamic feature module.
[v2.10.4] - 2023-10-05
Added
Added the ability to style buttons in the cancel modal separately from the general step button styles via the server.
Fixed
Workaround a bug with Android’s dynamic feature plugin. Moved all declarations of content providers to the dynamic-feature module.
[v2.10.3] - 2023-09-27
Added
Added the dynamic-feature module. This module makes it easier to use persona with Android’s dynamic feature plugin.
Changed
Changed video capture to work on devices with no physical microphone.
Downgrade Lottie to 4.2.2 due to some customers having compatibility issues with the latest version of Lottie.
[v2.10.2] - 2023-09-22
Added
Added ability to override device locale via .locale(String) method on InquiryTemplateBuilder or InquiryBuilder.
[v2.10.1] - 2023-09-21
Fixed
Fixed a bug where the error message for required input was not clea red after the input was entered.
Fixed a crash that can occurs if the user presses backspace on the address auto-complete field.
[v2.10.0] - 2023-09-19
Changed
Changed the address input to appear as a single text field initially that can be expanded by the user.
Improved support for Government Id NFC.
[v2.9.2] - 2023-08-31
Added
Added an error code to error results.
Changed
Updated ESignature component styling.
Support the no overlay option for Government ID scan step.
[v2.9.1] - 2023-08-08
Added
Added the ability to color custom SVGs via the server. Note that if loading the local custom asset, the SVG must be placed in the raw resources directory in order for the color replacement to occur since this process does not work on vector drawables.
Changed
Update AGP and Gradle to 8.1.0
Update dependencies.
Fixed
Fixed a crash that occurs when an app is built with R8 full mode.
[v2.9.0] - 2023-07-27
Added
Added the ability to hide local image components based on json logic from the server.
Changed
Update AGP to 8.0.2
[v2.8.3] - 2023-10-13
Added
Added ability to override device locale via .locale(String) method on InquiryTemplateBuilder or InquiryBuilder.
[v2.8.2] - 2023-10-04
Added
Added the ability to style buttons in the cancel modal separately from the general step button styles via the server.
[v2.8.1] - 2023-09-27
Changed
Downgrade Lottie to 4.2.2 due to some customers having compatibility issues with the latest version of Lottie.
[v2.8.0] - 2023-07-20
Added
Added .environmentId on InquiryTemplateBuilder to create inquiries with a specific environment token.
Changed
Breaking change Changed .routingCountry on InquiryTemplateBuilder and InquiryBuilder to accept String instead of enum.
Breaking change Changed SST colors to parse as format #RRGGBBAA instead of #AARRGGBB
From our audit, this change should not affect any customers. If you are affected by this change, please reach out to your account team.
Fixed
Fixed a bug where the values of hidden fields were being submitted to the inquiry.
[v2.7.2] - 2023-07-05
Fixed
Fixed InquiryActivity retention leak introduced in v2.6.0
[v2.7.1] - 2023-06-27
Fixed
Fixed a crash when a PDF417 barcode is scanned but the barcode does not indicate an expiration date.
[v2.7.0] - 2023-06-22
Added
Added .routingCountry to InquiryTemplateBuilder and InquiryBuilder to choose which server region the inquiry is routed to directly.
Fixed
Fixed a bug when passing empty string as sessionToken to InquiryBuilder.
[v2.6.2] - 2023-05-23
Added
Added an experimental feature to allow setting the themeSetId when starting an inquiry. This determines what theme set to read from on the server.
[v2.6.1] - 2023-05-16
Changed
Now setting status bar color to match default background color for initial loading screen.
Try multiple configurations for video capture if the first configuration doesn’t work.
Dismiss capture tips screen on back press instead of navigating back.
Fixed
Fix a possible crash that can occur if using Android Gradle Plugin 8.0.0 on Android 13.
Fix a rare crash with video capture.
Fix a layout bug with margins on input date select components.
[v2.6.0] - 2023-04-14
Changed
UI UPDATES: GOVERNMENT ID CAMERA CAPTURE SCREEN We’ve changed the animation that plays on the screen where the user is asked to take a photo of their government ID. The previous animation featured a line sweeping back and forth, horizontally. This animation has been replaced with a more subtle sweeping animation around the border of the camera preview frame. The new animation is designed to be performant and distraction-free. It is rendered with custom code for better performance.
We’ve also added a button to the government id capture screen that displays capture tips when tapped. This change was made to improve the quality of photos captured by the user.
If you have any questions about these changes, please reach out to your CSM.
Fixed
Fixed a rare native library crash where the native library could not be found due to an incompatible architecture.
[v2.5.1] - 2023-04-06
Changed
Update dependencies.
Fixed
Fixed a bug that would cause government id steps to trigger auto capture immediately if auto capture is disabled.
[v2.5.0] - 2023-04-03
Added
Added the ability to load static templates from bundled json files. This can be accessed with the fromStaticTemplate(staticInquiryTemplate: StaticInquiryTemplate) function. Note that this is currently an experimental feature.
Added support for inquiries that require video capture.
Added functionality to extract text from government documents on the client.
Changed
Upgrade Lottie to 6.0.0.
Fixed
Fixed a crash that could occur when we failed to open a network connection for remote animation assets.
[v2.4.1] - 2023-03-29
Fixed
Return InquiryResponse.Cancel instead of InquiryResponse.Error if the SDK was killed due to an activity starting in a new task. Eg. an activity started with the singleTask flag.
[v2.4.0] - 2023-02-22
Changed
Deprecated the theme(@StyleRes theme: Int) function. theme(themeSource: ThemeSource) should be used instead. Pass in ServerThemeSource(@StyleRes theme: Int) to use theming set in the Persona Dashboard. Pass in ClientThemeSource(theme: Int) with your current client theme id to keep the current behavior that only uses client side theming. Note that ClientThemeSource is also marked as deprecated.
[v2.3.6] - 2023-02-13
Added
Added welsh translations.
Added titles to camera permission modals.
Changed
Update dependencies.
Fixed
Fixed an issue where images could sometimes be cut-off if the value sent from the server was too large.
[v2.3.5] - 2023-01-25
Fixed
Fixed a performance issue with input select bottom sheets that contained a large number of options.
Expose classes of objects returned by collection mode in the SDK.
[v2.3.4] - 2023-01-23
Added
Added the ability to use custom processing animations on the document processing screen.
Added status bar coloring behavior to match the background color of each page automatically when using styles from the server.
Added collection mode. When enabled, the SDK will return all locally collected data from the inquiry on inquiry completion.
Added support for radio button components
[v2.3.3] - 2023-01-17
Fixed
Fixed problems with government id hint capture text alignment and border radii.
[v2.3.2] - 2023-01-12
Fixed
Fixed an issue where centering vertically on pages wasn’t working.
Camera feed radii did not match border radii around the feed.
Apply the correct font family from the server to disclaimer texts on capture steps.
Fixed broken text alignment when supportsRtl is not set to true in the hosting app manifest.
[v2.3.1] - 2023-01-10
Added
Support for various customizations and polish items on document upload steps.
Changed
Improve handling of certain network errors.
Document file uploads will now use progress bars instead of loading spinners.
[v2.3.0] - 2022-12-15
Changed
Make nfc-impl module an extension module that is not include dy default.
Upgraded minimum SDK to 33.
[v2.2.46] - 2022-12-01
Changed
Downgraded minimum SDK from 33.
[v2.2.45] - 2022-11-30
Added
Added some validations for SDK arguments.
Fixed
Fixed a crash when using split screen mode during the government id flow and the screen is resized.
Fixed a crash when split screen is enabled and the permission modal is shown.
[v2.2.44] - 2022-11-18
Fixed
Fixed an issue where the selfie capture progress bar was too thin.
Added
Added support for government id localization overrides.
[v2.2.43] - 2022-11-16
Added
Added the ability to use custom copy for permissions modals via the server.
Added support for rendering QR code components.
Changed
Document verification flow now uploads files prior to submit.
Improve error logging for certain types of errors.
Fixed
Fixed lateinit crash on camera screens.
Fixed a rare network error crash.
Fixed a crash if activity is killed and resumed while permission modal is shown.
Fixed an ANR that can occur if permissions are accepted after the activity has been killed and recreated.
Fixed a bug where input select components would not render correctly if multiple input select components existed on a single screen.
[v2.2.42] - 2022-11-08
Added
Added ability to configure margins on input components via the server.
Added the photo picker as an option when choosing documents to upload.
Added the ability to render the document combined step start screen as a configurable server driven screen.
Added improved error handling for document verification flows.
Changed
Improved accessibility throughout the flows, including talkback, touch target size, and speakable text.
[v2.2.41] - 2022-10-19
Added
Added support for styling image preview borders in document flows.
Added support for customizing cancel modal texts via the server.
Changed
Update dependencies.
Input Select component now has sticky header and blocks clicks on background components.
Fixed
Don’t allow buttons to run up against the edge of the screen when using margins from the server.
[v2.2.40] - 2022-10-04
Changed
Make sure that there is always a minimum built in margin on the selfie start screen page.
[v2.2.39] - 2022-09-29
Fixed
Removed shadow on primary material buttons when using server side theming.
[v2.2.38] - 2022-09-29
Added
Added support for checkbox components in UI steps.
Added support for number only input components in UI steps.
Added support for theming the government id upload flow via the server.
Changed
Now surfacing clearer error message when invalid fields are included on the InquiryBuilder.
Update dependencies.
Fixed
Fixed issues where IO streams were not closed after use.
Added support for the ‘disabled’ field which some components use.
Fixed a bug where date inputs were not disabled while submitting information.
Fixed some minor layout issues on UI steps.
Fixed a line wrapping issue for the month field on date inputs.
Fixed placeholders for address components when country code is not US.
Fixed some layout issues when errors were shown on input fields.
[v2.2.37] - 2022-09-13
Added
Added the ability to style footer components as a bottom presented sheet.
Added support for the ‘hidden’ field which some components use.
Fixed
Fixed an issue where buttons were not getting paddings from the server properly applied.
Fixed an issue where buttons on the final complete screen were being added to footers incorrectly.
Fixed an issue where date input does not display error.
Fixed a crash when using custom styled buttons on API 21.
[v2.2.36] - 2022-09-06
Fixed
Added padding to branding elements to prevent run-up against the edge of the screen
Fixed validation on address input.
Fixed location of disclaimer on government id camera screens.
[v2.2.35] - 2022-09-01
Fixed
Fixed an issue where submit buttons in footer components could get into a state where they appear to spin forever.
Fixed an issue where nested vertical stacks within UI steps would not render properly.
[v2.2.34] - 2022-08-30
Fixed
Fixed a crash when custom text attributes are set on the overlay hint of the government ID capture screen.
[v2.2.33] - 2022-08-30
Fixed
Fixed a bug where background images and colors wouldn’t stretch to fill the screen.
[v2.2.32] - 2022-08-29
Changed
Autosubmit confirmation code after it has been typed in.
Confirmation code fields now paste properly and align with expected behavior when deleting and changing numbers.
Give a default margin of 24dp to footers
Fixed
Fixed a crash related to lottie.
Fixed text layouts when the device is set to render large font sizes for accessibility.
Fixed a bug that caused inquiries which contained back-to-back combined steps of the same type to hang.
[v2.2.31] - 2022-08-22
Added
Added the ability to render the government id select screen as a more granularly configurable page type
Added the ability to style processing screen text elements via the server
Fixed
Fix a bug where text fields will not retain their state on activity recreate.
Fix a bug where cursor will jump to the front in text fields on text input.
Changed
Downgrade dependency on bouncy castle from jdk18on to jdk15to18.
[v2.2.30] - 2022-08-15
Fixed
Workaround an Android 12 bugs where requesting permissions can cause a memory leak.
Fix a crash that would occur when a selfie/government id flow is launched on a device has no cameras.
Changed
Keep screen on on camera capture screens.
Default assets for government id, selfie, and document processing animations have been updated.
[v2.2.29] - 2022-07-29
Added
Added the ability to control page level vertical alignment via the server
Added the ability to style buttons on the government id capture page via the server
Fixed
Fixed an animation bug on small screens on the review captured image screen.
Swapped the order of the buttons on the permission request bottom sheet to be consistent with Android standards.
Fixed an issue where you couldn’t resume inquiries created in sandbox mode and have the pass/fail toggle show up.
[v2.2.28] - 2022-07-19
Fixed
Fixed a bug where buttons were not being properly aligned when a loading indicator is built into the button.
[v2.2.27] - 2022-07-18
Added
Support configuration to skip the instructions screen for selfie capture.
Fixed
Fixed a bug where the government ID step will send the wrong parameters to the server in certain edge cases.
[v2.2.26] - 2022-07-08
Added
Added the following theme property:
personaInitialLoadingBackgroundDrawable
Added animations when transitioning between screens
Changed
Improve barcode scanning to detect barcodes faster
Removed loading screens when navigating back
Update dependencies
[v2.2.25] - 2022-06-27
Changed
When transitioning to the next step, show a progress bar embedded into the action button as opposed to showing a full screen progress bar.
Fixed
Fix a crash for the document select step when a selected document cannot be opened.
Fix a bug that caused the government ID step to upload one more photo than necessary.
Made lottie animation loading more resilient.
[v2.2.24] - 2022-06-15
Fixed
Confirm back press when users press the back button on transition/load screens.
Disable submit button on document select screen if no documents are selected.
Show an icon for PDF documents selected for the document verification step.
Added
Added a hint shadow that indicates when there is more content to be scrolled.
Match camera feed edge radius and hint box radius to the radius of the capture feed border.
Updated the implementation of government id auto capture to allow server configurability.
Update dependencies
Limit polling for inquiry status update to 90 seconds. Previously there was no time limit.
Update the network write timeout to 1 minute. Previously this was 10 seconds.
[v2.2.23] - 2022-05-24
Added
Added support for the following InquiryField types: date, datetime, float
Changed
Change the government ID select screen to be configurable by the server
Update dependencies
Depend on Kotlin 1.6.10
[v2.2.22] - 2022-05-20
Fixed
Disable back action for government id flows without a back step
Improve handling of network errors
[v2.2.21] - 2022-05-16
Changed
Make the number of images captured for the government id step configurable by the server
Make the manual capture button delay for the government id step configurable by the server
Update the image shown when there was an error verifying the back side of a government id
[v2.2.20] - 2022-05-06
Changed
Allow users to retry navigating between certain steps on recoverable network errors
Allow users to retry uploading government id/document files
Improve network calls so they are more resilient
Update dependency of Coil from 0.12.0 to 2.0.0-rc03
Fixed
Display errors on input fields when there is a user input error
Fix flickering of image/document previews in rare cases.
[v2.2.19] - 2022-04-29
Fixed
Fix the resolution of font names when loading custom font families in texts
[v2.2.18] - 2022-04-27
Changed
Handle more types of network errors
[v2.2.17] - 2022-04-22
Changed
Make the clickable area of the back and close button slightly bigger
Fixed
Fix a race condition crash on the inquiry success screen
[v2.2.16] - 2022-04-20
Added
Added the ability to render markdown on selfie step disclosure text
[v2.2.15] - 2022-04-13
Removed
The following string resources have been removed, their values are now supplied by the server:
pi2_selfie_hold_still
[v2.2.14] - 2022-04-04
Added
Added the following style attribute: personaCenterAlignRemoteAsset
Fixed
Handle 404s more gracefully
[v2.2.13] - 2022-03-30
Changed
Skip government ID select screen if only one ID class is available
Fixed
Allow for server-defined images to have nullable widths/heights without crashing
[v2.2.12] - 2022-03-24
Changed
Selfie manual capture button for the center pose now triggers a capture immediately for behavior consistency. Previously it would trigger a countdown instead.
Fixed
Show users the manual capture button immediately if auto capture cannot be performed on the device
Recover from camera related errors more gracefully, allow users to retake photos on error
[v2.2.11] - 2022-03-22
Changed
Government id list items now use textAppearanceListItem instead of textAppearanceSubtitle1
Selfie capture animations are now customizable via personaSelfieLookLeftLottieRaw and personaSelfieLookRightLottieRaw
When a static image (drawable) is set instead of a Lottie animation via personaSelfieLookLeftDrawable and personaSelfieLookRightDrawable, the animation will not play. Instead, the given static image will be used instead.
Fixed
Respect the values of personaSelfieLookLeftDrawable and personaSelfieLookRightDrawable
Prevent buttons from overlapping with UI elements on government ID flow
[v2.2.10] - 2022-03-16
Changed
Various animations and drawables are more themeable
UI UPDATES: SELFIE CAMERA CAPTURE SCREEN
We’ve made updates to the selfie verification flow to help reduce blurry and repeat pose captures. You’ll notice the following changes to the selfie verification flow:
New selfie animation includes an arrow that points users in the direction they should look for left and right pose capture.
Auto-capture is delayed for left and right pose until each animation plays. In addition, user will be able to clearly preview selfie during capture (blur overlay removed).
If you have any questions about these changes, please reach out to your CSM.
Fixed
Reduce flickering due to re-layouts during first render pass
Title/body text fields can now honor android:textAlignment properly
Improve government ID capture’s user experience on lower end devices; make UI more responsive
Improve the capture speed of government ID auto capture and manual capture
[v2.2.9] - 2022-03-07
Added
Show a (hide-able) cancel “X” on every non-loading screen to match iOS and web
Added support for upload option with government id verification
Changed
Buttons on government id review screen will flow vertically when text is more than one line
Update the cancel sheet’s copy
Fixed
Fix compatibility issues with Lottie 5.0+
Fix layout on government id select screen when no back button is shown
Fix back button on government id review screen
[v2.2.8] - 2022-02-24
Added
Added support for custom government id scanning lottie animation
Added support for custom selfie look left and look right drawable
[v2.2.7] - 2022-02-22
Added
Added support for custom government id overlays and hint animations
Fixed
Allow “center-only” selfie experiences to pass
Fixed crash in government id
[v2.2.6] - 2022-02-16
Added
Various theme attributes have been added
Changed
Default alignment of ui step screens
Country select now presents a bottom sheet instead of a dropdown
[v2.2.5] - 2022-02-11
Added
Auto-capture for center pose selfies
Support for additional government IDs
Citizenship Certificate
Consular ID
Foreigner ID
Health Insurance Card
Long Term Pass
National Bureau of Investigation Certificate
Permanent Account Number card (SSN)
Changed
Autofocus first input field on page load
Only allow digits (0-9) in day/month input fields
[v2.2.4] - 2022-02-04
Added
Added support for custom Selfie animation on selfie start view with
Lottie file personaInquirySelfieLottieRaw
Size between 0.0 and 1.0 for personaInquirySelfieLottieWidthPercent
Removed
The following string resources have been removed, their values are now supplied by the server:
