Skip to main content

REST API

Entrupy's REST API provides a comprehensive interface for your backend systems to interact with the Entrupy platform. It allows you to retrieve authentication and fingerprinting results, manage SDK sessions and facilitate customer support interactions. This API is central to integrating Entrupy's capabilities, whether you use the Entrupy SDKs for in-app experiences or manage authentications through the Entrupy app.

Authentication​

Entrupy's authentication solutions involve image capture and submission. The Authentication API endpoints allow your backend to manage these sessions and their outcomes.

Data from SDK-Initiated Authentications:

When using an Entrupy SDK, your backend typically requests a session token from the API. This token initializes the SDK's capture flow in your mobile application. After the SDK submits images and data, Entrupy's systems process the authentication. Final authentication results, ETAs, event timelines, and any associated flags are accessible via the API. This information can also be displayed in the SDK's Detail View, which includes the Entrupy Certificate.

Data from Entrupy App-Initiated Authentications:

When your team uses the Entrupy app for authentications, the app directly handles image capture and submission. All resulting data—including status, detailed results, ETAs, event timelines, and certificate information—is accessible through the same API endpoints that service SDK-originated data.

Fingerprinting​

Entrupy's fingerprinting technology allows platforms to register unique items for future identity verification. This is particularly useful for scenarios such as return fraud prevention, where it is important to confirm that a returned item is the exact same item that was originally sold.

Fingerprint Registration and Verification Workflows:

Item capture for creating an initial fingerprint (registering an item) or for verifying an item against an existing fingerprint can be performed in two ways:

  • Using the Entrupy Mobile SDKs: The SDKs manage the item capture process. This involves using the standard SDK capture flow with specific parameters designated for fingerprinting.
  • Using the Entrupy App: The Entrupy app can also be used to register an item's fingerprint and to later verify an item against its registered fingerprint.

API for Fingerprinting Data:

Whether the fingerprint registration or verification is initiated via an SDK or the Entrupy app, the Fingerprinting API is used to:

  • Retrieve the results of verification sessions, which indicate whether a new scan matches the original registered fingerprint.
  • Manage fingerprint records.
  • Access data related to fingerprinting events, correlated using the customer_item_id.

Customer Support (SDK)​

For SDK integrators, the Entrupy API offers mechanisms for your backend systems to manage and facilitate support interactions concerning item authentications on a per-item basis using a structured communication system.

Key API Capabilities for Support:

  • Accessing Communication Data:
    • Retrieve conversation history for an item.
    • Access event timelines related to an item's authentication process.
    • Get available structured message choices for user responses (e.g., for retake requests).
  • Facilitating User Responses:
    • Submit a user's chosen structured response, useful for custom UI implementations.
  • Managing Item Status & Issues:
    • Flag items for Entrupy review.
    • Mark an item as abandoned.
  • Notifications:
    • Configure webhooks for real-time notifications on support-related events.

Typical support interactions include requesting clarification on retake requirements or responding to queries from the Entrupy team. Refer to the Customer Support Concepts article for a higher-level overview and the API Reference v2 for specific endpoint details.