LogoLogo
To the Oz WebsiteOz API ReferenceContact Us
  • General
    • Oz Liveness and Biometry Key Concepts
      • Solution Architecture
      • Liveness, Face Matching, Black List Checks
      • Passive and Active Liveness
      • Hybrid Liveness
      • Oz API Key Concepts
      • Oz API vs. Oz API Lite
      • SaaS, On-premise, On-device: What to Choose
      • Oz Licensing Options
    • Integration Quick Start Guides
      • Server-Based Liveness
        • How to Integrate Server-Based Liveness into Your Web Application
        • How to Integrate Server-Based Liveness into Your Mobile Application
        • How to Check Your Media for Liveness without Oz Front End
      • On-Device Liveness
        • How to Integrate On-Device Liveness into Your Mobile Application
      • Face Matching
        • How to Add Face Matching of Liveness Video with a Reference Photo From Your Database
        • How to Add Photo ID Capture and Face Matching to Your Web or Mobile Application
  • Guides
    • Developer Guide
      • API
        • Oz API
          • Working with Oz System: Basic Scenarios
            • Authentication
            • Uploading Media
            • Liveness
            • Biometry (Face Matching)
            • Best Shot
            • Blacklist Check
              • Blacklist (Collection) Management in Oz API
            • Quantitative Results
            • Using a Webhook to Get Results
            • Single Request
            • Instant API: Non-Persistent Mode
          • System Objects
          • User Roles
          • Types of Analyses and What They Check
          • Rules of Assigning Analyses
          • Statuses in API
          • Media Tags
          • Metadata
          • API Error Codes
          • Oz API Postman Collections
          • Changelog
        • Oz API Lite
          • API Lite Methods
          • Oz API Lite Postman Collection
          • Changelog
      • SDK
        • Oz Mobile SDK (iOS, Android, Flutter)
          • On-Device Mode
          • Android
            • Getting a License for Android SDK
              • Master License for Android
            • Adding SDK to a Project
            • Connecting SDK to API
            • Capturing Videos
            • Checking Liveness and Face Biometry
            • Customizing Android SDK
              • How to Restore the Previous Design after an Update
            • Android Localization: Adding a Custom or Updating an Existing Language Pack
            • Android SDK Methods and Properties
            • Changelog
          • iOS
            • Getting a License for iOS SDK
              • Master License for iOS
            • Adding SDK to a Client’s Mobile App
            • Connecting SDK to API
            • Capturing Videos
            • Checking Liveness and Face Biometry
            • Customizing iOS SDK Interface
              • How to Restore the Previous Design after an Update
            • iOS Localization: Adding a Custom or Updating an Existing Language Pack
            • iOS SDK Methods and Properties
            • Changelog
          • Flutter
            • How to Install and Use Oz Flutter Plugin
            • Flutter SDK Methods and Properties
            • Changelog
        • Oz Liveness Web SDK
          • Web Plugin
            • Adding the Plugin to Your Web Page
            • Launching the Plugin
              • Description of the on_complete Callback
              • Description of the on_result Callback
              • Capturing Video and Description of the on_capture_complete Callback
              • Description of the on_error Callback
            • Closing or Hiding the Plugin
            • Localization: Adding a Custom Language Pack
            • Look-and-Feel Customization
              • Customization Options for Older Versions (before 1.0.1)
            • Security Recommendations
            • Browser Compatibility
            • No-Server Licensing
          • Changelog
    • Administrator Guide
      • Deployment Architecture
      • Installation in Docker
      • Installation in Kubernetes
      • Performance and Scalability Guide
      • Publishing API Methods in the Internet: Security Recommendations
      • Monitoring
      • License Server
      • Web Adapter Configuration
        • Installation and Licensing
        • Configuration File Settings
        • Configuration Using Environment Variables
        • Server Configuration via Environment Variables
      • Oz API Configuration
    • User Guide
      • Oz Web UI
        • Requesting Analyses
        • Users and Companies
        • Blacklist
        • Statistics
        • Settings
        • Changelog
  • Other
    • Media Quality Requirements
    • Oz SDK Media Quality Checks
    • Media File Size Overview
    • Compatibility
    • FAQ
    • Tips and Tricks
      • Oz Liveness Gestures: Table of Correspondence
      • Sudo without Password
      • Android: Certificate Validation Error
    • Previous Documentation
      • Mobile SDK
        • Android
          • Interactions with the Oz API Server
          • Uploading and Analyzing Media
        • iOS
          • Uploading and Analyzing Media
      • User Guides
        • Oz Demo Kit
        • Web UI
      • Oz Modules Installation
        • Standalone Installer
        • Oz System Lite
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Guides
  2. Developer Guide
  3. SDK
  4. Oz Mobile SDK (iOS, Android, Flutter)
  5. iOS

Changelog

iOS SDK changes

8.16.2 – Apr. 22, 2025

  • Xcode updated to version 16 to comply with Apple requirements.

8.16.1 – Apr. 09, 2025

  • Security updates.

8.16.0 – Mar. 11, 2025

  • Updated the authorization logic.

  • Improved voiceover.

  • SDK now compresses videos if their size exceeds 10 MB.

  • Head movement gestures are now handled properly.

  • Security updates.

8.15.0 – Dec. 30, 2024

  • Changed the wording for the head_down gesture: the new wording is “tilt down”.

  • Added proper focus order for VoiceOver when the antiscam hint is enabled.

  • Added the public setting extract_action_shot in the Demo Application.

  • Bug fixes.

  • Security updates.

8.14.0 – Dec. 3, 2024

  • Accessibility updates according to WCAG requirements: the SDK hints and UI controls can be voiced.

  • Improved user experience with head movement gestures.

  • Minor bug fixes and telemetry updates.

8.13.0 – Nov. 11, 2024

  • The screen brightness no longer changes when the rear camera is used.

  • Fixed the video recording issues on some smartphone models.

  • Security and telemetry updates.

8.12.2 – Oct. 24, 2024

  • Internal SDK improvements.

8.12.1 – Sept. 30, 2024

  • Added Xcode 16 support.

  • Security and telemetry updates.

8.11.0 – Sept. 10, 2024

  • Security updates.

8.10.1 – Aug. 23, 2024

  • Bug fixes.

8.10.0 – Aug. 1, 2024

  • SDK now requires Xcode 15 and higher.

  • Security updates.

  • Bug fixes.

8.9.1 – July 16, 2024

  • Internal SDK improvements.

8.8.3 – July 11, 2024

  • Internal SDK improvements.

8.8.2 – June 25, 2024

  • Bug fixes.

8.8.1 – June 25, 2024

  • Logging updates.

8.8.0 – June 18, 2024

  • Security updates.

8.7.0 – May 10, 2024

  • Added a description for the error that occurs when providing an empty string as an ID in the addFolderID method.

  • Bug fixes.

8.6.0 – Apr. 10, 2024

  • The messages displayed by the SDK after uploading media have been synchronized with Android.

  • The bug causing analysis delays that might have occurred for the One Shot gesture has been fixed.

8.5.0 – Mar. 06, 2024

  • Removed the pause after the Scan gesture.

  • Security and logging updates.

8.4.2 – Jan. 24, 2024

  • Security updates.

8.4.0 – Jan. 09, 2024

  • Changed the default behavior in case a localization key is missing: now the English string value is displayed instead of a key.

  • Fixed some bugs.

8.3.3 – Dec. 11, 2023

  • Internal licensing improvements.

8.3.0 – Nov. 17, 2023

  • Implemented the possibility of using a master license that works with any bundle_id.

  • Fixed the bug with background color flashing.

8.2.1 – Nov. 11, 2023

  • Bug fixes.

8.2.0 – Oct. 30, 2023

  • The Analysis structure now contains the sizeReductionStrategy field. This field defines what type of media is being sent to the server in case of the hybrid analysis once the on-device analysis is finished successfully.

  • The messages for the errors that are retrieved from API are now detailed.

  • The toFrameGradientColor option in hintAnimationCustomization is now deprecated, please use the hintGradientColor option instead.

  • Got back the iOS 11 support.

8.1.1 – Oct. 09, 2023

8.1.0 – Sept. 07, 2023

  • Updated the Liveness on-device model.

  • Added the Portuguese (Brazilian) locale.

  • If a media hasn't been uploaded correctly, the system now repeats the upload.

  • Added a new method to retrieve the telemetry (logging) identifier: getEventSessionId.

  • The setPermanentAccessToken, configure and login methods are now deprecated. Please use the setApiConnection method instead.

  • The setLicense(from path:String) method is now deprecated. Please use the setLicense(licenseSource: LicenseSource) method instead.

  • Fixed some bugs and improved the SDK work.

8.0.2 – Aug. 15, 2023

  • Fixed some bugs and improved the SDK algorithms.

8.0.0 – June 27, 2023

  • Added the new analysis mode – hybrid (Liveness only). If the score received from an on-device analysis is too high, the system initiates a server-based analysis as an additional check.

  • Improved the on-device models.

  • Updated the run method.

  • Added new structures: RequestStatus (analysis state), ResultMedia (analysis result for a single media) and RequestResult (consolidated analysis result for all media).

  • The updated AnalysisResult structure should be now used instead of OzAnalysisResult.

  • For the OZMedia object, you can now specify additional tags that are not included into our tags list.

  • The Selfie video length is now about 0.7 sec, the file size and upload time are reduced.

  • The hint text width can now exceed the frame width (when using the main camera).

  • The methods below are no longer supported:

Removed method

Replacement

analyse

AnalysisRequest.run

addToFolder

uploadMedia

documentAnalyse

AnalysisRequest.run

uploadAndAnalyse

AnalysisRequest.run

runOnDeviceBiometryAnalysis

AnalysisRequest.run

runOnDeviceLivenessAnalysis

AnalysisRequest.run

addMedia

uploadMedia

7.3.0 – June 06, 2023

  • Added the center hint background customization.

  • Added new face frame forms (Circle, Square).

  • Synchronized the default customization values with Android.

  • Added the Spanish locale.

  • iOS 11 is no longer supported, the minimal required version is 12.

7.2.1 – May 24, 2023

  • Fixed the issue with the server-based One shot analysis.

7.2.0 – May 18, 2023

  • Improved the SDK algorithms.

7.1.6 – May 04, 2023

  • Fixed error handling when uploading a file to API. From this version, an error will be raised to a host application in case of an error during file upload.

7.1.5 – Apr. 03, 2023

  • Improved the on-device Liveness.

7.1.4 – Mar. 24, 2023

  • Fixed the animation for sunglasses/mask.

  • Fixed the bug with the .document analysis.

  • Updated the descriptions of customization methods and structures.

7.1.2 – Feb. 21, 2023

  • Updated the TensorFlow version to 2.11.

  • Fixed several bugs, including the Biometry check failures on some phone models.

7.1.1 – Feb. 06, 2023

  • Added customization for the hint animation.

7.1.0 – Jan. 20, 2023

  • Integrated a new model.

  • Added the uploadMedia method to AnalysisRequest. The addMedia method is now deprecated.

  • Fixed the combo analysis error.

  • Added a button to reset the SDK theme and language settings.

  • Fixed some bugs and localization issues.

  • Extended the network request timeout to 90 sec.

  • Added a setting for the animation icon size.

7.0.0 – Dec. 08, 2022

6.7.0

6.4.0

  • Synchronized the version numbers with Android SDK.

  • Added a new field to the Analysis structure. The params field is for any additional parameters, for instance, if you need to set extracting the best shot on server to true. The best shot algorithm chooses the most high-quality frame from a video.

  • Fixed some localization issues.

  • Changed the Combo gesture.

  • Now you can launch the Liveness check to analyze images taken with another SDK.

3.0.1

  • The Zoom in and Zoom out gestures are no longer supported.

3.0.0

  • Added a new simplified analysis structure – AnalysisRequest.

2.3.0

  • Added methods of on-device analysis: runOnDeviceLivenessAnalysis and runOnDeviceBiometryAnalysis.

  • You can choose the installation version. Standard installation gives access to full functionality. The core version (OzLivenessSDK/Core) installs SDK without the on-device functionality.

  • Added a method to upload data to server and start analyzing it immediately: uploadAndAnalyse.

  • Improved the licensing process, now you can add a license when initializing SDK: OZSDK(licenseSources: [LicenseSource], completion: @escaping ((LicenseData?, LicenseError?) -> Void)), where LicenseSource is a path to physical location of your license, LicenseData contains the license information.

  • Added the setLicense method to force license adding.

2.2.3

  • Added the Turkish locale.

2.2.1

  • Added the Kyrgyz locale.

  • Added Completion Handler for analysis results.

  • Added Error User Info to telemetry to show detailed info in case of an analysis error.

2.2.0

  • Added local on-device analysis.

  • Added oval and rectangular frames.

  • Added Xcode 12.5.1+ support.

2.1.4

  • Added SDK configuration with licenses.

2.1.3

  • Added the One Shot gesture.

  • Improved OZVerificationResult: added bestShotURL which contains the best shot image and preferredMediaURL which contains an URL to the best quality video.

  • When performing a local check, you can now choose a main or back camera.

2.1.2

  • Authorization sessions extend automatically.

  • Updated authorization interfaces.

2.1.1

  • Added the Kazakh locale.

  • Added license error texts.

2.1.0

  • You can cancel network requests.

  • You can specify Bundle for license.

  • Added analysis parameterization documentAnalyse.

  • Fixed building errors (Xcode 12.4 / Cocoapods 1.10.1).

2.0.0

  • Added license support.

  • Added Xcode 12 support instead of 11.

  • Fixed the documentAnalyse error where you had to fill analyseStates to launch the analysis.

  • Fixed logging.

PreviousiOS SDK Methods and PropertiesNextFlutter

Last updated 1 month ago

Was this helpful?

The sample is now available on SwiftUI. Please find it .

The length of the Selfie gesture is now (affects the video file size).

You can instead of Oz logo if your license allows it.

The code in is now up-to-date.

If multiple analyses are applied to the folder simultaneously, the system sends them as a group. It means that the “worst” of the results will be taken as resolution, not the latest. Please refer to for details.

For the Liveness analysis, the system now treats the highest score as a quantitative result. The Liveness analysis output is described .

You can now add a custom or update an existing language pack. The instructions can be found .

Added the antiscam widget and its . This feature allows you to alert your customers that the video recording is being conducted, for instance, for loan application purposes. The purpose of this is to safeguard against scammers who may attempt to deceive an individual into approving a fraudulent transaction.

Implemented a range of options and switched to the new design. To restore the previous settings, please refer to .

The run method now works similar to the one in Android SDK and returns an .

here
Readme.md
here
UI customization
this article
this article
here
configurable
set your own logo
customization
array of analysis' results