PassportScanHelper

public class PassportScanHelper extends NSObject

This is the helper class that provides Passport document scanning functionality.

• All documents (Identity and Miscellaneous) must have the 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, i.e., 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 the 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 init(isDataRequiredOnFail: Bool = false, bidScannerView: BIDScannerView, ppResponseDelegate: PassportResponseDelegate, cutoutView: CGRect, expiryGracePeriod: Int)

• Creates an object of PassportScanHelper. 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 Passport document should be registered or not.

Parameters
isDataRequiredOnFail	Bool	Indicates if the scanner must return the passport document data. The default value is false.
bidScannerView	BIDScannerView	An object of BIDScannerView.
nidScanResponseDelegate	PassportResponseDelegate	The block to execute after the Passport document scanning is completed.
cutoutView	CGRect	An view frame if an additional overlay is used in the app.
expiryDateGracePeriod	int	Number of days to allow as grace period ahead of Passport document expiry.

Method Summary

Parameters
Bool	isRunning()	Indicates if the Passport document scanner is running or not.
void	startPassportScanning()	Starts the Passport document scanner.
void	startRFIDScanning(defaultTimeout: TimeInterval = 15)	Starts Passport document's RFID scanning with custom timeout. The default timeout is 15 seconds, if not set.
void	stopRFIDScanning()	Stops Passport document's RFID scanning.
void	stopPassportScanning()	Stops the Passport document scanner.

Method Detail

isRunning

public func isRunning() -> Bool

• Indicates if the Passport document scanner is running or not.

startPassportScanning

public func startPassportScanning()

• Starts the Passport document scanner.

startRFIDScanning

public func startRFIDScanning(defaultTimeout: TimeInterval = 15)

• Starts Passport document's RFID scanning with a default timeout of 15 seconds.

Parameters
defaultTimeout	TimeInterval	A custom timeout value for RFID scan.

stopRFIDScanning

public func stopRFIDScanning()

• Stops Passport document's RFID scanning.

stopScanning

public func stopPassportScanning()

• Stops the Passport document scanner.

Protocol Summary

Parameters
PassportResponseDelegate	Callback for the event when Passport document scanning is completed.

PassportResponseDelegate

public protocol PassportResponseDelegate: AnyObject

• Callback for the event when Passport document scanning is completed.

Method Details

func passportScanCompleted(withPassport docDic: [String : Any]?, error: ErrorResponse?, signatureToken signToken: String?, isWithRFID: Bool?)

• A callback method that is triggered after the Passport document scanning is completed.

Parameters
withPassport	Dictionary	Returns the Passport document data after the scanning is completed.
error	ErrorResponse	In case of error, an object of ErrorResponse is returned.
signatureToken	String	A token that carries information about a scanned Passport. This is used to verify if the Passport document is modified or not before storing it on the BlockID blockchain platform.
isWithRFID	Bool	A flag to indicate if the Passport document data contains RFID data or not.

func readyForDetection()

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