API & integration Details

Document Scanning-Capture SDK ANDROID v4.0

QuickCapture Mobile Scanning SDK Specially designed for native ANDROID from Extrieve.

It's not "just" a scanning SDK. It's a "document" scanning/capture SDK evolved with Best Quality, Highest Possible Compression, Image Optimisation, keeping output quality of the document in mind.

Control DPI,Layout & Size of output images and can convert them into PDF & TIFF

QR code & BAR Code Scanning & Generation

Developer-friendly & Easy to integrate SDK.

Works entirely offline, locally on the device, with no data transferred to any server or third party.

For reduced build size if needed, an initial internet connection may optionally be required to fetch ML data or resource files, depending on the specific integration and features used by the consumer application

End of support Notice : QuickCapture SDK Android V1 deprecated by Dec. 2022.For any further updates and support, can use V2 which having no major modifications.But with improved funcionalities,feature additions and fixes.

QuickCapture SDK Android V2 deprecated by May. 2024.For any further updates and support, can use V4 & bugfixes on V3

Access / Download

You can use this SDK in any Android project simply by using Gradle :

//Add expack central repo in settings.gradle
repositories {
  google()
  mavenCentral()
  maven {url 'https://expack.extrieve.in/maven/'}
}

//Then add implementation for SDK in dependencies in build.gradle (module:<yourmodulename>)
dependencies {
  implementation 'com.extrieve.quickcapture:QCv4_PLUS:<SDK-VERSION>'
  //latest version : 4.1.10
}
SDK-VERSION - Need to replace with the correct v4 series.

Or Maven:

<dependency>
  <groupId>com.extrieve.quickcapture</groupId>
  <artifactId>QCv4_PLUS</artifactId>
  <version>SDK-VERSION</version>
</dependency>
SDK-VERSION - Need to replace with the correct v4 series

Or can even integrate with the .aar library file and manually add the file dependency to the project/app.

Compatibility

JAVA 17 Support: QuickCapture v4 requires JAVA version 17 support for the application.
Minimum Android SDK: QuickCapture v4 requires a minimum API level of 21.
Target Android SDK: QuickCapture v4 features supports API 35.
Compiled SDK Version: QuickCapture v4 compiled against API 34.Host application using this SDK should compiled against 34 or later

API & integration Details

Available properties and method

SDK has four core classes and supporting classes :

CameraHelper - Handles the camera related operations. Basically, an activity.
ImgHelper - Purpose of this class is to handle all imaging related operations.
OpticalCodeHelper - Handles the Optical code (QR CODE & BAR CODE) related activities
HumanFaceHelper - Advanced Ai based utility class handles all functionalities such as face detection, extraction,matching & related functions.
Config - Holds various configurations for SDK including licensing

Based on the requirement, any one or all classes can be used.And need to import those from the SDK.

    import com.extrieve.quickcapture.sdk.*;
    //OR : can import only required classes as per use cases.
    import  com.extrieve.quickcapture.sdk.ImgHelper;  
    import  com.extrieve.quickcapture.sdk.CameraHelper;
    import  com.extrieve.quickcapture.sdk.OpticalCodeHelper;
    import  com.extrieve.quickcapture.sdk.Config;  
    import com.extrieve.quickcapture.sdk.HumanFaceHelper;
    import  com.extrieve.quickcapture.sdk.ImgException;

1. CameraHelper

This core class will be implemented as an activity.This class can be initialized as intent.

//JAVA
CameraHelper CameraHelper = new CameraHelper();

//Kotlin
var cameraHelper: CameraHelper? = CameraHelper()

With an activity call, triggering the SDK for capture activity can be done.Most operations in CameraHelper is activity based.

SDK is having multiple flows as follows :

CAMERA_CAPTURE_REVIEW - Default flow. Capture with SDK Camera -> review.
SYSTEM_CAMERA_CAPTURE_REVIEW - Capture with system default camera -> review.
IMAGE_ATTACH_REVIEW - Attach/pass image -> review.

1. CAMERA_CAPTURE_REVIEW - Default flow of the CameraHelper. Includes Capture with SDK Camera -> Review Image.

//JAVA

//Set CaptureMode as CAMERA_CAPTURE_REVIEW
Config.CaptureSupport.CaptureMode = Config.CaptureSupport.CaptureModes.CAMERA_CAPTURE_REVIEW;
//set permission for output path that set in config.
UriphotoURI = Uri.parse(Config.CaptureSupport.OutputPath);
this.grantUriPermission(this.getPackageName(),photoURI,Intent.FLAG_GRANT_WRITE_URI_PERMISSION | Intent.FLAG_GRANT_READ_URI_PERMISSION);  

//Create CameraIntent for CameraHelper activity call.
Intent CameraIntent = new Intent(this,Class.forName("com.extrieve.quickcapture.sdk.CameraHelper"));
if  (Build.VERSION.SDK_INT <= Build.VERSION_CODES.LOLLIPOP)  {
	CameraIntent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
}
//Call the Activity.
startActivityForResult(CameraIntent,REQUEST_CODE_FILE_RETURN);

//On activity result,recieve the captured, reviewed, cropped, optimised & compressed image collection as array.
@Override
protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data)  
{
	super.onActivityResult(requestCode,  resultCode,  data);
	if  (requestCode == REQUEST_CODE_FILE_RETURN && resultCode == Activity.RESULT_OK)
	{  
		Boolean Status = (Boolean)data.getExtras().get("STATUS");
		String Description = (String)data.getExtras().get("DESCRIPTION");  
		if(Status == false){ 
			//Failed  to  capture
		}
		finishActivity(REQUEST_CODE_FILE_RETURN); return;
	}
	FileCollection = (ArrayList<String>)data.getExtras().get("fileCollection");
	//FileCollection //: will contain all capture images path as string
	finishActivity(REQUEST_CODE_FILE_RETURN);
}

//Kotlin
try {
    /*DEV_HELP :redirecting to camera*/
    val captureIntent = Intent(this, Class.forName("com.extrieve.quickcapture.sdk.CameraHelper"))
    val photoURI = Uri.parse(Config.CaptureSupport.OutputPath)
    grantUriPermission(
	this.packageName, photoURI,
	Intent.FLAG_GRANT_WRITE_URI_PERMISSION or Intent.FLAG_GRANT_READ_URI_PERMISSION
    )
    if (Build.VERSION.SDK_INT <= Build.VERSION_CODES.LOLLIPOP) {
	captureIntent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION)
    }
    captureActivityResultLauncher!!.launch(captureIntent)
} catch (ex: Exception) {
    /*DEV_HELP : TODO : handle invalid Exception*/
    Toast.makeText(this, "Failed to open camera  -" + ex.message, Toast.LENGTH_LONG).show()
}

2. SYSTEM_CAMERA_CAPTURE_REVIEW - If user needs to capture an image with system default camera, this can be used. It includes Capture with system default camera -> Review.

//JAVA

//Set CaptureMode as SYSTEM_CAMERA_CAPTURE_REVIEW
Config.CaptureSupport.CaptureMode = Config.CaptureSupport.CaptureModes.SYSTEM_CAMERA_CAPTURE_REVIEW;
//set permission for output path that is set in config.
UriphotoURI = Uri.parse(Config.CaptureSupport.OutputPath);
this.grantUriPermission(this.getPackageName(),photoURI,Intent.FLAG_GRANT_WRITE_URI_PERMISSION | Intent.FLAG_GRANT_READ_URI_PERMISSION);  

//Create CameraIntent for CameraHelper activity call.
Intent CameraIntent = new Intent(this,Class.forName("com.extrieve.quickcapture.sdk.CameraHelper"));
if  (Build.VERSION.SDK_INT <= Build.VERSION_CODES.LOLLIPOP)  {
	CameraIntent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
}
//Call the Activity.
startActivityForResult(CameraIntent,REQUEST_CODE_FILE_RETURN);

//On activity result,recieve the captured, reviewed, cropped, optimised & compressed image colletion as array.
@Override
protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data)  
{
	super.onActivityResult(requestCode,  resultCode,  data);
	if  (requestCode == REQUEST_CODE_FILE_RETURN && resultCode == Activity.RESULT_OK)
	{  
		Boolean Status = (Boolean)data.getExtras().get("STATUS");
		String Description = (String)data.getExtras().get("DESCRIPTION");  
		if(Status == false){ 
			//Failed  to  capture
		}
		finishActivity(REQUEST_CODE_FILE_RETURN); return;
	}
	FileCollection = (ArrayList<String>)data.getExtras().get("fileCollection");
	//FileCollection //: will contain all capture images path as string
	finishActivity(REQUEST_CODE_FILE_RETURN);
}

//Kotlin
try {
    /*DEV_HELP :redirecting to camera*/
    val captureIntent = Intent(this, Class.forName("com.extrieve.quickcapture.sdk.CameraHelper"))
    val photoURI = Uri.parse(Config.CaptureSupport.OutputPath)
    grantUriPermission(
	this.packageName, photoURI,
	Intent.FLAG_GRANT_WRITE_URI_PERMISSION or Intent.FLAG_GRANT_READ_URI_PERMISSION
    )
    if (Build.VERSION.SDK_INT <= Build.VERSION_CODES.LOLLIPOP) {
	captureIntent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION)
    }
    captureActivityResultLauncher!!.launch(captureIntent)
} catch (ex: Exception) {
    /*DEV_HELP : TODO : handle invalid Exception*/
    Toast.makeText(this, "Failed to open camera  -" + ex.message, Toast.LENGTH_LONG).show()
}

3. IMAGE_ATTACH_REVIEW - This option can be used if the user needs to review an image from their device's gallery. After attaching each image, the review and all dependent functionalities become available.

//JAVA

//Set CaptureMode as IMAGE_ATTACH_REVIEW
Config.CaptureSupport.CaptureMode = Config.CaptureSupport.CaptureModes.IMAGE_ATTACH_REVIEW;
//Create/Convert/ get Image URI from image source.
Uri ImgUri = data.getData();
//Create ReviewIntent for CameraHelper activity call.
Intent ReviewIntent = new Intent(this,Class.forName("com.extrieve.quickcapture.sdk.CameraHelper"));
//Add the image URI to intent request with a key : ATTACHED_IMAGE.
ReviewIntent.putExtra("ATTACHED_IMAGE", ImUri);
//Call the Activity.
startActivityForResult(ReviewIntent,REQUEST_CODE_FILE_RETURN);

//On activity result,recieve the captured, reviewed, cropped, optimised & compressed image colletion as array.
@Override
protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data)  
{
	super.onActivityResult(requestCode,  resultCode,  data);
	if  (requestCode == REQUEST_CODE_FILE_RETURN && resultCode == Activity.RESULT_OK)
	{  
		Boolean Status = (Boolean)data.getExtras().get("STATUS");
		String Description = (String)data.getExtras().get("DESCRIPTION");  
		if(Status == false){ 
			//Failed  to  capture
		}
		finishActivity(REQUEST_CODE_FILE_RETURN); return;
	}
	FileCollection = (ArrayList<String>)data.getExtras().get("fileCollection");
	//FileCollection //: will contains all capture images path as string
	finishActivity(REQUEST_CODE_FILE_RETURN);
}

//Kotlin

try {
    /*DEV_HELP :redirecting to camera*/
    val captureIntent = Intent(this, Class.forName("com.extrieve.quickcapture.sdk.CameraHelper"))
    val photoURI = Uri.parse(Config.CaptureSupport.OutputPath)
    grantUriPermission(
	this.packageName, photoURI,
	Intent.FLAG_GRANT_WRITE_URI_PERMISSION or Intent.FLAG_GRANT_READ_URI_PERMISSION
    )
    if (Build.VERSION.SDK_INT <= Build.VERSION_CODES.LOLLIPOP) {
	captureIntent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION)
    }
    captureActivityResultLauncher!!.launch(captureIntent)
} catch (ex: Exception) {
    /*DEV_HELP : TODO : handle invalid Exception*/
    Toast.makeText(this, "Failed to open camera  -" + ex.message, Toast.LENGTH_LONG).show()
}

2. Config

The SDK includes a supporting class called for static configuration. This class holds all configurations related to the SDK. It also contains sub-configuration collection for further organization. This includes: :

CaptureSupport - Contains all the Capture & review related configurations. Config.CaptureSupport contains various configurations as follows:

BottomStampData - This configuration will automatically print the specified text at the bottom of the captured image with correct alignment, font size and DPI**. This also supports placeholders, such as {DATETIME}, which will be replaced with the current date and time from the device at the time of stamping. $ - for new line print.
```
  //JAVA
 Config.CaptureSupport.BottomStampData ="{DATETIME} , Other info $ next line info.";
```
```
  //Kotlin
 Config!!.CaptureSupport!!.BottomStampData = ="{DATETIME} , Other info $ next line info.";
```

OutputPath - To set the output directory in which the captured images will be saved, base app should have rights to write to the provided path.

 //JAVA
 Config.CaptureSupport.OutputPath = "pass output path sd string";

 //Kotlin
 Config!!.CaptureSupport!!.OutputPath = "pass output path sd string";

MaxPage - To set the number of captures to do on each camera session, can also control whether the capture mode is single or multi i.e :

if MaxPage <= 0 / not set: means unlimited.If MaxPage >= 1: means limited.

 //JAVA
 // MaxPage <= 0  : Unlimited Capture Mode  
 // MaxPage = 1   : Limited Single Capture  
 // MaxPage > 1   : Limited Multi Capture Mode  
 Config.CaptureSupport.MaxPage = 0;

 //Kotlin
 // MaxPage <= 0  : Unlimited Capture Mode  
 // MaxPage = 1   : Limited Single Capture  
 // MaxPage > 1   : Limited Multi Capture Mode  
 Config!!.CaptureSupport!!.MaxPage = 0;

ColorMode - To Set the capture color mode - supporting color and grayscale.

 //JAVA
 Config.CaptureSupport.ColorMode = Config.CaptureSupport.ColorModes.RBG;
 //RBG (1) - Use capture flow in color mode.
 //GREY (2) - Use capture flow in grey scale mode.

 //Kotlin
 Config!!.CaptureSupport!!.ColorMode = Config!!.CaptureSupport!!.ColorModes!!.RBG;
 //RBG (1) - Use capture flow in color mode.
 //GREY (2) - Use capture flow in grey scale mode.

EnableFlash - Enable Document capture specific flash control for SDK camera.

 //JAVA
 Config.CaptureSupport.EnableFlash = true;

 //Kotlin
 Config!!.CaptureSupport!!.EnableFlash = true;

CaptureSound - To Enable camera capture sound.

 //JAVA
 Config.CaptureSupport.CaptureSound = true;

 //Kotlin
 Config!!.CaptureSupport!!.CaptureSound = true;

CameraToggle - Toggle camera between front and back.

 //JAVA
 Config.CaptureSupport.CameraToggle = CameraToggleType.ENABLE_BACK_DEFAULT;
 //DISABLED (0) -Disable camera toggle option.
 //ENABLE_BACK_DEFAULT (1) - Enable camera toggle option with Front camera by default.
 //ENABLE_FRONT_DEFAULT (2) - Enable camera toggle option with Back camera  by default.

 //Kotlin
 Config!!.CaptureSupport!!.CameraToggle = CameraToggleType!!.ENABLE_BACK_DEFAULT;
 //DISABLED (0) -Disable camera toggle option.
 //ENABLE_BACK_DEFAULT (1) - Enable camera toggle option with Front camera by default.
 //ENABLE_FRONT_DEFAULT (2) - Enable camera toggle option with Back camera  by default.

Common - Contains various configurations as follows:

SDKInfo - Contains all version related information on SDK.

 //JAVA
 Config.Common.SDKInfo;

 //Kotlin
 Config!!.Common!!.SDKInfo;

DeviceInfo - Will share all general information about the device.

 //JAVA
 Config.Common.DeviceInfo;

 //Kotlin
 Config!!.Common!!.DeviceInfo;

License - Cotrolls all activities relates to licensing.

Activate - Method to activate the SDK license.
```
 //JAVA
 Config.License.Activate(hostApplicationContext,licenseString);
```
```
 //Kotlin
 Config!!.License!!.Activate(hostApplicationContext,licenseString)
```
hostApplicationContext : Application context of host/client application which is using the SDK. > licenseString : Licence data in string format.

3. ImgHelper

Following are the options/methods available from class ImgHelper :

//JAVA
ImgHelper ImageHelper = new ImgHelper(this);

//Kotlin
var ImageHelper: ImgHelper? = ImgHelper(this)

SetImageQuality - Set the Quality of the image, Document_Quality is used. If documents are used further for any automations and OCR, use Document_Quality.

Available Image Qualities : 1. Photo_Quality. 2. Document_Quality. 3. Compressed_Document.

 //JAVA
 ImageHelper.SetImageQuality(ImgHelper.ImageQuality.Photo_Quality.ordinal());
 //--------------------------
 ImageHelper.SetImageQuality(1);//0,1,2 - Photo_Quality, Document_Quality, Compressed_Document

 //Kotlin
 imageHelper!!.SetImageQuality(1)

SetPageLayout - Set the Layout for the images generated/processed by the system.

 //JAVA
 ImageHelper.SetPageLayout(ImgHelper.LayoutType.A4.ordinal());
 //--------------------------
 ImageHelper.SetPageLayout(4);//A1-A7(1-7),PHOTO,CUSTOM,ID(8,9,10)

 //Kotlin
 imageHelper!!.SetPageLayout(4)

Available layouts : A1, A2, A3, A4, A5, A6, A7,PHOTO & CUSTOM

A4 is the most recommended layout for document capture scenarios.

SetDPI - Set DPI(depth per inch) for the image.
```
 //JAVA
 ImageHelper.SetDPI(ImgHelper.DPI.DPI_200.ordinal());
 //--------------------------
 ImageHelper.SetDPI(200);//int dpi_val = 150, 200, 300, 500, 600;
```
```
 //Kotlin
 imageHelper!!.SetDPI(200)
```
Available DPI : DPI_150, DPI_200, DPI_300, DPI_500, DPI_600

150 & 200 DPI is most used.And 200 DPI recommended for OCR and other image extraction prior to capture.

GetThumbnail - This method Will build thumbnail for the given image in custom width,height & AspectRatio.

 //JAVA
 Bitmap thumb = ImageHelper.GetThumbnail(ImageBitmap, 600, 600, true);
 /*
 Bitmap GetThumbnail(
 	@NonNull  Bitmap bm,
     int reqHeight,
     int reqWidth,
     Boolean AspectRatio )throws ImgException.
 */

 //KOTLIN
 var thumb = ImageHelper!!.GetThumbnail(ImageBitmap, 600, 600, true);

CompressToJPEG - This method will Compress the provided bitmap image and will save to given path.

 //JAVA
 Boolean Iscompressed = ImageHelper.CompressToJPEG(bitmap,outputFilePath);
 /*
 Boolean CompressToJPEG(Bitmap bm,String outputFilePath)
 	throws ImgException
 */

 //KOTLIN
 var Iscompressed = ImageHelper!!.CompressToJPEG(bitmap, outputFilePath);

GetTiffForLastCapture - Build Tiff output file from last captured set of images.

 //JAVA
 ImageHelper.GetTiffForLastCapture(outPutFileWithpath);
 //on success, will respond with string : "SUCCESS:::TiffFilePath";
 //use  ":::"  char.  key  to  split  the  response.
 //on failure,will respond with string : "FAILED:::Reason for failure";
 //use ":::" char. key to split the response.
 //on failure, error details can collect from CameraSupport.CamConfigClass.LastLogInfo

 //KOTLIN
 var thumb = ImageHelper!!.GetTiffForLastCapture(outPutFileWithpath);

GetPDFForLastCapture - Build PDF output file from last captured set of images.

 //JAVA
 ImageHelper.GetPDFForLastCapture(outPutFileWithpath);
 //on success, will respond with string : "SUCCESS:::PdfFilePath";
 //use  ":::"  char.  key  to  split  the  response.
 //on failure,will respond with string : "FAILED:::Reason for failure";
 //use ":::" char. key to split the response.
 //on failure, error details can collect from CameraSupport.CamConfigClass.LastLogInfo

 //KOTLIN
 var thumb = ImageHelper!!.GetPDFForLastCapture(outPutFileWithpath);

BuildTiff - Build tiff output file from the list of images shared.

 //JAVA
 ImageHelper.BuildTiff(ImageCol,OutputTiffFilePath);
 *@param "Image File path collection as ArrayList<String>".
 *@param "Output Tiff FilePath as String".
 *@return on failure = "FAILED:::REASON" || on success = "SUCCESS:::TIFF file path".

 //KOTLIN
 var thumb = ImageHelper!!.BuildTiff(ImageCol,OutputTiffFilePath);

BuildPDF - Build PDF output file from last captured set of images.

 //JAVA
 ImageHelper.BuildPDF(ImageCol,outPutPDFFileWithpath);
 *@param  "Image File path collection as ArrayList<String>"
 *@param "Output Tiff FilePath as String".
 *@return  on failure = "FAILED:::REASON" || on success = "SUCCESS:::PDF file path".

 //KOTLIN
 var thumb = ImageHelper!!.BuildPDF(ImageCol,OutputTiffFilePath);

Recommended Settings:

ImageQuality: documentQuality

DPI: 150 or 200

LayoutType: A4

ResizeMode: preserveAspectOnly

4. HumanFaceHelper

QuickCapture SDK equipped with advanced face identification intelligence can accurately detect human faces within documents and match them precisely.SDK needs to be activated using a proper license with Config.License.Acivate(); for the plus features to initialise.

//JAVA
HumanFaceHelper humanFaceObj = new HumanFaceHelper(this);

//Kotlin
var humanFaceObj:HumanFaceHelper? = HumanFaceHelper(this)

Following are the options/methods available from the class HumanFaceHelper :

DetectHumanFaces - DetectHumanFaces Method from **humanFaceObj ** will Identify human faces from provided image and return the detected details. .

//DetectHumanFaces will use callback function to return the result.
humanFaceObj.DetectHumanFaces(inputImage,detectHumanFacesCallBack);
*@param : inputImage "input image in Bitmap".
*@param : "A callback method to capture the detected human faces response".
   
function detectHumanFacesCallBack(resultJson) {
	//Process the resultJson
}

//Or use lambda function
humanFaceObj.DetectHumanFaces(inputImage,resultJson -> {
	//Detected response JSON
});

Following is a sample of response structure :

{
	 STATUS: true/false,
	 //Detection status
	 DESCRIPTION : "SUCCESS",
	 //Success or failure description
	 DOC_ID : 0,
	 //Identifier/index of the used document.
	 FACE_DATA :[
	 //Collection of identified face data
		 {
			 ID : 0,
			 //Identifier/index of face.
			 LEFT : 0,
			 TOP : 0,
			 RIGHT : 0,
			 BOTTOM : 0
			 //Each location of face in document
		} 
	 ]
}

MatchHumanFaces - DetectHumanFaces Method from humanFaceObj - With AI intelligence, analyses the provided face data and returns a response on whether the provided faces are of same human or not.Document Id and Face Id will be provided by DetectHumanFaces, and same can be used.

//MatchHumanFaces will use callback function to return the result.
humanFaceObj.MatchHumanFaces(DocId1,FaceId1,DocId2,FaceId2,matchHumanFacesCallBack);
*@param  "ID of first document"
*@param  "Face ID of first document"
*@param  "ID of second document"
*@param  "Face ID of second document".
*@param : "A callback method to capture the match human faces response".
   
function matchHumanFacesCallBack(resultJson) 	{
	//Process the resultJson
}

//Or use lambda function
humanFaceObj.MatchHumanFaces(DocId1,FaceId1,DocId2,FaceId2,,resultJson -> {
	//Detected response JSON
});

Following is a sample response structure :

{
	 STATUS: true/false,
	 //Match status
	 DESCRIPTION : "SUCCESS",
	 //Success or failure description
	 ACCURACY: 0,
	 //Accuracy of match
}

Face Match Accuracy Interpretation

The match level is determined based on the accuracy percentage, which reflects the similarity between two facial images. The table below provides detailed descriptions for each match level.

Match Percentage	Match Level	Description
90% - 100%	✅ Highly Reliable Match	Faces match with extremely high confidence. They are almost certainly the same person. Suitable for critical identification applications.
75% - 89%	✅ Strong Match	Faces matched successfully with a high probability of being the same person. Reliable for most identity verification use cases.
65% - 74%	⚠️ Moderate Match	Faces show good similarity, but further validation may be required. Manual verification is recommended before confirmation.
50% - 64%	⚠️ Low Confidence Match	Faces have some resemblance, but the similarity is not strong enough to confirm identity. Additional verification is needed.
0% - 49%	❌ No Match	Faces do not match. There is minimal similarity, and they are highly unlikely to be the same person.

Usage of Results

✅ Highly Reliable Match (90% - 100%)

Best for: Secure identity verification, biometric authentication, and critical decision-making.
Action: Automatic acceptance. No further review required.

✅ Strong Match (75% - 89%)

Best for: General identification scenarios where strong confidence is required.
Action: Safe for automatic approval in most applications.

⚠️ Moderate Match (65% - 74%)

Best for: Cases where additional review is acceptable before finalizing the decision.
Action: Manual verification recommended before confirming a match.

⚠️ Low Confidence Match (50% - 64%)

Best for: Situations requiring strict validation before acceptance.
Action: Use alternative verification methods. Do not rely on this score alone.

❌ No Match (0% - 49%)

Best for: Definitive rejection of mismatches.
Action: Automatically reject matches in this range.

5. OpticalCodeHelper

Following are the options/methods available from class OpticalCodeHelper :

//JAVA
OpticalCodeHelper opticalCodeObj = new OpticalCodeHelper(this);

//Kotlin
var opticalCodeObj : OpticalCodeHelper? = OpticalCodeHelper(this)

GenerateQRCode - Method to generate QR Code.Data need to pass in string format.Will return a bitmap of generated QR Code.

 //JAVA
 Bitmap qrcode = opticalCodeObj.GenerateQRCode(QRdata);

 //KOTLIN
 var qrcode = opticalCodeObj!!.GenerateQRCode(QRdata);

GenerateBarcode - Method to generate BAR Code.Data need to pass in string format.Will return a bitmap of generated BAR Code.

 //JAVA
 Bitmap qrcode = opticalCodeObj.GenerateBarcode(QRdata);

 //KOTLIN
 var qrcode = opticalCodeObj!!.GenerateBarcode(QRdata);

GenerateBarcodeWithText - Method to generate GenerateBarcodeWithText.Data need to pass in string format.Will return a bitmap of generated BAR Code with visible text.
```
 //JAVA
 Bitmap qrcode = opticalCodeObj.GenerateBarcode(QRdata);
```
```
 //KOTLIN
 var qrcode = opticalCodeObj!!.GenerateBarcode(QRdata);
```

Scan / Capture OpticalCodes (QR Code / BAR Code) - Option to Scan or capture the Optical Codes.This is an activity based call.On activity result, will get the extracted data from the optical code

 //JAVA
 //Register the activity results
 private OpticalCodeActivityResultLauncher<Intent> registerForActivityResult(new ActivityResultContracts.StartActivityForResult(), result -> handleOpticalCaptureActivityResult(result));
 
 //trigger the activity
 try {  
 	Intent CameraIntent = new Intent(this, Class.forName("com.extrieve.quickcapture.sdk.OpticalCodeHelper"));  
 	Uri photoURI = Uri.parse(Config.CaptureSupport.OutputPath);  
 	this.grantUriPermission(this.getPackageName(), photoURI, Intent.FLAG_GRANT_WRITE_URI_PERMISSION | Intent.FLAG_GRANT_READ_URI_PERMISSION);  
 	if (Build.VERSION.SDK_INT <= Build.VERSION_CODES.LOLLIPOP) {  
 		CameraIntent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);  
 	}  
 	captureActivityResultLauncher.launch(CameraIntent);  
 } catch (ClassNotFoundException e) {  
 	Toast.makeText(this, "Failed to open camera + ", Toast.LENGTH_LONG).show();  
 	e.printStackTrace();  
 }
 
 //Registered method to handle the result on callback
 private void handleOpticalCaptureActivityResult(ActivityResult result) {  
 {  
 	int resultCode = result.getResultCode();  
 	if (resultCode == Activity.RESULT_OK) {
 		String qrData = (String) data.getExtras().get("DATA");  
 		String qrType = (String) data.getExtras().get("TYPE");  
 		//showToast("QR_BAR_Code Data: " + qrData, Gravity.CENTER);  
 		//Here captured optical codes data can be extracted
 		finishActivity(REQUEST_CODE_FILE_RETURN);  
 		return;
 	}
 }

 //Kotlin
 
 // Register the activity results
 private val opticalCaptureActivityResultLauncher = registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result ->
    handleOpticalCaptureActivityResult(result)
 }

 // Trigger the activity
 try {
    val cameraIntent = Intent(this, Class.forName("com.extrieve.quickcapture.sdk.OpticalCodeHelper"))
    val photoURI: Uri = Uri.parse(Config.CaptureSupport.OutputPath)
    this.grantUriPermission(this.packageName, photoURI, Intent.FLAG_GRANT_WRITE_URI_PERMISSION or Intent.FLAG_GRANT_READ_URI_PERMISSION)
    if (Build.VERSION.SDK_INT <= Build.VERSION_CODES.LOLLIPOP) {
        cameraIntent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION)
    }
    opticalCaptureActivityResultLauncher.launch(cameraIntent)
 } catch (e: ClassNotFoundException) {
    Toast.makeText(this, "Failed to open camera + ", Toast.LENGTH_LONG).show()
    e.printStackTrace()
 }

 // Registered method to handle the result on callback
 private fun handleOpticalCaptureActivityResult(result: ActivityResult) {
    val resultCode = result.resultCode
    val data = result.data
    if (resultCode == Activity.RESULT_OK && data != null) {
        val qrData = data.extras?.getString("DATA")
        val qrType = data.extras?.getString("TYPE")
        // showToast("QR_BAR_Code Data: $qrData", Gravity.CENTER)
        // Here captured optical codes data can be extracted
        finishActivity(REQUEST_CODE_FILE_RETURN)
    }
 }

Error Handling & Exceptions

As a part of exceptional error handling ImgException class is available.
- Following are the possible errors and corresponding codes:
  - CREATE_FILE_ERROR= -100;
  - IMAGE_ROTATION_ERROR= -101;
  - LOAD_TO_BUFFER_ERROR= -102;
  - DELETE_FILE_ERROR= -103;
  - GET_ROTATION_ERROR= -104;
  - ROTATE_BITMAP_ERROR= -105;
  - BITMAP_RESIZE_ERROR= -106;
  - CAMERA_HELPER_ERROR= -107;
  - LOG_CREATION_ERROR= -108;
Also with Config.CaptureSupport.LastLogInfo last logged exception or error details can be identified.

Notes

Regarding accuracy :

The accuracy of face detection and matching technologies depends on input image quality, including factors such as image distortion, rotation angles, lighting conditions, and color consistency. While offline solutions effectively reduce manual effort and operational costs, they do not guarantee 100% reliability in all scenarios.

This system enables on-device verification, efficiently identifying doubtful matches and flagging them for backend verification within the offline environment. By integrating backend validation, the system enhances reliability without relying on external APIs. Additionally, when a match achieves high accuracy as defined in the accuracy thresholds, the system can be considered reliable even without backend verification, making it a valuable solution for offline scenarios where external validation is limited.

For use cases demanding exceptionally high accuracy and reliability, an API-based advanced system is recommended.

Extrieve - Your Expert in Document Management & AI Solutions.

Name		Name	Last commit message	Last commit date
Latest commit History 177 Commits
java_sample		java_sample
kotlin_sample		kotlin_sample
README.md		README.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Document Scanning-Capture SDK ANDROID v4.0

Access / Download

Compatibility

API & integration Details

1. CameraHelper

2. Config

3. ImgHelper

4. HumanFaceHelper

Face Match Accuracy Interpretation

Usage of Results

✅ Highly Reliable Match (90% - 100%)

✅ Strong Match (75% - 89%)

⚠️ Moderate Match (65% - 74%)

⚠️ Low Confidence Match (50% - 64%)

❌ No Match (0% - 49%)

5. OpticalCodeHelper

Error Handling & Exceptions

Notes

Regarding accuracy :

About

Releases 9

Packages

Contributors 2

Languages

ExtrieveTechnologies/QuickCapture_Android

Folders and files

Latest commit

History

Repository files navigation

Document Scanning-Capture SDK ANDROID v4.0

Access / Download

Compatibility

API & integration Details

1. CameraHelper

2. Config

3. ImgHelper

4. HumanFaceHelper

Face Match Accuracy Interpretation

Usage of Results

✅ Highly Reliable Match (90% - 100%)

✅ Strong Match (75% - 89%)

⚠️ Moderate Match (65% - 74%)

⚠️ Low Confidence Match (50% - 64%)

❌ No Match (0% - 49%)

5. OpticalCodeHelper

Error Handling & Exceptions

Notes

Regarding accuracy :

About

Topics

Resources

Stars

Watchers

Forks

Releases 9

Packages 0

Contributors 2

Languages

Packages