Document scanning SDK

Once the premium module has been added to your app, you may use the following APIs to access its functionality .

Implementation Guide

Create a javascript function to accept a scanned image. It will be called with an object with the fields:

  • image: a base64 encoded string representing the jpeg image file

  • mimeType: 'image/jpeg'

  • encoding: 'base64'

To initiate a scan, open the url:


Replace CALLBACKFUNCTION with your actual javascript function name.

Here is the source code for a demo that simply displays the scanned image.

<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Document Scanner Test</title>
function callback(data) {
document.getElementById('page').setAttribute('src', 'data:' + data.mimeType +
';' + data.encoding + ', ' + data.image);
max-width: 100%;
min-width: 300px;
height: auto;
<h1>Document Scanner test</h1>
<p><a href="gonative://documentScanner/scanPage?callback=callback">Scan page</a></p>
<p><img id="page" src=""/></p>