MobbScan Configuration · Mobbeel for developers

The API of MobbScan allows to get configured by the developers using a configuration object. In order to do this, you must create an instance of the object MSConfiguration and initialize the MobbScan API using it:

Swift

ObjectiveC

var msConfiguration:MSConfiguration = MSConfiguration()
msConfiguration.falsePositive = true
msConfiguration.returnOriginalImage = true

. . . 

MobbScanAPI.getInstance().initAPI(withLicense:"YOUR_LICENSE_HERE", configuration: msConfiguration, result: {(result, date) in
            // Your block code here  
})

MSConfiguration *msConfiguration = [MSConfiguration new];
msConfiguration.falsePositive = YES;
msConfiguration.returnOriginalImage = YES;
 
. . . 
 
[[MobbScanAPI getInstance] initAPIWithLicense:@"YOUR_LICENSE_HERE"
                                configuration:msConfiguration
                                       result:^(MobbScanLicenseResult result, NSDate* date) {
                                        // Your block code here                               
 }];

Configuration parameters

The parameters that you can configure by using MSConfiguration are these:

Global configuration

Parameter	Type	Comment
`baseURL`	`NSString`	Configure MobbScan base url
`apiMode`	`MobbScanAPIMode`	Configure MobbScan api mode

Quality Control

This is a set of checks that ensure that the detected image have the necessary quality to scan the document or validate the face later.

All of these parameters are boolean which are set true by default.

Document Detection QA Checks

Parameter	Comment
`checkDocumentLightness`	Check the ambient light is neither too dark nor too shiny.
`checkDocumentPosition`	Check the document is placed within the detection box, and it is neither too far nor too near.
`checkDocumentSparkles`	Check there are no sparkles on the document image.
`falsePositive`	Check the document side is the one we are looking for.

Facial Detection QA Checks

Parameter	Comment
`checkFacialLightness`	Check the ambient light is neither too dark nor too shiny.
`checkFacialPosition`	Check the face of the user is placed within the frame, and it is neither too far nor too near.
`checkFacialMask`	Check the face is not covered by a mask.
`checkFacialFocus`	Check the image of the face is focused.