Enrollments and Verifications

Retrieving Work Items

One of the primary Imageware Authenticate and the Imageware Authenticate Mobile SDK use cases is to perform user enrollments and verifications. In the Imageware Authenticate Mobile SDK these are referred to as "work items". Retrieve these work items using the MessagesServiceManager.

note

In order to retrieve alerts or enrollments, you'll need to have the profile registered to the active device.

To capture the work items, call the renderNextWorkItemIfNeeded function detailed below:

iOS

private var messagesManager: MessagesServiceManagerProtocol = MessagesServiceManager()

messagesManager.synchronizeWorkItems { }

Android

messagesManager = MessagesServiceManager(requireContext())

messagesManager.synchronizeWorkItems(context)

important

If the user account gets 404s during this call, they have been deleted from the Authenticate service and are removed from the internal profile list.

iOS

When rendering an alert, register the appropriate base UI class with the MessagesServiceManager, as illustrated below.

messagesManager.register(rootController: myFavoriteVC, delegate: mainViewModel)

Implement an InteractionManagerDelegate to listen for interaction callbacks, such as completion or rejection of alerts.

Android

When rendering an alert, pass a context and listener, as shown below.

messagesManager.register(context, listener)

listener is an implemented InteractionManagerListener to listen for interaction callbacks, such as completion or rejection of alerts.

For simplicity of implementation, we typically roll the InteractionManagerDelegate/Listener into our ViewModel class as shown below.

iOS

extension MainViewModel: InteractionManagerDelegate {

public func alertCompleted(_ captureable: Capturable) {

self.alertTitle = "alert completed"

self.showingAlert.toggle()

}

public func alertAccepted(_ captureable: Capturable) {

self.alertTitle = "alert accepted"

self.showingAlert.toggle()

}

public func alertRejected(_ captureable: Capturable) {

self.alertTitle = "alert rejected"

self.showingAlert.toggle()

}

public func enrollmentHidden(_ captureable: Capturable) {

self.alertTitle = "enrollment hidden"

self.showingAlert.toggle()

}

public func enrollmentComplete(_ captureable: Capturable) {

self.alertTitle = "enrollment complete"

self.showingAlert.toggle()

}

}

Android

class MainViewModel(context: Context) : BaseDataViewModel(context) {

override fun onAlertCompleted() {

self.alertTitle = "alert completed"

self.showingAlert.toggle()

}

override fun onAlertAccepted() {

self.alertTitle = "alert accepted"

self.showingAlert.toggle()

}

override fun onAlertRejected() {

self.alertTitle = "alert rejected"

self.showingAlert.toggle()

}

override fun onEnrollmentHidden() {

self.alertTitle = "enrollment hidden"

self.showingAlert.toggle()

}

override fun onEnrollmentCompleted() {

self.alertTitle = "enrollment complete"

self.showingAlert.toggle()

}

}

To see this registration, rendering and callback work in action, check out the example apps.

Getting Work Item Count

You can get the current count of active alerts and enrollments using the appropriate members of the MessagesServiceManager.

iOS

func countPendingAlertsAndEnrolls() {

self.alertTitle = "There are \(messagesManager.activeAlertsCount) pending alerts and \(messagesManager.activeEnrollsCount) enrolls"

self.showingAlert.toggle()

}

Android

fun countPendingAlertsAndEnrolls() {

self.alertTitle = "There are ${messagesManager.activeAlertsCount} pending alerts and ${messagesManager.activeEnrollmemtsCount} enrolls"

self.showingAlert.toggle()

}

Enrollments Overview

You can grab the list of enrollments for a profile using the enrolls member of the MessagesServiceManager. Enrollment objects can be useful for displaying the user's current status, and potentially work items that they need to complete.

note

The SDK will not allow users to verify biometrics they haven't enrolled. For example, an alert that allows the user to choose between face, voice, and PIN will not allow the user to continue with voice if they haven't enrolled voice. Because of this, it can be useful to require users to complete all enrollments before allowing them to get alerts.

iOS

messagesServiceManager.enrolls

Android

messagesServiceManager.enrolls