NationalIDScanHelper

public class NationalIDScanHelper extends NSObject

This is the helper class that provides National ID 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., a 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, nidScanResponseDelegate: NationalIDResponseDelegate, cutoutView: CGRect, expiryGracePeriod: Int)

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

Parameters
isDataRequiredOnFail	Bool	Indicates if the scanner must return the National ID document data. The default value is false.
bidScannerView	BIDScannerView	An object of BIDScannerView.
nidScanResponseDelegate	NationalIDResponseDelegate	The block to execute after the National ID 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 National ID document expiry.

---

public init(nidscanResponseDelegate: NationalIDResponseDelegate)

• Creates an object of NationalIDScannerHelper. Used to select the enhanced document scanner.

note

It is the application's responsibility to decide if the scanned National ID document should be registered or not.

Parameter
nidscanResponseDelegate	NationalIDResponseDelegate: The block to execute after the National ID document scanning is completed.

Method Summary

Parameters
Bool	isRunning()	Indicates if the National ID document scanner is running or not.
void	startNationalIDScanning(scanningSide: NIDScanningSide) } Starts the National ID document scanner with the given document side.
void	stopNationalIDScanning()	Stops the National ID document scanner.

Method Detail

isRunning

public func isRunning() -> Bool

• Indicates if the National ID document scanner is running or not.

startNationalIDScanning

public func startNationalIDScanning(scanningSide: NIDScanningSide)

• Starts the National ID document scanner with the given document side.

Parameters
scanningSide	NIDScanningSide	The side of National ID document with which the National ID scanner will start.

stopNationalIDScanning

public func stopNationalIDScanning()

• Stops the National ID document scanner.

Protocol Summary

Parameters
NationalIDResponseDelegate	Callback for the event when National ID document scanning is completed.

NationalIDResponseDelegate

public protocol NationalIDResponseDelegate: AnyObject

• Callback for the event when National ID document scanning is completed.

Method Details

func nidScanCompleted(nidScanSide: NIDScanningSide, dictNationalID: [String : Any]?, signatureToken signToken: String?, error: ErrorResponse?)

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

Parameters
nidScanSide	NIDScanningSide	Provides National ID document side for which the scan is done.
dictNationalID	Dictionary	Returns the National ID document data after the scanning is completed.
signatureToken	String	A token that carries information about scanned National ID documents. This is used to verify if the National ID document data is modified or not before storing it on the 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 National ID document.

optional func scanBackSide()

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

optional func scanFrontSide()

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

optional func verifyingDocument()

• A callback method to indicate that the scanner has started verifying Nation ID document.