Skip to content

Latest commit

 

History

History
233 lines (181 loc) · 11.5 KB

File metadata and controls

233 lines (181 loc) · 11.5 KB

ID Document Liveness Detection Linux SDK

MiniAiLive Logo

Welcome to the MiniAiLive!

Welcome to the 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!

Note

  • Our SDK is fully on-premise, processing all happens on hosting server and no data leaves server.

Table of Contents

ID-LivenessSDK Installation Guide

Prerequisites

  • Python 3.6+
  • Linux
  • CPU: 2cores 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

  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
MiniAiLive Installer
You can refer our Documentation here. https://docs.miniai.live
  1. 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
MiniAiLive Installer
Then you can see the license request file on your directory, and send it to us via email or WhatsApp. 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
MiniAiLive Installer
  1. 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.

MiniAiLive Installer

ID-LivenessSDK API Details

Endpoint

  • POST http://127.0.0.1:8093/api/check_id_liveness ID Document Liveness Detection API
  • POST http://127.0.0.1:8093/api/check_id_liveness_base64 ID Document Liveness Detection API

Request

  • URL: http://127.0.0.1:8093/api/check_id_liveness
  • Method: POST
  • Form Data:
    • image: The image file (PNG, JPG, etc.) to be analyzed. This should be provided as a file upload.
Screenshot 2024-07-16 at 5 12 01 AM
  • URL: http://127.0.0.1:8093/api/check_id_liveness_base64
  • Method: POST
  • Raw Data:
    • JSON Format: { "image": "--base64 image data here--" }
Screenshot 2024-07-16 at 5 11 34 AM

Response

The API returns a JSON object with the ID document liveness detection details. Here is an example response:

Gradio Demo

We have included a Gradio demo to showcase the capabilities of our 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:

    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

Prerequisites

  • Python 3.6+
  • requests library (you can install it using pip install requests)

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)

Request license

Feel free to Contact US to get a trial License. We are 24/7 online on WhatsApp: +19162702374.

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive messages.
4. Push your changes to your forked repository.
5. Submit a pull request to the original repository.

Face & IDSDK Online Demo, Resources

Our Products

No Project Feature
1 FaceRecognition-Android 1:N Face Matching, 3D Face Passive LivenessDetection
2 FaceRecognition-LivenessDetection-Windows 1:N Face Matching, 3D Face Passive LivenessDetection
3 FaceLivenessDetection-Android 2D & 3D Face Passive LivenessDetection
4 FaceLivenessDetection-Linux 2D & 3D Face Passive LivenessDetection
5 FaceLivenessDetection-Windows 2D & 3D Face Passive LivenessDetection
6 FaceMatching-Android 1:1 Face Matching
7 FaceMatching-Windows 1:1 Face Matching
8 FaceAttributes-Android Face Attributes, Age & Gender Estimation
9 ID-DocumentRecognition-Android IDCard, Passport, Driver License, Credit, MRZ Recognition
10 ID-DocumentRecognition-Linux IDCard, Passport, Driver License, Credit, MRZ Recognition
11 ID-DocumentRecognition-Windows IDCard, Passport, Driver License, Credit, MRZ Recognition
12 ID-DocumentLivenessDetection-Linux ID Document LivenessDetection
13 ID-DocumentLivenessDetection-Windows ID Document LivenessDetection

About MiniAiLive

MiniAiLive is a leading AI solutions company specializing in computer vision and machine learning technologies. We provide cutting-edge solutions for various industries, leveraging the power of AI to drive innovation and efficiency.

Contact US

For any inquiries or questions, please Contact US

www.miniai.livewww.miniai.livewww.miniai.live