DocumentationAPI Reference
API ChangelogOpenAPIStatus

iOS Changelog

Changes, Fixes, and Features for our iOS SDK.

Releases

Watch this repo to be notified when new versions of the iOS SDK are available.

Changes

[v2.15.1] - 2024-02-06

Fixed

  • Fixed an issue where some German passports would not be able to be scanned over nfc.

[v2.15.0] - 2024-02-02

Added

  • Added improved back button navigation support on gov id, selfie, document steps.

[v2.14.3] - 2024-01-25

Added

  • Added support for rows on text area component

Changed

  • Improved error messaging for Government Id NFC flows.

[v2.14.2] - 2024-01-10

Added

  • Markdown is now supported in checkbox component labels.
  • Added support for localization overrides on government id capture feed instructions.
  • Added support for direction for footer component.

Changed

  • Changed default assets for flows that allow uploading gov id from files or photos.

Fixed

  • Fixed Chinese character input when using Pinyin.
  • Fixed input multi-select sheet behavior.

[v2.14.1] - 2023-12-15

Fixed

  • Fixed a video verification bug that occurs when establishing the webRTC connection.

[v2.14.0] - 2023-12-15

Added

  • Added the component checkbox group, has multi-select feature.
  • Added support for reusable Personas.
  • Added search bar for input select list.
  • Added the ability to stream government id and selfie verifications via WebRTC in the optional PersonaWebRtc framework.
  • Added currency text input components.

Removed

Fixed

  • Fixed styling for radio group component title

[v2.13.0] - 2023-11-10

Added

  • Improved support for advanced masks on MaskedInput components.

Fixed

  • Addressed some retention cycle leaks.
  • Addressed an autocapture issue on iPhone 15 Pro / Pro max.
  • Fixed server side theming of font rendering for languages that use non-uniform character widths (e.g. Thai)

[v2.12.5] - 2023-10-05

Added

  • Added the ability to style buttons in the cancel modal separately from the general step button styles via the server.

[v2.12.4] - 2023-09-21

Added

  • Added ability to override device locale via .locale(String) method on InquiryTemplateBuilder or InquiryBuilder.

Fixed

  • Fixed the crash that occurred when utilizing the remote asset for overlay images during the camera capture step for the Government ID.

[v2.12.3] - 2023-09-18

Fixed

  • Addressed an issue affecting barcode extraction rates in some cases.
  • Fixed a networking error when using Xcode 15.

Changed

  • The popover alert window for govID and document would appear in the middle for iPad, no changes for iPhone
  • Changed the address input to appear as a single text field initially that can be expanded by the user.

[v2.12.2] - 2023-09-01

Changed

  • Now returning PersonaError.rateLimitExceeded instead of PersonaError.networking to InquiryDelegate.inquiryError when API quotas have been exceeded.

[v2.12.1] - 2023-08-24

Changed

  • No longer include CHANGELOG.md (16kb) in our SDK target.
  • No longer including PhoneNumberMetadata.json (310kb) in our SDK target.

[v2.12.0] - 2023-08-18

Added

  • Added the ability to color custom SVGs via the server.
  • Added the ability to add description texts under radio groups and checkbox input components.

Changed

  • Updated ESignature component styling.
  • Are now compiling the Persona SDK with Xcode 14.3.
  • No longer requiring NSPhotoLibraryUsageDescription to access photo library.

[v2.11.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.
    • Before: .routingCountry(RoutingCountry.de) after: .routingCountry(RoutingCountry.de.rawValue)
  • 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 the evaluation of hidden input components.

[v2.10.0] - 2023-06-22

Added

  • Added .routingCountry to InquiryTemplateBuilder and InquiryBuilder to choose which server region inquiry is routed to directly.

[v2.9.1] - 2023-05-23

Added

  • Added a hint on the government id capture screen to notify if the user is not holding the device still.

[v2.9.0] - 2023-05-23

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.

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.
  • Added the ability to record and upload video during the selfie and government id flows.
  • Added a public method assetBundle to InquiryTemplateBuilder to allow setting the bundle from which the SDK retrieves resources. Defaults to Bundle.main.
  • Added capture hints to the government id capture screen.
  • Added a modal for capture help on the government id capture screen.

Changed

  • Changed the default scanning animation on the government id capture screen.
  • Now allowing optionals on InquiryTemplateBuilder and InquiryBuilder methods for convenience.

Fixed

  • Fixed an issue where the status bar text was not being set to the correct color when using server side theming.
  • Fixed spacing on government id select screen when using server side theming.
  • Fixed masked input (ssn) fields submission when submitting as masked.

[v2.8.0] - 2023-04-14

Added

  • Added new InquiryTemplateBuilder and InquiryBuilder to simplify creation of Inquiry objects. Acquire a builder with new Inquiry.from methods.

[v2.7.4] - 2023-04-03

Added

  • Added support for e-signature components.
  • Added functionality to extract text from government documents on the client.

Changed

  • Now respecting the property overrideUserInterfaceStyle on window or view controller that presents the persona flow.

Fixed

  • Fixed a memory leak.

[v2.7.3] - 2023-03-08

Fixed

  • Fixed a layout bug that caused some texts to not render on iOS 14.

[v2.7.2] - 2023-03-06

Fixed

  • Fixed a networking error.

Removed

  • Removed vendorized JsonLogic types from our public interface.

[v2.7.1] - 2023-03-02

Fixed

  • Fixed an issue with app store connect rejecting our framework for usage of CIFalseColor.inputImage.

Removed

  • Removed the dismiss button on permission info modal after App Store Rejection from Apple.
    Per Apple, "A message appears before the permission request, and the user can close the
    message and delay the permission request with the “Don’t Enable” button. The user should
    always proceed to the permission request after the message."

[v2.7.0] - 2023-02-22

Changed

  • Deprecated the InquiryTheme() constructor. The InquiryTheme(themeSource: ThemeSource) constructor should be used instead. Pass in .server to use theming set in the Persona Dashboard. Pass in .client to keep current behavior that uses the client side theming api. Note that .client is also marked as deprecated.

[v2.6.2] - 2023-02-14

Fixed

  • Fixed a weak retention issue that could result in extra callbacks of inquiryError

[v2.6.1] - 2023-02-13

Fixed

  • Fixed buttons inside footer on ui steps will now disable properly after being tapped.

[v2.6.0] - 2023-02-10

Added

  • Added an optional client side callback to return the data collected during the inquiry flow to the host application.

Fixed

  • Remote image assets now match Android / Web loading behavior and height.
  • Selfie flow on iOS Simulator no longer allows you to mash the shutter button and produce a network error.

[v2.5.11] - 2023-01-25

Added

  • Added support for input radio group components.

Fixed

  • Fixed an issue where some camera feeds were not showing previews.

[v2.5.10] - 2023-01-12

Added

  • Added optional parameter, animated, to Inquiry.start() to disable the presentation and dismiss animation when launching the persona flow.

Changed

  • Users will receive an error message when sdk fails to load a photo during document flow instead of flow resulting in an error.

Fixed

  • Improved camera focus for iPhone 13 and 14 Pro / Pro max devices.
  • Now requesting camera permission prior to launching document scanner during document flow.

[v2.5.9] - 2023-01-10

Added

  • Added support for Welsh.

Fixed

  • Fixed a crash on iOS 15 related to usage of Realm.

[v2.5.8] - 2023-01-10

Fixed

  • Fixed a bug with some government id image uploads.
  • Added better error handling when the dimensions of the uploaded government id are not accepted by the server.

[v2.5.7] - 2023-01-06

Fixed

  • Resuming a document flow will now load existing files
  • Fixed various styling and SST properties on document flows

[v2.5.5] - 2022-12-19

Fixed

  • Fixed a bug with checkboxes not applying the correct state.

[v2.5.4] - 2022-12-15

Added

  • Added support for server sheet corner radius style.

[v2.5.3] - 2022-11-30

Changed

  • Improved checkbox component UI and styling

[v2.5.2] - 2022-11-21

Added

  • Added support for government id localization overrides.

Fixed

  • Fixed an issue where Gov id titles and prompts are not visible.
  • Fixed an issue where disabled button text is not visible in dark mode.

[v2.5.1] - 2022-11-18

Added

  • Added support for rendering QR code components.
  • Added improved error handling for document verification flows.
  • Added support for custom start screens on document verificiation flows.

Changed

  • Removed section indexes from country select when there are few countries.

[v2.5.0] - 2022-11-08

Changed

  • Minimum deployment target is now iOS 13.0.

Fixed

  • Fixed an issue where the processing animations stuttered after the camera feed was closed.

Added

  • Added ability to configure margins on input components via the server.

[v2.4.3] - 2022-10-20

Added

  • Added support for customizing cancel modal texts via the server.

[v2.4.2] - 2022-09-30

Added

  • Added the ability to style the upload government id flow via the server.
  • Added support for json logic for hiding and disabling various ui components.
  • Added the ability to use mDLs in the SDK.
  • Added public logging for load times.

Changed

  • Relaxed blur detection on government id autocapture for pro max devices.

Fixed

  • Auto-capture during selfie flow will now pause while user is presented with cancel modal.

[v2.4.1] - 2022-09-23

Changed

  • Moved the Sandbox force verification pass/fail menu to top of screen and added the button to camera screens.
  • Now surfacing clearer error message when invalid fields value is supplied on InquiryConfiguration.

Added

  • Added support for number only input components in UI steps.

Fixed

  • No longer crashing after a user selects a country with no supported id types.

[v2.4.0] - 2022-09-15

Changed

  • Now building the SDK with Xcode 14 in order to make use of iOS 16 features.

Added

  • Added the ability to style footer components as a bottom presented sheet

Removed

  • Removed camera icon from camera permissions modal to be more consistent with other Persona modals.

[v2.3.11] - 2022-10-20

Added

  • Added support for customizing cancel modal texts via the server.

[v2.3.10] - 2022-10-10

These changes have already been released in version 2.4.2 (built with xcode 14). This release is built with xcode 13 for customers who are not yet using xcode 14.

Added

  • Added the ability to style the upload government id flow via the server.
  • Added support for json logic for hiding and disabling various ui components.
  • Added support for number only input components in UI steps.

Changed

  • Relaxed blur detection on government id autocapture for pro max devices.
  • Moved the Sandbox force verification pass/fail menu to top of screen and added the button to camera screens.
  • Now surfacing clearer error message when invalid fields value is supplied on InquiryConfiguration.

Fixed

  • Auto-capture during selfie flow will now pause while user is presented with cancel modal.
  • No longer crashing after a user selects a country with no supported id types.

Removed

  • Removed camera icon from camera permissions modal to be more consistent with other Persona modals.

[v2.3.9] - 2022-09-02

Fixed

  • Fixed a bug in the success checkmark animation so that it shows all 8 of the radiating dots around the check instead of just one.
  • Fixed address component validations.

Changed

  • Render the error text on input select components as red when we have other styles coming from the server.

[v2.3.8] - 2022-08-30

Fixed

  • Fixed a bug where the new processing animation was not being fully configured by colors from the server
  • Fixed a bug with hyperlinks not being tappable

[v2.3.7] - 2022-08-26

Changed

  • Autosubmit confirmation code after it has been typed in.

Added

  • Added the ability to render the government id select screen as a more granularly configurable page type

[v2.3.6] - 2022-08-18

Changed

  • Processing and loading screens have been aligned to center of screen.
  • Selfie completion animation now plays when using static assets.

Added

  • Added the ability to style processing screen text elements via the server

[v2.3.5] - 2022-08-15

Changed

  • Default assets for government id, selfie, and document processing animations have been updated.

Removed

  • Removed unused 'Try again' button after users have denied permissions for the camera.

[v2.3.4] - 2022-08-02

Fixed

  • Fixed a bug where existing document previews were vanishing after deleting a different document.
  • Fixed a layout issue on the selfie start page where text would not be shown correctly when the device screen wasn't large enough to show all of the content.

[v2.3.3] - 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 a bug where document previews were not showing when the chosen file was a PDF.
  • Fixed a bug where government id capture page instructions were not respecting alignment coming from the server.

[v2.3.2] - 2022-07-18

Added

  • Added the following theme property:
    • initialLoadingBackgroundImage
  • Added support for skipping the selfie start page.

Changed

  • The color set for backgroundColor on the theme now applies to the initial loading screen.

Fixed

  • Fixed a bug where new selfie animations where not using server side theming colors (again).

[v2.3.1] - 2022-06-30

Fixed

  • Fixed a bug where new selfie animations where not using server side theming colors.
  • Fixed a bug where selfie consent text was not using appropriate styles.

[v2.3.0] - 2022-06-15

Added

Changed

  • Match camera feed edge radius and hint box radius to the radius of the capture feed border.

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

  • Fixed bug where selfie blur overlay would show up solid black when Reduce Transparency was enabled.
  • Fixed bug where selfie circle animation was not using the correct frame.

[v2.2.13] - 2022-05-26

Added

  • Added the ability to render markdown in body texts and titles.

[v2.2.12] - 2022-05-16

Changed

  • Network requests are now more resilient to connectivity errors and certain server errors are now recoverable.

Fixed

  • Screen layouts has been fixed on first gen iPhone SE.

[v2.2.11] - 2022-04-20

Added

  • Added the ability to render markdown in the selfie step disclaimer

[v2.2.10] - 2022-04-04

Added

  • Added the following theme property: centerAlignRemoteAsset

Changed

  • The loading icon for initial inquiry load has been changed to a neutral grey spinner

[v2.2.9] - 2022-03-29

Fixed

  • No longer returning a status value of "unknown" for inquiryComplete

[v2.2.8] - 2022-03-16

Changed

  • Transitive dependencies have been namespaced to avoid runtime symbol collisions

[v2.2.7] - 2022-03-14

Fixed

  • Dynamic screens use titleTextAlignment and bodyTextAlignment theme properties again
  • Custom animation assets now properly use loopMode on selfie start

Removed

  • No longer showing a failure screen when client side errors occur

[v2.2.6] - 2022-03-07

Added

  • Added option for uploading a government ID from the file system
  • Added improved face detection for government id autocapture
  • Added support for optional cancel buttons
  • Following strings have been added to Persona.strings
    • cancelTitle
    • cancelBody
    • cancelResumeButton
    • cancelConfirmButton

Fixed

  • Fixed back button not appearing on dynamic ui screens
  • Fixed a crash when capturing on old devices
  • Fixed layout for government id select disclaimer text

[v2.2.5] - 2022-03-01

Changed

  • Selfie camera hint style has changed to be consistent with Android

Fixed

  • Fixed government id captures cropping too close to the bottom of the id

[v2.2.4] - 2022-02-24

Added

  • Added the following theme properties:
    • governmentIdOverlayGenericFrontImage
    • governmentIdOverlayBarcodeImage
    • governmentIdOverlayMrzImage
    • selfieStartScreenHeaderIcon

Removed

  • Following strings have been removed from Persona.strings
    • selfieSubmittingTitle
    • selfieSubmittingBody
    • governmentIdSubmittingTitle
    • governmentIdSubmittingBody

[v2.2.3] - 2022-02-16

Added

  • Support for dark mode.

Fixed

  • Improved blur detection during government id auto-capture.

[v2.2.2] - 2022-02-10

Added

  • Added the following theme properties:
    • tableViewChevronColor
  • Added build method to InquiryConfiguration to build a config from all possible parameters.

Fixed

  • Theme property governmentIdHintBackgroundColor is now properly used.

[v2.2.1] - 2022-02-08

Added

  • Added support for optional disclaimer on government id screens
  • Added the following theme properties:
    • governmentIdSelectScreenHeaderIcon
    • governmentIdCaptureDisclaimerIcon
    • governmentIdHintTextAlignment
    • governmentIdHintTextColor
    • governmentIdHintTextFont
    • governmentIdHintBackgroundColor
    • showGovernmentIdHintIcons
  • Added support for SVGs in remote asset components
  • Added the ability to override the following strings:
    • cameraPermissionsTitle
    • cameraPermissionsSelfieText
    • cameraPermissionsGovernmentIdText
    • cameraPermissionsSettingsDescription
    • cameraPermissionsDismissButtonText
    • cameraPermissionsEnableButtonText
    • cameraPermissionsSettingsButtonText
    • cameraPermissionsTryAgainButtonText

Changed

  • Spacing and margins have been adjusted for consistency

Fixed

  • Fixed a bug with address autocomplete

[v2.2.0] - 2022-01-27

Changed

  • Persona module has been renamed to Persona2

[v2.1.3] - 2022-01-25

Added

  • Added the following theme properties:
    • governmentIdCaptureBackgroundColor
    • governmentIdScanningStrokeStyle
    • governmentIdCapturingStrokeStyle
    • governmentIdConfirmingStrokeStyle
    • governmentIdScanningAnimation
    • showGovernmentIdOverlays
    • selfieLookLeftAsset
    • selfieLookRightAsset

Removed

  • Removed the following strings from Persona.strings (unused in dynamic flows):
    • governmentIdStartTitle
    • governmentIdStartBody
    • governmentIdChooseType
    • selfieStartTitle
    • selfieStartBody
    • selfieStartButton

[v2.1.2] - 2021-12-13

Added

  • Added support for server driven localizations on gov id capture screen.
  • Added support for multi-file document uploads.

[v2.1.1] - 2021-11-23

Added

  • The background color for the silhouette overlay, shown when taking automated selfies, can now be themed via selfieOverlayBackgroundColor. If no color is provided, a blur effect is used instead (the default behavior).

Fixed

  • Fixed a bug where form field errors would not be displayed underneath the affected fields.
  • Fixed a bug where certain assets could be rendered at a lower resolution than expected.

[v2.1.0] - 2021-11-16

Added

  • Added themeable text alignment on title and body labels: titleTextAlignment and bodyTextAlignment.
  • Added themeable asset selfieStartAsset for pre-selfie collection screen.
  • Added LoopMode enum for InquiryTheme.AnimationAsset which determines loop mode of animation, defaults to playOnce.
  • Added support for completing an Inquiry without showing the completion screen.
  • Added support for Dynamic Type.
  • Added support for the Reduce Motion accessibility setting.

Changed

  • Attempting to start an Inquiry on templates prefixed with tmpl_ will now fail immediately.
  • Government ID camera capture experience has been redesigned.
  • Improved support for Voice Over.

[v2.0.1] - 2021-09-01

Added

  • Added support for Keypass ID and visa government id types.
  • The footer container now has themable options via footerBackgroundColor, footerBorderColor and footerBorderWidth.

Changed

  • Standard InquiryField key values are now camelCase instead of kebab-case
  • InquiryField enum case values are now optional
  • InquiryDelegate.inquiryComplete parameter status has been made not optional

Fixed

  • Relative links are no longer rendered as links in the PrivacyPolicy component.

[v2.0.0] - 2021-08-06

Added

  • InquiryDelegate.inquiryCanceled now includes a sessionToken parameter to resume the inquiry flow

Changed

  • Support Inquiry templates prefixed with itmpl_ instead of tmpl_
  • InquiryDelegate.inquirySuccess and InquiryDelegate.inquiryFailed are now represented by InquiryDelegate.inquiryComplete with a status of completed or failed (though can be customizable in the future)
  • InquiryDelegate.inquiryCancelled has been renamed to InquiryDelegate.inquiryCanceled
  • Attributes parameter in the inquirySuccess delegate are now a part of inquiryComplete fields parameter

Removed

  • Relationships and the containing list of Verification no longer exists