These docs are for v2.6. Click to read the latest docs for v3.1.

credolabSDK for Android is a Kotlin library designed to capture a client’s digital footprint from an Android device and upload it to the credolab web service for future processing of scorecards and fragments.

Versions

πŸ“˜

Go to the "Declare dependencies" section of the Android SDK Integration documentation to learn how to resolve these artefacts in your project

❗️

3.x.x Compatibility

4.x.x modules are not compatible with previous versions of Credolab Android SDK, excluding Logging Plugin

Artifact IDVersion
modular.core

Please note that starting from 3.x.x, the CoreModule artifact id has been changed from modular.core.proxy.encrypt to modular.core
4.1.0
modular.application4.0.0
modular.account4.0.0
modular.behavioral4.0.0
modular.calendar4.0.0
modular.contact4.0.0
modular.fraudforce 4.0.0
modular.audio4.0.0
modular.images4.0.0
modular.video4.0.0
modular.sms4.0.0
modular.logging4.0.0
iovation5.1.0

Modules

Core

πŸ“₯

Main module

Mandatory

Extracts various metadata connected with device characteristics & configuration, media (internal storage), and data collection process. This includes info about the device's brand, model, storage, total and available free memory, battery characteristics, Wi-Fi, Bluetooth, and other device description data.

Permissions

Requires only normal permission declaration

  • android.permission.ACCESS_WIFI_STATE
  • android.permission.USE_FINGERPRINT
  • android.permission.ACCESS_NETWORK_STATE

Account

πŸ“¦

Additional module

Extracts metadata connected with user's accounts on the device. For example, Gmail, Facebook, etc.

Permissions

  • android.permission.GET_ACCOUNTS

Application

πŸ“¦

Additional module

Extracts information related to how many applications are installed on the device and the respective metadata connected with that app, features, and existing permissions.

Permissions

No permission declaration is needed, however, an intent query is required:

    <queries>
        <intent>
            <action android:name="android.intent.action.MAIN" />
        </intent>
    </queries>

Behavioral

πŸ“¦

Additional module

❗️

Does not support Jetpack Compose

Extracts metadata related to the user’s in-app behavior, such as touch, taps, text input, scroll, etc.

Permissions

  • android.permission.ACCESS_NETWORK_STATE

Calendar

πŸ“¦

Additional module

Extracts metadata connected with calendar information presented on the device. This includes the following attributes of calendars Events, Attendees, and Reminders.

Permissions

  • android.permission.READ_CALENDAR

Contact

πŸ“¦

Additional module

Extracts metadata connected with Contacts and Contacts Group presented on the device.

Permissions

  • android.permission.READ_CONTACTS

FraudForce

πŸ“¦

Additional module

Requires third party TruValidate(formerly known as iovation) module, it's available through credolab repositories

Extracts device profile metadata collected by TruValidate SDK, such as device type, geolocation & browser information, and system settings.

Permissions

Doesn't require permission declaration

Audio

πŸ“¦

Additional module

Extracts metadata connected with music, audio files that are located in the external storage.

Permissions

  • android.permission.READ_EXTERNAL_STORAGE
  • android.permission.READ_MEDIA_AUDIO

Images

πŸ“¦

Additional module

Extracts metadata connected with images files that are located in the external storage.

Permissions

  • android.permission.READ_EXTERNAL_STORAGE
  • android.permission.READ_MEDIA_IMAGES

Video

πŸ“¦

Additional module

Extracts metadata connected with video files that are located in the external storage.

Permissions

  • android.permission.READ_EXTERNAL_STORAGE
  • android.permission.READ_MEDIA_VIDEO

SMS

πŸ“¦

Additional module

Extracts metadata related to SMS presented on the device.

Permissions

  • android.permission.READ_SMS

Plugins

Logging

πŸ“¦

Optional plugin, use this to allow credolab to monitor SDK errors

🚧

credolab highly recommends using a logging plugin to gain information for identifying and analysing a particular case.