DriverLicenseScanHelper

public class DriverLicenseScanHelper: NSObject

This is the 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.

** Test**

Parameters
String	Activity: The application activity from the registration screen
String	String: The user name which requires authentication.
String	String: The tenant DNS against which the user is authenticated.
String	String: The community name against which the user is authenticated.
String	String: HTML file name.
String	FIDO2Callback: The block to execute after the response is received.

Constructor

public init(isDataRequiredOnFail: Bool = false, scanningMode: ScanningMode, bidScannerView: BIDScannerView), dlScanResponseDelegate: DriverLicenseResponseDelegate, cutoutView: CGRect, expiryGracePeriod: Int)

• Creates an object of DriverLicenseScanHelper. 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
isDataRequiredOnFail	Bool: Indicates if the scanner must return the driver's License document data. The default value is false.
scanningMode	ScanningMode: An enum value. In the application, ScanningMode.SCAN_LIVE must be used.
bidScannerView	BIDScannerView: An object of BIDScannerView.
dlScanResponseDelegate	DriverLicenseResponseDelegate: The block to execute after the driver's License document scanning is completed.
cutoutView	CGRect: A view frame if an additional overlay is used in the app.
expiryDateGracePeriod	int: Number of days to allow as grace period ahead of Drivers License document expiry.

---

public init(dlScanResponseDelegate: DriverLicenseResponseDelegate)

• Creates an object of DriverLicenseScanHelper. Used to choose an enhanced document scanner.

note

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

Parameter
dlScanResponseDelegate	DriverLicenseResponseDelegate: The block to execute after the Drivers License document scanning is completed.

Method Summary

Parameters
Bool	isRunning()	Indicates if the Drivers License scanner is running or not.
void	startDLScanning(scanningSide: DLScanningSide)	Starts the Drivers License document scanner with the given document side.
void	stopDLScanning()	Stops the Drivers License document scanner.

Method Detail

isRunning

public func isRunning() -> Bool

• Indicates if the Drivers License scanner is running or not.

startDLScanning

public func startDLScanning(scanningSide: DLScanningSide)

• Starts the Drivers License document scanner with the given document side.

Parameters
scanningSide	DLScanningSide	The side of Drivers License with which the Drivers License scanner will start.

stopDLScanning

public func stopDLScanning()

• Stops the Drivers License document scanner.

Protocol Summary

Parameters
DriverLicenseResponseDelegate	Callback for event when Drivers License document scanning is completed.

DriverLicenseResponseDelegate

public protocol DriverLicenseResponseDelegate: AnyObject

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

Method Details

func dlScanCompleted(dlScanSide: DLScanningSide, dictDriveLicense: [String : Any]?, signatureToken signToken: String?, error: ErrorResponse?)

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

Parameters
dlScanSide	DLScanningSide	Provides Driver License document side for which the scan is done.
dictDriveLicense	Dictionary	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	ErrorResponse	In case of error, an object of ErrorResponse is returned.

optional func readyForDetection()

• A callback method to indicate that the scanner is ready to detect the Drivers License document.

optional func scanBackSide()

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

optional func scanFrontSide()

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

optional func verifyingDocument()

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