Android SDK

• Include Android SDK in your mobile apps.
• Get a visitorId.
• Read the SDK response.
• Enable location data collection (optional; to start getting additional location-based proximity data).
• Configure the SDK as per your needs.
• Specify additional metadata in your identification request.
• Handle errors.

​

Prerequisites

​

Including the SDK in your app

1. Add the repositories to your Project Settings file. Depending on your build configuration language, this file can either be settings.gradle.kts or settings.gradle.

...
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url = uri("https://maven.fpregistry.io/releases") }
    }
}

allprojects {
    repositories {
        google()
        mavenCentral()
        maven { url = uri("https://maven.fpregistry.io/releases") }
    }
}

2. Add the dependencies to your module-level build file. Depending on your build configuration language, this file can either be build.gradle.kts or build.gradle.

dependencies {
    implementation("com.fingerprint.android:pro:2.10.0")
}

3. Perform a Gradle sync to update all the dependencies.

​

Getting a visitorId

​

Specifying a custom timeout

fpjsClient.getVisitorId (
  // Set a timeout value of 10 seconds
  timeoutMillis = 10_000,
  
  // Get a 'visitorId', will timeout after 10s
  listener = { visitorIdResponse ->
    visitorId = visitorIdResponse.visitorId;
  }
)

​

Using Location Data for Proximity Detection

​

Location permissions

​

Declaring permissions

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

​

Asking for permissions

​

Enabling location collection

​

Reading the response

​

Configuring the SDK

​

region

​

endpointUrl

​

fallbackEndpointUrls

​

extendedResponseFormat

• visitorFound - Boolean. Indicates if this device has already been encountered by your app.
• ipAddress - String. The IPv4 address of the device.
• ipLocation - IPLocation. [This field is deprecated and will not return a result for applications created after January 23rd, 2024. See IP Geolocation for a replacement available in our Smart Signals product.] Indicates the location as deduced from the IP address.
• osName - String. Indicates the name of the underlying operating system.
• osVersion - String. Indicates the version of the underlying operating system of the device.
• firstSeenAt, lastSeenAt - Timestamp. See Visitor Footprint Timestamps.

​

allowUseOfLocationData

​

locationTimeoutMillis

​

Specifying linkedID and tag

fpjsClient.getVisitorId (
  // Associate additional metadata to this request
  tags = mapOf("orderID" to orderId, "zip" to zipCode),
  // Associate an account number to this request 
  linkedId = accountID,
  
  // Get a 'visitorId'
  listener = { visitorIdResponse ->
    visitorId = visitorIdResponse.visitorId;
  }
)   

​

Handling errors

fpjsClient.getVisitorId (
  // Get a 'visitorId'
  listener = { visitorIdResponse ->
    visitorId = visitorIdResponse.visitorId;
  },
  errorListener = { error ->
    when(error) {
      is ApiKeyRequired -> {
        val requestId = error.requestId
        // Handle error
      }
    }
  }
)

​

Data Classes

​

ConfidenceScore

data class ConfidenceScore(
  val score: Double
)

​

Configuration

public class Configuration @JvmOverloads constructor(
    public val apiKey: String,
    public val region: Region = Region.US,
    public val endpointUrl: String = region.endpointUrl,
    public val extendedResponseFormat: Boolean = false,
    public val fallbackEndpointUrls: List<String> = emptyList(),
    public val integrationInfo: List<Pair<String, String>> = emptyList(),
    public val allowUseOfLocationData: Boolean = false,
    public val locationTimeoutMillis: Long = DEFAULT_LOCATION_TIMEOUT_MILLIS,
)

​

Error

• ApiKeyRequired
• ApiKeyNotFound
• ApiKeyExpired
• RequestCannotBeParsed
• Failed
• RequestTimeout
• TooManyRequest
• OriginNotAvailable
• PackageNotAuthorized
• HeaderRestricted
• NotAvailableForCrawlBots
• NotAvailableWithoutUA
• WrongRegion
• SubscriptionNotActive
• UnsupportedVersion
• InstallationMethodRestricted
• ResponseCannotBeParsed
• InvalidProxyIntegrationHeaders
• InvalidProxyIntegrationSecret
• NetworkError
• UnknownError
• ClientTimeout
• ProxyIntegrationSecretEnvironmentMismatch

sealed class Error(
  // The request ID of the identification request
  val requestId: String = UNKNOWN,
  // A self-explanatory description of the error
  val description: String? = UNKNOWN
)

​

IPLocation

data class IpLocation(
  val accuracyRadius: Int,
  val latitude: Double,
  val longitude: Double,
  val postalCode: String,
  val timezone: String,
  val city: City,
  val country: Country,
  val continent: Continent,
  val subdivisions: List<Subdivisions>
) {
  data class City(
    val name: String
  )
  data class Country(
    val code: String,
    val name: String
  )
  data class Continent(
    val code: String,
    val name: String
  )
  data class Subdivisions(
    val isoCode: String,
    val name: String
  )
}

​

Region

public enum class Region(public val endpointUrl: String) {
  US("https://api.fpjs.io"),
  EU("https://eu.api.fpjs.io"),
  AP("https://ap.api.fpjs.io")
}

​

Timestamp

data class Timestamp(
  val global: String,
  val subscription: String
}