https://github.com/kby-ai/idcardrecognition-android
ID Card Recognition, Intelligent ID OCR, Global ID Document Recognition, ID Card Recognition, Passport Recognition, Driver License Recognition, ID Scanner, ID Document Reader, ID Card OCR, ID Document OCR
https://github.com/kby-ai/idcardrecognition-android
authentication barcode-reader barcode-scanner biometrics id id-card-extraction id-card-recognition id-document-reader id-scan id-scanning identity idv idverification kyc mrz-parser mrz-scanner nfc-card-reader ocr onbording passport-reader
Last synced: 3 months ago
JSON representation
ID Card Recognition, Intelligent ID OCR, Global ID Document Recognition, ID Card Recognition, Passport Recognition, Driver License Recognition, ID Scanner, ID Document Reader, ID Card OCR, ID Document OCR
- Host: GitHub
- URL: https://github.com/kby-ai/idcardrecognition-android
- Owner: kby-ai
- Created: 2023-06-11T08:23:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-05T13:21:39.000Z (5 months ago)
- Last Synced: 2025-05-19T15:15:44.879Z (5 months ago)
- Topics: authentication, barcode-reader, barcode-scanner, biometrics, id, id-card-extraction, id-card-recognition, id-document-reader, id-scan, id-scanning, identity, idv, idverification, kyc, mrz-parser, mrz-scanner, nfc-card-reader, ocr, onbording, passport-reader
- Language: Kotlin
- Homepage: https://kby-ai.com/id-document-recognition-sdk/
- Size: 511 KB
- Stars: 15
- Watchers: 6
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### Our facial recognition algorithm is globally top-ranked by NIST in the FRVT 1:1 leaderboards. 
[Latest NIST FRVT evaluation report 2024-12-20](https://pages.nist.gov/frvt/html/frvt11.html)
#### 🆔 ID Document Liveness Detection - Linux - [Here](https://web.kby-ai.com)
#### 🤗 Hugging Face - [Here](https://huggingface.co/spaces/kby-ai/IDCardRecognition)
#### 📚 Product & Resources - [Here](https://github.com/kby-ai/Product)
#### 🛟 Help Center - [Here](https://docs.kby-ai.com/help/product/id-card-sdk)
#### 💼 KYC Verification Demo - [Here](https://github.com/kby-ai/KYC-Verification-Demo-Android)
#### 🙋♀️ Docker Hub - [Here](https://hub.docker.com/r/kbyai/idcard-recognition)
# IDCardRecognition-Android
## Overview
This repository demonstrates `ID document recognition`, `ID card recognition`, `ID card scanner and reader` `ID document scanner and reader`, `ID Card OCR`, `passport reader` and `passport recognition` technology developed by `KBY-AI`.
> In this repository, we integrated `KBY-AI`'s `ID document OCR` solution into `Android` native platform.
## Try the APK
### Google Play
## Performance Video
You can visit our YouTube video [here](https://www.youtube.com/watch?v=s3G3MzrdDXI) to see how well our demo app works.
[](https://www.youtube.com/watch?v=s3G3MzrdDXI)
## Screenshots
### ◾ID Card Recognition SDK Main Functionalities
| Surpported ID Type | Functionalities | Release Type |
|------------------|------------------|------------------|
| ID Card | Extracting Information(OCR) | Android(`Kotlin & Java`) |
| Passport | Scanning Barcode | iOS(`Swift & Objectiv-C`) |
| Driver License | Parsing MRZ | Flutter(`Dart`) |
| | Auto Capturing | Web Front-end(`Javascript`) |
| | Scanning QR code | Server-Windows(`Python`) |
| | Supporting 200+ Countries' ID Documents | Server-Linux(`Python`) |
| | Supporting 130+ Languages | |
| | ID Document Detection | |
### ◾ID Card Recognition Product List
| No. | Repository | Release Type |
|------------------|------------------|------------------|
| ➡️ | [ID Card Recognition - Android](https://github.com/kby-ai/IDCardRecognition-Android) | Android |
| 2 | [ID Card Recognition - iOS](https://github.com/kby-ai/IDCardRecognition-iOS) | iOS |
| 3 | [ID Card Recognition - Flutter](https://github.com/kby-ai/IDCardRecognition-Flutter) | Flutter |
| 4 | [ID Auto Capture - React](https://github.com/kby-ai/ID-document-capture-React) | Web Front-end |
| 5 | [ID Card Recognition - Windows](https://github.com/kby-ai/IDCardRecognition-Windows) | Server-Windows |
| 6 | [ID Card Recognition - Linux](https://github.com/kby-ai/IDCardRecognition-Docker) | Server-Linux |
| 7 | [ID Card Recognition - C#](https://github.com/kby-ai/IDCardRecognition-CSharp-.NET) | Server-Windows |
## SDK License
- The code line below shows how to update SDK with the `license key`: https://github.com/kby-ai/IDCardRecognition-Android/blob/1db9754a66b0211715ab458a23d3a2dd93f9303d/app/src/main/java/com/kbyai/idcardrecognition/MainActivity.kt#L22-L31
- To request `license key`, please contact us:
🧙`Email:` contact@kby-ai.com
🧙`Telegram:` [@kbyai](https://t.me/kbyai)
🧙`WhatsApp:` [+19092802609](https://wa.me/+19092802609)
🧙`Discord:` [KBY-AI](https://discord.gg/CgHtWQ3k9T)
🧙`Teams:` [KBY-AI](https://teams.live.com/l/invite/FBAYGB1-IlXkuQM3AY)
## How To Run
### 1. Placing Library File
Download the `SDK library` file for `Android`(`idsdk.aar`) from [here](https://drive.google.com/file/d/1hys99a7QG7-px_m8DGa9RKqR7wr6E8bS/view?usp=sharing) and put it on the suitable `SDK` folder(folder `libidsdk`).
### 3. Running the App
Try to build this repo on `Android Studio` by linking real `Android` phone, not `simulator`. Once it works fine, you are ready to integrate our `SDK` to your project.
## About SDK
### 1. Set up
1. Download our SDK library file(`idsdk.aar`) from [here](https://drive.google.com/file/d/1hys99a7QG7-px_m8DGa9RKqR7wr6E8bS/view?usp=sharing) and paste it to SDK folder(folder `libidsdk`). Try to build this repo to make sure that SDK works fine by linking real `Android` phone, not `simulator`. Once it works fine, you are ready to integrate our SDK to your project.
And then copy the SDK(folder `libidsdk`) to the `root` folder in your project.
2. Add SDK to the project in `settings.gradle`.
```bash
include ':libidsdk'
```
3. Add dependency to your `build.gradle`.
```bash
implementation project(path: ':libidsdk')
```
### 2. Initializing the SDK
- Step One
To begin, you need to activate the SDK using the `license key` that you have received.
```kotlin
IDSDK.setActivation("...")
```
If activation is successful, SDK would return `SDK_SUCCESS`. Otherwise, it would return an error message.
- Step Two
Once activation is successful, you can call initialization function supported by our SDK.
```kotlin
IDSDK.init(getAssets());
```
If initialization is successful, SDK would return `SDK_SUCCESS`. Otherwise, it would return an error message.