# FaceLiveSDK - iOS

{% hint style="success" %}
Our SDK is fully on-device, processing all happens on your device and no data leaves your device.
{% endhint %}

## Overview

We provide system integrators with fast, flexible and extremely precise facial recognition with 3D passive face liveness detection (face anti-spoofing) that can be deployed across a number of scenarios, including security, access control, public safety, fintech, smart retail and home protection. Feel free to use our **MiniAiLive** Face Liveness Detection iOS SDK.

### Key Features <a href="#features" id="features"></a>

* Face Detection : Advanced face detection
* Face Liveness Detection : Provides liveness score to determine whether a face is real or fake
* Pose Estimation : Ensure that face is not standard frontal position and properly aligned within the expected boundaries
* Face Landmark Detection
* Age, Gender Estimation
* Fully offline, On-Premise SDK

## How to build

### Prerequisites

* Xcode 9.3 or later
* macOS 10.13 or later
* iPhone 5S or later (iOS 11.0 or later)

### Download SDK

We provide iOS demo project with our Face Liveness Detection iOS SDK. Please contact us to get demo project.

{% hint style="info" %}
Note: Current demo bundle ID is "com.miniai.liveness". If you want to use your own bundle ID with our SDK, then you need to provide your bundle ID to us, then we will provide you trial license for your bundle ID.
{% endhint %}

### Initializing SDK <a href="#initializing-sdk" id="initializing-sdk"></a>

To begin, you need to activate the SDK using the license that you have received.

```
val ret = FaceSDK.getInstance().init(assets)
        if(ret != FaceSDK.SDK_SUCCESS) {
            Log.i("SYSTEM Log : ", ret.toString())
        }
```

If activation is successful, the return value will be `SDK_SUCCESS`. Otherwise, an error value will be returned. If all good, you can build and run app successfully.

## Youtube - Demo Video

{% embed url="<https://www.youtube.com/watch?v=l_whnX5lKak>" %}

## Screenshots

&#x20;              <img src="https://559891175-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZNwfjUfgEKAU8sqYBQl4%2Fuploads%2FZaMg3S3ZYPaPGEbmyqXg%2Fimage.png?alt=media&#x26;token=934cf75b-68d8-412f-9ff6-53ba5c883f8f" alt="" data-size="original">           ![](https://559891175-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZNwfjUfgEKAU8sqYBQl4%2Fuploads%2F4BsbI5FXD6IPvuf3jQbm%2Fimage.png?alt=media\&token=876938da-575e-4d4a-a362-0767befc919e)

## Face & IDSDK Online Demo, Resources

| [![](https://camo.githubusercontent.com/806c4c9371684f21d03953dcc53853b790fa8440239f30681a21ce2cf2adcf92/68747470733a2f2f6d696e6961692e6c6976652f77702d636f6e74656e742f75706c6f6164732f323032342f31302f6e65775f6769742d312d3330307836372e706e67)](https://github.com/MiniAiLive) | [![](https://camo.githubusercontent.com/28530427ea25f63b9ae20a1dce8d4a92ce76f67af276e92d5cf7ac370f335e08/68747470733a2f2f6d696e6961692e6c6976652f77702d636f6e74656e742f75706c6f6164732f323032342f31302f6e65775f68756767696e672d312d3330307836372e706e67)](https://huggingface.co/MiniAiLive) | [![](https://camo.githubusercontent.com/514dcba45bbc416e9ff4d28794755408d015fcafca876e5ef3dc0321e80fa4c6/68747470733a2f2f6d696e6961692e6c6976652f77702d636f6e74656e742f75706c6f6164732f323032342f31302f6e65775f67726164696f2d3330307836372e706e67)](https://demo.miniai.live/)                                     |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [![](https://camo.githubusercontent.com/09f3ad9287d86c1c5839adbe83dd7cec21eb4778d845a7e36ad7e58fa64c5fd6/68747470733a2f2f6d696e6961692e6c6976652f77702d636f6e74656e742f75706c6f6164732f323032342f31302f612d3330307837302e706e67)](https://docs.miniai.live/)                     | [![](https://camo.githubusercontent.com/3137c2356707552aa1332fea60196413ab2f89ced339c8fe4367e8167d04b16f/68747470733a2f2f6d696e6961692e6c6976652f77702d636f6e74656e742f75706c6f6164732f323032342f31302f556e7469746c65642d312d3330307837302e706e67)](https://www.youtube.com/@miniailive)     | [![](https://camo.githubusercontent.com/c642d8abd48cbc0861511ae78bc53ad1c544f7bf59432790bba60a84df44e98a/68747470733a2f2f6d696e6961692e6c6976652f77702d636f6e74656e742f75706c6f6164732f323032342f31302f676f6f676c65706c61792d3330307836322e706e67)](https://play.google.com/store/apps/dev?id=5831076207730531667) |

## Our Products

<table><thead><tr><th width="74">No</th><th>Project</th><th>Feature</th></tr></thead><tbody><tr><td>1</td><td><a href="https://github.com/MiniAiLive/FaceRecognition-Linux">FaceRecognition-Linux</a></td><td>1:1 &#x26; 1:N Face Matching</td></tr><tr><td>2</td><td><a href="https://github.com/MiniAiLive/FaceRecognition-Windows">FaceRecognition-Windows</a></td><td>1:1 &#x26; 1:N Face Matching</td></tr><tr><td>3</td><td><a href="https://github.com/MiniAiLive/FaceRecognition-Docker">FaceRecognition-Docker</a></td><td>1:1 &#x26; 1:N Face Matching</td></tr><tr><td>4</td><td><a href="https://github.com/MiniAiLive/FaceRecognition-Android">FaceRecognition-Android</a></td><td>1:1 &#x26; 1:N Face Matching, 2D &#x26; 3D Face Passive LivenessDetection</td></tr><tr><td>5</td><td><a href="https://github.com/MiniAiLive/FaceRecognition-LivenessDetection-Windows">FaceRecognition-LivenessDetection-Windows</a></td><td>1:1 &#x26; 1:N Face Matching, 2D &#x26; 3D Face Passive LivenessDetection</td></tr><tr><td>6</td><td><a href="https://github.com/MiniAiLive/FaceLivenessDetection-Linux">FaceLivenessDetection-Linux</a></td><td>2D &#x26; 3D Face Passive LivenessDetection</td></tr><tr><td>7</td><td><a href="https://github.com/MiniAiLive/FaceLivenessDetection-Windows">FaceLivenessDetection-Windows</a></td><td>2D &#x26; 3D Face Passive LivenessDetection</td></tr><tr><td>8</td><td><a href="https://github.com/MiniAiLive/FaceLivenessDetection-Docker">FaceLivenessDetection-Docker</a></td><td>2D &#x26; 3D Face Passive LivenessDetection</td></tr><tr><td>9</td><td><a href="https://github.com/MiniAiLive/FaceLivenessDetection-Android">FaceLivenessDetection-Android</a></td><td>2D &#x26; 3D Face Passive LivenessDetection</td></tr><tr><td>10</td><td><a href="https://github.com/MiniAiLive/FaceMatching-Android">FaceMatching-Android</a></td><td>1:1 Face Matching</td></tr><tr><td>11</td><td><a href="https://github.com/MiniAiLive/FaceMatching-Windows">FaceMatching-Windows-Demo</a></td><td>1:1 Face Matching</td></tr><tr><td>12</td><td><a href="https://github.com/MiniAiLive/FaceAttributes-Android">FaceAttributes-Android</a></td><td>Face Attributes, Age &#x26; Gender Estimation</td></tr><tr><td>13</td><td><a href="https://github.com/MiniAiLive/ID-DocumentRecognition-Linux">ID-DocumentRecognition-Linux</a></td><td>IDCard, Passport, Driver License, Credit, MRZ Recognition</td></tr><tr><td>14</td><td><a href="https://github.com/MiniAiLive/ID-DocumentRecognition-Windows">ID-DocumentRecognition-Windows</a></td><td>IDCard, Passport, Driver License, Credit, MRZ Recognition</td></tr><tr><td>15</td><td><a href="https://github.com/MiniAiLive/ID-DocumentRecognition-Docker">ID-DocumentRecognition-Docker</a></td><td>IDCard, Passport, Driver License, Credit, MRZ Recognition</td></tr><tr><td>16</td><td><a href="https://github.com/MiniAiLive/ID-DocumentRecognition-Android">ID-DocumentRecognition-Android</a></td><td>IDCard, Passport, Driver License, Credit, MRZ Recognition</td></tr><tr><td>17</td><td><a href="https://github.com/MiniAiLive/ID-DocumentLivenessDetection-Linux">ID-DocumentLivenessDetection-Linux</a></td><td>ID Document LivenessDetection</td></tr><tr><td>18</td><td><a href="https://github.com/MiniAiLive/ID-DocumentLivenessDetection-Windows">ID-DocumentLivenessDetection-Windows</a></td><td>ID Document LivenessDetection</td></tr><tr><td>19</td><td><a href="https://github.com/MiniAiLive/ID-DocumentLivenessDetection-Docker">ID-DocumentLivenessDetection-Docker</a></td><td>ID Document LivenessDetection</td></tr></tbody></table>

## Request license

Feel free to [Contact US](https://www.miniai.live/contact/) to get a trial License. We are 24/7 online on WhatsApp: [+19162702374](https://wa.me/+19162702374).


---

# 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.miniai.live/product/face-liveness-detection-sdk/facelivesdk-ios.md?ask=<question>
```

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.