MobbScan Web: Installation

Requirements

License Key

A license key linked to your application is needed to use MobbScan Web. Please, contact us to obtain one.

Supported browsers

SafariChromeFirefoxOpera
Minimum required version11415040
Real-time detectionYesYesYesYes
File upload detectionYesYesYesYes
VideoconferenceYes*YesYesYes
Unattended VideoYesYesYesYes

*Communication not allowed between two Safari browsers

EdgeIEChromeFirefoxOpera
Minimum required version4011504940
Real-time detectionYesNoYesYesYes
File upload detectionYesYesYesYesYes
VideoconferenceNoNoYesYesYes
Unattended VideoNoNoYesYesYes
EdgeChromeFirefoxOpera
Minimum required version40504940
Real-time detectionYesYesYesYes
File upload detectionYesYesYesYes
VideoconferenceYesYesYesYes
Unattended VideoYesYesYesYes
SafariChromeFirefoxOpera
Minimum required version11501216
Real-time detectionYesNoYes*Yes*
File upload detectionYesYes*Yes*Yes*
VideoconferenceNoNoNoNo
Unattended VideoYesNoYes*No

*Feature allowed from iOS 14

jQuery

MobbScan Web needs at least a 3.2.1 version of jQuery. In the distributable file, a jQuery file is included for its use if your project does not already have it.

Installation & Configuration

  1. Unzip the distribution bundle.

  2. Copy the mobbscan-api folder in a public route in your server/local environment.

  3. Add the following files in the <head> element of your website, replacing {version} with your current MobbScan version, and specifying the correct path to your mobbscan-api folder:

    <link
 type="text/css"
 rel="stylesheet"
 href="./mobbscan-api/css/mobbscan.css"
/>
<script
 type="text/javascript"
 src="./mobbscan-api/mobbscan-api-{version}.min.js"
></script>

    NOTE: The CSS file can be imported in your own stylesheets.

  4. If jQuery is not being used, add the included jQuery javascript before the previous includes:

    <script
 type="text/javascript"
 src="./mobbscan-api/js/jquery-3.2.1.min.js"
></script>

  5. Put an empty div in the body with an id. For example:

    <div id="mobbscan-placeholder"></div>

  6. Now the SDK can be initialized when the document is ready. For example, using jQuery:

    $(document).ready(() => {
 // Here goes MobbScan initialization code, check next step
});

  7. Initialize the SDK:

    // Sets the license
MobbScanAPI.initAPI('YOUR_LICENSE_HERE');
// Sets the URL of the MobbScan server
MobbScanAPI.setBaseURL('https://yourmobbscaninstance.yourcompany.com');
// Indicate the placeholder where the UI will be rendered
// (in this example, it points to an element with id "mobbscan-placeholder")
MobbScanAPI.setPlaceholder('mobbscan-placeholder');
// This listener is called when a frame has been analyzed or a detection starts
MobbScanAPI.setDetectionListener(console.log);

// This renders the user interface in the element with id == "mobbscan-placeholder"
MobbScanAPI.start(
 MobbScanDocumentType.ESPIDCard,
 MobbScanOperationMode.SCAN_BOTH_SIDES,
 console.log
);

    NOTE

    There are several listeners like setDetectionListener which can be configured. They will be covered in the Usage section. Also, in that section you can get further details about the MobbScanAPI.start() call.

    NOTE

    If you want to allow file uploading to try to detect the document you should call this method to enable it:MobbScanAPI.setFileBrowserEnabled(true);