Skip to main content

Overview

Integrate Entrupy's authentication services directly into your Android application using the Entrupy Android SDK. This SDK allows your users to seamlessly submit items for authentication and receive results within your app's experience. The authentication flow begins with a guided Capture Flow, where users provide item details and images. Once submitted, Entrupy processes the request, and the SDK's Detail View displays the authentication result, ETA (Estimated Time of Arrival), and other item-specific information or actions.

This documentation is intended for Android developers and product teams integrating Entrupy's services into their mobile applications. For a broader understanding of Entrupy's capabilities and how it can be customized to fit your product, refer to the Entrupy Solutions Introduction.

SDK and API Interaction​

The Entrupy Android SDK and the Entrupy API work together to power the authentication service:

  • Android SDK (Client-Side):

    Integrated into your mobile app, the SDK manages the entire user-facing experience, including image capture, smart assistance (e.g., blur detection, glare reduction), and displaying results. It handles direct communication with the Entrupy platform during the authentication process.

  • Entrupy API (Server-Side):

    Your backend can use the Entrupy API for data synchronization, mapping your internal IDs (like customer_item_id) with Entrupy items, retrieving authentication statuses, handling web hooks, and managing auxiliary data.

Together, the SDK provides the UI and user flow, while the API ensures backend integration and control. For more details on this collaboration, refer to The Entrupy Platform: How SDK & API Work Together.

Key Android SDK Components​

The Entrupy Android SDK consists of two primary UI components, each of which can be embedded into your application flow. These components will be further explored in the SDK Reference and Integration Guide sections.

Capture Flow​

The Capture Flow is a full-screen activity or fragment that guides users through the process of capturing item photos and relevant information.

Responsibilities:

  • Guides users step-by-step through photo capture for item authentication.
  • Utilizes on-device AI for enhanced capture quality:
    • Real-time blur detection
    • Glare feedback
    • Zoom and gyro-based alignment assistance
  • Manages direct upload of captured media to Entrupy servers.
  • Optionally transitions to a Results Screen showing processing status and ETA.

Detail View​

The Detail View presents the full status and outcome of an authentication submission.

Features:

  • Displays final authentication results once available.
  • Shows ETA if results are still processing.
  • Visualizes authentication timelines and submission events.
  • Highlights required actions (e.g., image retake).
  • Displays flags and structured messages from Entrupy.
  • Provides access to the Certificate (with shareable links).
  • Shows Catalog Data (product information, condition, etc.).
  • Integrates in-app support/chat functionality for item-specific communication.

Direct Access​

While the SDK provides core UI components, integrators may also access authentication data, support messages, and search functionalities via public SDK interfaces or the Entrupy API. This enables you to build custom UI flows or hybrid experiences alongside the core SDK.

Multi-Language Support​

The SDK supports multiple UI languages out-of-the-box:

  • English (default)
  • Japanese
  • Traditional Chinese
  • Simplified Chinese

The Android SDK automatically detects the device language and adapts the UI accordingly. If a language is not supported, the UI defaults to English.

Next Steps​

To begin integrating the Entrupy Android SDK: