CocoaPods

To integrate OZLivenessSDK into an Xcode project via the CocoaPods dependency manager, add the following code to Podfile:

pod 'OZLivenessSDK', :git => 'https://gitlab.com/oz-forensics/oz-liveness-ios', :tag => 'VERSION'

Version is optional as, by default, the newest version is integrated. However, if necessary, you can find the older version number in Changelog.

Since 8.1.0, you can also use a simpler code:

// for the latest version
pod ‘OZLivenessSDK’
// OR, for the specific version
// pod ‘OZLivenessSDK’, ‘8.10.0’

By default, the full version is being installed. It contains both server-based and on-device analysis modes. To install the server-based version only, use the following code:

pod 'OZLivenessSDK/Core', :git => 'https://gitlab.com/oz-forensics/oz-liveness-ios.git',  :tag => 'VERSION'

For 8.1.0 and higher:

pod ‘OZLivenessSDK/Core’
// OR
// pod ‘OZLivenessSDK/Core’, ‘8.1.0’

SPM

Please note: installation via SPM is available for versions 8.7.0 and above.

Add the following package dependencies via SPM: https://gitlab.com/oz-forensics/oz-mobile-ios-sdk (if you need a guide on adding the package dependencies, please refer to the Apple documentation). OzLivenessSDK is mandatory. If you don't need the on-device analyses, skip the OzLivenessSDKOnDevice file.

Manual Installation

You can also add the necessary frameworks to your project manually.

1. Download the SDK files from here and add them to your project.

• OZLivenessSDK.xcframework,

• OZLivenessSDKResources.bundle,

• OZLivenessSDKOnDeviceResources.bundle (if you don't need the on-device analyses, skip this file).

1. Download the TensorFlow framework 2.11 from here.

2. Make sure that:

• both xcframework are in Target-Build Phases -> Link Binary With Libraries and Target-General -> Frameworks, Libraries, and Embedded Context;

• the bundle file(s) are in Target-Build Phases -> Copy Bundle Resources.

To connect SDK to Oz API, specify the API URL and access token as shown below.

OZSDK.setApiConnection(Connection.fromServiceToken(host: "https://sandbox.ohio.ozforensics.com", token: token)) { (token, error) in
}

Alternatively, you can use the login and password provided by your Oz Forensics account manager:

OZSDK.setApiConnection(Connection.fromCredentials(host: “https://sandbox.ohio.ozforensics.com”, login: login, password: p)) { (token, error) in
    // Your code to handle error or token
}

By default, logs are saved along with the analyses' data. If you need to keep the logs distinct from the analysis data, set up the separate connection for telemetry as shown below:

let eventsConnection = Connection.fromCredentials(host: https://tm.ozforensics.com/,
                                login: <your_telemetry_user_eg_tm@company.com>,
                                password: your_telemetry_password)
OZSDK.setEventsConnection(eventsConnection) { (token, error) in
}

To start using Oz iOS SDK, follow the steps below.

1. Embed Oz iOS SDK into your project as described here.

2. Get a trial license for SDK on our website or a production license by email. We'll need your bundle id. Add the license to your project as described here.

3. Connect SDK to API as described here. This step is optional, as this connection is required only when you need to process data on a server. If you use the on-device mode, the data is not transferred anywhere, and no connection is needed.

4. Capture videos by creating the controller as described here. You'll send them for analysis afterwards.

5. Upload and analyze media you've taken at the previous step. The process of checking liveness and face biometry is described here.

6. If you want to customize the look-and-feel of Oz iOS SDK, please refer to this section.

Resources

Minimal iOS version: 11.

Minimal Xcode version: 15 for versions 8.10.0 and newer.

Available languages: EN, ES, HY, KK, KY, TR, PT-BR.

A sample app source code using the Oz Liveness SDK is located in the GitLab repository:

Follow the link below to see a list of SDK methods and properties:

Download the demo app latest build here.

License

You can generate the trial license here or contact us by email to get a productive license. To create the license, your bundle id is required. After you get a license file, there are two ways to add the license to your project.

1. Rename this file to forensics.license and put it into the project. In this case, you don't need to set the path to the license.

2. During the runtime: when initializing SDK, use the following method.

OZSDK(licenseSources: [.licenseFileName(“forensics.license”)]) { licenseData, error in
      if let error = error {
        print(error)
      }
    }

or

OZSDK(licenseSources: [.licenseFilePath(“path_to_file”)]) { licenseData, error in
      if let error = error {
        print(error)
      }
    }

LicenseSource a source of license, and LicenseData is the information about your license. Please note: this method checks whether you have an active license or not and if yes, this license won't be replaced with a new one. To force the license replacement, use the setLicense method.

In case of any license errors, the system will use your error handling code as shown above. Otherwise, the system will return information about license. To check the license data manually, use OZSDK.licenseData.

Possible License Errors

Master license is the offline license that allows using Mobile SDKs with any bundle_id, unlike the regular licenses. To get a master license, create a pair of keys as shown below. Email us the public key, and we will email you the master license shortly after that. Your application needs to sign its bundle_id with the private key, and the Mobile SDK checks the signature using the public key from the master license. Master licenses are time-limited.

Generating Keys

This section describes the process of creating your private and public keys.

Creating a Private Key

To create a private key, run the commands below one by one.

openssl genpkey -algorithm RSA -outform DER -out privateKey.der -pkeyopt rsa_keygen_bits:2048
# for MacOS
base64 -i privateKey.der -o privateKey.txt
# for Linux 
base64 -w 0 privateKey.der > privateKey.txt

You will get these files:

• privateKey.der is a private .der key;

• privateKey.txt is privateKey.der encoded by base64. This key containing will be used as the host app bundle_id signature.

File examples:

The OpenSSL command specification: https://www.openssl.org/docs/man1.1.1/man1/openssl-pkcs8.html

Creating a Public Key

To create a public key, run this command.

openssl rsa -pubout -in privateKey.der -out publicKey.pub

You will get the public key file: publicKey.pub. To get a license, please email us this file. We will email you the license.

File example:

SDK Integration

SDK initialization:

OZSDK(licenseSources: [LicenseSource], masterLicenseSignature: String? = nil, completion: @escaping ((LicenseData?, LicenseError?) -> Void))

License setting:

setLicense(licenseSource: LicenseSource, masterLicenseSignature: String? = nil)

Prior to the SDK initializing, create a base64-encoded signature for the host app bundle_id using the private key.

Signature creation example:

private func getSignature() -> String? {
    let privateKeyBase64String = "the string copied from the privateKey.txt file"
    // with key example:
    // let privateKeyBase64String = "MIIEogIBAAKCAQEAvxpyONpif2AjXiiG8fs9pQkn5C9yfiP0lD95Z0UF84t0Ox1S5U1UuVE5kkTYYGvS2Wm7ykUEGuHhqt/PyOAxrrNkAGz3OcVTsvcqPmwcf4UNdYZmug6EnQ5ok9wxYARS0aYqJUdzUb4dKOYal6WpHZE4yLx08R0zQ5jPkg5asT2u2PLB7JHZNnXwBcvdUonAgocNzdakUbWTNHKMxjwdAvwdIICdIneLZ9nCqe1d0cx7JBIhLzSPu/DVRANF+DOsE9JM8DT/Snnjok2xXzqpxBs1GwqiMJh98KYP78AVRWFuq3qbq0hWpjbq+mWl8xa7UMv8WxVd4PvQkWVYq/ojJwIDAQABAoIBAEvkydXwTMu/N2yOdcEmAP5I25HQkgysZNZ3OtSbYdit2lQbui8cffg23MFNHA125L65Mf4LWK0AZenBhriE6NYzohRVMf28cxgQ9rLhppOyGH1DCgr79wiUj02hVe6G6Qkfj39Ml+yvrs7uS0NMZBQ89yspRNv4t8IxrsWXc8cNQr33fdArlZ021Z12u2wdamaagiFwTa6ZYcQ5OYl3d/xL+oAwf9ywHwRrVM2JksGCxrcLJ7JCOL6lLyjp8rRrIG4iZ1V8YDfUNHmwD4w1fl30H6ejA+Cy5qge7CBZK+hqKr+hOcfBfakfOtgcEbFq2L8DqHoSaTeY6n9wjPJiFrkCgYEA8fc/Cg+d0BN98aON80TNT+XLEZxXMH+8qdmJYe/LB2EckBj1N0en87OEhqMFm9BjYswGf/uO+q2kryEat1n3nejbENN9XaO36ahlXTpQ6gdHO3TuO+hnnUkXeUNgiGYs+1L8Ot6PuNykwL0BZ09U0iBVoawEjTAg9tLNfVW2upsCgYEAyi/75YFT3ApxfSf/9XR74a0aKrfGGlBppcGvxuhVUC2aW2fPEZGXo4qlEhP2tyVTfj78F2p0Fnf3NSyvLZAzSwKo4w8EyZfXn1RI4sM95kzIMhH3Gz8VxCZWKEgr7cKNU5Zhs8un/VFd9Mc0KyZfmVy4VrZ5JumgahBRzSn9zGUCgYA7TTt3/cfRvVU6qbkajBw9nrYcRNLhogzdG+GdzSVXU6eqcVN4DunMwoySatXvEC2rgxF8wGyUZ4ZbHaPsl/ImE3HNN+gb0Qo8C/d719UI5mvA2LGioRzz4XwNTkQUaeZQWlBTJUTYK8t9KVV0um6xaRdTnlMnP0p088lFFILKTQKBgDsR98selKyF1JBXPl2s8YCGfU2bsWIAukz2IG/BcyNgn2czFfkxCxd5qy5z7LGnUxRgPHBu5oml9PBxJKDwLzwsA8GKosBu/00KZ9zwY8ZECn0uaH5qWOacuLE+HK9zFq0kE1lfF65XtlaMWH5+0JFS2HxlBVJMEVTLfcquCPtNAoGAG6ytPm24AS1satPwlKnZODQEg0kc7d5S42jbt4X7lwICY/7gORSdbNS8OmrqYhP/8tDOAUtzPQ20fEt43/VA87bq88BVzoSp4GVQcSL44MzRBQHQwTVkoVnbCXSD9K9gZ71wii+m+8rZZ0EMdiTR3hsRXRuSmw4t8y3CuzlZ9k4="
    guard let data = Data(base64Encoded: privateKeyBase64String, options: [.ignoreUnknownCharacters]) else {
      return nil
    }
     
    let sizeInBits = data.count * 8
    let keyDict: [CFString: Any] = [
      kSecAttrKeyType: kSecAttrKeyTypeRSA,
      kSecAttrKeyClass: kSecAttrKeyClassPrivate,
      kSecAttrKeySizeInBits: NSNumber(value: sizeInBits)
    ]
     
    var error: Unmanaged<CFError>?
    guard let secKey = SecKeyCreateWithData(data as CFData, keyDict as CFDictionary, &error) else {
      return nil
    }
     
    guard let bundleID = Bundle.main.bundleIdentifier else {
      return nil
    }
    guard let signature = SecKeyCreateSignature(secKey,
                          .rsaSignatureMessagePKCS1v15SHA512,
                          Data(bundleID.utf8) as CFData,
                          &error) else {
      return nil
    }
    return (signature as Data).base64EncodedString()
  }

Pass the signature as the masterLicenseSignature parameter either during the SDK initialization or license setting.

If the signature is invalid, the initialization continues as usual: the SDK checks the list of bundle_id included into the license like it does it by default without a master license.

Create a controller that will capture videos as follows:

let actions: [OZVerificationMovement] = [.selfie]
let ozLivenessVC: UIViewController = OZSDK.createVerificationVCWithDelegate(self, actions: actions)
self.present(ozLivenessVC, animated: true)

action – a list of user’s while capturing the video.

Once video is captured, the system calls the onOZLivenessResult method:

extension viewController: OZLivenessDelegate {
 func onError(status: OZVerificationStatus?) {
        // show error
   }
 }
 func onOZLivenessResult(results: [OZMedia]) {
   // proceed to the checks step
 }
}

The method returns the results of video capturing: the [] objects. The system uses these objects to perform checks.

If a user closes the capturing screen manually, the failedBecauseUserCancelled error appears.

To customize the Oz Liveness interface, use OZCustomization as shown below. For the description of customization parameters, please refer to iOS SDK Methods and Properties.

// customization parameters for the toolbar
let toolbarCustomization = ToolbarCustomization(
   closeButtonIcon: UIImage(named: "example"),
   closeButtonColor: .black.withAlphaComponent(0.8),
   titleText: "",
   titleFont: .systemFont(ofSize: 18, weight: .regular),
   titleColor: .gray,
   backgroundColor: .lightGray)

// customization parameters for the center hint
let centerHintCustomization = CenterHintCustomization(
   textColor: .white,
   textFont: .systemFont(ofSize: 22, weight: .regular),
   verticalPosition: 42,
   backgroundColor: UIColor.init(hexRGBA: "1C1C1E8F")!,
   hideTextBackground: false,
   backgroundCornerRadius: 14)
   
// customization parameters for the center hint animation
let hintAnimationCustomization = HintAnimationCustomization(
    hideAnimation: false,
    animationIconSize: 80,
    toFrameGradientColor: UIColor.red)

// customization parameters for the frame around the user face
let faceFrameCustomization = FaceFrameCustomization(
   strokeWidth: 4,
   strokeFaceAlignedColor: .green,
   strokeFaceNotAlignedColor: .red,
   geometryType: .rect(cornerRadius: 10),
   strokePadding: 3)

// customization parameters for the SDK version text
let versionCustomization = VersionLabelCustomization(
   textFont: .systemFont(ofSize: 12, weight: .regular),
   textColor: .gray
)

// customization parameters for the background outside the frame
let backgroundCustomization = BackgroundCustomization(
   backgroundColor: .lightGray
)

// customization parameters for the antiscam protection text
let antiscamCustomization: AntiscamCustomization = AntiscamCustomization(
  customizationEnableAntiscam: false,
  customizationAntiscamTextMessage: "Face recognition",
  customizationAntiscamTextFont: UIFont.systemFont(ofSize: 15, weight: .semibold),
  customizationAntiscamTextColor: UIColor.black,
  customizationAntiscamBackgroundColor: UIColor.init(hexRGBA: "F2F2F7FF")!,
  customizationAntiscamCornerRadius: 18,
  customizationAntiscamFlashColor: UIColor.init(hexRGBA: "FF453AFF")!)

// customization parameters for your logo
// should be allowed by license
let logoCustomization = LogoCustomization(image: UIImage(), size: CGSize(width: 100, height: 100))

OZSDK.customization = Customization(toolbarCustomization: toolbarCustomization,
                   antiscamCustomization: antiscamCustomization,
                   centerHintCustomization: centerHintCustomization,
                   hintAnimationCustomization: hintAnimationCustomization,
                   faceFrameCustomization: faceFrameCustomization,
                   versionCustomization: vesrionCustomization,
                   backgroundCustomization: backgroundCustomization,
                  logoCustomization: logoCustomization)

If you want to get back to the previous (up to 6.4.2) versions' design, reset the customization settings of the capture screen and apply the parameters that are listed below.

// customization parameters for the toolbar
let toolbarCustomization = ToolbarCustomization(
   closeButtonColor: .white,
   backgroundColor: .black)

// customization parameters for the center hint
let centerHintCustomization = CenterHintCustomization(
   verticalPosition: 70)
   
// customization parameters for the center hint animation
let hintAnimationCustomization = HintAnimationCustomization(
    hideAnimation: true)

// customization parameters for the frame around the user face
let faceFrameCustomization = FaceFrameCustomization(
   strokeWidth: 6,
   strokeFaceAlignedColor: .green,
   strokeFaceNotAlignedColor: .red)

// customization parameters for the background outside the frame
let backgroundCustomization = BackgroundCustomization(
   backgroundColor: .clear)

OZSDK.customization = OZCustomization(toolbarCustomization: toolbarCustomization,
   centerHintCustomization: centerHintCustomization,
   hintAnimationCustomization: hintAnimationCustomization,
   faceFrameCustomization: faceFrameCustomization,
   versionCustomization: vesrionCustomization,
   backgroundCustomization: backgroundCustomization)

Please note: this feature has been implemented in 8.1.0.

To add or update the language pack for Oz iOS SDK, use the set(languageBundle: Bundle) method. It shows the SDK that you are going to use the non-standard bundle. In OzLocalizationCode, use the custom language (optional).

• If you don’t set the custom language and bundle, the SDK uses the pre-installed languages only.

• If the custom bundle is set (and language is not), it has a priority when checking translations, i.e, SDK checks for the localization record in the custom bundle localization file. If the key is not found in the custom bundle, the standard bundle text for this key is used.

• If both custom bundle and language are set, SDK retrieves all the translations from the custom bundle localization file.

A list of keys for iOS:

The keys Action.*.Task refer to the appropriate gestures. Others refer to the hints for any gesture, info messages, or errors.

When new keys appear with new versions, if no translation is provided by your custom bundle localization file, you’ll see the default (English) text.

If you use our SDK just for capturing videos, omit this step.

To check liveness and face biometry, you need to upload media to our system and then analyze them.

Below, you'll see the example of performing a check and its description.

let analysisRequest = AnalysisRequestBuilder()
// create one or more analyses
let analysis = Analysis.init(
	media: mediaToAnalyze, // mediaToAnalyze is an array of OzMedia that were captured or otherwise created
	type: .quality, // check the analysis types in iOS methods
	mode: .serverBased) // or .onDevice if you want the on-device analysis
analysisRequest.uploadMedia(mediaToAnalyze)
analysisRequest.addAnalysis(analysis)
// initiate the analyses
analysisRequest.run(
	statusHandler: { state in }, // scenario steps progress handler
	errorHandler: { _ in }  
) { result in
    // receive and handle analyses results here 
}

To delete media files after the checks are finished, use the cleanTempDirectory method.

Adding Metadata

To add metadata to a folder, use AnalysisRequest.addFolderMeta.

let analysis = Analysis.init(media: mediaToAnalyze, type: .quality, mode: .serverBased)
var folderMeta: [String: Any] = ["key1": "value1"]
analysisRequest.addFolderMeta(folderMeta)
...

Extracting the Best Shot

In the params field of the Analysis structure, you can pass any additional parameters (key + value), for instance, to extract the best shot on the server side.

let analysis = Analysis.init(media: mediaToAnalyze, type: .quality, mode: .serverBased, params: [“extract_best_shot” : true])

Using Media from Another SDK

To use a media file that is captured with another SDK (not Oz iOS SDK), specify the path to it in the OzMedia structure (the bestShotURL property):

let referenceMedia = OZMedia.init(movement: .selfie,
                  mediaType: .movement,
                  metaData: ["meta":"data"],
                  videoURL: nil,
                  bestShotURL: imageUrl,
                  preferredMediaURL: nil,
                  timestamp: Date())

Adding Media to a Certain Folder

If you want to add your media to the existing folder, use the addFolderId method:

let analysis = Analysis.init(media: mediaToAnalyze, type: .quality, mode: .serverBased)
analysisRequest.addFolderId(IdRequired)

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

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

• 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

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

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

• Removed the pause after the Scan gesture.

• The code in Readme.md is now up-to-date.

• 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

• 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 this article for details.

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

8.1.0 – Sept. 07, 2023

• Updated the Liveness on-device model.

• Added the Portuguese (Brazilian) locale.

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

• 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:

7.3.0 – June 06, 2023

• Added the center hint background customization.

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

• Added the antiscam widget and its customization. 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.

• 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

• Implemented a range of UI customization options and switched to the new design. To restore the previous settings, please refer to this article.

6.7.0

• The run method now works similar to the one in Android SDK and returns an array of analysis' results.

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.

OZSDK

A singleton for Oz SDK.

Methods

OZSDK

Initializes OZSDK with the license data. The closure is either license data or LicenseError.

Returns

-

setLicense

Forces the license installation.

setApiConnection

Retrieves an access token for a user.

Returns

The access token or an error.

setEventsConnection

Retrieves an access token for a user to send telemetry.

Returns

The access token or an error.

isLoggedIn

Checks whether an access token exists.

Parameters

-

Returns

The result – the true or false value.

logout

Deletes the saved access token

Parameters

-

Returns

-

createVerificationVCWithDelegate

Creates the Liveness check controller.

Returns

UIViewController or an exception.

createVerificationVC

Creates the Liveness check controller.

Returns

UIViewController or an exception.

cleanTempDirectory

Deletes all videos.

Parameters

-

Returns

-

getEventSessionId

Retrieves the telemetry session ID.

Parameters

-

Returns

The telemetry session ID (String parameter).

set

Sets the bundle to look for translations in.

Returns

-

setSelfieLength

Sets the length of the Selfie gesture (in milliseconds).

generateSignedPayload

Generates the payload with media signatures.

Returns

Payload to be sent along with media files that were used for generation.

Properties

localizationCode

SDK locale (if not set, works automatically).

host

The host to call for Liveness video analysis.

attemptSettings

The holder for attempts counts before SDK returns error.

version

The SDK version.

OZLivenessDelegate

A delegate for OZSDK.

Methods

onOZLivenessResult

Gets the Liveness check results.

Returns

-

onError

The error processing method.

Returns

-

AnalysisRequest

A protocol for performing checks.

Methods

AnalysisRequestBuilder

Creates the AnalysisRequest instance.

Returns

The AnalysisRequest instance.

addAnalysis

Adds an analysis to the AnalysisRequest instance.

Returns

-

uploadMedia

Uploads media on server.

Returns

-

addFolderId

Adds the folder ID to upload media to a certain folder.

Returns

-

addFolderMeta

Adds metadata to a folder.

Returns

-

run

Runs the analyses.

Returns

The analysis result or an error.

Customization

Customization for OzLivenessSDK (use OZSDK.customization).

toolbarCustomization

A set of customization parameters for the toolbar.

centerHintCustomization

A set of customization parameters for the center hint that guides a user through the process of taking an image of themselves.

hintAnimationCustomization

A set of customization parameters for the hint animation.

faceFrameCustomization

A set of customization parameters for the frame around the user face.

backgroundCustomization

A set of customization parameters for the background outside the frame.

versionCustomization

A set of customization parameters for the SDK version text.

antiscamCustomization

A set of customization parameters for the antiscam message that warns user about their actions being recorded.

logoCustomization

Logo customization parameters. Custom logo should be allowed by license.

Variables and Objects

enum LicenseSource

A source of a license.

struct LicenseData

The license data.

enum OzVerificationMovement

Contains action from the captured video.

enum OZLocalizationCode

Contains the locale code according to ISO 639-1.

struct OZMedia

Contains all the information on the media captured.

enum MediaType

The type of media captured.

enum OZVerificationStatus

Error description. These errors are deprecated and will be deleted in the upcoming releases.

struct Analysis

Contains information on what media to analyze and what analyses to apply.

enum AnalysisType

The type of the analysis.

enum AnalysisMode

The mode of the analysis.

enum ScenarioState

Shows the media processing status.

struct AnalysisStatus

Shows the files' uploading status.

RequestStatus

Shows the analysis processing status.

ResultMedia

Describes the analysis result for the single media.

RequestResult

Contains the consolidated analysis results for all media.

class AnalysisResult

Contains the results of the checks performed.

enum AnalyseResolutionStatus

The general status for all analyses applied to the folder created.

struct AnalyseResolution

Contains the results for single analyses.

enum GeometryType

Frame shape settings.

enum LicenseError

Possible license errors.

enum Connection

The authorization type.

struct UploadMediaSettings

Defines the settings for the repeated media upload.

enum SizeReductionStrategy

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. By default, the system uploads the compressed video.