Register Face
Registers a reference image for user face authentication
Description
This step is used to register the selfie image as a reference for further face authentication. This step leverages Mosaic Identity Verification powered with advanced AI-driven facial recognition technology.
Before initiating registration, the journey must obtain a selfie using the Selfie Acquisition step. The reference image has to be bound to a specific user and Mosaic application. The user may be provided implicitly by the journey if the user is already authenticated; otherwise, a user identifier must be specified in the step configuration. A face can only be registered to an existing user.
When executed, the step validates that the selfie captured in a previous step passes the security checks and assigns it to the specified user identity.
If the registration is successful, the journey proceeds to the next step. If it fails, the journey is either aborted or proceeds to the dedicated cancel or failure branches (if configured).
To support face registration, you'll need to:
- Configure the Selfie Acquisition step and implement Identity Verification SDK calls required for submitting a reference selfie
- Configure the Register Face step
Configuration
| Field | Description |
|---|---|
| User auth state | Indicates if the user has authenticated in this journey. - If set to The user is authenticated (default), the user context is provided implicitly by the journey. - If set to The user is not authenticated, a user identifier must be provided. Note that, if the identifier doesn’t exist, a Mosaic user record is automatically created. |
| External user ID | User identifier, specified as an expression. Only configured if the journey doesn't authenticate the user before invoking this step. |
| Error output variable | Name of the variable that stores any errors returned by step |
| Failure behavior | Determines the behavior in case of failure, which either aborts the journey or proceeds to a failure branch of the control flow (default). |
| Custom branches | Additional journey branches supported for this step. The client can select a branch by returning the branch ID. For each branch, you can define a schema for the information that the client is expected to return (used by the code generator and for autocompleting journey expressions) and a display name to label it in the editor. |
| Branch output variable | Name of the variable used to store the data returned by the client, which can be used in subsequent journey steps. |
| Cancel behavior | Determines the behavior of client cancellation, which either aborts the journey (default) or proceeds to a cancel branch of the control flow |
Example
Consider a journey that authenticates the user (e.g., using password) before collecting a selfie and initiating a face registration. In our example, the User auth state is set to The user is already authenticated in the step configuration. When executed, the Register Face step obtains the selfie data from the journey context and binds it to the specified user identity.
