LiveIDScannerHelper

public class LiveIDScannerHelper extends NSObject

The LiveIDScannerHelper class is a helper class to work with the Live ID feature.

Constructors

public init(bidScannerView: BIDScannerView, overlayFrame: CGRect? = nil, shouldResetOnWrongExpresssion: Bool = true, liveIdResponseDelegate: LiveIDResponseDelegate)

• Creates an object of LiveIDScannerHelper. It has an additional parameter to indicate if the complete Live ID scanning feature must be reset if any expressions go wrong. The default value for shouldResetOnWrongExpression is true.

Parameter
bidLiveIDScannerView	BIDScannerView: A custom view to be provided by the application. This is generally used for UI customization.
overlayFrame	CGRect: An overlay rect which is placed on top of the BIDScannerView object.
shouldResetOnWrongExpression	Bool: A flag to indicate if the Live ID scanning feature must be reset if the wrong expression is detected.
liveIdResponseDelegate	LiveIDResponseDelegate: The block to execute after the response is received.

public init(liveIdResponseDelegate: LiveIDResponseDelegate)

• Creates an object of LiveIDScannerHelper. Used to choose enhanced liveid scanner.

Parameter
liveIdResponseDelegate	LiveIDResponseDelegate: The block to execute after the Live id scan is completed.

Method Summary

Parameters
void	startLiveIDScanning(dvcID: String? = nil)	Starts the LiveI D scanning based on given dvcID (Document Verification Connector Identifier). If dvcID is given, the Live ID is checked for liveness check.
void	stopLiveIDScanning	Stops Live ID scanning.

Method Detail

startLiveIDScanning

startLiveIDScanning(dvcID: String? = nil)

• Starts the LiveI D scanning based on the given dvcID (Document Verification Connector Identifier). If dvcID is given, the Live ID is checked for liveness check.

stopLiveIDScanning

public void stopLiveIDScanning()

• Stops Live ID scanning.

Interface Summary

Parameters
LiveIDResponseDelegate	Callback for the event when Live ID is captured, face expressions are changed, or face is out of focus.

Method Summary

Parameters
void	faceLivenessCheckStarted()	Called when scanner has started liveness check. This protocol method is Optional.
void	focusOnFaceChanged(isFocused: Bool?)	Called when if the user's face is in focus area for an expression to be performed. This protocol method is Optional.
void	liveIdDetectionCompleted(_ liveIdImage: UIImage?, signatureToken: String?, error: ErrorResponse?)	Called when Live ID scanning is successful based on given expression checks. This protocol method is Required.
void	liveIdDidDetectErrorInScanning(error: ErrorResponse?)	Called when an error is occurred during Live ID scanning. This protocol method is Optional.
void	readyForExpression(_ livenessFactor : LivenessFactorType)	Called when Live ID scanner is ready for a given expression. This protocol method is Optional.
void	wrongExpressionDetected(_ livenessFactor: LivenessFactorType)	Called when Live ID scanner detects wrong expression. The method returns the expected expression to be performed. This protocol method is Optional.

faceLivenessCheckStarted

func faceLivenessCheckStarted()

• Called when the scanner has started liveness check.

focusOnFaceChanged

func focusOnFaceChanged(isFocused: Bool?)

• Called when the user's face is in the focus area for an expression to be performed.

Parameters
isFocused	boolean	A flag that indicates if the user's face is in the focus area.

liveIdDetectionCompleted

func liveIdDetectionCompleted(_ liveIdImage: UIImage?, signatureToken: String?, error: ErrorResponse?)

• Called when Live ID scanning is successful based on given expression checks.

Parameters
liveIdImage	UIImage	An image of person's face.
signatureToken	String	A token that carries information about Live ID. This is used to verify if the user's Live ID is modified or not before storing it on the BlockID blockchain platform.
error	ErrorResponse	An object of ErrorResponse.

liveIdDidDetectErrorInScanning

func liveIdDidDetectErrorInScanning(error: ErrorResponse?)

• Called when an error occurs during Live ID scanning.

Parameters
error	ErrorResponse	An error object.

readyForExpression

func readyForExpression(_ livenessFactor : LivenessFactorType)

• Called when the Live ID scanner is ready for a given expression.

Parameters
livenessFactor	LivenessFactorType	An enum value for different expressions.

wrongExpressionDetected

func wrongExpressionDetected(_ livenessFactor: LivenessFactorType)

• Called when the Live ID scanner detects the wrong expression. The method returns the expected expression to be performed.

Parameters
livenessFactor	LivenessFactorType	An expected expression to be performed.