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 used to initialize the SDK and authenticate your app.

⚠️ Important: Keep your API Key secure. It authorizes your app to interact with Entrupy services.

2. Permissions Management​

The Entrupy SDK requires access to the device camera, media storage, 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.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />
<uses-permission android:name="android.permission.INTERNET" />

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

📌 Note: Make sure your targetSdk version aligns with current Android permission behavior. For apps targeting Android 13+ (API 33+), the SDK will handle READ_MEDIA_IMAGES accordingly.

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. Next Steps​

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

  • Initialize the SDK using your API key
  • 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.