# ID Card Recognition SDK - Android ## Features * [x] Support ID documents from 200+ countries * [x] Document Detection * [x] Recognition of ID Cards, Passports, Driver's Licenses * [x] MRZ and Barcode Recognition * [x] Document Image Extraction * [x] Portrait Image Extraction * [x] 130+ languages, by including Greek, Arabic, Latin, Cyrillic, Hebrew, Chinese, and more * [x] Fully-Offline Works and On-Premise ## License We offer `lifetime license(perpetual license)` tied to each `application ID` for `Android` `SDK`s. The license is available with a `one-time payment`—meaning once you purchase it, you can use our `SDK` indefinitely without any recurring fees. To request a license, please contact us: > **Email:** > > **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` ```gradle include ':libidsdk' ``` 3. Add dependency to your `build.gradle` ```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. ```java IDSDK.setActivation("..."); ``` * If activation is successful, the return value will be `SDK_SUCCESS`. Otherwise, an error value will be returned. 2. Step Two * After activation, call the SDK's initialization function. ```java 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.
FeatureValueName
Successful activation or initialization0SDK_SUCCESS
License key error-1SDK_LICENSE_KEY_ERROR
AppID error (Not used in Server SDK)-2SDK_LICENSE_APPID_ERROR
License expiration-3SDK_LICENSE_EXPIRED
Not activated-4SDK_NO_ACTIVATED
Failed to initialize SDK-5SDK_INIT_ERROR
## APIs ### 1. setActivation To begin, you need to activate the SDK using the license that you have received. ```kotlin 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. ```kotlin 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: ```java 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`. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.kby-ai.com/help/product/id-card-recognition-sdk/id-card-recognition-sdk-android.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.