Skip to main content

B. App Registration & Permissions

Before you can fully use the Entrupy Android SDK, your application must be registered with Entrupy and configured with minimal setup. The SDK internally handles permission requests and related user flows.

1. Registering Your Application​

To begin integrating the Entrupy SDK into your Android app, you must first register your application with Entrupy.

Steps:​

  1. Contact Entrupy

    Reach out to Entrupy support or your assigned Entrupy contact (e.g., developer@entrupy.com or your account manager).

  2. Provide Application ID

    Share your app's application ID (also known as the package name), for example:

    com.yourcompany.yourapp
  3. Describe Intended Use

    Provide a short description of how your app will use Entrupy's services.

  4. Receive API Key

    Upon approval, Entrupy will provide an API Key for your backend server. Your server uses this key with the Entrupy API to sign authorization requests that the mobile app exchanges for SDK session tokens. The SDK is not initialized with the API key—EntrupyApp.init() takes only your Application instance.

Important

Keep your API Key secure on the server side. It is used to authenticate your backend with Entrupy services, not inside the Android app.

2. Permissions Management​

The Entrupy SDK requires access to the device camera and internet to perform item authentication.

Good news: You don't need to handle runtime permission requests manually — the SDK takes care of it for you.

Required Permissions (Handled by the SDK)​

These permissions are declared within the SDK's manifest and include:

<uses-feature android:name="android.hardware.camera.any" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.INTERNET" />

When needed, the SDK will request camera permission from the user at runtime using the Android system dialog.

Developer Tip​

If you choose to proactively inform users why camera access is needed (before the system dialog), you can do so using a custom explanation screen or toast. This is optional but may improve trust and user experience.

3. Data Disclosures​

Besides Entrupy's backend, the SDK sends data to one third party: Google ML Kit, which scans barcodes on the device. ML Kit processes barcode images and results on the device and does not send them to Google. It does send diagnostics and usage analytics, including device and app information, per-installation identifiers, performance metrics, API configuration, input and output sizes, and event and error data.

Review ML Kit's Android data disclosure guidance and declare the applicable data in places such as the Data safety section in Google Play Console.

The SDK contains no general-purpose product analytics or crash-reporting vendor, and it sends no error reports to your crash reporter.

4. Next Steps​

Once your app is registered and permissions are in place (via the SDK), you're ready to:

  • Initialize the SDK in your Application class
  • Launch the Capture Flow
  • Display authentication results via the Detail View

Continue to the SDK User Authorization section to manage user association and track authentication sessions.