TrullyDocs

TrullySDK

TrullyWebSDK is an identity validation component designed to be integrated into your decision-making process.

Table of Contents

1. Add TrullySDK repository and dependencies
   1. Add jitpack as repository store in settings.gradle
   2. Check compileSdk and minSdk
   3. Add Jetpack Compose and ViewBinding
   4. Add dependencies
      1. Without libraries system
      2. With libraries system
   5. Add permission in manifest
2. Add it to your project
   1. Add Listeners
      1. Configure back event
      2. Listeners data structure
         1. onTrack
         2. onTrackDetail
         3. onResult
         4. onError
   2. Configure SDK
   3. Launch SDK
   4. Complete Example with default styles
3. Personalization
   1. Example
   2. Changing styles
      1. To configure texts
         1. Texts enums
      2. Colors
      3. Images
4. Full Example
5. Reading Results
   1. Decision Maker Response
   2. Receiving data with webhook
6. How to know the app size
7. Shrinking App
   1. Create a new Dynamic Feature Module
   2. Add android.play to the App level build.gradle
   3. Add split android.play SplitCompatApplication to the App manifest
   4. Move DocumentReaderFullAuth dependencies to your new module
   5. Configure an Activity to init the download
8. Demos

Add TrullySDK repository and dependencies

1.- Add jitpack as repository store in settings.gradle

Kotlin DSL

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)

    repositories {
        google()
        mavenCentral()

        maven {
            url = uri("https://jitpack.io")
        }
    }
}

Groovy DSL

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)

    repositories {
        google()
        mavenCentral()

        maven {
            url 'https://jitpack.io'
        }
    }
}

2.- Check compileSdk and minSdk

Our module requires a compileSdk of, at least, 34 and a minSdk of, at least, 24. Make sure your build.gradle has the correct versioning

Kotlin DSL

android {
    compileSdk = 34

    defaultConfig {
        minSdk = 24
    }
}

Groovy DSL

android {
    compileSdk 34

    defaultConfig {
        minSdk 24
    }
}

3.- Add Jetpack Compose and ViewBinding on your App level build.gradle

Enable Jetpack Compose by adding the following to the android section

Kotlin DSL

android {
    compileOptions {
        // Support for Java 8 features
        isCoreLibraryDesugaringEnabled = true
        sourceCompatibility = JavaVersion.VERSION_1_8
        targetCompatibility = JavaVersion.VERSION_1_8
    }

    buildFeatures {
        compose = true
    }

    composeOptions {
        kotlinCompilerExtensionVersion = "1.5.1"
    }

    viewBinding {
        enable = true
    }
}

Groovy DSL

android {
    compileOptions {
        // Support for Java 8 features
        coreLibraryDesugaringEnabled true
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }

    buildFeatures {
        compose true
    }

    composeOptions {
    	kotlinCompilerExtensionVersion '1.5.1'
    }

    viewBinding {
        enabled true
    }
}

4- Add dependencies

Without libraries system. Add the dependencies directly to the App level build.gradle

IMPORTANT: Use it until sdk version v3.1.0

Kotlin DSL

dependencies {
    implementation("com.github.TrullyAI:DocumentReaderFullAuth:7.9.9555")
    implementation("com.github.TrullyAI:TrullyKotlinSDK:latest") //change latest for the version number
    // Support for Java 8 features
    coreLibraryDesugaring("com.android.tools:desugar_jdk_libs:1.1.5")
}

Groovy DSL

dependencies {
    implementation 'com.github.TrullyAI:DocumentReaderFullAuth:7.9.9555'
    implementation 'com.github.TrullyAI:TrullyKotlinSDK:latest' //change latest for the version number
    // Support for Java 8 features
    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:1.1.5
}

IMPORTANT: Use it after sdk version v4.0.0

Kotlin DSL

dependencies {
    implementation("com.github.TrullyAI:TrullyKotlinSDK:latest") //change latest for the version number
    // Support for Java 8 features
    coreLibraryDesugaring("com.android.tools:desugar_jdk_libs:1.1.5")
}

Groovy DSL

dependencies {
    implementation 'com.github.TrullyAI:TrullyKotlinSDK:latest' //change latest for the version number
    // Support for Java 8 features
    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:1.1.5
}

With libraries system.

1.- Add the dependencies info to the libs.versions.toml file

[versions]
trully = "latest" //change latest for the version number
docReader = "7.9.9555"
desugaring = "1.1.5"

[libraries]
trully-doc = { group = "com.github.TrullyAI", name = "DocumentReaderFullAuth", version.ref = "docReader" }
desugaring-library = { group = "com.android.tools", name = "desugar_jdk_libs", version.ref = "desugaring" }
trully-sdk = { group = "com.github.TrullyAI", name = "TrullyKotlinSDK", version.ref = "trully" }

2.- Add the library dependencies to your App level build.gradle

dependencies {
    implementation(libs.trully.sdk)
    implementation(libs.trully.doc)
    coreLibraryDesugaring(libs.desugaring.library)
}

5.- Add permission in manifest

    <uses-feature android:name="android.hardware.camera" android:required="true" />

    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
    <uses-permission android:name="android.permission.CAMERA" />

6.- Replace theme (Optional)

If you have a custom app theme declared in the manifest file:

    <application
	...
        android:theme="@style/Theme.your_theme"
	... >

Please add this line to replace the themes and avoid compile configs:

    <application
	...
        tools:replace="android:theme">

Add it to you’re project

Add Listeners

Add TrullyListeners to the activity that will launch the SDK and implement its members so you can have access to the process data.

Method	Description
onTrack	Catch the step changing of the operation.
onTrackDetail	Catch the user’s interaction during the operation.
onResult	Catch the results of the operation.
onError	Catch the errors of the operation.
onLeaveFromStart	Optional. Set an action for the onBackPressed event for the initial view of the process.

Example

class MainActivity : AppCompatActivity(), TrullyListeners {

    override fun onTrack(trackStep: TrackStep) {
        Log.d("onTrack", trackStep.toString())
    }

    override fun onTrackDetail(trackDetail: TrackDetail) {
        Log.d("onTrackDetail", trackDetail.toString())
    }

    override fun onResult(response: TrullyResponse) {
        Log.d("onresult", response.toString())
    }

    override fun onError(errorData: ErrorData) {
        Log.d("onError", errorData.toString())
    }
}

Configure back event

To start the process you need to pass the packageContext. This is because our SDK runs on top of that context, which means if you run it from an empty Activity and the user goes back while on the first view of the SDK it will be left with an empty view. Same goes for fragments.
You can control this by adding the optional onLeaveFromStart listener so you can decide where the user should be redirected

Example

    class MainActivity : AppCompatActivity(), TrullyListeners {

    override fun onLeaveFromStart() {
        Log.d("onLeaveFromStart", "Custom back action when the user back to the previous screen from the TrullySDK")
    }

}

Listeners data structure

Here you’ll found the structures of the data received in each listener function

onTrack

This listener function will be called every time the user starts a new step on the process. There are five different steps. When a new step is started, you’ll receive the data from the previous completed step.

Key	Description
step	Name of the previous completed step.
userID	The userID you passed during initialization.
started_on	UTC timezone. Step starting time.
completed_on	UTC timezone. Step completion time.

Example

    override fun onTrack(trackStep: TrackStep) {
        Log.d("onTrack", trackStep.toString())
    }

Steps Table

Name	Description
form_start	User is currently scanning the document.
form_document	Process is currently trying to obtained location.
form_location	User is currently completing liveness process.
form_selfie	User reach the final step of the operation.
form_decision_maker	Operation has the Decision Maker respond.

onTrackDetail

This listener function will be called when the user take some actions during the operation. The actions that will trigger it are the ones related to the data needed for the Decision Maker.

Key	Description
userID	The userID you passed during initialization.
action	Name of the action that trigger the function.
timestamp	UTC timezone. When the function was trigger.

Example

    override fun onTrackDetail(trackDetail: TrackDetail) {
        Log.d("onTrackDetail", trackDetail.toString())
    }

Actions Table

Name	Description
LEGAL_DOCUMENTATION_ACCEPTED	User accept Privacy Policy and Terms and Conditions.
LEGAL_DOCUMENTATION_DECLINED	User declined Privacy Policy and Terms and Conditions.
LOAD_NEXT_PAGE	Operation start new page.
NO_CAMERA_AVAILABLE	The operation couldn’t start camera.
FRONT_IMAGE_OBTAINED	Operation has document front.
BACK_IMAGE_OBTAINED	Operation has document back.
DOCUMENT_ANALYSIS_RETRY	Operation needs to re start document analysis.
DOCUMENT_ANALYSIS_COMPLETE	Operation has analyzed front and back image.
LOCATION_OBTAINED	Operation has user’s location.
LOCATION_RETRY	Operation blocked due to location permissions denied. Retry operation
LOCATION_SKIPPED	Operation has continued without user’s location.
LIVENESS_RECOGNITION_PROCESS_STARTED	Operation has start liveness analysis.
LIVENESS_RECOGNITION_PROCESS_COMPLETED	Operation has analyzed liveness status.
DATA_SEND_TO_DECISION_MAKER	Operation has sended data collected to Decision Maker. Awaiting result
END_KYC_PROCESS	Operation has Decision Maker result.

onResult

This listener function will be called when the operation gets the Decision Maker result. Go to Reading Results section to get more information

onError

This listener function will be called in case of an error during the operation.

Key	Description
process	Which part of the process trigger the function.
message	Error message
userID	The userID you passed during initialization.
timestamp	UTC timezone. When the function was trigger.

Example

    override fun onError(errorData: ErrorData) {
        Log.d("onError", errorData.toString())
    }

Process Table

Name	Description
SAVING_TRACK_STEP	HTTP error when saving track data.
OBTAINING_IP	HTTP error when getting ip data.
INITIALIZING_DOCUMENT_READER	Process error during document reader initialization.
READING_DOCUMENT	Process error analyzing document.
GETTING_LOCATION	Process error obtaining location.
GETTING_LIVENESS	Process error analyzing liveness.
OBTAINING_DM_RESPONSE	HTTP error when getting Decision Maker response.

Configure SDK

To configure the SDK you’ll need to call the init method.

Parameter	Description
packageContext	Is the context of your Application/Activity.
apiKey	You’re client API_KEY. The SDK won’t work without it.
config	Config object will pass the environment and the styles to the SDK. See more

Example

    val config = TrullyConfig(environment = Environment.DEBUG, userID = "YOUR_ID_FOR_THE_PROCESS")
    //* For production environments use `Environment.RELEASE`. Required
    //* userID will identify the user completing the process. Required

    TrullySdk.init(apiKey = "YOUR_API_KEY", config = config)

Launch SDK

To start the SDK you’ll need to call the start method.

Parameter	Description
packageContext	Is the context of your Application/Activity.
listener	Is the TrullyListeners of your Application/activity.

Example

    TrullySdk.start(packageContext = this, listener = this)

Complete Example with default styles

import ai.trully.sdk.TrullySdk
import ai.trully.sdk.configurations.TrullyConfig
import ai.trully.sdk.models.Environment
import ai.trully.sdk.models.ErrorData
import ai.trully.sdk.models.TrackDetail
import ai.trully.sdk.models.TrackStep
import ai.trully.sdk.models.TrullyResponse
import ai.trully.sdk.protocols.listeners.TrullyListeners

class MainActivity : AppCompatActivity(), TrullyListeners {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        initialize()
    }

    override fun onResult(response: TrullyResponse) {
        Log.d("onResult", response.toString())
    }

    override fun onTrack(trackStep: TrackStep) {
        Log.d("onTrack", trackStep.toString())
    }

    override fun onTrackDetail(trackDetail: TrackDetail) {
        Log.d("onTrackDetail", trackDetail.toString())
    }

    override fun onError(errorData: ErrorData) {
        Log.d("onError", errorData.toString())
    }


    private fun initialize() {
        //Set SDK configuration
        val config = TrullyConfig(environment = Environment.DEBUG, userID = "YOUR_ID_FOR_THE_PROCESS")
        //* For production environments use `Environment.RELEASE`. Required
        //* userID will identify the user completing the process. Required

        //Initialize SDK
        TrullySdk.init(apiKey = "YOUR_API_KEY", config = config)

        //Run SDK
        TrullySdk.start(packageContext = this, listener = this)
    }
}

Personalization

The config object will allow to configure environment execution and change the styles. Also, for the process to work you need to pass a userID. The config object will let you do that.

Parameter	Description
environment	Environment.DEBUG for development. Environment.RELEASE for production. Required
userID	Will allow you to link the process to an ID generate by you for better track of each process. Required
tag	Valid uuid string. If you do not provide it, one will automatically generated.
	This tag is used to link every image analysis run by this SDK
showIdView	Boolean. Set it to true if you want to ask your client to show their id while running the validation. Optional. Default false
styles	Styles object that will allow you to config color, logo and texts. Optional

Example

  private fun initialize() {
    val styles: TrullyStyles = TrullyStyles()

    //Set SDK configuration
    val config = TrullyConfig(environment = Environment.DEBUG, userID = "YOUR_ID_FOR_THE_PROCESS", tag = "VALID_UUID_STRING" , style = styles, showIdView = true)
    //* For production environments use `Environment.RELEASE`.
    //* We recommend using named arguments so the order doesn't matter. If you're not using them, this example shows the order you should pass the arguments.

    //Initialize SDK
    TrullySdk.init(apiKey = "YOUR_API_KEY", config = config)

    //Run SDK
    TrullySdk.start(packageContext = this, listener = this)
}

Changing styles

Optionally you can change colors, texts and images. These are the default values

To configure texts use the uiTexts object

Value	Description
docType	What type of document the user need to complete de process. One of the Texts enum

Texts enums

Parameter	Value
INE_PASSPORT	INE o Pasaporte vigente
INE	INE vigente
PASSPORT	Pasaporte vigente

Example

private fun initialize() {
    val styles: TrullyStyles = TrullyStyles()

    styles.uiTexts.docType = Texts.PASSPORT

    //Set SDK configuration
    val config = TrullyConfig(environment = Environment.DEBUG, userID = "YOUR_ID_FOR_THE_PROCESS", tag = "VALID_UUID_STRING" , style = styles, showIdView = true)
    //* For production environments use `Environment.RELEASE`.
    //* We recommend using named arguments so the order doesn't matter. If you're not using them, this example shows the order you should pass the arguments.

    //Initialize SDK
    TrullySdk.init(apiKey = "YOUR_API_KEY", config = config)

    //Run SDK
    TrullySdk.start(packageContext = this, listener = this)
}

Colors

Key	Description	Value
primaryColor	Will change statusBar, button, icons and links color.	#475FFF
disabledColor	Will change button color when legal is not accepted.	#D6A0FF
backgroundColor	Will change button color when legal is not accepted.	#FFFFFF

Example

private fun initialize() {
    val styles: TrullyStyles = TrullyStyles()

    styles.primaryColor = ai.trully.sdk.R.color.primary
    styles.disabledColor = ai.trully.sdk.R.color.disabled
    styles.backgroundColor = ai.trully.sdk.R.color.background

    //Set SDK configuration
    val config = TrullyConfig(environment = Environment.DEBUG, userID = "YOUR_ID_FOR_THE_PROCESS", tag = "VALID_UUID_STRING" , style = styles, showIdView = true)
    //* For production environments use `Environment.RELEASE`.
    //* We recommend using named arguments so the order doesn't matter. If you're not using them, this example shows the order you should pass the arguments.

    //Initialize SDK
    TrullySdk.init(apiKey = "YOUR_API_KEY", config = config)

    //Run SDK
    TrullySdk.start(packageContext = this, listener = this)
}

Images

We are using the url to show you the images. Please, make sure you upload the images to your project and pass the corresponding drawable to the styles object

Key	Value
logo	https://trully-api-documentation.s3.amazonaws.com/trully-sdk/logo.png
IDIcon	https://trully-api-documentation.s3.amazonaws.com/trully-sdk/ID-1.svg
selfieIcon	https://trully-api-documentation.s3.amazonaws.com/trully-sdk/Video-1.svg
IDImage	https://trully-api-documentation.s3.amazonaws.com/trully-sdk/ID2-1.svg
permissions	https://trully-api-documentation.s3.amazonaws.com/trully-sdk/modalcamera-andriod.svg
light	https://trully-api-documentation.s3.amazonaws.com/trully-sdk/luzIcon.svg
cross	https://trully-api-documentation.s3.amazonaws.com/trully-sdk/retirarElementosIcon.svg
showId	https://trully-api-documentation.s3.amazonaws.com/trully-sdk/pruebavida.svg
check	https://trully-api-documentation.s3.amazonaws.com/trully-sdk/icon-check.svg
faceTimeout	https://trully-api-documentation.s3.amazonaws.com/trully-sdk/rostrofail.svg
noLocation	https://trully-api-documentation.s3.amazonaws.com/trully-sdk/pin-1.svg
noCamera	https://trully-api-documentation.s3.amazonaws.com/trully-sdk/cameraDenied-1.svg
error	https://trully-api-documentation.s3.amazonaws.com/trully-sdk/timeout.svg

Example

private fun initialize() {
    val styles: TrullyStyles = TrullyStyles()

    styles.logo = ai.trully.sdk.R.drawable.logo
    styles.IDIcon = ai.trully.sdk.R.drawable.ine
    styles.selfieIcon = ai.trully.sdk.R.drawable.selfie
    styles.IdImage = ai.trully.sdk.R.drawable.id
    styles.permission = ai.trully.sdk.R.drawable.modalandroid_camara
    styles.light = ai.trully.truedeepfakedetection.R.drawable.light
    styles.cross = ai.trully.truedeepfakedetection.R.drawable.cross
    styles.showId = ai.trully.sdk.R.drawable.pruebavida
    styles.check = ai.trully.sdk.R.drawable.check_circulo
    styles.faceTimeout = ai.trully.truedeepfakedetection.R.drawable.rostrofail
    styles.noLocation = ai.trully.sdk.R.drawable.ubicacion
    styles.noCamera = ai.trully.sdk.R.drawable.camara
    styles.errorIcon = ai.trully.sdk.R.drawable.timeouticon

    //Set SDK configuration
    val config = TrullyConfig(environment = Environment.DEBUG, userID = "YOUR_ID_FOR_THE_PROCESS", tag = "VALID_UUID_STRING" , style = styles, showIdView = true)
    //* For production environments use `Environment.RELEASE`.
    //* We recommend using named arguments so the order doesn't matter. If you're not using them, this example shows the order you should pass the arguments.

    //Initialize SDK
    TrullySdk.init(apiKey = "YOUR_API_KEY", config = config)

    //Run SDK
    TrullySdk.start(packageContext = this, listener = this)
}

Full Example

import ai.trully.sdk.TrullySdk
import ai.trully.sdk.configurations.TrullyConfig
import ai.trully.sdk.configurations.TrullyStyles
import ai.trully.sdk.models.Environment
import ai.trully.sdk.models.ErrorData
import ai.trully.sdk.models.TrackDetail
import ai.trully.sdk.models.TrackStep
import ai.trully.sdk.models.TrullyResponse
import ai.trully.sdk.protocols.listeners.TrullyListeners

class MainActivity : AppCompatActivity(), TrullyListeners {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        initialize()
    }

    override fun onResult(response: TrullyResponse) {
        Log.d("onResult", response.toString())
    }

    override fun onTrack(trackStep: TrackStep) {
        Log.d("onTrack", trackStep.toString())
    }

    override fun onTrackDetail(trackDetail: TrackDetail) {
        Log.d("onTrackDetail", trackDetail.toString())
    }

    override fun onError(errorData: ErrorData) {
        Log.d("onError", errorData.toString())
    }


    private fun initialize() {
        val styles: TrullyStyles = TrullyStyles()

	styles.uiTexts.docType = Texts.PASSPORT

        styles.primaryColor = ai.trully.sdk.R.color.primary
        styles.disabledColor = ai.trully.sdk.R.color.disabled
        styles.backgroundColor = ai.trully.sdk.R.color.background

        styles.logo = ai.trully.sdk.R.drawable.logo
        styles.IDIcon = ai.trully.sdk.R.drawable.ine
    	styles.selfieIcon = ai.trully.sdk.R.drawable.selfie
    	styles.IdImage = ai.trully.sdk.R.drawable.id
    	styles.permission = ai.trully.sdk.R.drawable.modalandroid_camara
    	styles.light = ai.trully.truedeepfakedetection.R.drawable.light
    	styles.cross = ai.trully.truedeepfakedetection.R.drawable.cross
    	styles.showId = ai.trully.sdk.R.drawable.pruebavida
    	styles.check = ai.trully.sdk.R.drawable.check_circulo
    	styles.faceTimeout = ai.trully.truedeepfakedetection.R.drawable.rostrofail
    	styles.noLocation = ai.trully.sdk.R.drawable.ubicacion
    	styles.noCamera = ai.trully.sdk.R.drawable.camara
    	styles.errorIcon = ai.trully.sdk.R.drawable.timeouticon

        val config = TrullyConfig(environment = Environment.DEBUG, userID = "YOUR_ID_FOR_THE_PROCESS", tag = "VALID_UUID_STRING" , style = styles, showIdView = true)

        //Initialize SDK
        TrullySdk.init(apiKey = "YOUR_API_KEY", config = config)

        //Run SDK
        TrullySdk.start(packageContext = this, listener = this)
    }
}

Reading Results

Decision Maker Response

You’ll find more details in Decision Maker API Docs

Key	Description
tag	String. The tag from the process. Automatically generated when you didn’t pass one through configuration prop
user_id	String. The userID you passed with the TrullyConfig object
raw_data	Object containing the unprocessed data from the Decision Maker. You can learn more about here
label	String. The label generate by the Decision Maker for the user who has completed the process
	No Threat - low risk user. Review - medium risk user. Potential Threat - high risk
reason	Array. Contains the reasons behind the decision
request_id
ip	String. Device IP captured on the SDK process (Only available after v4.2.2)
location	Object containing the latitude and longitude captured on the SDK process (Only available after v4.2.2)
image	Base64 string. Selfie
document_image	Base64 string. Document front cropped
document_image_complete	Base64 string. Document front uncropped
document_image_back	Base64 string. Document back cropped
document_image_back_complete	Base64 string. Document back uncropped

Example

    override fun onResult(response: TrullyResponse) {
        //Complete Decision Maker response
        Log.d("TRULLY_SDK", response.raw_data.toString())

        //Short response
        Log.d("TRULLY_SDK", response.user_id.toString())
        Log.d("TRULLY_SDK", response.request_id.toString())
        Log.d("TRULLY_SDK", response.label.toString())
        Log.d("TRULLY_SDK", response.reason.toString())

        //Images - base64 string
        Log.d("TRULLY_SDK", response.image.toString())
        Log.d("TRULLY_SDK", response.document_image.toString())
        Log.d("TRULLY_SDK", response.document_image_complete.toString())
        Log.d("TRULLY_SDK", response.document_image_back.toString())
        Log.d("TRULLY_SDK", response.document_image_back_complete.toString())

	// IP (Only available after v4.2.2)
	Log.d("TRULLY_SDK", response.ip.toString())

	// Location (Only available after v4.2.2)
	Log.d("TRULLY_SDK", response.location?.lat.toString())
	Log.d("TRULLY_SDK", response.location?.lng.toString())
    }

Receiving data with webhook

If you prefer it is possible to set a webhook url to receive the Decision Maker response. To do it, add webhook parameter to the TrullyConfig object

Example

  private fun initialize() {

    //Set SDK configuration
    val config = TrullyConfig(environment = Environment.DEBUG, userID = "YOUR_ID_FOR_THE_PROCESS", webhook = "YOUR_WEBHOOK_URL")
    //* For production environments use `Environment.RELEASE`.
    //* We recommend using named arguments so the order doesn't matter. If you're not using them, this example shows the order you should pass the arguments.

    //Initialize SDK
    TrullySdk.init(apiKey = "YOUR_API_KEY", config = config)

    //Run SDK
    TrullySdk.start(packageContext = this, listener = this)
}

How to know the app size

The size that you are seeing is not the size that your end users will get. The size that you can see includes support for four architectures (arm64-v8a, armeabi-v7a, x86, and x86_64). But one device has one architecture, not four. You can check the size of the app for one architecture creating an .aab for a specific architecture by following these instructions

1.- Configure the desired architecture build on your app level build.gradle

Kotlin DSL

android {
    defaultConfig {
        ...
        ndk {
            abiFilters 'arm64-v8a'
        }
    }
}

Groovy DSL

android {
    defaultConfig {
        ...
        ndk {
            abiFilters("arm64-v8a")
        }
    }
}

2.- Generate a signed App Bundle

In the Menu of Android Studio: Build -> Generate Signed Bundle / APK. Then choose the Android App Bundle option. Follow the assistance instructions and the result should be a single architecture bundle with the size your app will take on a user device

⚠️ Make sure to delete these configuration before creating the final package

Shrinking App

To reduce the App download size you can implement Dynamic Feature Modules to generate an on-demand installation of DocumentReaderFullAuth

⚠️ The .aab size will not be reduced but Google Play will manage the files so the download size will be reduced

⚠️ Make sure to download the Dynamic Feature Module before initializing TrullySDK

1.- Create a new Dynamic Feature Module

You can create a new Dynamic Feature Module with Android Studio using File > New > New Module this will open a window. Select Dynamic Feature and choose a name for your module then click next. The next window will ask to create a Module Title and to choose how you would like to include the module. We recommend to choose Do not include module at install-time (on-demand only) because it will let you decide when you want to start the download. This action will generate some changes to your app

settings.gradle

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)

    repositories {
        google()
        mavenCentral()

        maven {
            url = uri("https://jitpack.io")
        }
    }
}

rootProject.name = "Your Application Name"
include(":app")
include(":your_module_name")

App level build.gradle

android {
    //...other configurations
    dynamicFeatures += ":your_module_name"
}

2.- Add android.play to the App level build.gradle

Kotlin DSL

dependencies {
    implementation("com.google.android.play:core-ktx:1.8.1")
}

Groovy DSL

dependencies {
    implementation 'com.google.android.play:core-ktx:1.8.1'
}

3.- Add split android.play SplitCompatApplication to the App manifest

    <application
        android:name="com.google.android.play.core.splitcompat.SplitCompatApplication"
        android:allowBackup="true"
        android:dataExtractionRules="@xml/data_extraction_rules"
        android:fullBackupContent="@xml/backup_rules"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/Theme.MyApplication"
        tools:targetApi="31">
        <activity
            android:name=".MainActivity"
            android:exported="true">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>

4.- Move DocumentReaderFullAuth dependencies to your new module build.gradle

App level build.gradle dependencies

Kotlin DSL

dependencies {
    //android.play so we can use SplitCompat
    implementation("com.google.android.play:core-ktx:1.8.1")

    //SDK dependencies without DocumentReaderFullAuth and FaceCore
    implementation("com.github.TrullyAI:TrullyKotlinSDK:version")
}

Groovy DSL

dependencies {
    //android.play so we can use SplitCompat
    implementation 'com.google.android.play:core-ktx:1.8.1'

    //SDK dependencies without DocumentReaderFullAuth and FaceCore
    implementation 'com.github.TrullyAI:TrullyKotlinSDK:version'
}

Module level build.gradle dependencies

Kotlin DSL

dependencies {
    implementation("com.github.TrullyAI:DocumentReaderFullAuth:7.9.9555")
}

Groovy DSL

dependencies {
    implementation 'com.github.TrullyAI:DocumentReaderFullAuth:7.9.9555'
}

5.- Configure an Activity to init the download

class MainActivity : AppCompatActivity(), TrullyListeners, SplitInstallStateUpdatedListener {
    //variable to store the SplitInstallManager instance
    private lateinit var installManager: SplitInstallManager

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        //Generate SplitInstallManager instance
        installManager = SplitInstallManagerFactory.create(applicationContext)
        //Register Activity as listener
        installManager.registerListener(this)

        findViewById<Button>(R.id.launchTrully)
            .setOnClickListener {
                onTap()
            }
    }

    //Start download
    private fun onTap() {
        installManager.startInstall(
            SplitInstallRequest.newBuilder()
                .addModule("your_module_name")
                .build()
        )
    }

    //Delete all unnecessary data when Activity is destroy
    override fun onDestroy() {
        installManager.unregisterListener(this)
        installManager.deferredUninstall(listOf("your_module_name"))
        super.onDestroy()
    }

    //Configure the actions for the different states
    override fun onStateUpdate(state: SplitInstallSessionState) {
        when (state.status()) {
            //This state is required for every module larger than 10MB. You'll need it in this case
            SplitInstallSessionStatus.REQUIRES_USER_CONFIRMATION -> {
                installManager.startConfirmationDialogForResult(state, this, 123)
                Toast.makeText(this, "Request State", Toast.LENGTH_SHORT).show()
            }
            SplitInstallSessionStatus.INSTALLED -> {
                initialize()
                Toast.makeText(this, "Install State", Toast.LENGTH_SHORT).show()
            }
            SplitInstallSessionStatus.FAILED -> {
                Toast.makeText(this, "Failed State", Toast.LENGTH_SHORT).show()
            }

            SplitInstallSessionStatus.CANCELED -> {
                Toast.makeText(this, "Canceled State", Toast.LENGTH_SHORT).show()
            }

            SplitInstallSessionStatus.CANCELING -> {
                Toast.makeText(this, "Canceling State", Toast.LENGTH_SHORT).show()
            }

            SplitInstallSessionStatus.DOWNLOADED -> {
                Toast.makeText(this, "Downloaded State", Toast.LENGTH_SHORT).show()
            }

            SplitInstallSessionStatus.DOWNLOADING -> {
                Toast.makeText(this, "Downloading State", Toast.LENGTH_SHORT).show()
            }

            SplitInstallSessionStatus.INSTALLING -> {
                Toast.makeText(this, "Installing State", Toast.LENGTH_SHORT).show()
            }

            SplitInstallSessionStatus.PENDING -> {
                Toast.makeText(this, "Pending State", Toast.LENGTH_SHORT).show()
            }

            SplitInstallSessionStatus.UNKNOWN -> {
                Toast.makeText(this, "Unknown State", Toast.LENGTH_SHORT).show()
            }
        }
    }

    override fun onResult(response: TrullyResponse) {
        Log.i("response", "finish")
    }

    override fun onTrack(trackStep: TrackStep) {
        Log.d("onTrack", trackStep.toString())
    }

    override fun onTrackDetail(trackDetail: TrackDetail) {
        Log.d("onTrackDetail", trackDetail.toString())
    }

    override fun onError(errorData: ErrorData) {
        Log.d("onError", errorData.toString())
    }

    private fun initialize() {
        val config = TrullyConfig(environment = Environment.DEBUG, userID = "YOUR_ID_FOR_THE_PROCESS")

        //Initialize SDK
        TrullySdk.init(apiKey = "YOUR_API_KEY", config = config)

        //Run SDK
        TrullySdk.start(packageContext = this, listener = this)
    }
}

Demos

SDK implementation using Activities