Help Center
  • Welcome to KBY-AI
  • Product
    • Face Liveness Detection SDK, Face Recognition SDK
      • Basic SDK - Mobile
        • Basic SDK - Android
        • Basic SDK - iOS
      • Standard SDK - Mobile
        • Standard SDK - Android
        • Standard SDK - iOS
      • Premium SDK - Mobile
        • Premium SDK - Android
        • Premium SDK - iOS
      • Face Liveness Detection SDK - Server
      • Face Recognition SDK - Server
    • ID Card Recognition SDK
      • ID Card Recognition SDK - Android
      • ID Card Recognition SDK - iOS
      • ID Card Recognition SDK - Server
      • Supported Documents
      • Result Parsing
    • ID Document Liveness Detection SDK
    • ID Document Auto Capture Web
    • Palm Recognition SDK
      • Palmprint Recognition SDK - Server
      • Palmvein Recognition SDK - Server
    • Automatic License Plate/Number Recognition SDK
      • License Plate Recognition-Server
      • License Plate Recognition-Flutter
      • License Plate Recognition-Android
    • Computer Vision Solutions
      • Fire/Smoke Detection-Server
  • Demo Projects
    • Mobile (Android, iOS)
      • FaceLivenessDetection - Android
      • FaceLivenessDetection - iOS
      • FaceRecognition - Android
      • FaceRecognition - iOS
      • FaceRecognition - Flutter
      • FaceRecognition - Ionic-Cordova
      • FaceRecognition - React-Native
      • FaceAttribute - Android
      • FaceAttribute - iOS
      • FaceAttribute - Flutter
      • IDCardRecognition - Android
      • IDCardRecognition - iOS
      • License Plate Recognition-Flutter
      • License Plate Recognition-Android
    • Server (Windows, Linux)
      • FaceLivenessDetection - Windows
      • FaceLivenessDetection - Docker
      • FaceLivenessDetection - C# - .NET
      • FaceRecognition - Windows
      • FaceRecognition - Docker
      • FaceRecognition - C# - .NET
      • IDCardRecognition - Windows
      • IDCardRecognition - Docker
      • IDCardRecognition - C# - .NET
      • Palm Print Recognition SDK - Docker
      • Palm Vein Recognition SDK - Docker
      • License Plate Recognition-Docker
      • License Plate Recognition - C# - .NET
  • FAQ
    • How can I set up a Kubernetes system?
    • Has KBY-AI's facial algorithm been certified by a reliable standard measurement authority?
    • Accelerating KBY-AI SDKs with Kubernetes Configuration
Powered by GitBook
On this page
  • Features
  • License
  • System Requirements
  • Setup
  • Initializing SDK
  • Enums and Classes
  • 1. SDK_ERROR
  • APIs
  • 1. setActivation
  • 2. init
  • 3. idcardRecognition
  1. Product
  2. ID Card Recognition SDK

ID Card Recognition SDK - Android

This stands for ID card scanner, ID document reader, ID card reader, ID document recognition, passport scanner, ID scanner, MRZ parser, barcode reader, barcode scan, MRZ scan on Android

Features

License

We offer lifetime license(perpetual license) based on application ID for Android SDKs. The license is available for one-time payment. In other words, once you purchase license from me, you can use our SDK permanently.

To request a license, please contact us:

Email: contact@kby-ai.com

Telegram: @kbyai

WhatsApp: +19092802609

System Requirements

  • CPU: 2 cores or more

  • RAM: 150MB or more

  • OS: Android 4.4 or later

  • Architecture: arm64-v8a, armeabi-v7alibidsdk

Setup

  1. Copy the SDK (libidsdk folder) to the root folder of your project.

  2. Add SDK to the project in settings.gradle

include ':libidsdk'
  1. Add dependency to your build.gradle

implementation project(path: ':libidsdk')

Initializing SDK

  1. Step one

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

IDSDK.setActivation("...");
  • If activation is successful, the return value will be SDK_SUCCESS. Otherwise, an error value will be returned.

  1. Step Two

  • After activation, call the SDK's initialization function.

IDSDK.init(this);  //this -> MainActivity
  • If initialization is successful, the return value will be SDK_SUCCESS. Otherwise, an error value will be returned.

Enums and Classes

1. SDK_ERROR

This enumeration represents the return value of the init and setActivation functions.

Feature
Value
Name

Successful activation or initialization

0

SDK_SUCCESS

License key error

-1

SDK_LICENSE_KEY_ERROR

AppID error (Not used in Server SDK)

-2

SDK_LICENSE_APPID_ERROR

License expiration

-3

SDK_LICENSE_EXPIRED

Not activated

-4

SDK_NO_ACTIVATED

Failed to initialize SDK

-5

SDK_INIT_ERROR

APIs

1. setActivation

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

var ret = IDSDK.setActivation("...") 

If activation is successful, the return value will be SDK_SUCCESS. Otherwise, an error value will be returned.

2. init

After activation, call the SDK's initialization function.

ret = IDSDK.init(this)  //this -> MainActivity

If initialization is successful, the return value will be SDK_SUCCESS. Otherwise, an error value will be returned.

3. idcardRecognition

The SDK provides a single API for ID card recognition.

The function can be used as follows:

String result = IDSDK.idcardRecognition(bitmap);

This function takes a single parameter, which is a bitmap object.

If the recognition is successful, the function will return a JSON-formatted string containing the recognized information. In case of failure, the return value will be NULL.

PreviousID Card Recognition SDKNextID Card Recognition SDK - iOS

Last updated 2 months ago