Android

iOS

Cordova

Flutter

React Native

Android SDK

This page sets out step-by-step instructions for setting up your App Drop-in via the Android SDK.

Prerequisites & configuration

You will need your tenantId provided by Fourthline.

Operating system specifications:

• Minimum API version: 23
• Language: The SDK is written in Kotlin but is also compatible with Java.

GitHub credentials

Provide your implementation manager with the GitHub usernames and email addresses of your staff who need access to our repositories.

Identity data

Configurable

If you want to receive a copy of the identity data gathered by the App Drop-in when it's uploaded to our backend (before case processing), let your implementation manager know.

Document data

Configurable

Discuss with your implementation manager what data to extract from ID document photos via optical character recognition (OCR):

Supported devices

More information

For questions about supported devices, contact your implementation manager.

Flow

Follow these steps:

1. Add SDK to project

You can add the SDK to your project using Gradle.

1. In your top-level build.gradle file, link to Fourthline's repository:

allprojects {
 repositories {
 //...
 maven {
 url "https://maven.pkg.github.com/Fourthline-com/FourthlineSDK-Android"
 credentials {
 username ""
 password getLocalProperty("github_token")
 }
 }
 }
}

allprojects {
 repositories {
 //...
 maven {
 url = URI("https://maven.pkg.github.com/Fourthline-com/FourthlineSDK-Android")
 credentials {
 username = ""
 password = getLocalProperty("github_token")
 }
 }
 }
}

2. To access Fourthline's repository, in your GitHub account, go to Settings > Account security > Enable two-factor authentication.

3. Go to Settings > Developer settings > Personal access tokens > Generate a new token.

4. Select the scope "read:packages", and then generate a new token.

5. Store the access token in a secure, but accessible location, e.g. local.properties.

Tip

Treat the token as a password. Don't add it to your version control system.
If you have to share it, use a password manager.

Example code for local.properties:

//..
github_token=YOUR_ACCESS_TOKEN

6. In your module-level build.gradle file, add a dependency to the Fourthline SDK:

dependencies {
 // ...
 def fourthlineSdkVersion = "%%LATEST_SDK_VERSION%%"
 implementation "com.fourthline:fourthline-sdk:$fourthlineSdkVersion"
}

dependencies {
 // ...
 val fourthlineSdkVersion = "%%LATEST_SDK_VERSION%%"
 implementation("com.fourthline:fourthline-sdk:$fourthlineSdkVersion")
}

2. Set up analytics

The FourthlineCore module collects and processes Android SDK metrics.

Note

By default, analytics data collection is disabled, so no data is collected or shared with Fourthline without your consent.

To enable analytics data collection and sharing:

1. Initialize FourthlineAnalytics with your Fourthline tenantId.

Tip

If you get an invalidTenantId error, ensure you are using the correct ID provided by Fourthline.

2. TrackingConsent determines what data the SDK should collect and send to Fourthline, using. Set it to one of the following values:

Example code:

// To initialize analytics, call `FourthlineAnalytics.initialize(TENANT_ID, context)` when suitable, usually in `Application.onCreate()`, using your `tenantId`.
try {
    FourthlineAnalytics.initialize(tenantId = "<tenantId>", context = applicationContext)
} catch (e: AnalyticsError) {
    when (e) {
        is AnalyticsError.DatadogNotImported -> TODO()
        is AnalyticsError.InvalidTenantId -> TODO()
    }
}

FourthlineAnalytics.setTrackingConsent(consent = TrackingConsent.GRANTED)

Tip

To change the TrackingConsent value, after the SDK is initialized, make a FourthlineAnalytics.setTrackingConsent API request.

Set up analytics observer

You can set up an analytics observer for the SDK to forward Fourthline events to.

Events are only forwarded when you initialize FourthlineAnalytics by calling FourthlineAnalytics.initialize(...) with TrackingConsent set to granted.

• To set up the observer, call FourthlineAnalytics.setObserver(...).
• To remove the observer, call FourthlineAnalytics.removeObserver().

Example code:

import com.fourthline.analytics.AnalyticsObserver
import com.fourthline.analytics.FourthlineAnalytics

val observer = object : AnalyticsObserver {
    override fun log(event: String, attributes: Map<String, Any?>) {
        // Log the Fourthline event
    }
}

FourthlineAnalytics.setObserver(observer)

3. Add data delegate

To receive notifications for each data group that the SDK uploads to Fourthline and a copy of the data itself, add a data delegate.

Example code:

import com.fourthline.orca.Orca
import com.fourthline.orca.workflow.WorkflowResults.*
import com.fourthline.orca.workflow.workflow

Orca.workflow(context, validationCode)
  .configure(config)
  .customize(customisationConfig)
  .addDelegate { results ->
    when(results){
      is IDV.Address -> TODO()
      is IDV.DeviceMetadata -> TODO()
      is IDV.Document -> TODO()
      is IDV.DocumentVideo -> TODO()
      is IDV.Nfc -> TODO()
      is IDV.Person -> TODO()
      is IDV.Selfie -> TODO()
      is IDV.SelfieVideo -> TODO()
    }
  }
  .present { result -> }

4. Delete temporary files

The SDK stores some data collected during workflows (e.g. selfie and document videos) in the tmp/fourthline folder in the client's device filesystem. This is because the videos must remain available until collected, packaged into a zipfile, and uploaded to our backend.

You must delete the temporary files when they are no longer needed, e.g. after the SDK has uploaded all data to Fourthline or immediately before the app is terminated in onDestroy().

Example code:

context.deleteFourthlineFiles()

FourthlineFileManager.deleteFourthlineFiles(context);

5. Handle errors

You need to handle the following error values:

6. Configure workflow modules

If your workflow includes Bank Account Verification, this module redirects to the Web SDK.

To redirect the client back to your app after completing the module in the web browser, you need to register a URL scheme.

For instructions, see Apple – Register your URL scheme.

Success

You have configured and set up your App Drop-in!
To integrate your solutions, see the Integration Guides.

Top of page