DLScannerHelper

public class DLScannerHelper extends Object

↳ package com.onekosmos.blockid.sdk.cameramodule.dlScanner

Helper class that provides Drivers License document scanning functionality.

• All documents (Identity and Miscellaneous) must have following baseline attributes.

Parameters
String	id: It represents the document's ID eg: driver license number.
String	category: Currently this SDK supports two categories for documents that can be registered i.e, identity_document or misc_document.
String	type: This represents the type of document that the user will try to register eg: pin, dl, ppt, liveid, nationalid.
String	proofedBy: This identifies the entity responsible for proofing the document. When you use BlockID SDK Scanners, this defaults to “blockid”.

• The identity documents must have following baseline attributes.

Parameters
String	firstName: First name of document holder.
String	lastName: Last name of document holder.
String	dob: Date of birth {yyyyMMdd} of document holder.
String	doe: Date of expiry {yyyyMMdd} of document.
String	face: Base64 string of document holder's face photo.
String	image: Base64 string of document image.

Constructor

public DLScannerHelper(@NonNull Context context, @NonNull DLScanningOrder scanningOrder, @NonNull IDriverLicenseResponseListener driverLicenseListener)

• Creates an object of DLScannerHelper. The method does not return the data in case Drivers License document scanning is failed.

note

It is the application's responsibility to decide if the scanned Drivers License should be registered or not

Parameter
context	Context: Application's context.
scanningOrder	DLScanningOrder: DL Scanning Order
driverLicenseListener	IDriverLicenseResponseListener: The block to execute after the Drivers License document scanning is completed.

---

public DLScannerHelper(@NonNull Context context, @NonNull DLScanningOrder scanningOrder, @NonNull BIDScannerView scannerView, int expiryDateGracePeriod, boolean isDataRequiredOnFail, @NonNull IDriverLicenseResponseListener driverLicenseListener)

• Creates an object of DLScannerHelper. The scanner will throw an error if the document has already expired. If the document expires before gracePeriod, the scanner will complete the scan and return an advisory error.

note

It is the application's responsibility to decide if the scanned Drivers License should be registered or not

Parameter
context	Context: Application's context.
scanningOrder	DLScanningOrder: DL Scanning Order
bidScannerView	BIDScannerView: An object of BIDScannerView.
expiryDateGracePeriod	int: Number of days to allow as grace period ahead of Drivers License document expiry.
isDataRequiredOnFail	boolean: Indicates if the scanner must return the Drivers License document data. The default value is false.
driverLicenseListener	IDriverLicenseResponseListener: The block to execute after the Drivers License document scanning is completed.

---

public DLScannerHelper(@NonNull Context context, @NonNull DLScanningOrder scanningOrder, @NonNull BIDScannerView scannerView, int expiryDateGracePeriod, @NonNull IDriverLicenseResponseListener driverLicenseListener)

• Creates an object of DLScannerHelper. The method does not return data in the event the Drivers License document scanning has failed. The scanner will throw an error if the document is already expired. If the document expires before gracePeriod, the scanner will complete the scan and return an advisory error.

note

It is the application's responsibility to decide if the scanned Drivers License should be registered or not

Parameters
context	Context: Application's context.
scanningOrder	DLScanningOrder: DL Scanning Order
bidScannerView	BIDScannerView: An object of BIDScannerView.
expiryDateGracePeriod	int: Number of days to allow as grace period ahead of Drivers License document expiry.
driverLicenseListener	IDriverLicenseResponseListener: The block to execute after the Drivers License document scanning is completed.

Method Summary

Type	Name	Description
void	startScanning()	Starts the Drivers License document scanner
void	stopScanning()	Stops the Drivers License document scanner

Method Detail

---

startScanning

public void startScanning()

• Starts the Drivers License document scanner.

---

stopScanning

public void stopScanning()

• Stops the Drivers License document scanner.

Interface Summary

Name	Description
IDriverLicenseResponseListener	Callback for event when Drivers License document scanning is completed

IDriverLicenseResponseListener

public interface IDriverLicenseResponseListener

↳ package com.onekosmos.blockid.sdk.cameramodule.camera.dlModule

• Callback for event when Drivers License document scanning is completed.

Method Details

void onDriverLicenseResponse(LinkedHashMap<String, Object> driverLicense, String signatureToken, ErrorManager.ErrorResponse error)

• A callback method which is triggered after the Drivers License document scanning is completed.

Parameters
driverLicense	BIDDriverLicense: Returns the Drivers License data after the scanning is completed.
signatureToken	String: A token which carries information about scanned Drivers License. This is used to verify if the Drivers License is modified or not before storing it to BlockID blockchain platform.
error	ErrorManager.ErrorResponse: An object of ErrorManager.ErrorResponse, returned if an error is encountered

default void scanBackSide()

• A callback method to indicate that the scanner has started the back side of the Drivers License.

default void scanFrontSide()

• A callback method to indicate that the scanner has started the front side of the Drivers License.

default void verifyingDocument()

• A callback method to indicate that the scanner has started document verification of the Drivers License.