Response Events

Below is the list of possible events fired from OCR Activity during the flow.

Event Identifier	Payload	Description	Behavior after post
LAUNCH_FAILURE	none	Fired in case of launch failure due to insufficient or faulty parameters provided.	Activity will exit.
FRONT_SUCCESS	"frontImage": String	Fired after successfully capturing valid front CNIC image. Local url of stored image (of provided size) will be sent.	Flow will continue for back card.
FRONT_FAILURE	none	Posted when unable to capture picture of front card due to device inability.	Activity will exit.
BACK_SUCCESS	"backImage": String	Similar to FRONT_SUCCESS for back image.	Loading interface will be shown as CNIC extraction is proceeded.
BACK_FAILURE	none	Device error to capture image.	Activity will exit.
OCR_SUCCESS	Listed Below	Successful extraction of identity number from captured images after complete flow.	Activity will exit.
OCR_FAILURE	none	Unsuccessful recognition identity number.	User will be prompted to re-scan (back card only).

Payload provide along with OCR_SUCCESS event

Key	Type	Description
identityNumber	String	Extracted identity number
frontImage	String	Local Url of captured front image (same as sent on FRONT_SUCCESS)
backImage	String	Local Url of captured back image (same as sent on BACK_SUCCESS)
documentType	"new" | "old"	Detected type of CNIC.
distance	Float	Distance between provided and extracted number. (between 1 and 0)