Skip to main content

Detail Screen UI Guide

The Detail Screen UI is a key component in the Entrupy iOS SDK. It serves as a comprehensive dashboard for a single authenticated item, displaying current status, final results, historical events, and any required user actions.

Overview​

Once an item has been submitted via the Capture Flow UI, the Detail Screen UI is the primary interface within the SDK for your users to:

  • Track the authentication status (e.g., Processing, Completed, Needs Retake).
  • View the final authentication result (e.g., Authentic, Unidentified).
  • See the Estimated Time of Arrival (ETA) if results are pending.
  • Review an event timeline of the item's authentication journey.
  • Respond to actions required, such as performing image retakes.
  • Manage and view flags associated with the item's result.
  • Access certificate information, including a shareable link (for authentic items).
  • View integrated Catalog Data, providing rich product details.
  • The Entrupy logo is displayed in this view, reinforcing the verification service.

Presenting the Detail Screen UI​

To display the Detail Screen for a specific item, present it using the Entrupy ID and a configuration object. See the Post-Authentication Operations guide for a complete snippet.

// Swift
import EntrupySDK

class ResultsViewController: UIViewController, EntrupyDetailViewDelegate {
    func showEntrupyDetailView(for entrupyId: String) {
        guard EntrupyApp.sharedInstance().isAuthorizationValid() else { return }

        let viewConfig = EntrupyDetailViewConfiguration(
            displayTimeline: true,
            displayUploadedImages: true,
            enableFlagging: true,
            enableItemDetailEdit: false
        )

        EntrupyApp.sharedInstance().detailViewDelegate = self

        EntrupyApp.sharedInstance().displayDetailViewForItem(
            withEntrupyID: entrupyId,
            withConfiguration: viewConfig
        )
    }

    // EntrupyDetailViewDelegate
    func didDisplayDetailViewForItem(withEntrupyID entrupyID: String) {}
    func didDismissDetailViewForItem(withEntrupyID entrupyID: String) {}
    func didDisplayDetailViewFailWithError(
        _ errorCode: EntrupyErrorCode,
        description: String,
        localizedDescription: String,
        forEntrupyID entrupyID: String
    ) {}
}

Key Information and Features Displayed​

The Detail Screen UI consolidates various pieces of information:

1. Authentication Status & ETA​

  • Current Status: Clearly indicates the item's state (e.g., "Processing," "Awaiting Retake," "Completed").
  • ETA: If authentication is in progress, an estimated completion time is displayed when available.

2. Final Authentication Results​

  • Once processing is complete, the definitive authentication outcome is prominently shown (e.g., "Authentic," "Unidentified," "Not Supported").
  • (A comprehensive list of all possible result statuses and their meanings should be referenced from a dedicated "Results & Statuses Reference" if provided by Entrupy, or inferred from sdk-v1-legacy.md result types.)

3. Event Timeline​

  • A chronological log of significant events related to the item's authentication:
    • Submission created
    • Additional images requested/provided
    • Authentication status changes (e.g., started, completed)
    • Flags added/resolved
    • Support messages exchanged
  • (The exact event types visible will be determined by the SDK's implementation.)

4. Flags Management​

  • Viewing Flags: If a result has been flagged (e.g., by the integrator or Entrupy support), information about active flags, such as the reason and current status, can be displayed.

  • User Flagging (Conditional): The ability for end-users to initiate a flag on a result via the SDK may be configurable by Entrupy per integrator. If enabled, the Detail Screen would be the interface for this.

  • Interacting with Flags: The SDK provides methods to get flag details and set/clear flags, which the Detail Screen UI would utilize.

    • getFlagDetailsForResult(withEntrupyID:completion:): To obtain flag status and eligibility.
    • setFlag(_:forResultWithEntrupyID:flagReasonId:message:): To flag or clear a flag.
    • An EntrupyFlagDelegate (didFlagResultSuccessfully, didFlagResultFailWithError) handles the outcome of these actions.

    Refer to Section 11 of sdk-v1-legacy.md for the underlying SDK methods.

5. Structured Communications (Item-Specific Support)​

  • The Detail Screen often includes an interface for per-item structured communication with Entrupy's authentication support team.
  • Users can select from predefined messages or queries, and Entrupy support can respond or provide guidance directly within this view.
  • This is the primary channel for authentication-specific support issues (e.g., assistance with retakes, queries about a result).
  • The SDK should visually indicate new messages from Entrupy support.
  • (For notifications when the application or Detail Screen is not active, integrators would typically implement their own push notification system, triggered by events received via Entrupy API webhooks related to new support messages.)

6. Certificate Information (for Authentic Items)​

  • Details Displayed: For items confirmed as "Authentic," key details from the Entrupy Certificate of Authenticity are shown (e.g., authenticity status, unique certificate ID, date of authentication).
  • Shareable Link: A shareable web link to the full Entrupy Certificate is provided.
  • Certificate Transfers: If a Certificate Transfer has been completed using the Entrupy API, the SDK's Detail Screen will automatically update to display the new certificate holder's details. This ensures the information presented in the SDK is always current with the latest ownership record.

7. MarketEdge Integration​

  • The Detail Screen can display MarketEdge data associated with the authenticated item: condition grade, market value, and comparable marketplace listings.
  • Content typically includes:
    • Market Grade: Condition rating, issues, and per-region details (exterior, hardware, stitching, etc.).
    • Market Value: Best-estimate value from recent market data.
    • Market Match: Similar recent listings (platform, link, price, similarity) for context.
  • The specific MarketEdge elements shown in the SDK may be configurable by Entrupy per integrator. For a dedicated MarketEdge screen, use the MarketEdge View UI.
  • Refer to the Understanding MarketEdge in SDK guide for structure and programmatic access.

Entrupy Branding​

The Entrupy logo will be displayed within the Detail Screen, reinforcing the authenticity verification service being provided.

Customization​

Customization options for the Detail Screen (e.g., theming, hiding/showing certain sections) are generally limited to maintain a consistent Entrupy experience. Any available options, such as applying a global UI Theme, will be noted in the relevant SDK documentation.

Delegate Callbacks (If Applicable)​

The Detail Screen uses EntrupyDetailViewDelegate so your app can react when the view is shown, dismissed, or fails to display.

How Result Updates Work​

After submission, results may be available immediately or delivered asynchronously.

  1. Post-submission: After Capture Flow UI, your app can route users into the Detail Screen to view the result status.
  2. Immediate outcomes: Some authentications return a final result shortly after submission.
  3. Asynchronous outcomes: Some items enter an interim state (for example, Needs Review) and may include an ETA for final result delivery.
  4. Result retrieval: Use entrupy_id with your backend/API workflows (preferably webhook-driven) to track completion and notify your app (for example, via push notification).
  5. In-app display: When users open Detail Screen UI, they see the latest available status and details.

Next Steps​