# Premium SDK - iOS ## Features * [x] Face Detection * [x] Face Liveness Detection * [x] Face Recognition * [x] Pose Estimation * [x] 68 points Face Landmark Detection * [x] Face Quality Calculation * [x] Face Occlusion Detection * [x] Eye Closure Detection * [x] Age, Gender Estimation * [x] Fully-Offline Works and On-Premise ## License We offer `lifetime license(perpetual license)` tied to each `bundle ID` for `iOS` `SDK`s. The license is available with a `one-time payment`—meaning once you purchase it, you can use our `SDK` indefinitely without any recurring fees. To request a license, please contact us: > **Email:** > > **Telegram:** @kbyaisupport > > **WhatsApp:** +19092802609 ## System Requirements * **CPU:** 2 cores or more * **RAM:** 150MB or more * **OS:** iOS 13.0 or later * **Architecture:** arm64-v8a ## Setup 1. Copy the SDK (`facesdk.framework` folder) to the `root` folder of your project. 2. Add `SDK framework` to the project in `Xcode`. > Project Navigator -> General -> Frameworks, Libraries, and Embedded Content

3. Add the bridging header to your project settings > Project Navigator -> Build Settings -> Swift Compiler - General

## Initializing SDK 1. Step one * To begin, you need to activate the SDK using the license that you have received. ```swift FaceSDK.setActivation("...") ``` * If activation is successful, the return value will be `SDK_SUCCESS`. Otherwise, an error value will be returned. 2. Step Two * After activation, call the SDK's initialization function. ```swift FaceSDK.initSDK() ``` * If initialization is successful, the return value will be `SDK_SUCCESS`. Otherwise, an error value will be returned. ## Enums and Classes ### 1. SDK\_ERROR This enumeration represents the return value of the `initSDK` and `setActivation` functions.

Feature	Value	Name
Successful activation or initialization	0	SDK_SUCCESS
License key error	-1	SDK_LICENSE_KEY_ERROR
AppID error (Not used in Server SDK)	-2	SDK_LICENSE_APPID_ERROR
License expiration	-3	SDK_LICENSE_EXPIRED
Not activated	-4	SDK_NO_ACTIVATED
Failed to initialize SDK	-5	SDK_INIT_ERROR

### 2. FaceBox This class represents the output of the `face detection` function that contains the detected `face rectangle`, `liveness score`, and `facial angle`s such as `yaw`, `roll`, and `pitch`\`. | Feature | Type | Name | | ------------------------- | ----- | --------------------- | | Face rectangle | int | x1, y1, x2, y2 | | Face angles (-45 \~ 45) | float | yaw, roll, pitch | | Liveness score (0 \~ 1) | float | liveness | | Face quality (0 \~ 1) | float | face\_quality | | Face luminance (0 \~ 255) | float | face\_luminance | | Face occlusion (0 \~ 1) | float | face\_occlusion | | Eye closure (0 \~ 1) | float | left\_eye, right\_eye | | Mouth opening (0 \~ 1) | float | mouth\_opened | | Age, Gender | int | age, gender | | 68 points facial landmark | Data | landmark |

## APIs ### 1. setActivation To begin, you need to activate the SDK using the license that you have received. ```swift var ret = FaceSDK.setActivation("...") ``` If activation is successful, the return value will be `SDK_SUCCESS`. Otherwise, an error value will be returned. ### 2. initSDK After activation, call the SDK's initialization function. ```swift ret = FaceSDK.initSDK() ``` If initialization is successful, the return value will be `SDK_SUCCESS`. Otherwise, an error value will be returned. ### 3. faceDetection The SDK offers a single function for detecting face and liveness detection, which can be used as follows: ```swift let templates = FaceSDK.templateExtraction(image, faceBox: faceBox) ``` This function takes a single parameter, which is a `UIImage` object. The return value of the function is a list of `FaceBox` objects. ### 4. templateExtraction The `FaceSDK` provides a function that can generate a `template` from a `UIImage`. This `template` can then be used to verify the identity of the individual captured in the image. ```swift let templates = FaceSDK.templateExtraction(capturedImage, faceBox: faceBox) ``` The SDK's `template extraction` function takes two parameters: a `UIImage` object and an object of `FaceBox`. The function returns `Data`, which contains the `template` that can be used for person verification. ### 5. similarityCalucation The `similarityCalculation` function takes a `Data` of two `template`s as a parameter. ```java float similarity = FaceSDK.similarityCalucation(templates1, templates1); ``` It returns the similarity value between the two `template`s, which can be used to determine the degree of similarity between the two individuals. ## Default Thresholds ```swift let livenessThreshold = 0.7 let identifyThreshold = 0.8 let yawThreshold = 10.0 let rollThreshold = 10.0 let pitchThreshold = 10.0 let occlusionThreshold = 0.5 let eyeCloseThreshold = 0.8 let mouthOpeningThreshold = 0.5 ``` * If the liveness score exceeds `0.7`, the face is a real face. * If the similarity between two faces is higher than `0.8`, the face matching is successful. * If the absolute values of the face angles are less than `10.0`, the face is identified as a fronted face. * If the occlusion value is higher than `0.5`, the face is occluded. * If the eye close value is higher than `0.8`, it indicates that the eyes are closed. * If the mouth opening value is higher than `0.5`, it indicates that the mouth is open. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.kby-ai.com/help/product/face-liveness-detection-sdk-face-recognition-sdk/premium-sdk-mobile/premium-sdk-ios.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.