Skip to main content

Overview

Integrate Entrupy's authentication services directly into your iOS application using the Entrupy iOS SDK. This SDK enables your end-users to submit items for authentication and receive results seamlessly within your app's environment. Authentication through the SDK involves users interacting with its guided Capture Flow to submit item details and images. Once submitted, Entrupy processes the authentication, and the SDK's Detail View presents the final results, Estimated Time of Arrival (ETA), and any further item-specific communications or actions.

This documentation is for developers and product teams integrating Entrupy's authentication services into their iOS applications. For a comprehensive understanding of the Entrupy platform and the different ways it can be used to fit in your specific use case, refer to the Entrupy Solutions Introduction.

SDK and API Interaction​

The Entrupy iOS SDK and the Entrupy API work in tandem to integrate Entrupy's authentication services into your ecosystem:

  • iOS SDK (Client-Side): Embedded in your mobile app, the SDK provides the user interface (UI) and manages the interactive experience for item capture and results display. It communicates directly with Entrupy's platform to facilitate the authentication process for the end-user.

  • Entrupy API (Server-Side): Your backend systems use the API for programmatic access to authentication data, synchronization of item information (e.g., correlating with your customer_item_id), and management of related processes like webhooks or auxiliary data.

In essence, the SDK handles the front-end user journey within your app, while the API provides your backend with the necessary control and data access. For a more detailed explanation of how they operate together, please see The Entrupy Platform: How SDK & API Work Together.

Key iOS SDK Components​

The iOS SDK is primarily composed of two main UI flows/components that will be detailed in the SDK Reference section. The Integration Guide will walk you through implementing them.

Capture Flow​

The Capture Flow is an integrated view controller for capturing images. Its responsibilities include:

  • Guiding the user through the capture of images and relevant data for an item.
  • Incorporating client-side AI for smart capture features (e.g., real-time blur detection, glare detection, zoom/gyro assistance) to ensure image quality.
  • Managing image uploads directly to Entrupy's systems.
  • Optionally displaying an immediate Results Screen upon completion, primarily showing the processing ETA.

Detail View​

The Detail View is a unified view controller for displaying information about an authentication. Fields include:

  • Final authentication results (once available).
  • Estimated Time of Arrival (ETA) for results.
  • Event timelines related to the authentication.
  • Actions required (e.g., retakes).
  • Active flags on an item.
  • Per-item structured communications (support/chat with Entrupy).
  • Certificate information (including shareable links).
  • Relevant Catalog Data (product details, condition, etc.).

Direct Access​

Additionally, certain data points and functionalities related to the SDK's operation, such as authentication results, search and support messages, can be accessed programmatically. This allows integrators to build custom UI elements or workflows that complement the SDK's core views.

Multi-Language Support​

The SDK UI components, such as the Capture Flow and Detail View, support multiple languages:

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

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

Next Steps​

To begin integrating the Entrupy iOS SDK: