FaceMatcher

interface FaceMatcher

Interface for verifying user identity via face matching.

The normal way to use createSession is through the prompt machinery via org.multipaz.prompt.showFaceMatcherPrompt.

The normal way to use createLivenessSession is through the prompt machinery via org.multipaz.prompt.showFaceMatcherLivenessPrompt.

The multipaz-facenet library provides an implementation based on Google FaceNet and the MobileFaceNet model which can be used for development and testing.

Properties

Link copied to clipboard

Human-readable display name (e.g. "Simulated", "Google FaceNet").

Link copied to clipboard
abstract val name: String

Unique machine identifier for this matcher (e.g. "simulated", "facenet").

Link copied to clipboard

Whether this matcher supports active liveness detection and portrait photo capture.

Link copied to clipboard

Whether this matcher provides its own custom user interface (including operating the camera and drawing graphics itself).

Functions

Link copied to clipboard
open fun createLivenessSession(poses: List<FacePose> = listOf(FacePose.FRONT)): FaceMatcherLivenessSession

Creates a new FaceMatcherLivenessSession driving an interactive session to check user liveness and capture a verified portrait photo of the subject.

Link copied to clipboard
abstract fun createSession(referencePortrait: ByteString): FaceMatcherSession

Creates a new FaceMatcherSession driving an interactive verification session to verify that the user in front of the camera matches the provided referencePortrait.