Skip to main content

Document Scanner

Document Scanner UI​

ScanbotSDK.UI.startDocumentScanner(configuration: DocumentScannerConfiguration)​

The Scanbot SDK provides a Ready-To-Use UI screen component for document scanning. Use the Ready-To-Use Document Scanner for guided, automatic document scanning.

alt text

Document Scanner usage example​

Document Scanner hook example
loading...

Parameters​

Document Scanner Configuration

Handling the result​

Document Scanner Result The promise resolves to an object with the following properties:

  • status: Result status,'OK' if some pages were snapped, 'CANCELED' if the user canceled the operation.
  • pages: An array of pages. If multi-page mode is enabled, this array may contain more than one page. If multi-page mode is not enabled and status is 'OK', this array contains one object.

Polygon​

The Scanbot SDK polygon is a list with 4 float points (one for each corner). Each point has coordinates in range [0..1], representing position relative to image size. For instance, if a point has the coordinates (0.5, 0.5), it means that it is located exactly in the center of the image.

Example code of a detected polygon as JSON result:

{
    "polygon": [
        {"y":0.046, "x":0.13066667},
        {"y":0.035, "x":0.91066664},
        {"y":0.92, "x":0.9346667},
        {"y":0.916, "x":0.10666667}
    ]
}

Finder Document Scanner UI​

ScanbotSDK.UI.startDocumentScanner(configuration: FinderDocumentScannerConfiguration)​

The Scanbot SDK also provides a Ready-To-Use UI screen component for document scanning called Finder Document Scanner, which enables you to scan a single document page with the help of a viewfinder bound to a certain aspect ratio.

Finder Document Scanner usage example​

Finder Document Scanner hook example
loading...

Parameters​

Finder Document Scanner Configuration

Returns​

Finder Document Scanner Result

Want to scan longer than one minute?

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

Get your free Trial License

What do you think of this documentation?

On this page

Scroll to top