# Welcome to MiniAiLive ## Overview **MiniAiLive**, a tech company, is a biometric technology company on a mission to deliver a new generation of “zero-effort” identity verification and authentication. Our vision is a passwordless world where users don’t have to sacrifice security to gain convenience. Imagine the ability to access personal information and perform transactions simply by using your voice or face. Through the science of biometrics and advances in AI, we’re making this vision a reality. MiniAiLive is a provider of Touchless Biometrics Authentication, ID verification solutions. We offer strong security solutions with cutting-edge technologies for facial recognition, liveness detection, and ID document recognition. We also ensure that these solutions seamlessly integrate with our clients’ existing systems. MiniAiLive’s AI-powered eKYC solution offers real-time, reliable identity verification to combat sophisticated identity fraud. We’re here to help you build trust in digital world. ### Features * **On-premise**, **Fully offline** and **On-device** SDK * Compact **Library-type** SDK for easy on-premise installation. * **Simple and comprehensive** API. * **Licensing model** based on the actual use of the system. ### Who we serve Leading identity and biometric solution providers, integrators, and enterprise customers use **MiniAiLive**’s core authentication and liveness technology. Additionally, multiple companies are integrating our industry-leading biometric technology into their custom hardware. **MiniAiLive** products are used in worldwide in 200+ countries.
## Products
Face Recognition SDKTop 1 Face Matching Engine/files/gP99zj3tyLusofOaQ6Td/pages/6lXjjn1yMXBQEipY2Qtr
Face Liveness Detection SDK3D Passive Liveness Detection Engine/files/l8zX8AeLMaL8v42zvsZG/pages/nmfogffEQD2nEzIxxiU6
ID Document Recognition SDKID Document Recognition Engine/files/ZRlo0XNa9175RvKVqEkA/pages/zO3Ckai5XMKpb5oY36MH
ID Document Liveness Detection SDKID Document Liveness Detection Engine/files/3JiD7fRElcQ1tM7Fj3Qz/pages/6CA6TdP8XMwxpwupv6eE
## Online Demo & Resources
Playground - MiniAiLive/files/NHEgqSNK0ZF4ZL1OOgPuhttps://demo.miniai.live/
HuggingFace - MiniAiLive/files/Daxz8FImuo7Hfp1OKA89https://huggingface.co/MiniAiLive
GooglePlay - MiniAiLive/files/G4YsAiShI18UPkCbE79ghttps://play.google.com/store/apps/dev?id=5831076207730531667
Github - MiniAiLive/files/q4wCc6NdtrgkZ8LkK3sRhttps://github.com/MiniAiLive
Gitlab - MiniAiLive /files/MYySVR8Av6rVY36VO55Shttps://gitlab.com/miniailive/
Youtube - MiniAiLive/files/8tm0jKbDuS2N11pcXXqXhttps://www.youtube.com/@miniailive
## Contact US Whether you are a business exploring biometrics to improve security and remove friction out of your UX or a technology company seeking industry-leading core biometric technology, we'd love to talk.
Click to WhatsApp - MiniAiLive/files/nG6ihxlFLttiHc90q1Z9https://wa.me/+19162702374
Click to Live Chat - MiniAiLive/files/UHGIuaUQUzYTAIdqgvF0https://www.miniai.live
Click to Email - MiniAiLive/files/bTEduqzdz4p4DBcJBmM3mailto:info@miniai.live
Click to Telegram - MiniAiLive/files/XpVVN65wbzF9Cnj9MGL5https://t.me/Contact_MiniAiLive
Click to Skype - MiniAiLive/files/XjOPi6fIHc8MbgRMbznYhttps://join.skype.com/invite/ltQEVDmVddTe
# Face Recognition SDK Welcome to the MiniAiLive Face Recognition SDK Overview, your gateway to understanding the powerful capabilities and inner workings of our advanced biometric verification technology. ## Overview **MiniAiLive** Face Recognition SDK is a cross-platform biometric verification solution for a digital identity verification process. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. This section introduces the **MiniAiLive** Face Recognition SDK essential features: Face Detection, Face Comparison (Face Matching), Face Identification. ### Face Detection Face Detection can analyze images, recognize faces in them, and return cropped and aligned portraits of the detected people. Face Detection includes the following features: **Face attributes evaluation** estimates the age range of a person; checks whether the eyes are occluded, closed, or open; detects the facial expression or a smile; shows if there are glasses, sunglasses, head coverage, medical mask, etc. **Face image quality assessment** is a fast and handy way to check whether a portrait meets certain standards, for example, ICAO, Schengen visa, USA visa. ### Face Comparison (1 : 1) Face Comparison is a convenient and powerful way to match two or more portraits in the same image or in different ones and find out whether the face belongs to the same person, how similar the detected faces are. ### Face Identification (1 : N) The Face Identification module lets you match a face in an image against a database of faces. You can create and manage such a database with identities, upload photos, and associate them with names. When you show the system a photo, it can search for a match in the database. ### Key Features and Benefits * **High Accuracy**\ NIST-certified, achieving top accuracy in both 1:1 and 1:N identification through FRVT evaluations. * **Instant Matching**\ Provides rapid and precise face recognition, allowing for immediate verification and identification across various applications. * **Support Cross Platform**\ Users can authenticate seamlessly on any device or platform. SDK supports Windows, Linux, Android, iOS. * **Easy Integration**\ Designed for partners who demand extensive control and flexibility in their solutions. * **Customizable and Extensible**\ Adaptable to client's needs with the ability to scale and integrate additional features as required. * **Free Support and Update**\ Includes complimentary support and ongoing updates to ensure the latest features and improvements. ## Products
Face Recognition SDK - Windows /files/7rjJZeEmWwbd6qGY49dB/pages/J34wH4Ji86yW0hfHqxpp
Face Recognition SDK - Linux/files/R82zT8MqgZiEizPhg6zC/pages/ICkdpJGgEIXwPTD29Xol
Face Recognition SDK - Android/files/3FKPQoW10ezIzVJqraNY/pages/PzEQ2lnkvWhePqXWUCam
Face Recognition SDK - iOS /files/g075LYKheK0MBJFlmhxm/pages/5flTSvnFBNIaFPT1bsCg
## Contact US Whether you are a business exploring biometrics to improve security and remove friction out of your UX or a technology company seeking industry-leading core biometric technology, we'd love to talk.
Click to WhatsApp - MiniAiLive/files/nG6ihxlFLttiHc90q1Z9https://wa.me/+19162702374
Click to Live Chat - MiniAiLive/files/UHGIuaUQUzYTAIdqgvF0https://www.miniai.live
Click to Email - MiniAiLive/files/bTEduqzdz4p4DBcJBmM3mailto:info@miniai.live
Click to Telegram - MiniAiLive/files/XpVVN65wbzF9Cnj9MGL5https://t.me/Contact_MiniAiLive
Click to Skype - MiniAiLive/files/XjOPi6fIHc8MbgRMbznYhttps://join.skype.com/invite/ltQEVDmVddTe
# FaceSDK - Windows Face Recognition Windows Server SDK {% hint style="success" %} Our SDK is fully on-premise, processing all happens on hosting server and no data leaves your server. {% endhint %} ## Installation ### Prerequisites * Python 3.6+ * Windows * CPU: 2 cores or more * RAM: 8GB or more ### Installation Steps 1. **Download the Face Recognition Windows Server Installer** Download the Server installer for your operating system from the following link: [Download the On-premise Server Installer](https://drive.google.com/file/d/1cNaJETo2liaAn0ijXqM45B6sNEhbNj6L/view?usp=sharing) 2. **Install the On-premise Server** Run the installer and follow the on-screen instructions to complete the installation 3. **Request License and Update**\ Run MIRequest.exe file to generate a license request file. You can find it here.\ \ Open it, generate a license request file, and send it to us via [email ](mailto:info@miniai.live)or [WhatsApp](https://wa.me/+19162702374). We will send the license based on your Unique Request file, then you can upload the license file to allow to use. Refer the below images. ```markdown C:\Program Files\MiniAiLive\MiniAiLive-FaceSDK-WinServer ```
4. **Verify Installation**\ After installation, verify that the On-premise Server is correctly installed by checking the task manager
## API Reference 1. **Endpoint** `POST` [`http://127.0.0.1:8083/api/face_detect`](http://127.0.0.1:8083/api/face_detect) \ * **Form Data:** * `image`: The image file (PNG, JPG, etc.) to be analyzed. This should be provided as a file upload
`POST` `http://127.0.0.1:8083/api/face_detect_base64` \ * **Raw Data:** * `JSON Format`: ```json { "image": "--base64 image data here--" } ```
Other available endpoints here. `POST` `http://127.0.0.1:8083/api/face_match` <1:1, 1:N Face Matching API> `POST` `http://127.0.0.1:8083/api/face_match_base64` <1:1, 1:N Face Matching API> 2. **Response** The API returns a JSON object with the recognized details from the input face image. Here is an example response
## Testing API ### Gradio Demo We have included a Gradio demo to showcase the capabilities of our Face Recognition SDK. Gradio is a Python library that allows you to quickly create user interfaces for machine learning models. #### How to Run the Gradio Demo 1. **Install Gradio:** First, you need to install Gradio. You can do this using pip: ```json git clone https://github.com/MiniAiLive/FaceRecognition-Windows.git pip install -r requirement.txt cd gradio ``` 2. **Run Gradio Demo:** ``` python app.py ``` ### Python Test API Example To help you get started with using the API, here is a comprehensive example of how to interact with the Face Recognition API using Python. You can use API with another language you want to use like C++, C#, Ruby, Java, Javascript, and more 1. **Prerequisites** * Python 3.6+ * `requests` library (you can install it using `pip install requests`) 2. **Example Script** This example demonstrates how to send an image file to the API endpoint and process the response. ``` import requests # URL of the web API endpoint url = 'http://127.0.0.1:8083/api/face_detect' # Path to the image file you want to send image_path = './test_image.jpg' # Read the image file and send it as form data files = {'image': open(image_path, 'rb')} try: # Send POST request response = requests.post(url, files=files) # Check if the request was successful if response.status_code == 200: print('Request was successful!') # Parse the JSON response response_data = response.json() print('Response Data:', response_data) else: print('Request failed with status code:', response.status_code) print('Response content:', response.text) except requests.exceptions.RequestException as e: print('An error occurred:', e) ``` ## 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
NoProjectFeature
1FaceRecognition-Linux1:1 & 1:N Face Matching
2FaceRecognition-Windows1:1 & 1:N Face Matching
3FaceRecognition-Docker1:1 & 1:N Face Matching
4FaceRecognition-Android1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
5FaceRecognition-LivenessDetection-Windows1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
6FaceLivenessDetection-Linux2D & 3D Face Passive LivenessDetection
7FaceLivenessDetection-Windows2D & 3D Face Passive LivenessDetection
8FaceLivenessDetection-Docker2D & 3D Face Passive LivenessDetection
9FaceLivenessDetection-Android2D & 3D Face Passive LivenessDetection
10FaceMatching-Android1:1 Face Matching
11FaceMatching-Windows-Demo1:1 Face Matching
12FaceAttributes-AndroidFace Attributes, Age & Gender Estimation
13ID-DocumentRecognition-LinuxIDCard, Passport, Driver License, Credit, MRZ Recognition
14ID-DocumentRecognition-WindowsIDCard, Passport, Driver License, Credit, MRZ Recognition
15ID-DocumentRecognition-DockerIDCard, Passport, Driver License, Credit, MRZ Recognition
16ID-DocumentRecognition-AndroidIDCard, Passport, Driver License, Credit, MRZ Recognition
17ID-DocumentLivenessDetection-LinuxID Document LivenessDetection
18ID-DocumentLivenessDetection-WindowsID Document LivenessDetection
19ID-DocumentLivenessDetection-DockerID Document LivenessDetection
## 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). # FaceSDK - Linux Face Recognition Linux Server SDK {% hint style="success" %} Our SDK is fully on-premise, processing all happens on hosting server and no data leaves your server. {% endhint %} ## Installation ### Prerequisites * Python 3.6+ * Linux * CPU: 2 cores or more * RAM: 8GB or more ### Installation Steps 1. **Download the Face Recognition Linux Server Installer** Download the Server installer for your operating system from the following link: [Download the On-premise Server Installer](https://drive.google.com/file/d/1DQ1epQVPMQOMBJs_6f-UsJb7Z3bd-jhk/view?usp=sharing) 2. **Install the On-premise Server** Run the installer and follow the on-screen instructions to complete the installation. Go to the Download folder and run this command. ``` $ cd Download $ sudo dpkg -i --force-overwrite MiniAiLive-FaceSDK-LinuxServer.deb ```
3. **Request License and Update**\ You can generate the License Request file by using this command: ``` $ cd /opt/miniai/face-rec-service $ sudo ./MiRequest request /home/ubuntu/Download/trial_key.miq ```
Then you can see the license request file on your directory, and send it to us via [email ](mailto:info@miniai.live)or [WhatsApp](https://wa.me/+19162702374). We will send the license based on your Unique Request file, then you can upload the license file to allow to use. Refer the below images. ``` $ sudo ./MiRequest update /home/ubuntu/Download/trial_30.mis ```
4. **Verify Installation**\ After installation, verify that the On-premise Server is correctly installed by using this command: ``` $ systemctl list-units --state running ``` If you can see 'Mini-facesvc.service', 'Mini-fdsvc.service', the server has been installed successfully. Refer the below image.
## API Reference 1. **Endpoint** `POST` [`http://127.0.0.1:8083/api/face_detect`](http://127.0.0.1:8083/api/face_detect) \ * **Form Data:** * `image`: The image file (PNG, JPG, etc.) to be analyzed. This should be provided as a file upload
`POST` `http://127.0.0.1:8083/api/face_detect_base64` \ * **Raw Data:** * `JSON Format`: ```json { "image": "--base64 image data here--" } ```
Other available endpoints here. `POST` `http://127.0.0.1:8083/api/face_match` <1:1, 1:N Face Matching API> `POST` `http://127.0.0.1:8083/api/face_match_base64` <1:1, 1:N Face Matching API> 2. **Response** The API returns a JSON object with the recognized details from the input face image. Here is an example response
## Testing API ### Gradio Demo We have included a Gradio demo to showcase the capabilities of our Face Recognition SDK. Gradio is a Python library that allows you to quickly create user interfaces for machine learning models. #### How to Run the Gradio Demo 1. **Install Gradio:** First, you need to install Gradio. You can do this using pip: ```json git clone https://github.com/MiniAiLive/FaceRecognition-Windows.git pip install -r requirement.txt cd gradio ``` 2. **Run Gradio Demo:** ``` python app.py ``` ### Python Test API Example To help you get started with using the API, here is a comprehensive example of how to interact with the Face Recognition API using Python. You can use API with another language you want to use like C++, C#, Ruby, Java, Javascript, and more 1. **Prerequisites** * Python 3.6+ * `requests` library (you can install it using `pip install requests`) 2. **Example Script** This example demonstrates how to send an image file to the API endpoint and process the response. ``` import requests # URL of the web API endpoint url = 'http://127.0.0.1:8083/api/face_detect' # Path to the image file you want to send image_path = './test_image.jpg' # Read the image file and send it as form data files = {'image': open(image_path, 'rb')} try: # Send POST request response = requests.post(url, files=files) # Check if the request was successful if response.status_code == 200: print('Request was successful!') # Parse the JSON response response_data = response.json() print('Response Data:', response_data) else: print('Request failed with status code:', response.status_code) print('Response content:', response.text) except requests.exceptions.RequestException as e: print('An error occurred:', e) ``` ## 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
NoProjectFeature
1FaceRecognition-Linux1:1 & 1:N Face Matching
2FaceRecognition-Windows1:1 & 1:N Face Matching
3FaceRecognition-Docker1:1 & 1:N Face Matching
4FaceRecognition-Android1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
5FaceRecognition-LivenessDetection-Windows1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
6FaceLivenessDetection-Linux2D & 3D Face Passive LivenessDetection
7FaceLivenessDetection-Windows2D & 3D Face Passive LivenessDetection
8FaceLivenessDetection-Docker2D & 3D Face Passive LivenessDetection
9FaceLivenessDetection-Android2D & 3D Face Passive LivenessDetection
10FaceMatching-Android1:1 Face Matching
11FaceMatching-Windows-Demo1:1 Face Matching
12FaceAttributes-AndroidFace Attributes, Age & Gender Estimation
13ID-DocumentRecognition-LinuxIDCard, Passport, Driver License, Credit, MRZ Recognition
14ID-DocumentRecognition-WindowsIDCard, Passport, Driver License, Credit, MRZ Recognition
15ID-DocumentRecognition-DockerIDCard, Passport, Driver License, Credit, MRZ Recognition
16ID-DocumentRecognition-AndroidIDCard, Passport, Driver License, Credit, MRZ Recognition
17ID-DocumentLivenessDetection-LinuxID Document LivenessDetection
18ID-DocumentLivenessDetection-WindowsID Document LivenessDetection
19ID-DocumentLivenessDetection-DockerID Document LivenessDetection
## 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). # FaceSDK - Android Face Recognition Android SDK {% 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 Recognition Android SDK. ### Key Features * 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 * 1 : 1, 1 : N Face Matching * Age, Gender Estimation * Fully offline, On-Premise SDK ## How to build ### Prerequisites * Android 5.0 (API level 21) OS or newer * RAM 256 MB or more * Android Studio 4.0 IDE or later ### Download SDK We provide Android demo project with our Face Recognition Android SDK. You can just download it from our Github repository and build it. ``` git clone https://github.com/MiniAiLive/FaceRecognition-Android.git ``` {% hint style="info" %} Note: Current demo application ID is "com.miniai.facerecognition". If you want to use your own application ID with our SDK, then you need to provide your application ID to us, then we will provide you trial license for your app ID. {% endhint %} If you need to use our SDK on your existing application, please add dependency to your `build.gradle` 
implementation files('libs/miniai_face.aar')
You can download our **MiniAiLive** android lib file here : [miniai\_face.aar](https://drive.google.com/file/d/1kKmVb3nBB3yRjWHWMdawUoNCbSFyWvN3/view?usp=sharing) ### Initializing SDK 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. ## Get it on Google Play [![](/files/vNWSgq7i7IPaLsOWs1jP)](https://play.google.com/store/apps/details?id=com.miniai.facerecognition) ## Youtube - Demo Video {% embed url="" %} ## 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
NoProjectFeature
1FaceRecognition-Linux1:1 & 1:N Face Matching
2FaceRecognition-Windows1:1 & 1:N Face Matching
3FaceRecognition-Docker1:1 & 1:N Face Matching
4FaceRecognition-Android1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
5FaceRecognition-LivenessDetection-Windows1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
6FaceLivenessDetection-Linux2D & 3D Face Passive LivenessDetection
7FaceLivenessDetection-Windows2D & 3D Face Passive LivenessDetection
8FaceLivenessDetection-Docker2D & 3D Face Passive LivenessDetection
9FaceLivenessDetection-Android2D & 3D Face Passive LivenessDetection
10FaceMatching-Android1:1 Face Matching
11FaceMatching-Windows-Demo1:1 Face Matching
12FaceAttributes-AndroidFace Attributes, Age & Gender Estimation
13ID-DocumentRecognition-LinuxIDCard, Passport, Driver License, Credit, MRZ Recognition
14ID-DocumentRecognition-WindowsIDCard, Passport, Driver License, Credit, MRZ Recognition
15ID-DocumentRecognition-DockerIDCard, Passport, Driver License, Credit, MRZ Recognition
16ID-DocumentRecognition-AndroidIDCard, Passport, Driver License, Credit, MRZ Recognition
17ID-DocumentLivenessDetection-LinuxID Document LivenessDetection
18ID-DocumentLivenessDetection-WindowsID Document LivenessDetection
19ID-DocumentLivenessDetection-DockerID Document LivenessDetection
## 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). # FaceSDK - iOS Face Recognition iOS SDK {% 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 Recognition iOS SDK. ### Key Features * 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 * 1 : 1, 1 : N Face Matching * 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 Recognition iOS SDK. Please contact us to get demo project. {% hint style="info" %} Note: Current demo bundle ID is "com.miniai.facerecognition". 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 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="" %} ## 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
NoProjectFeature
1FaceRecognition-Linux1:1 & 1:N Face Matching
2FaceRecognition-Windows1:1 & 1:N Face Matching
3FaceRecognition-Docker1:1 & 1:N Face Matching
4FaceRecognition-Android1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
5FaceRecognition-LivenessDetection-Windows1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
6FaceLivenessDetection-Linux2D & 3D Face Passive LivenessDetection
7FaceLivenessDetection-Windows2D & 3D Face Passive LivenessDetection
8FaceLivenessDetection-Docker2D & 3D Face Passive LivenessDetection
9FaceLivenessDetection-Android2D & 3D Face Passive LivenessDetection
10FaceMatching-Android1:1 Face Matching
11FaceMatching-Windows-Demo1:1 Face Matching
12FaceAttributes-AndroidFace Attributes, Age & Gender Estimation
13ID-DocumentRecognition-LinuxIDCard, Passport, Driver License, Credit, MRZ Recognition
14ID-DocumentRecognition-WindowsIDCard, Passport, Driver License, Credit, MRZ Recognition
15ID-DocumentRecognition-DockerIDCard, Passport, Driver License, Credit, MRZ Recognition
16ID-DocumentRecognition-AndroidIDCard, Passport, Driver License, Credit, MRZ Recognition
17ID-DocumentLivenessDetection-LinuxID Document LivenessDetection
18ID-DocumentLivenessDetection-WindowsID Document LivenessDetection
19ID-DocumentLivenessDetection-DockerID Document LivenessDetection
## 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). # Face Liveness Detection SDK Welcome to the MiniAiLive Face Liveness Detection SDK Overview, your gateway to understanding the powerful capabilities and inner workings of our advanced biometric verification technology. ## Overview **MiniAiLive** Face Liveness Detection SDK is a cross-platform biometric verification solution for a digital identity verification process. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. A 100% spoofing-prevention rate for both 3D printed and resin facial masks, confirms **MiniAiLive** as a leading facial recognition solution for preventing biometric fraud in remote applications, such as online banking, requiring identity verification before granting access to sensitive data or valuable assets. Feel free to use our **MiniAiLive** 3D Face Passive Liveness Detection (face anti-spoofing) Windows SDK. ### Key Features and Benefits * **Passive Liveness Detection**\ Advanced presentation attack detection, ensuring accurate differentiation between genuine human presence and video or image, realistic mask, 3D model spoofs. * **Deepfake Detection**\ Consistently enhance AI models with cutting-edge deepfake detection techniques, proactively identifying and mitigating emerging threats. * **Leading Accuracy**\ Optimized for digital identity verification, providing best-in-class precision with server-side liveness detection and advanced image quality SDKs for iOS and Android. * **ISO 30107 Compliance**\ Tested by our +70 Partners and by the development and security teams for hundreds of Apps and numerous State and Federal Governments. * **Customizable and Extensible**\ Adaptable to client's needs with the ability to scale and integrate additional features as required. * **Live Feedback**\ Providing real-time feedback ensures that the technology proactively minimizes errors and reduces retries caused by low-quality images, offering high accuracy and a smooth experience, even for first-time users. ### Face Liveness Assessment Is it a real human being looking at the camera? Not a mannequin or a 3D image? The Liveness verification module is created to check whether the biometric information source accessing the camera is a physically present live person. In addition to enhancing security measures against spoofing attacks, deepfakes, and fraud, the liveness verification module offers an extra capability. By leveraging advanced AI algorithms, it can also provide an estimated age of the person with an accuracy of approximately +/-3 years. Liveness detection can be performed in two modes: active and passive. The **active** mode requires users to turn their head during the session. This guarantees highly accurate liveness detection. The **passive** liveness check simply involves taking a selfie. This approach offers improved user experience, however, the accuracy of the **active** liveness detection result will be higher. Whether to use passive or active liveness check is specified in the request code. Switching between the two options doesn't require any modifications on the backend meaning that on the same backend, both active and passive procedures can be performed. ## Products
Face Liveness Detection SDK - Windows /files/7rjJZeEmWwbd6qGY49dB/pages/z6GJeFAtXgwSPeQXBxk6
Face Liveness Detection SDK - Linux/files/R82zT8MqgZiEizPhg6zC/pages/ZDxbMc2t7W0V5wYJmCIJ
Face Liveness Detection SDK - Android/files/3FKPQoW10ezIzVJqraNY/pages/ClgD6izJyPMXi00ocHt2
Face Liveness Detection SDK - iOS /files/g075LYKheK0MBJFlmhxm/pages/hbKwhrrbym5PaK9pX3R0
## Contact US Whether you are a business exploring biometrics to improve security and remove friction out of your UX or a technology company seeking industry-leading core biometric technology, we'd love to talk.
Click to WhatsApp - MiniAiLive/files/nG6ihxlFLttiHc90q1Z9https://wa.me/+19162702374
Click to Live Chat - MiniAiLive/files/UHGIuaUQUzYTAIdqgvF0https://www.miniai.live
Click to Email - MiniAiLive/files/bTEduqzdz4p4DBcJBmM3mailto:info@miniai.live
Click to Telegram - MiniAiLive/files/XpVVN65wbzF9Cnj9MGL5https://t.me/Contact_MiniAiLive
Click to Skype - MiniAiLive/files/XjOPi6fIHc8MbgRMbznYhttps://join.skype.com/invite/ltQEVDmVddTe
# FaceLiveSDK - Windows Face Liveness Detection Windows Server SDK {% hint style="success" %} Our SDK is fully on-premise, processing all happens on hosting server and no data leaves your server. {% endhint %} ## Installation ### Prerequisites * Python 3.6+ * Windows * CPU: 2 cores or more * RAM: 8GB or more ### Installation Steps 1. **Download the Face Liveness Detection Windows Server Installer** Download the Server installer for your operating system from the following link: [Download the On-premise Server Installer](https://drive.google.com/file/d/1Fy_udnTLsxELcBj4HimICwcFbCF4d2aA/view?usp=sharing) 2. **Install the On-premise Server** Run the installer and follow the on-screen instructions to complete the installation
3. **Request License and Update**\ Run MIRequest.exe file to generate a license request file. You can find it here.\ \ Open it, generate a license request file, and send it to us via [email ](mailto:info@miniai.live)or [WhatsApp](https://wa.me/+19162702374). We will send the license based on your Unique Request file, then you can upload the license file to allow to use. Refer the below images. ```markdown C:\Users\{User name}\AppData\Local\MiniAiLive\MiniAiLive-FaceLiveness-WinServer ```
4. **Verify Installation**\ After installation, verify that the On-premise Server is correctly installed by checking the task manager
## API Reference 1. **Endpoint** `POST` `http://127.0.0.1:8092/api/check_liveness` \ * **Form Data:** * `image`: The image file (PNG, JPG, etc.) to be analyzed. This should be provided as a file upload
`POST` `http://127.0.0.1:8092/api/check_liveness_base64` \ * **Raw Data:** * `JSON Format`: ```json { "image": "--base64 image data here--" } ```
2. **Response** The API returns a JSON object with the liveness result of the input face image. Here is an example response
## Testing API ### Gradio Demo We have included a Gradio demo to showcase the capabilities of our **MiniAiLive** Face Liveness Detection SDK. Gradio is a Python library that allows you to quickly create user interfaces for machine learning models. #### How to Run the Gradio Demo 1. **Install Gradio:** First, you need to install Gradio. You can do this using pip: ```json git clone https://github.com/MiniAiLive/FaceLivenessDetection-Windows-SDK.git pip install -r requirement.txt cd gradio ``` 2. **Run Gradio Demo:** ``` python app.py ``` ### Python Test API Example To help you get started with using the API, here is a comprehensive example of how to interact with the Face Liveness Detection API using Python. You can use API with another language you want to use like C++, C#, Ruby, Java, Javascript, and more 1. **Prerequisites** * Python 3.6+ * `requests` library (you can install it using `pip install requests`) 2. **Example Script** This example demonstrates how to send an image file to the API endpoint and process the response. ``` import requestsL of the web API endpoint url = 'http://127.0.0.1:8092/api/check_liveness' # Path to the image file you want to send image_path = './test_image.jpg' # Read the image file and send it as form data files = {'image': open(image_path, 'rb')} try: # Send POST request response = requests.post(url, files=files) # Check if the request was successful if response.status_code == 200: print('Request was successful!') # Parse the JSON response response_data = response.json() print('Response Data:', response_data) else: print('Request failed with status code:', response.status_code) print('Response content:', response.text) except requests.exceptions.RequestException as e: print('An error occurred:', e) ``` ## 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
NoProjectFeature
1FaceRecognition-Linux1:1 & 1:N Face Matching
2FaceRecognition-Windows1:1 & 1:N Face Matching
3FaceRecognition-Docker1:1 & 1:N Face Matching
4FaceRecognition-Android1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
5FaceRecognition-LivenessDetection-Windows1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
6FaceLivenessDetection-Linux2D & 3D Face Passive LivenessDetection
7FaceLivenessDetection-Windows2D & 3D Face Passive LivenessDetection
8FaceLivenessDetection-Docker2D & 3D Face Passive LivenessDetection
9FaceLivenessDetection-Android2D & 3D Face Passive LivenessDetection
10FaceMatching-Android1:1 Face Matching
11FaceMatching-Windows-Demo1:1 Face Matching
12FaceAttributes-AndroidFace Attributes, Age & Gender Estimation
13ID-DocumentRecognition-LinuxIDCard, Passport, Driver License, Credit, MRZ Recognition
14ID-DocumentRecognition-WindowsIDCard, Passport, Driver License, Credit, MRZ Recognition
15ID-DocumentRecognition-DockerIDCard, Passport, Driver License, Credit, MRZ Recognition
16ID-DocumentRecognition-AndroidIDCard, Passport, Driver License, Credit, MRZ Recognition
17ID-DocumentLivenessDetection-LinuxID Document LivenessDetection
18ID-DocumentLivenessDetection-WindowsID Document LivenessDetection
19ID-DocumentLivenessDetection-DockerID Document LivenessDetection
## 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). # FaceLiveSDK - Linux Face Liveness Detection Linux Server SDK {% hint style="success" %} Our SDK is fully on-premise, processing all happens on hosting server and no data leaves your server. {% endhint %} ## Installation ### Prerequisites * Python 3.6+ * Linux * CPU: 2 cores or more * RAM: 8GB or more ### Installation Steps 1. **Download the Face Liveness Detection Windows Server Installer** Download the Server installer for your operating system from the following link: [Download the On-premise Server Installer](https://drive.google.com/file/d/1nFxftQYJPh-BJ5NRiIaAG5d9bC5Ydo5E/view?usp=sharing) 2. **Install the On-premise Server** Run the installer and follow the on-screen instructions to complete the installation. Go to the Download folder and run this command. ``` $ cd Download $ sudo dpkg -i --force-overwrite MiniAiLive-FaceLiveness-LinuxServer.deb ```
3. **Request License and Update**\ You can generate the License Request file by using this command: ``` $ cd /opt/mini-faceliveness/ $ sudo ./MiRequest request /home/ubuntu/Download/trial_request.miq ```
Then you can see the license request file on your directory, and send it to us via [email ](mailto:info@miniai.live)or [WhatsApp](https://wa.me/+19162702374). We will send the license based on your Unique Request file, then you can upload the license file to allow to use. Refer the below images. ``` $ sudo ./MiRequest update /home/ubuntu/Download/Faceliveness_trial_linux.mis ```
4. **Verify Installation**\ After installation, verify that the On-premise Server is correctly installed by using this command: ``` $ systemctl list-units --state running ``` If you can see 'Mini-faceliveness-svc.service', the server has been installed successfully. Refer the below image.
## API Reference 1. **Endpoint** `POST` `http://127.0.0.1:8092/api/check_liveness` \ * **Form Data:** * `image`: The image file (PNG, JPG, etc.) to be analyzed. This should be provided as a file upload
`POST` `http://127.0.0.1:8092/api/check_liveness_base64` \ * **Raw Data:** * `JSON Format`: ```json { "image": "--base64 image data here--" } ```
2. **Response** The API returns a JSON object with the liveness result of the input face image. Here is an example response
## Testing API ### Gradio Demo We have included a Gradio demo to showcase the capabilities of our **MiniAiLive** Face Liveness Detection SDK. Gradio is a Python library that allows you to quickly create user interfaces for machine learning models. #### How to Run the Gradio Demo 1. **Install Gradio:** First, you need to install Gradio. You can do this using pip: ```json git clone https://github.com/MiniAiLive/FaceLivenessDetection-Linux-SDK.git pip install -r requirement.txt cd gradio ``` 2. **Run Gradio Demo:** ``` python app.py ``` ### Python Test API Example To help you get started with using the API, here is a comprehensive example of how to interact with the Face Liveness Detection API using Python. You can use API with another language you want to use like C++, C#, Ruby, Java, Javascript, and more 1. **Prerequisites** * Python 3.6+ * `requests` library (you can install it using `pip install requests`) 2. **Example Script** This example demonstrates how to send an image file to the API endpoint and process the response. ``` import requests # URL of the web API endpoint url = 'http://127.0.0.1:8092/api/check_liveness' # Path to the image file you want to send image_path = './test_image.jpg' # Read the image file and send it as form data files = {'image': open(image_path, 'rb')} try: # Send POST request response = requests.post(url, files=files) # Check if the request was successful if response.status_code == 200: print('Request was successful!') # Parse the JSON response response_data = response.json() print('Response Data:', response_data) else: print('Request failed with status code:', response.status_code) print('Response content:', response.text) except requests.exceptions.RequestException as e: print('An error occurred:', e) ``` ## 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
NoProjectFeature
1FaceRecognition-Linux1:1 & 1:N Face Matching
2FaceRecognition-Windows1:1 & 1:N Face Matching
3FaceRecognition-Docker1:1 & 1:N Face Matching
4FaceRecognition-Android1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
5FaceRecognition-LivenessDetection-Windows1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
6FaceLivenessDetection-Linux2D & 3D Face Passive LivenessDetection
7FaceLivenessDetection-Windows2D & 3D Face Passive LivenessDetection
8FaceLivenessDetection-Docker2D & 3D Face Passive LivenessDetection
9FaceLivenessDetection-Android2D & 3D Face Passive LivenessDetection
10FaceMatching-Android1:1 Face Matching
11FaceMatching-Windows-Demo1:1 Face Matching
12FaceAttributes-AndroidFace Attributes, Age & Gender Estimation
13ID-DocumentRecognition-LinuxIDCard, Passport, Driver License, Credit, MRZ Recognition
14ID-DocumentRecognition-WindowsIDCard, Passport, Driver License, Credit, MRZ Recognition
15ID-DocumentRecognition-DockerIDCard, Passport, Driver License, Credit, MRZ Recognition
16ID-DocumentRecognition-AndroidIDCard, Passport, Driver License, Credit, MRZ Recognition
17ID-DocumentLivenessDetection-LinuxID Document LivenessDetection
18ID-DocumentLivenessDetection-WindowsID Document LivenessDetection
19ID-DocumentLivenessDetection-DockerID Document LivenessDetection
## 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). # FaceLiveSDK - Android Face Liveness Detection Android SDK {% 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 Android SDK. ### Key Features * 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 * Android 5.0 (API level 21) OS or newer * RAM 256 MB or more * Android Studio 4.0 IDE or later ### Download SDK We provide Android demo project with our Face Liveness Detection Android SDK. You can just download it from our Github repository and build it. ``` git clone https://github.com/MiniAiLive/FaceLivenessDetection-Android.git ``` {% hint style="info" %} Note: Current demo application ID is "com.miniai.liveness". If you want to use your own application ID with our SDK, then you need to provide your application ID to us, then we will provide you trial license for your app ID. {% endhint %} If you need to use our SDK on your existing application, please add dependency to your `build.gradle` 
implementation files('libs/miniai_face.aar')
You can download our **MiniAiLive** android lib file here : [miniai\_face.aar](https://drive.google.com/file/d/1kKmVb3nBB3yRjWHWMdawUoNCbSFyWvN3/view?usp=sharing) ### Initializing SDK 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. ## Get it on Google Play [![](/files/vNWSgq7i7IPaLsOWs1jP)](https://play.google.com/store/apps/details?id=com.miniai.facerecognition\&hl=en-HK) ## Youtube - Demo Video {% embed url="" %} ## Screenshots ![](/files/5ENd8o11mZsEWtkDWVgx) ## 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
NoProjectFeature
1FaceRecognition-Linux1:1 & 1:N Face Matching
2FaceRecognition-Windows1:1 & 1:N Face Matching
3FaceRecognition-Docker1:1 & 1:N Face Matching
4FaceRecognition-Android1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
5FaceRecognition-LivenessDetection-Windows1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
6FaceLivenessDetection-Linux2D & 3D Face Passive LivenessDetection
7FaceLivenessDetection-Windows2D & 3D Face Passive LivenessDetection
8FaceLivenessDetection-Docker2D & 3D Face Passive LivenessDetection
9FaceLivenessDetection-Android2D & 3D Face Passive LivenessDetection
10FaceMatching-Android1:1 Face Matching
11FaceMatching-Windows-Demo1:1 Face Matching
12FaceAttributes-AndroidFace Attributes, Age & Gender Estimation
13ID-DocumentRecognition-LinuxIDCard, Passport, Driver License, Credit, MRZ Recognition
14ID-DocumentRecognition-WindowsIDCard, Passport, Driver License, Credit, MRZ Recognition
15ID-DocumentRecognition-DockerIDCard, Passport, Driver License, Credit, MRZ Recognition
16ID-DocumentRecognition-AndroidIDCard, Passport, Driver License, Credit, MRZ Recognition
17ID-DocumentLivenessDetection-LinuxID Document LivenessDetection
18ID-DocumentLivenessDetection-WindowsID Document LivenessDetection
19ID-DocumentLivenessDetection-DockerID Document LivenessDetection
## 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). # FaceLiveSDK - iOS Face Liveness Detection iOS SDK {% 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 * 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 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="" %} ## Screenshots ![](/files/5ENd8o11mZsEWtkDWVgx) ## 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
NoProjectFeature
1FaceRecognition-Linux1:1 & 1:N Face Matching
2FaceRecognition-Windows1:1 & 1:N Face Matching
3FaceRecognition-Docker1:1 & 1:N Face Matching
4FaceRecognition-Android1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
5FaceRecognition-LivenessDetection-Windows1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
6FaceLivenessDetection-Linux2D & 3D Face Passive LivenessDetection
7FaceLivenessDetection-Windows2D & 3D Face Passive LivenessDetection
8FaceLivenessDetection-Docker2D & 3D Face Passive LivenessDetection
9FaceLivenessDetection-Android2D & 3D Face Passive LivenessDetection
10FaceMatching-Android1:1 Face Matching
11FaceMatching-Windows-Demo1:1 Face Matching
12FaceAttributes-AndroidFace Attributes, Age & Gender Estimation
13ID-DocumentRecognition-LinuxIDCard, Passport, Driver License, Credit, MRZ Recognition
14ID-DocumentRecognition-WindowsIDCard, Passport, Driver License, Credit, MRZ Recognition
15ID-DocumentRecognition-DockerIDCard, Passport, Driver License, Credit, MRZ Recognition
16ID-DocumentRecognition-AndroidIDCard, Passport, Driver License, Credit, MRZ Recognition
17ID-DocumentLivenessDetection-LinuxID Document LivenessDetection
18ID-DocumentLivenessDetection-WindowsID Document LivenessDetection
19ID-DocumentLivenessDetection-DockerID Document LivenessDetection
## 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). # ID Document Recognition SDK Welcome to the MiniAiLive ID Document Recognition SDK Overview, your gateway to understanding the powerful capabilities and inner workings of our cuttin-edge document verification technology. ## Overview **MiniAiLive** ID Document Recognition SDK is a standalone document verification software that helps organize an enhanced identity verification process on any platform - **mobile**, **web** - to detect and fight fraud at early stages. It fully automates reading and verification of personal data in **passports**, **ID cards**, **driver’s licenses**, **visas**, and other identity documents. Reduce drop-off and boost conversions with ID scanning and verification solutions. Quickly and securely capture, extract, and verify data from diverse **ID cards**, **passports**, **driver’s licenses**, and other documents with our proven, AI-first approach. Designed to fit seamlessly together, our technology can be integrated as a fully-bundled identity document verification solution or as separate modules via developer-friendly mobile or server SDK. Try it out today! ### Key Features and Benefits * **Document Capture**\ Get an ideal image with advanced document capture capabilities. **MiniAiLive** ID Document Recognition SDK technology improves ID verification results with image preprocessing techniques no matter how IDs are captured: with mobile devices, web cameras, or passport readers. * **Visual Analysis and OCR**\ Find, read, and verify machine-readable zones (MRZs) in various IDs. **MiniAiLive** MRZ reading technology automatically reads the MRZ lines, dividing them into separate fields, and validates MRZs with all the data they contain in accordance with ICAO 9303 and ISO 18013 standards. * **Automated Document Type Detection**\ Automatically recognize the type of the identity document and country of origin in a matter of seconds with no manual labor such as selecting a country, document type or series. * **Accurate Visual Zone Verification**\ **MiniAiLive** visual zone OCR technology instantly analyzes the ID layout in accordance with **MiniAiLive** ’s extensive document template database and reads all the typed, printed, or embossed data. Once the analysis is complete, the data is ready for cross-validation with other sources of information, like MRZ or barcode. * **Barcode Recognition**\ Automatically read and verify the data encoded in barcodes for the biggest possible variety of barcodes in the world. To ensure the integrity of the document, the **MiniAiLive** solution compares the ID data for consistency across various security elements: MRZ, barcode, visual zone, and electronic chip. * **Global Coverage**\ 14,000+ document templates covering 250+ countries and territories, 140+ languages including Latin, Cyrillic, Hebrew, Greek, Arabic, Chinese, and more are supported. * **Complete Automation, No Human Oversight**\ Eliminates human error and automates manual processes, ensuring efficiency and accuracy. ### Supported Functions * **Document Detection**\ Detect and isolate the ID documents such as National **ID Cards**, **Passports**, **Driver’s Licenses** from the background. * **Document Quality Check**\ Assess the document’s quality for issues like glare, blur, and clarity. * **Document Field Extraction**\ Recognize and extract essential information from documents, such as name, date of birth, ID number, MRZ, and other required fields. * **Portrait Extraction**\ Capture the portrait image of the document holder for biometric authentication. ## Products
ID Document Recognition SDK - Windows /pages/Z2NgSPIRB56mL2q16ZSm/files/7rjJZeEmWwbd6qGY49dB
ID Document Recognition SDK - Linux/pages/mwtdbzZPPgJODjfmdnkU/files/R82zT8MqgZiEizPhg6zC
ID Document Recognition SDK - Android/pages/xi2xxTYvd5Lrub6CYztX/files/3FKPQoW10ezIzVJqraNY
ID Document Recognition SDK - iOS /pages/MGYnQO8KYudCJtbDyv7q/files/g075LYKheK0MBJFlmhxm
## Contact US Whether you are a business exploring biometrics to improve security and remove friction out of your UX or a technology company seeking industry-leading core biometric technology, we'd love to talk.
Click to WhatsApp - MiniAiLive/files/nG6ihxlFLttiHc90q1Z9https://wa.me/+19162702374
Click to Live Chat - MiniAiLive/files/UHGIuaUQUzYTAIdqgvF0https://www.miniai.live
Click to Email - MiniAiLive/files/bTEduqzdz4p4DBcJBmM3mailto:info@miniai.live
Click to Telegram - MiniAiLive/files/XpVVN65wbzF9Cnj9MGL5https://t.me/Contact_MiniAiLive
Click to Skype - MiniAiLive/files/XjOPi6fIHc8MbgRMbznYhttps://join.skype.com/invite/ltQEVDmVddTe
# IDSDK - Windows ID Document Recognition Windows Server SDK {% hint style="success" %} * Our SDK is fully on-premise, processing all happens on hosting server and no data leaves your server. * 14,000+ document templates covering IDs issued in 250+ countries and territories. * Support of 140+ languages and special characters via sophisticated neural networks. {% endhint %} ## Introduction Welcome to the **MiniAiLive** ID Document Recognition SDK! This SDK provides powerful tools for recognizing and extracting information from ID documents. The SDK is available for both Windows and Linux platforms and includes an API for integration. Reduce drop-off and boost conversions with ID scanning and verification solutions. Quickly and securely capture, extract, and verify data from diverse **ID cards**, **passports**, **driver’s licenses**, and other documents with our proven, AI-first approach. Designed to fit seamlessly together, our technology can be integrated as a fully-bundled identity document verification solution or as separate modules via developer-friendly mobile or server SDK. Try it out today! ## Installation ### Prerequisites * Python 3.6+ * Windows * CPU: 2 cores or more * RAM: 4GB or more ### Installation Steps 1. **Download the ID Document Recognition Windows Server Installer** Download the Server installer for your operating system from the following link: [Download the On-premise Server Installer](https://drive.google.com/file/d/1aPi9rI8Yg7dnkZ3qCE_zMZoU14r4yCva/view?usp=sharing) 2. **Install the On-premise Server** Run the installer and follow the on-screen instructions to complete the installation
3. **Request License and Update**\ Run MIRequest.exe file to generate a license request file. You can find it here.\ \ Open it, generate a license request file, and send it to us via [email ](mailto:info@miniai.live)or [WhatsApp](https://wa.me/+19162702374). We will send the license based on your Unique Request file, then you can upload the license file to allow to use. Refer the below images. ```markdown C:\Program Files\MiniAiLive\MiniAiLive-ID-Server ```
4. **Verify Installation**\ After installation, verify that the On-premise Server is correctly installed by checking the task manager
## API Reference 1. **Endpoint** `POST` `http://127.0.0.1:8082/api/check_id` \ * **Form Data:** * `image`: The image file (PNG, JPG, etc.) to be analyzed. This should be provided as a file upload
`POST` `http://127.0.0.1:8082/api/check_id_base64` \ * **Raw Data:** * `JSON Format`: ```json { "image": "--base64 image data here--" } ```
Other available endpoints here. `POST` `http://127.0.0.1:8082/api/check_credit` \ `POST` `http://127.0.0.1:8082/api/check_credit_base64` \ `POST` `http://127.0.0.1:8082/api/check_mrz` \ `POST` `http://127.0.0.1:8082/api/check_mrz_base64` \ 2. **Response** The API returns a JSON object with the liveness result of the input face image. Here is an example response
## Testing API ### Gradio Demo We have included a Gradio demo to showcase the capabilities of our **MiniAiLive** ID Document Recognition SDK. Gradio is a Python library that allows you to quickly create user interfaces for machine learning models. #### How to Run the Gradio Demo 1. **Install Gradio:** First, you need to install Gradio. You can do this using pip: ```json git clone https://github.com/MiniAiLive/ID-DocumentRecognition-Windows-SDK.git pip install -r requirement.txt cd gradio ``` 2. **Run Gradio Demo:** ``` python app.py ``` ### Python Test API Example To help you get started with using the API, here is a comprehensive example of how to interact with the ID Document Recognition API using Python. You can use API with another language you want to use like C++, C#, Ruby, Java, Javascript, and more 1. **Prerequisites** * Python 3.6+ * `requests` library (you can install it using `pip install requests`) 2. **Example Script** This example demonstrates how to send an image file to the API endpoint and process the response. ``` import requests # URL of the web API endpoint url = 'http://127.0.0.1:8082/api/check_id' # Path to the image file you want to send image_path = './test_image.jpg' # Read the image file and send it as form data files = {'image': open(image_path, 'rb')} try: # Send POST request response = requests.post(url, files=files) # Check if the request was successful if response.status_code == 200: print('Request was successful!') # Parse the JSON response response_data = response.json() print('Response Data:', response_data) else: print('Request failed with status code:', response.status_code) print('Response content:', response.text) except requests.exceptions.RequestException as e: print('An error occurred:', e) ``` ## 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
NoProjectFeature
1FaceRecognition-Linux1:1 & 1:N Face Matching
2FaceRecognition-Windows1:1 & 1:N Face Matching
3FaceRecognition-Docker1:1 & 1:N Face Matching
4FaceRecognition-Android1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
5FaceRecognition-LivenessDetection-Windows1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
6FaceLivenessDetection-Linux2D & 3D Face Passive LivenessDetection
7FaceLivenessDetection-Windows2D & 3D Face Passive LivenessDetection
8FaceLivenessDetection-Docker2D & 3D Face Passive LivenessDetection
9FaceLivenessDetection-Android2D & 3D Face Passive LivenessDetection
10FaceMatching-Android1:1 Face Matching
11FaceMatching-Windows-Demo1:1 Face Matching
12FaceAttributes-AndroidFace Attributes, Age & Gender Estimation
13ID-DocumentRecognition-LinuxIDCard, Passport, Driver License, Credit, MRZ Recognition
14ID-DocumentRecognition-WindowsIDCard, Passport, Driver License, Credit, MRZ Recognition
15ID-DocumentRecognition-DockerIDCard, Passport, Driver License, Credit, MRZ Recognition
16ID-DocumentRecognition-AndroidIDCard, Passport, Driver License, Credit, MRZ Recognition
17ID-DocumentLivenessDetection-LinuxID Document LivenessDetection
18ID-DocumentLivenessDetection-WindowsID Document LivenessDetection
19ID-DocumentLivenessDetection-DockerID Document LivenessDetection
## 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). # IDSDK - Linux ID Document Recognition Linux Server SDK {% hint style="success" %} * Our SDK is fully on-premise, processing all happens on hosting server and no data leaves your server. * 14,000+ document templates covering IDs issued in 250+ countries and territories. * Support of 140+ languages and special characters via sophisticated neural networks. {% endhint %} ## Introduction Welcome to the **MiniAiLive** ID Document Recognition SDK! This SDK provides powerful tools for recognizing and extracting information from ID documents. The SDK is available for both Windows and Linux platforms and includes an API for integration. Reduce drop-off and boost conversions with ID scanning and verification solutions. Quickly and securely capture, extract, and verify data from diverse **ID cards**, **passports**, **driver’s licenses**, and other documents with our proven, AI-first approach. Designed to fit seamlessly together, our technology can be integrated as a fully-bundled identity document verification solution or as separate modules via developer-friendly mobile or server SDK. Try it out today! ## Installation ### Prerequisites * Python 3.6+ * Linux * CPU: 2 cores or more * RAM: 4GB or more ### Installation Steps 1. **Download the ID Document Recognition Linux Server Installer** Download the Server installer for your operating system from the following link: [Download the On-premise Server Installer](https://drive.google.com/file/d/1NnZ-Ows3eI8O0TPTbJZcuIYUmVwXr-vV/view?usp=sharing) 2. **Install the On-premise Server** Run the installer and follow the on-screen instructions to complete the installation. Go to the Download folder and run this command. ``` $ cd Download $ sudo dpkg -i --force-overwrite MiniAiLive-IDSDK-LinuxServer.deb ```
3. **Request License and Update**\ You can generate the License Request file by using this command: ``` $ cd /opt/miniai/dr-webapi $ sudo ./MiRequest request /home/ubuntu/Download/trial_key.miq ```
Then you can see the license request file on your directory, and send it to us via [email ](mailto:info@miniai.live)or [WhatsApp](https://wa.me/+19162702374). We will send the license based on your Unique Request file, then you can upload the license file to allow to use. Refer the below images. ``` $ sudo ./MiRequest update /home/ubuntu/Download/trial_30.mis ```
4. **Verify Installation**\ After installation, verify that the On-premise Server is correctly installed by using this command: ``` $ systemctl list-units --state running ``` If you can see 'Mini-drsvc.service', 'Mini-idsvc.service', the server has been installed successfully. Refer the below image.
## API Reference 1. **Endpoint** `POST` `http://127.0.0.1:8082/api/check_id` \ * **Form Data:** * `image`: The image file (PNG, JPG, etc.) to be analyzed. This should be provided as a file upload
`POST` `http://127.0.0.1:8082/api/check_id_base64` \ * **Raw Data:** * `JSON Format`: ```json { "image": "--base64 image data here--" } ```
Other available endpoints here. `POST` `http://127.0.0.1:8082/api/check_credit` \ `POST` `http://127.0.0.1:8082/api/check_credit_base64` \ `POST` `http://127.0.0.1:8082/api/check_mrz` \ `POST` `http://127.0.0.1:8082/api/check_mrz_base64` \ 2. **Response** The API returns a JSON object with the liveness result of the input face image. Here is an example response
## Testing API ### Gradio Demo We have included a Gradio demo to showcase the capabilities of our **MiniAiLive** ID Document Recognition SDK. Gradio is a Python library that allows you to quickly create user interfaces for machine learning models. #### How to Run the Gradio Demo 1. **Install Gradio:** First, you need to install Gradio. You can do this using pip: ```json git clone https://github.com/MiniAiLive/ID-DocumentRecognition-Linux-SDK.git pip install -r requirement.txt cd gradio ``` 2. **Run Gradio Demo:** ``` python app.py ``` ### Python Test API Example To help you get started with using the API, here is a comprehensive example of how to interact with the ID Document Recognition API using Python. You can use API with another language you want to use like C++, C#, Ruby, Java, Javascript, and more 1. **Prerequisites** * Python 3.6+ * `requests` library (you can install it using `pip install requests`) 2. **Example Script** This example demonstrates how to send an image file to the API endpoint and process the response. ``` import requests # URL of the web API endpoint url = 'http://127.0.0.1:8082/api/check_id' # Path to the image file you want to send image_path = './test_image.jpg' # Read the image file and send it as form data files = {'image': open(image_path, 'rb')} try: # Send POST request response = requests.post(url, files=files) # Check if the request was successful if response.status_code == 200: print('Request was successful!') # Parse the JSON response response_data = response.json() print('Response Data:', response_data) else: print('Request failed with status code:', response.status_code) print('Response content:', response.text) except requests.exceptions.RequestException as e: print('An error occurred:', e) ``` ## 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
NoProjectFeature
1FaceRecognition-Linux1:1 & 1:N Face Matching
2FaceRecognition-Windows1:1 & 1:N Face Matching
3FaceRecognition-Docker1:1 & 1:N Face Matching
4FaceRecognition-Android1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
5FaceRecognition-LivenessDetection-Windows1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
6FaceLivenessDetection-Linux2D & 3D Face Passive LivenessDetection
7FaceLivenessDetection-Windows2D & 3D Face Passive LivenessDetection
8FaceLivenessDetection-Docker2D & 3D Face Passive LivenessDetection
9FaceLivenessDetection-Android2D & 3D Face Passive LivenessDetection
10FaceMatching-Android1:1 Face Matching
11FaceMatching-Windows-Demo1:1 Face Matching
12FaceAttributes-AndroidFace Attributes, Age & Gender Estimation
13ID-DocumentRecognition-LinuxIDCard, Passport, Driver License, Credit, MRZ Recognition
14ID-DocumentRecognition-WindowsIDCard, Passport, Driver License, Credit, MRZ Recognition
15ID-DocumentRecognition-DockerIDCard, Passport, Driver License, Credit, MRZ Recognition
16ID-DocumentRecognition-AndroidIDCard, Passport, Driver License, Credit, MRZ Recognition
17ID-DocumentLivenessDetection-LinuxID Document LivenessDetection
18ID-DocumentLivenessDetection-WindowsID Document LivenessDetection
19ID-DocumentLivenessDetection-DockerID Document LivenessDetection
## 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). # IDSDK - Android ID Document Recognition Android SDK {% hint style="success" %} * Our SDK is fully on-premise, processing all happens on hosting server and no data leaves your server. * 14,000+ document templates covering IDs issued in 250+ countries and territories. * Support of 140+ languages and special characters via sophisticated neural networks. {% endhint %} ## Introduction Welcome to the **MiniAiLive** ID Document Recognition SDK! This SDK provides powerful tools for recognizing and extracting information from ID documents. The SDK is available for both Windows and Linux platforms and includes an API for integration. Reduce drop-off and boost conversions with ID scanning and verification solutions. Quickly and securely capture, extract, and verify data from diverse **ID cards**, **passports**, **driver’s licenses**, and other documents with our proven, AI-first approach. Designed to fit seamlessly together, our technology can be integrated as a fully-bundled identity document verification solution or as separate modules via developer-friendly mobile or server SDK. Try it out today! ### Key Features * **Document Capture** * **Visual Analysis and OCR** * **Automated Document Type Detection** * **Accurate Visual Zone Verification** * **Barcode Recognition** * **Fully offline, On-Premise SDK** ## How to build ### Prerequisites * Android 5.0 (API level 21) OS or newer * RAM 256 MB or more * Android Studio 4.0 IDE or later ### Download SDK We provide Android demo project with our ID Document Recognition Android SDK. Please contact us to get demo project. {% hint style="info" %} Note: Current demo application ID is "com.miniai.idcardrecognition". If you want to use your own application ID with our SDK, then you need to provide your application ID to us, then we will provide you trial license for your app ID. {% endhint %} If you need to use our SDK on your existing application, please add dependency to your `build.gradle` 
implementation files('libs/miniai_id.aar')
You can download our **MiniAiLive** android lib file here : [miniai\_id.aar](https://drive.google.com/file/d/1kKmVb3nBB3yRjWHWMdawUoNCbSFyWvN3/view?usp=sharing) ### Initializing SDK 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. ## Get it on Google Driver [![](/files/XaWcHfUYqZxewpGGgue3)](https://drive.google.com/file/d/1tEA7hfW-TReW9j3hS4A7fstxr0HDp4Gw/view?usp=sharing) ## Youtube - Demo Video {% embed url="" %} ## 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
NoProjectFeature
1FaceRecognition-Linux1:1 & 1:N Face Matching
2FaceRecognition-Windows1:1 & 1:N Face Matching
3FaceRecognition-Docker1:1 & 1:N Face Matching
4FaceRecognition-Android1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
5FaceRecognition-LivenessDetection-Windows1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
6FaceLivenessDetection-Linux2D & 3D Face Passive LivenessDetection
7FaceLivenessDetection-Windows2D & 3D Face Passive LivenessDetection
8FaceLivenessDetection-Docker2D & 3D Face Passive LivenessDetection
9FaceLivenessDetection-Android2D & 3D Face Passive LivenessDetection
10FaceMatching-Android1:1 Face Matching
11FaceMatching-Windows-Demo1:1 Face Matching
12FaceAttributes-AndroidFace Attributes, Age & Gender Estimation
13ID-DocumentRecognition-LinuxIDCard, Passport, Driver License, Credit, MRZ Recognition
14ID-DocumentRecognition-WindowsIDCard, Passport, Driver License, Credit, MRZ Recognition
15ID-DocumentRecognition-DockerIDCard, Passport, Driver License, Credit, MRZ Recognition
16ID-DocumentRecognition-AndroidIDCard, Passport, Driver License, Credit, MRZ Recognition
17ID-DocumentLivenessDetection-LinuxID Document LivenessDetection
18ID-DocumentLivenessDetection-WindowsID Document LivenessDetection
19ID-DocumentLivenessDetection-DockerID Document LivenessDetection
## 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). # IDSDK - iOS ID Document Recognition iOS SDK {% hint style="success" %} * Our SDK is fully on-premise, processing all happens on hosting server and no data leaves your server. * 14,000+ document templates covering IDs issued in 250+ countries and territories. * Support of 140+ languages and special characters via sophisticated neural networks. {% endhint %} ## Introduction Welcome to the **MiniAiLive** ID Document Recognition SDK! This SDK provides powerful tools for recognizing and extracting information from ID documents. The SDK is available for both Windows and Linux platforms and includes an API for integration. Reduce drop-off and boost conversions with ID scanning and verification solutions. Quickly and securely capture, extract, and verify data from diverse **ID cards**, **passports**, **driver’s licenses**, and other documents with our proven, AI-first approach. Designed to fit seamlessly together, our technology can be integrated as a fully-bundled identity document verification solution or as separate modules via developer-friendly mobile or server SDK. Try it out today! ### Key Features * **Document Capture** * **Visual Analysis and OCR** * **Automated Document Type Detection** * **Accurate Visual Zone Verification** * **Barcode Recognition** * **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 ID Document Recognition iOS SDK. Please contact us to get demo project. {% hint style="info" %} Note: Current demo bundle ID is "com.miniai.idcardrecogntion". 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 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="" %} ## 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
NoProjectFeature
1FaceRecognition-Linux1:1 & 1:N Face Matching
2FaceRecognition-Windows1:1 & 1:N Face Matching
3FaceRecognition-Docker1:1 & 1:N Face Matching
4FaceRecognition-Android1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
5FaceRecognition-LivenessDetection-Windows1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
6FaceLivenessDetection-Linux2D & 3D Face Passive LivenessDetection
7FaceLivenessDetection-Windows2D & 3D Face Passive LivenessDetection
8FaceLivenessDetection-Docker2D & 3D Face Passive LivenessDetection
9FaceLivenessDetection-Android2D & 3D Face Passive LivenessDetection
10FaceMatching-Android1:1 Face Matching
11FaceMatching-Windows-Demo1:1 Face Matching
12FaceAttributes-AndroidFace Attributes, Age & Gender Estimation
13ID-DocumentRecognition-LinuxIDCard, Passport, Driver License, Credit, MRZ Recognition
14ID-DocumentRecognition-WindowsIDCard, Passport, Driver License, Credit, MRZ Recognition
15ID-DocumentRecognition-DockerIDCard, Passport, Driver License, Credit, MRZ Recognition
16ID-DocumentRecognition-AndroidIDCard, Passport, Driver License, Credit, MRZ Recognition
17ID-DocumentLivenessDetection-LinuxID Document LivenessDetection
18ID-DocumentLivenessDetection-WindowsID Document LivenessDetection
19ID-DocumentLivenessDetection-DockerID Document LivenessDetection
## 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). # Supported ID Document Types 14,000+ document templates covering 250+ countries and territories, 140+ languages including Latin, Cyrillic, Hebrew, Greek, Arabic, Chinese, and more are supported. Our database contains more than 14,000 types of documents from 251 countries and territories of the world. Here are the most common ones. Border Crossing Card, Business Travel Card, Citizenship Card, Crew member certificate, Diplomatic Id Card, Driving License, ePassport, Health Insurance Card, ID Card, Immigration Card, Insurance Board Card, Laissez-Passer, Lawyer Card, Marine License, Medicare Card, Passport, Personal Card, Police Card, Proof of Age Card, Refugee Card, Registration Certificate, Residence permit, Social Security Card, Visa, Voter Card, Work Permit, and others. You can find the list of supported ID documents in the [Documents Database (PDF file)](https://drive.google.com/file/d/1TrNjyMoP-RVagnsQc6FqPXSZjFcuYRl2/view?usp=sharing). {% hint style="info" %} Note: Didn't find your identity document in the list? You can contact us to request add your documents in our database. Our team will support to add your specific documents in the list. {% endhint %} # OCR Supported Languages The following optical character recognition languages are supported by the **MiniAiLive** ID Document Recognition SDK engine: | Language | Alphabetic script | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | | Afrikaans (Afrikaans) | Latin | | Albanian (Shqip) | Latin | | Amharic (አማርኛ) | Amharic | | Arabic (Bahrain, Egypt, Iraq, Jordan, Kuwait, Lebanon, Libya, Morocco,Oman, Qatar, Saudi Arabia, Sudan, Syria, Tunisia, United Arab Emirates, Yemen) | Arabic | | Armenian (հայերեն) | Armenian alphabet | | Azerbaijani (Azərbaycan) | Latin | | Basque (Euskara) | Latin | | Belarusian (Беларуская) | Cyrillic | | Bengali (বাংলা) | Bengali | | Bosnian (Bosanski) | Latin | | Bulgarian (Български) | Cyrillic | | Catalan (Català) | Latin | | Chewa (Chichewa) | Latin | | Chinese (汉语 / 漢語 / 中文) | Chinese characters(Traditional/Simplified) | | Corsican (Corsu) | Latin | | Creole (Kreyòl Ayisyen) \[Haiti] | Latin | | Croatian (Hrvatski) | Latin | | Czech (Čeština) | Latin | | Danish (Dansk) | Latin | | Dutch (Netherlands) \[Belgium, Netherlands] | Latin | | English (English) \[Australia, Belize, Canada, Caribbean, Ireland, Jamaica, New Zealand, South Africa, Trinidad, United Kingdom, USA, Zimbabwe] | Latin | | Esperanto (Esperanto) | Latin | | Estonian (Eesti keel) | Latin | | Faroese (Føroyskt mál) | Latin | | Filipino (Filipino) | Latin | | Finnish (Suomi) | Latin | | French (Français) \[Belgium, Canada, France, Luxembourg, Monaco, Switzerland] | Latin | | Frisian (Frysk) | Latin | | Galician (Galego) | Latin | | Georgian (ქართული) | Georgian | | German (Deutsch) \[Austria, Germany, Liechtenstein, Luxembourg, Switzerland] | Latin | | Greek (Ελληνικά) | Greek | | Hausa (Harshen) | Latin | | Hawaiian (ʻŌlelo Hawaiʻi) | Latin | | (עברית) Hebrew | Hebrew | | Hindi (हिन्दी) | Devanagari | | Hmong | Latin | | Hungarian (Magyar) | Latin | | Icelandic (Íslenska) | Latin | | Indonesian (Bahasa Indonesia) | Latin | | Irish (Gaeilge) | Latin | | Italian (Italiano) \[Italy, Switzerland] | Latin | | Japanese (日本語) | Japanese | | Kashmiri (कॉशुर) | Devanagari | | Kazakh (Қазақ) | Cyrillic | | Khosa (Xhosa) | Latin | | Khmer (ភាសាខ្មែរ) | Khmer | | Konkani (कोंकणी) | Konkani | | Korean (한국어) | Korean | | Kurmanji | Latin | | Kyrgyz (Кыргыз тили) | Cyrillic | | Latin (Latine) | Latin | | Latvian (Latviešu) | Latin | | Lao (ພາສາລາວ) | Lao | | Lithuanian (Lietuvių) | Latin | | Luxembourgish (Lëtzebuergesch) | Latin | | Macedonian (Македонски) | Cyrillic | | Malagasy | Latin | | Malay (Bahasa Melayu) \[Brunei Darussalam, Malaysia] | Latin | | Maltese (Malti) | Latin | | Marathi (मराठी) | Devanagari | | Mongolian (Монгол) | Cyrillic | | Norwegian (Norsk) \[Bokmal, Nynorsk] | Latin | | Pashto(پښتو) | Pashto | | Persian(فارسی(fārsi)) \[Afghanistan, Iran] | Persian | | Polish (Polski) | Latin | | Portuguese (Português) \[Brazil, Portugal] | Latin | | Punjabi (ਪੰਜਾਬੀ) | Gurmukhi | | Romanian (Română) | Latin | | Russian (Русский) | Cyrillic | | Sanskrit (संस्कृतम्) | Sanskrit | | Scottish (Gaelic) | Latin | | Serbian (Српски, Srpski) | Cyrillic, Latin | | Sindhi(سنڌي) | Sindhi | | Sinhala (සිංහල) | Sinhala | | Slovak (Slovenčina) | Latin | | Slovenian (Slovenščina) | Latin | | Somali (Af Soomaali) | Latin | | Sotho (Sesotho) | Latin | | Spanish (Español) \[Argentina, Bolivia, Chile, Colombia, Costa Rica, Dominican Republic, Ecuador, El Salvador, Guatemala, Honduras, Spain, Mexico, Nicaragua, Panama, Paraguay, Peru, Puerto Rico, Uruguay, Venezuela] | Latin | | Swahili (Swahili) | Latin | | Swedish (Svenska) \[Sweden, Finland] | Latin | | Tajik (Тоҷикӣ) | Cyrillic | | Tamil (தமிழ்) | Tamil | | Tatar (Татар теле) | Cyrillic | | Thai (ไทย) | Thai | | Turkish (Türkçe) | Latin | | Turkmen (Türkmençe) | Cyrillic | | Ukrainian (Українська) | Cyrillic | | Urdu(اردو) | Urdu | | Uzbek (Oʻzbekcha, Ўзбекча) | Cyrillic, Latin | | Vietnamese (Tiếng Việt) | Latin | | Welsh (Cymraeg) | Latin | | Yiddish(יידיש) | Hebrew | | Zulu (IsiZulu) | Latin | # ID Document Liveness Detection SDK Welcome to the MiniAiLive ID Document Liveness Detection SDK Overview, your gateway to understanding the powerful capabilities and inner workings of our cuttin-edge document liveness technology. ## Overview **MiniAiLive** ID Document Liveness Detection SDK is is the top document liveness detection solution. It is the ultimate in identity document verification from a leader in document liveness detection software and biometrics. Developed by skilled data scientists using advanced neural network technology, the product suite provides near complete, accurate document liveness detection with a friction-free experience that’s seamless for genuine users. With our IDLiveness SDK, you can address the three most common presentation attacks universally across all the common types of identity documents anywhere in the world without needing to train on document templates. ### Key Features and Benefits * **Automated and Accurate Review**\ Surpass manual checks by detecting attacks and identify ID Fake in real time with liveness detection in under a second, no human review needed. * **Quick and Easy Integration**\ Easily integrate on-premise and offline SDK into existing onboarding system with a single API for a seamless experience. * **Save Time and Effort**\ Save time, cost and effort by automating document liveness check, ensuring only live photos advance, and achieving long-term savings. * **Passive Liveness Detection**\ Implement a passive, single-image process that requires no complicated instructions or changes to your existing user interface. ### Key Functions * **Screen Replay Attack Prevention**\ Imagine a person presents a photo on a digital screen as proof of identity instead of a genuine document. In some cases, this is a purely innocent act by someone who keeps a digital copy of their driver’s license on their phone. \ \ But in most cases, screen replays are malicious acts. Fraudsters use them to imply they possess an identity document that they don’t actually have. In fact, screen replay attacks are the most common type of document liveness fraud today. They are low-effort attacks, and digital images are the easiest to doctor. \ \ With **MiniAiLive** IDLiveness SDK for Screen Replay Attacks, you can protect your business with the industry standard in detecting replayed documents, all while ensuring that the document liveness verification process is seamless for genuine users. * **Printed Copy Attack Prevention**\ Have you considered all the ways that fraudsters try to pass off printed copies as authentic identity documents? We have. In fact, we think about it all the time.
That’s why we developed **MiniAiLive** IDLiveness SDK for Printed Copy Attacks. Part of our IDLiveness SDK, it offers 360-degree protection from the physical document presentation attacks that fraudsters commit. All while ensuring that the verification process is seamless for genuine users.\ \ While printed copy attacks are not as common as screen replay attacks, the potential impact is just as serious. Plus, printed copy attacks are easy for fraudsters to commit. But with our **MiniAiLive** IDLiveness SDK for Printed Copy attacks, catching them is easy too. * **Portrait Substitution Attack Prevention**\ A fraudster thinks he has the perfect document spoofing scheme. He’s gotten his hands on an authentic government-issued ID that he alters by overlaying a new photo over the existing one. He thinks he’s in business. But he doesn’t know what **MiniAiLive** IDLiveness SDK for Portrait Substitution can do. \ Organizations that rely on document identity verification are vulnerable to portrait substitution attacks like this one. It’s simply too easy for fraudsters to manipulate identifying photos on lost or stolen authentic IDs. By substituting a victim’s identity with their likeness, fraudsters can trick humans and document verification systems.
We developed IDLiveness SDK for Portrait Substitution Attacks to tackle this specific type of document fraud, addressing a pressing market need with our templateless, AI-powered liveness detection capabilities. ## Products
ID Document Liveness Detection SDK - Windows /pages/zq7uGkUYFQkVbCPTkzqG/files/7rjJZeEmWwbd6qGY49dB
ID Document Liveness Detection SDK - Linux/pages/iAPYK2q3sH8ufq1736JX/files/R82zT8MqgZiEizPhg6zC
## Contact US Whether you are a business exploring biometrics to improve security and remove friction out of your UX or a technology company seeking industry-leading core biometric technology, we'd love to talk.
Click to WhatsApp - MiniAiLive/files/nG6ihxlFLttiHc90q1Z9https://wa.me/+19162702374
Click to Live Chat - MiniAiLive/files/UHGIuaUQUzYTAIdqgvF0https://www.miniai.live
Click to Email - MiniAiLive/files/bTEduqzdz4p4DBcJBmM3mailto:info@miniai.live
Click to Telegram - MiniAiLive/files/XpVVN65wbzF9Cnj9MGL5https://t.me/Contact_MiniAiLive
Click to Skype - MiniAiLive/files/XjOPi6fIHc8MbgRMbznYhttps://join.skype.com/invite/ltQEVDmVddTe
# IDLivenessSDK - Windows ID Document Liveness Detection Windows Server SDK {% hint style="success" %} Our SDK is fully on-premise, processing all happens on hosting server and no data leaves your server. {% endhint %} ## Introduction Welcome to the **MiniAiLive** ID Document Liveness Detection SDK! \ \ **MiniAiLive's** Complete Document Liveness Detection Solution for Digital Onboarding here! With 70% of fraud in digital onboarding and KYC happening with document fraud—or document presentation attacks—identity verification is a critical line of defense against the financial and reputational damage of document fraud. That’s where document liveness detection software comes in. It detects when an identity document is not genuine but instead a document presentation attack. With our product suite, you can address the three most common presentation attacks universally across all the common types of identity documents anywhere in the world without needing to train on document templates. Try it out today! ## Installation ### Prerequisites * Python 3.6+ * Windows * CPU: 2 cores or more * RAM: 4GB or more ### Installation Steps 1. **Download the ID Document Liveness Detection Windows Server Installer** Download the Server installer for your operating system from the following link: [Download the On-premise Server Installer](https://drive.google.com/file/d/1FTtd5Ylpiy8iNgDnEbxtcg6GAJiVxWUi/view?usp=sharing) 2. **Install the On-premise Server** Run the installer and follow the on-screen instructions to complete the installation
3. **Request License and Update**\ Run MIRequest.exe file to generate a license request file. You can find it here.\ \ Open it, generate a license request file, and send it to us via [email ](mailto:info@miniai.live)or [WhatsApp](https://wa.me/+19162702374). We will send the license based on your Unique Request file, then you can upload the license file to allow to use. Refer the below images. ```markdown C:\Users\{User name}\AppData\Local\MiniAiLive\MiniAiLive-IDLiveness-WinServer ```
4. **Verify Installation**\ After installation, verify that the On-premise Server is correctly installed by checking the task manager
## API Reference 1. **Endpoint** `POST` `http://127.0.0.1:8093/api/check_id_liveness` \ * **Form Data:** * `image`: The image file (PNG, JPG, etc.) to be analyzed. This should be provided as a file upload
`POST` `http://127.0.0.1:8093/api/check_id_liveness_base64` \ * **Raw Data:** * `JSON Format`: ```json { "image": "--base64 image data here--" } ```
2. **Response** The API returns a JSON object with the liveness result of the input face image. Here is an example response
## Testing API ### Gradio Demo We have included a Gradio demo to showcase the capabilities of our **MiniAiLive** ID Document Liveness Detection SDK. Gradio is a Python library that allows you to quickly create user interfaces for machine learning models. #### How to Run the Gradio Demo 1. **Install Gradio:** First, you need to install Gradio. You can do this using pip: ```json git clone https://github.com/MiniAiLive/ID-Document-LivenessDetection-Windows-SDK.git pip install -r requirement.txt cd gradio ``` 2. **Run Gradio Demo:** ``` python app.py ``` ### Python Test API Example To help you get started with using the API, here is a comprehensive example of how to interact with the ID Document Liveness Detection API using Python. You can use API with another language you want to use like C++, C#, Ruby, Java, Javascript, and more 1. **Prerequisites** * Python 3.6+ * `requests` library (you can install it using `pip install requests`) 2. **Example Script** This example demonstrates how to send an image file to the API endpoint and process the response. ``` import requests # URL of the web API endpoint url = 'http://127.0.0.1:8093/api/check_id_liveness' # Path to the image file you want to send image_path = './test_image.jpg' # Read the image file and send it as form data files = {'image': open(image_path, 'rb')} try: # Send POST request response = requests.post(url, files=files) # Check if the request was successful if response.status_code == 200: print('Request was successful!') # Parse the JSON response response_data = response.json() print('Response Data:', response_data) else: print('Request failed with status code:', response.status_code) print('Response content:', response.text) except requests.exceptions.RequestException as e: print('An error occurred:', e) ``` ## 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
NoProjectFeature
1FaceRecognition-Linux1:1 & 1:N Face Matching
2FaceRecognition-Windows1:1 & 1:N Face Matching
3FaceRecognition-Docker1:1 & 1:N Face Matching
4FaceRecognition-Android1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
5FaceRecognition-LivenessDetection-Windows1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
6FaceLivenessDetection-Linux2D & 3D Face Passive LivenessDetection
7FaceLivenessDetection-Windows2D & 3D Face Passive LivenessDetection
8FaceLivenessDetection-Docker2D & 3D Face Passive LivenessDetection
9FaceLivenessDetection-Android2D & 3D Face Passive LivenessDetection
10FaceMatching-Android1:1 Face Matching
11FaceMatching-Windows-Demo1:1 Face Matching
12FaceAttributes-AndroidFace Attributes, Age & Gender Estimation
13ID-DocumentRecognition-LinuxIDCard, Passport, Driver License, Credit, MRZ Recognition
14ID-DocumentRecognition-WindowsIDCard, Passport, Driver License, Credit, MRZ Recognition
15ID-DocumentRecognition-DockerIDCard, Passport, Driver License, Credit, MRZ Recognition
16ID-DocumentRecognition-AndroidIDCard, Passport, Driver License, Credit, MRZ Recognition
17ID-DocumentLivenessDetection-LinuxID Document LivenessDetection
18ID-DocumentLivenessDetection-WindowsID Document LivenessDetection
19ID-DocumentLivenessDetection-DockerID Document LivenessDetection
## 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). # IDLivenessSDK - Linux ID Document Liveness Detection Linux Server SDK {% hint style="success" %} Our SDK is fully on-premise, processing all happens on hosting server and no data leaves your server. {% endhint %} ## Introduction Welcome to the **MiniAiLive** ID Document Liveness Detection SDK! \ \ **MiniAiLive's** Complete Document Liveness Detection Solution for Digital Onboarding here! With 70% of fraud in digital onboarding and KYC happening with document fraud—or document presentation attacks—identity verification is a critical line of defense against the financial and reputational damage of document fraud. That’s where document liveness detection software comes in. It detects when an identity document is not genuine but instead a document presentation attack. With our product suite, you can address the three most common presentation attacks universally across all the common types of identity documents anywhere in the world without needing to train on document templates. Try it out today! ## Installation ### Prerequisites * Python 3.6+ * Linux * CPU: 2 cores or more * RAM: 4GB or more ### Installation Steps 1. **Download the ID Document Liveness Detection Linux Server Installer** Download the Server installer for your operating system from the following link: [Download the On-premise Server Installer](https://drive.google.com/file/d/1f1G5ORKgg9sCBDxKZR_uPweS8hhO7Cna/view?usp=sharing) 2. **Install the On-premise Server** Run the installer and follow the on-screen instructions to complete the installation. Go to the Download folder and run this command. ``` $ cd Download $ sudo dpkg -i --force-overwrite MiniAiLive-IDLiveness-LinuxServer.deb ```
3. **Request License and Update**\ You can generate the License Request file by using this command: ``` $ cd /opt/mini-idliveness/ $ sudo ./MiRequest request /home/ubuntu/Download/trial_key.miq ```
Then you can see the license request file on your directory, and send it to us via [email ](mailto:info@miniai.live)or [WhatsApp](https://wa.me/+19162702374). We will send the license based on your Unique Request file, then you can upload the license file to allow to use. Refer the below images. ``` $ sudo ./MiRequest update /home/ubuntu/Download/trial_key.mis ```
4. **Verify Installation**\ After installation, verify that the On-premise Server is correctly installed by using this command: ``` $ systemctl list-units --state running ``` If you can see 'Mini-idliveness-svc.service', the server has been installed successfully. Refer the below image.
## API Reference 1. **Endpoint** `POST` `http://127.0.0.1:8093/api/check_id_liveness` \ * **Form Data:** * `image`: The image file (PNG, JPG, etc.) to be analyzed. This should be provided as a file upload
`POST` `http://127.0.0.1:8093/api/check_id_liveness_base64` \ * **Raw Data:** * `JSON Format`: ```json { "image": "--base64 image data here--" } ```
2. **Response** The API returns a JSON object with the liveness result of the input face image. Here is an example response
## Testing API ### Gradio Demo We have included a Gradio demo to showcase the capabilities of our **MiniAiLive** ID Document Liveness Detection SDK. Gradio is a Python library that allows you to quickly create user interfaces for machine learning models. #### How to Run the Gradio Demo 1. **Install Gradio:** First, you need to install Gradio. You can do this using pip: ```json git clone https://github.com/MiniAiLive/ID-Document-LivenessDetection-Linux-SDK.git pip install -r requirement.txt cd gradio ``` 2. **Run Gradio Demo:** ``` python app.py ``` ### Python Test API Example To help you get started with using the API, here is a comprehensive example of how to interact with the ID Document Liveness Detection API using Python. You can use API with another language you want to use like C++, C#, Ruby, Java, Javascript, and more 1. **Prerequisites** * Python 3.6+ * `requests` library (you can install it using `pip install requests`) 2. **Example Script** This example demonstrates how to send an image file to the API endpoint and process the response. ``` import requests # URL of the web API endpoint url = 'http://127.0.0.1:8093/api/check_id_liveness' # Path to the image file you want to send image_path = './test_image.jpg' # Read the image file and send it as form data files = {'image': open(image_path, 'rb')} try: # Send POST request response = requests.post(url, files=files) # Check if the request was successful if response.status_code == 200: print('Request was successful!') # Parse the JSON response response_data = response.json() print('Response Data:', response_data) else: print('Request failed with status code:', response.status_code) print('Response content:', response.text) except requests.exceptions.RequestException as e: print('An error occurred:', e) ``` ## 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
NoProjectFeature
1FaceRecognition-Linux1:1 & 1:N Face Matching
2FaceRecognition-Windows1:1 & 1:N Face Matching
3FaceRecognition-Docker1:1 & 1:N Face Matching
4FaceRecognition-Android1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
5FaceRecognition-LivenessDetection-Windows1:1 & 1:N Face Matching, 2D & 3D Face Passive LivenessDetection
6FaceLivenessDetection-Linux2D & 3D Face Passive LivenessDetection
7FaceLivenessDetection-Windows2D & 3D Face Passive LivenessDetection
8FaceLivenessDetection-Docker2D & 3D Face Passive LivenessDetection
9FaceLivenessDetection-Android2D & 3D Face Passive LivenessDetection
10FaceMatching-Android1:1 Face Matching
11FaceMatching-Windows-Demo1:1 Face Matching
12FaceAttributes-AndroidFace Attributes, Age & Gender Estimation
13ID-DocumentRecognition-LinuxIDCard, Passport, Driver License, Credit, MRZ Recognition
14ID-DocumentRecognition-WindowsIDCard, Passport, Driver License, Credit, MRZ Recognition
15ID-DocumentRecognition-DockerIDCard, Passport, Driver License, Credit, MRZ Recognition
16ID-DocumentRecognition-AndroidIDCard, Passport, Driver License, Credit, MRZ Recognition
17ID-DocumentLivenessDetection-LinuxID Document LivenessDetection
18ID-DocumentLivenessDetection-WindowsID Document LivenessDetection
19ID-DocumentLivenessDetection-DockerID Document LivenessDetection
## 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). # About US ## Contact US Whether you are a business exploring biometrics to improve security and remove friction out of your UX or a technology company seeking industry-leading core biometric technology, we'd love to talk.
Click to WhatsApp - MiniAiLive/files/nG6ihxlFLttiHc90q1Z9https://wa.me/+19162702374
Click to Live Chat - MiniAiLive/files/UHGIuaUQUzYTAIdqgvF0https://www.miniai.live
Click to Email - MiniAiLive/files/bTEduqzdz4p4DBcJBmM3mailto:info@miniai.live
Click to Telegram - MiniAiLive/files/XpVVN65wbzF9Cnj9MGL5https://t.me/Contact_MiniAiLive
Click to Skype - MiniAiLive/files/XjOPi6fIHc8MbgRMbznYhttps://join.skype.com/invite/ltQEVDmVddTe