Welcome to the MiniAiLive!
Welcome to the 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!
Note
- Our SDK is fully on-premise, processing all happens on hosting server and no data leaves server.
- 8,000+ document templates covering IDs issued in 200+ countries and territories.
- Support of 100+ languages and special characters via sophisticated neural networks.
- Python 3.6+
- Windows
- CPU: 2cores or more
- RAM: 4GB or more
-
Download the ID Document Recognition Windows Server Installer:
Download the Server installer for your operating system from the following link:
-
Install the On-premise Server:
Run the installer and follow the on-screen instructions to complete the installation.
-
Request License and Update:
Run MIRequest.exe file to generate a license request file. You can find it here.
C:\Program Files\MiniAiLive\MiniAiLive-ID-Server
Open it, generate a license request file, 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.
-
Verify Installation:
After installation, verify that the On-premise Server is correctly installed by checking the task manager:
-
POST http://127.0.0.1:8082/api/check_id
ID Document Recognition API -
POST http://127.0.0.1:8082/api/check_id_base64
ID Document Recognition API -
POST http://127.0.0.1:8082/api/check_credit
Bank & Credit Card Reader API -
POST http://127.0.0.1:8082/api/check_credit_base64
Bank & Credit Card Reader API -
POST http://127.0.0.1:8082/api/check_mrz
MRZ & Barcode Recognition API -
POST http://127.0.0.1:8082/api/check_mrz_base64
MRZ & Barcode Recognition API
- URL:
http://127.0.0.1:8082/api/check_id
- 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](https://private-user-images.githubusercontent.com/127708602/350457261-fa954d58-d623-4db3-8a65-1df2d5c28baf.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjMyOTUyNTQsIm5iZiI6MTcyMzI5NDk1NCwicGF0aCI6Ii8xMjc3MDg2MDIvMzUwNDU3MjYxLWZhOTU0ZDU4LWQ2MjMtNGRiMy04YTY1LTFkZjJkNWMyOGJhZi5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjQwODEwJTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI0MDgxMFQxMzAyMzRaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT02Mjg2YTNkYzAxMTQxYWY5YjM1MjQ4MjI2NmYyOTRhMDI4Mjg4OTlhNmVhYzY3NDgwMDNmMzZjYjMxMzM0YjdlJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZhY3Rvcl9pZD0wJmtleV9pZD0wJnJlcG9faWQ9MCJ9.1cWnamfwFEJOAT8ug4w5Q4Ju3MUdYhlca6BBRbbUPZU)
- URL:
http://127.0.0.1:8082/api/check_id_base64
- Method:
POST
- Raw Data:
JSON Format
: { "image": "--base64 image data here--" }
![Screenshot 2024-07-16 at 5 11 34 AM](https://private-user-images.githubusercontent.com/127708602/350457365-fa6f5e12-0abc-4e5f-a078-f541e3c546a7.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjMyOTUyNTQsIm5iZiI6MTcyMzI5NDk1NCwicGF0aCI6Ii8xMjc3MDg2MDIvMzUwNDU3MzY1LWZhNmY1ZTEyLTBhYmMtNGU1Zi1hMDc4LWY1NDFlM2M1NDZhNy5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjQwODEwJTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI0MDgxMFQxMzAyMzRaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT00ZWI1NTczOTNkNThiYWQ0ZjllZjM3ZDE1ZjEwOGQzZTNmNjA2MjQ3MzE3NzIwMjAxODc2OGRkMTMwYzljZDNmJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZhY3Rvcl9pZD0wJmtleV9pZD0wJnJlcG9faWQ9MCJ9.T4Cfmy03e9TIgePtzxj7_5rTtoNIfqqaSv2Ei-Wmwz0)
The API returns a JSON object with the recognized details from the ID document. Here is an example response:
We have included a Gradio demo to showcase the capabilities of our ID Document Recognition SDK. Gradio is a Python library that allows you to quickly create user interfaces for machine learning models.
-
Install Gradio:
First, you need to install Gradio. You can do this using pip:
git clone https://github.com/MiniAiLive/ID-DocumentRecognition-Windows-SDK.git pip install -r requirement.txt cd gradio
-
Run Gradio Demo:
python app.py
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
- Python 3.6+
requests
library (you can install it usingpip install requests
)
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)
Feel free to Contact US to get a trial License. We are 24/7 online on WhatsApp: +19162702374.
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.
Please visit our ID API Web Demo here. https://demo.miniai.live
No | Project | Feature |
---|---|---|
1 | FaceRecognition-LivenessDetection-Android-SDK | Face Matching, 3D Face Passive Liveness |
2 | FaceRecognition-LivenessDetection-Windows-SDK | Face Matching, 3D Face Passive Liveness |
3 | FaceLivenessDetection-Android-SDK | 3D Face Passive Liveness |
4 | FaceLivenessDetection-Linux-SDK | 3D Face Passive Liveness |
5 | FaceLivenessDetection-Windows-SDK | 3D Face Passive Liveness |
6 | FaceMatching-Android-SDK | 1:1 Face Matching |
7 | FaceMatching-Windows-Demo | 1:1 Face Matching |
8 | FaceAttributes-Android-SDK | Face Attributes |
9 | ID-Document-Recognition-Android-SDK | ID Document, Credit, MRZ Recognition |
10 | ID-Document-Recognition-Linux-SDK | ID Document, Credit, MRZ Recognition |
11 | ID-Document-Recognition-Windows-SDK | ID Document, Credit, MRZ Recognition |
12 | ID-Document-LivenessDetection-Linux-SDK | ID Document Liveness Detection |
13 | ID-Document-LivenessDetection-Windows-SDK | ID Document Liveness Detection |
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.
For any inquiries or questions, please Contact US