Skip to main content

Programmatic Access to Session Data

The Entrupy Android SDK provides authentication data through its built-in UI — the Detail View Controller for individual item details — and through the Entrupy API from your backend.

Overview

Authentication data flows through two primary channels:

  • SDK UI (client-side): The Detail View displays authentication results and item details scoped to the logged-in user.
  • Entrupy API (server-side): Your backend receives authentication results and status updates via webhooks, and can query the API for cross-user reporting and data synchronization.

1. SDK UI Components

Detail View

For individual item details, launch the Detail View using an Entrupy ID:

import com.entrupy.sdk.app.EntrupyApp

fun showItemDetails(entrupyId: String) {
EntrupyApp.sharedInstance().displayDetailViewForItem(entrupyId)
}

The Detail View displays:

  • Authentication result (Authentic, Unknown, Not Supported, etc.)
  • Item metadata (brand, item type, style)
  • Processing status and timeline
  • Certificate access (for authentic items)
  • Flag status and support features

2. Authentication Data Model

The SDK uses the AuthenticationItem data class to represent authentication records. Key properties include:

PropertyDescription
authenticationIdUnique Entrupy identifier for the authentication
propertiesItem metadata — brand, model, function
statusCurrent status — result (ResultStatusId), flag (FlagStatusId)
imagesCaptured images (thumbnails, uploaded images)
eventTimesProcessing timeline events
timestampSubmission timestamp
textFieldsCustom text fields (e.g., customer_item_id)

Result Status Values

The ResultStatusId enum represents the possible authentication outcomes:

import com.entrupy.core.partner.data.model.ResultStatusId
ValueDescription
NEEDS_REVIEWPending manual review
RECEIVEDSubmission received, processing
REGISTEREDItem registered in the system
NOT_AVAILABLEResult not available
INVALIDInvalid submission
AUTHENTICItem authenticated as genuine
UNKNOWNUnable to determine authenticity
NOT_SUPPORTEDItem type not supported for authentication
NO_MATCHNo match found in reference data
MATCHMatch found in reference data
ANALYZEDAnalysis complete
CANCELEDAuthentication canceled
DATA_REQUIREDAdditional data required
REGISTRATION_INVALIDRegistration is invalid
REGISTRATION_NOT_SUPPORTEDRegistration type not supported
MATCH_FOUNDMatch found
NO_MATCH_FOUNDNo match found

3. Server-Side Data Access

For backend data access, reporting, and cross-user queries, use the Entrupy API:

  • Webhooks: Receive real-time notifications for result updates, flag changes, and other events.
  • API queries: Retrieve authentication details, search across users, and synchronize with your internal systems.
  • Data mapping: Use customer_item_id to map Entrupy authentications to your internal records.

Refer to Essential Backend Integration Tasks for setup details.

Best Practices

  • Use SDK UI for user-facing features. The Detail View provides a maintained, consistent experience.
  • Use the API for backend operations. Reporting, cross-user search, and data synchronization should go through your backend.
  • Map IDs consistently. Store the authenticationId alongside your customer_item_id for reliable cross-referencing.

Next Steps