Custom UI for the Android Check Scanner Module
Overview
To integrate the Custom UI Component for the Check Scanner, you can take a look at the Check Scanner example app or check the following step-by-step integration instructions.
CheckScanner can be used in conjunction with ScanbotCameraXView or separately. Let's have a look at an example with ScanbotCameraXView.
Adding the feature dependencies and initializing the SDK
CheckScanner is included in Scanbot SDK package 4. Therefore, add the dependency io.scanbot:sdk-package-4 or higher in your build.gradle.kts file:
implementation("io.scanbot:sdk-package-4:$latestVersion")
implementation("io.scanbot:sdk-check-assets:$latestSdkVersion")
Do not use multiple scanners (e.g., MRZ Scanner and Credit Card Scanner) at the same time.
Each scanner instance requires a lot of memory, GPU, and processor resources. Using multiple scanners will lead to performance issues for the entire application.
In order to use the Check Scanner, you need to first initialize the Scanbot SDK.
loading...
Unfortunately, we have noticed that all devices using a Cortex A53 processor DO NOT SUPPORT GPU acceleration. If you encounter any problems, please disable GPU acceleration for these devices.
ScanbotSDKInitializer()
.allowGpuAcceleration(false)
Getting the CheckScanner instance from ScanbotSDK and attaching it to ScanbotCameraXView
loading...
Adding a results handler for CheckScannerFrameHandler
loading...
handle will be triggered every time CheckScanner detects a check in the camera preview frame or if a license error has occurred.
After a successful check detection, the CheckScannerFrameHandler.ResultHandler callback receives a CheckScanningResult object that contains all recognized data:
status: CheckScannerStatus: represents the status of the scanning processcheck: GenericDocument?: represents all recognized check fields (accountNumber,routingNumber,checkNumber, etc.)
You can find more information about the result class in the API documentation.
You can now run your app and should see a simple camera preview that can scan check data from your document.
Adding a finder overlay
In addition, it is recommended to add a finder overlay. This feature allows you to predefine a check area over the ScanbotCameraXView screen. By using this overlay, the Check Scanner can skip the time-consuming step of searching for the check area and perform the recognition directly in the specified finder overlay area. By using this approach, the Check Scanner recognizes and extracts the check content much faster.
Details about applying finder view logic in the layout and in the code can be found in the Document Scanner SDK's User guidance section.
Want to scan longer than one minute?
Generate a free trial license to test the Scanbot SDK thoroughly.
Get free trial licenseScanbot SDK is part of the Apryse SDK product family
A mobile scan is just the start. With Apryse SDKs, you can expand mobile workflows into full cross‑platform document processing. Whether you need to edit PDFs, add secure digital signatures, or use a fast, customizable document viewer and editor, Apryse gives you the tools to build powerful features quickly.
Learn more
