Skip to main content

Classic UI for the Android Check Scanner Module

Overview​

To integrate the Classic UI Component for the Check Scanner, you can take a look at our 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:

implementation("io.scanbot:sdk-package-4:$latestVersion")
implementation("io.scanbot:sdk-check-assets:$latestSdkVersion")
caution

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.

InitializeScanbotSDK
loading...
caution

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​

Get Instances
loading...

Adding a results handler for CheckScannerFrameHandler​

Handle Result
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, you will receive the result in CheckScannerFrameHandler.ResultHandler callback - you will get a CheckScanningResult object that contains all recognized data:

  • status: CheckScannerStatus: represents the status of the scanning process
  • check: 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 here.

Want to scan longer than one minute?

Generate a free trial license to test the Scanbot SDK thoroughly.

Get free trial license

On this page