Skip to main content

B. Handling Result Flags

Entrupy provides a flagging mechanism that allows users or integrators to report a potential issue with an authentication result. This directs the Entrupy support team to review the specific case and resolve it appropriately. Flagging is the preferred method for disputing a result, rather than resubmitting an item, which could incur additional costs.

Purpose of Flags

Flags are typically used when an end-user or the integrating platform believes there might be an error or a need for re-evaluation of an authentication outcome. The ability to allow users to flag via the SDK is configurable; for some deployments, limiting this function to the platform is a better fit.

1. Flag Management Through the SDK UI​

Flag management in the Android SDK is handled through the built-in Detail View UI. When you call displayDetailViewForItem(entrupyId), the Detail View includes flag-related actions for eligible items:

import com.entrupy.sdk.app.EntrupyApp

val entrupyApp = EntrupyApp.sharedInstance()

if (entrupyApp.isAuthorizationValid()) {
    entrupyApp.displayDetailViewForItem("your-entrupy-id")
}

Within the Detail View, users can:

  • View the current flag status of a result.
  • Flag a result for review (if the item is eligible).
  • See updates when Entrupy support resolves a flag.

2. Flag Status in the Data Model​

The SDK exposes flag status through the AuthenticationItem data model, which is accessible through the Detail View. Each AuthenticationItem contains a Status object with a nested Flag property:

import com.entrupy.core.partner.data.model.FlagStatusId

// FlagStatusId enum values:
// FlagStatusId.FLAGGED   — the result has been flagged for review
// FlagStatusId.RESOLVED  — a previously flagged result has been resolved

When viewing an item through the Detail View, flag status is indicated visually.

3. Receiving Flag Resolution Notifications (Backend)​

The actual review and resolution of a flag happens on Entrupy's backend. To be notified of flag status changes programmatically:

  • Webhooks: Configure your backend server to receive webhook notifications from the Entrupy API for updates related to flag statuses or result changes.

Refer to the Essential Backend Integration Tasks for details on setting up webhooks.

4. Best Practices​

  • Use the Detail View for flag interactions. The SDK's built-in UI handles flag eligibility checks, submission, and status display.
  • Monitor flags via webhooks. For server-side tracking and reporting, configure webhooks to receive real-time flag status updates.
  • Do not resubmit items to dispute results. Flagging is the supported workflow for re-evaluation requests.

Next Steps​