FaceMatcherLivenessPromptState

data class FaceMatcherLivenessPromptState(val message: String? = null, val status: FaceMatcherLivenessPromptState.Status = Status.IN_PROGRESS, val overlay: OverlayFrame? = null, val capturedImages: Map<FacePose, ByteString> = emptyMap(), val backgroundColor: Color? = null)

State of the face matcher liveness prompt dialog observed by the UI layer.

Constructors

Link copied to clipboard
constructor(message: String? = null, status: FaceMatcherLivenessPromptState.Status = Status.IN_PROGRESS, overlay: OverlayFrame? = null, capturedImages: Map<FacePose, ByteString> = emptyMap(), backgroundColor: Color? = null)

Types

Link copied to clipboard

Overall status of the face liveness verification session.

Properties

Link copied to clipboard

optional background color for the liveness screen. When null, the UI reverts to the default theme background color.

Link copied to clipboard
val capturedImages: Map<FacePose, ByteString>

map from each requested FacePose to the portrait photo bytes captured for that pose during liveness verification. This map is populated if - and only if - status is Status.SUCCESS. When populated, each image is the uncropped full camera frame encoded in JPEG format at the resolution of the camera stream in upright portrait orientation. For all other statuses, this property is empty.

Link copied to clipboard

instructional or status message displayed to the user.

Link copied to clipboard

optional bitmap overlay to draw on top of the camera video stream.

Link copied to clipboard

overall verification status.