Overview
The credoapp SDK for Android is a multi-modular Android library used to capture the digital footprint of a smartphone user and upload it to the credolab web-service for future processing of scores and fragments.
The diagram below shows the overview on how your mobile app works with the credoSDK for Android embedded:

Standard flow for mobile:
1. Initialize credoapp SDK
2. Collect credolab dataset
2.1 Check reference number uniqueness
2.2 Collect dataSet
2.3 Upload to credolab dataset
3. Login
4. Get credolab score
Refer to our Integration Guideline section to understand more about our credoSDK modules and learn how to integrate them.
Download Android SDK
Click here to download the SDK modules.
There are 6 different modules, one for each of the 6 permissions that the SDK can access:
1. Registered Account
2. Calendar
3. Contact
4. Media
5. Core
6. SMS
Since the purpose of this SDK integration is to collect metadata for credit scoring purposes, we recommend you to download and integrate as many modules as possible into your mobile app. However, we recognise that you might not want to add any friction to the current user experience or that you might not want to enable a "dangerous permission". As such, you are free to limit the permissions to the ones that your mobile app already requires.
Rest assured that we collect only metadata, not personal data, and that we can calculate an alternative credit score even if you integrate only the core module.
What is a module?
What is a module?
What is a module?
You can easily customise the the SDK by adding different modules based on the permissions used in the application. Each module is presented as an AAR file that extracts different data types according to the table below.
Credoapp SDK Permissions
Credoapp SDK Permissions
Credoapp SDK Permissions
Required Dependencies
* — for Java project
How to integrate the credoapp SDK into an Android App
How to integrate the credoapp SDK into an Android App
How to integrate the credoapp SDK into an Android App
Preconditions
Preconditions
Preconditions
- Obtain a unique credoapp authentication key from credolab Representative(s) and use it during the data collection process. If you sign up via website, credolab Representative(s) will send you the authentication key 1-3 days upon sign up.
- For free trial user, the URL for the integration: https://scoring-sales.credolab.com/
- Download credolab's Android SDK modules
- The minSdkVersion must be set to 16 or higher to use these libraries
- The kotlin-stdlib must be 1.3.0 or higher to use these libraries
Integrate the credoapp SDK into your app
Integrate the credoapp SDK into your app
Integrate the credoapp SDK into your app
- Include credoapp SDK module AAR files into your android project
- Add permissions to AndroidManifest.xml from permissions table
- Add dependencies to build.gradle from dependencies table
Note: Make sure that you’ve added kotlin-stdlib if you’re using Java.
Logging credoapp SDK events
Logging credoapp SDK events
Logging credoapp SDK events
Credolab highly recommends logging the SDK events to gain information about the identification and analysis of a particular case. You can use a framework of your choice for this purpose. An example is below:
How to use the credoapp SDK
How to use the credoapp SDK
How to use the credoapp SDK
To start working with the credoapp SDK, firstly you need to create an instance of CredoAppService.
CredoAppService basic method:
execute. This method is intended to collect data from mobile phones and upload it to CredoLab web-service.
How to create a CredoAppService instance:
Kotlin
Java
How to access Modules?
An Example of credoapp usage in Kotlin:
An Example of credoapp usage in Java:
Not sure where to trigger our SDK? refer to our FAQ section to understand more on where our clients commonly trigger the credoSDK and other collection of frequently asked questions.
Credoapp API Description
Credoapp API Description
Credoapp API Description
Credoapp Builder
Credoapp Builder
Credoapp Builder
credoapp.CredoAppService.Builder
Builder is responsible for creating the CredoAppService class instance.
Class builder
Description:
Creates an instance of CredoAppService with target configuration.
Signature:
Parameters
Methods
addModule
Description:
Adds a module to the builder configuration.
Signature:
Parameters:
Returns: credoapp.CredoAppService.Builder
build
Description:
Instantiates CredoAppService class instance.
Signature:
Parameters:
No
Returns:
Credoapp Service
Credoapp Service
Credoapp Service
credoapp.CredoAppService
The CredoAppService facilitates the capture of a user’s digital footprint for future processing via the credolab web-service.
Methods
execute
Description:
Collects and uploads data from the smartphone to the credolab web-service and returns a reference number. This method performs networking operations and must not be called on the UI thread.
Signature:
Parameters:
Returns:
getUngrantedPermissions
Description:
Returns the collection of non-granted Android permissions required by the CredoAppService.
Signature:
Returns:
Credoapp Result Success
Credoapp Result Success
Credoapp Result Success
credoapp.CredoAppResult<T>.Success
CredoAppResult.Success indicates a successful operation and contains a value.
Fields
Value
Description:
Returns operation value.
Signature:
Parameters:
No
Returns:
Credoapp Result Error
Credoapp Result Error
Credoapp Result Error
credoapp.CredoAppResult.Error
CredoAppResult.Error indicates an unsuccessful operation and contains the relative details.
Fields
message
Description:
Returns a message value of error.
Signature:
Parameters:
No
Returns:
Code
Description:
Returns a code value of error.
Signature:
Parameters:
No
Returns: