Skip to main content
Unveilydocs

Download

Download the Unveily SDK and drop it into your project.

Download

Go to My Page → Downloads and download the file for your subscription plan.

Features by Plan

FeatureBasicStandardPro
QR / Barcode scan
Push notifications (FCM)
Camera / Gallery
GPS location
Deep links
Biometric auth
In-app purchases (Google Play / App Store)

Required Settings

1. WebView Domain (Required)

app/src/main/java/.../MainActivity.kt:

// ⚠️ Must be changed to your domain
private val TRUSTED_WEB_URL = "https://your-domain.com"

If TRUSTED_WEB_URL does not match your actual domain, the WebView will be blocked.

2. License Key File (Required)

Check your key in My Page → License, then create the file:

# For development builds
app/src/debug/assets/license.key

# For release builds
app/src/release/assets/license.key

Example file contents:

UW5DGz1nLpM8...(key copied from My Page)

3. Firebase Setup (Required — for push notifications)

  1. Firebase Console → Create a new project
  2. Add an Android app → Enter the package name
  3. Download google-services.json
  4. Place it at app/google-services.json

Optional Settings

4. App UI Configuration (config.json)

app/src/main/assets/config.json:

{
  "modules": {
    "accessibility": { "enabled": false },
    "topDownMenu":   { "enabled": false },
    "sideDrawer":    { "enabled": true },
    "bottomTabs":    { "enabled": true, "autoHide": false },
    "bottomSheet":   { "enabled": true }
  },
  "security": {
    "screenshotProtectionEnabled": true,
    "backgroundProtectionEnabled": true,
    "rootDetectionEnabled": true
  }
}

In app/build.gradle.kts, change the deep link scheme for each Flavor:

productFlavors {
    create("basic") {
        // Default: unveily-basic → change to your app's scheme
        buildConfigField("String", "DEEP_LINK_SCHEME", "\"yourapp\"")
    }
}

iOS Setup

iOS SDK v1.0.0 is available. For iOS-specific configuration, see the iOS Setup Guide.

Key differences from Android:

ItemAndroidiOS
License key pathapp/src/release/assets/license.keyResources/license.key
Google Sign-In configgoogle-services.jsonGoogleService-Info.plist
Apple Sign-InFirebase AuthASAuthorizationController (native)
Web URL settingTRUSTED_WEB_URL in MainActivity.ktunveilyInitialURL in config.json

On this page