Skip to main content

SDK Management API

When integrating Entrupy's Mobile SDKs (for iOS or Android) into your application, your backend server plays an important role in managing SDK user sessions and facilitating communication. This section outlines the key API interactions your server will handle.

Overview​

Your server is responsible for:

  1. Obtaining SDK Session Tokens: Your server requests SDK session tokens from the Entrupy API. These tokens are then passed to your mobile client to initialize and authorize the SDK.
  2. Managing User Information: While the Entrupy SDK and API interact with a unique_user_id that you provide, your backend is responsible for your actual user authentication, mapping your internal user identifiers to the unique_user_id used with Entrupy, and securely storing any associated user data (like email, which might be used on certificates).

SDK session tokens are specific to a unique_user_id and have a defined expiration period. A single token can be reused for multiple image capture flows initiated by that user until the token is close to its soft_exp (soft expiry) timestamp or the SDK indicates the token is invalid.

Customer Support Interactions​

When end-users interact with the Entrupy SDK within your mobile application, they might have questions or require assistance, for example, with image retakes or understanding authentication results. Your backend server can play a role in these interactions.

Entrupy provides a structured communication system, accessible both directly within the SDK (if you use its built-in UI components for support) and via the API.

Your backend can:

  • Act as an Intermediary: Retrieve support messages or available structured responses from the Entrupy API and present them within your custom UI, then submit user responses back through the API.
  • Facilitate Escalations: If you manage first-line support, ensure that any escalations to Entrupy include the relevant entrupy_id and customer_item_id to enable swift assistance.
  • Use Webhooks: Subscribe to webhook events (e.g., support.message) to be notified in real-time when new messages are available or actions are required for an item. This allows your backend to proactively update your systems or alert users.

Refer to the general Customer Support via API documentation for more details on API capabilities for support, as the underlying mechanisms are similar whether supporting SDK-initiated or app-initiated authentications.

For an example of how to implement a backend server to handle these responsibilities, see the Sample SDK Management Server.