Mobile Device Fingerprinting SDK Documentation - Integrating The IPQS SDK

This feature uses a mixture of IPQualityScore's web fingerprinting and the IPQS Mobile Device Fingerprinting SDK to enable your android app to accurately identify fraud and abuse with mobile device fingerprinting. Verify new or returning users and identify high risk behavior, such as mobile emulators, residential botnets, location spoofing, bots, non-human requests, fake accounts, and hijacked devices. Easily identify app install quality and see greater insights into your audience's KPIs. Detect duplicate accounts and prevent free trial abuse, fraudulent users, fake installs, and much more.

Please see the instructions below for further guidance on setting up the Android Device Fingerprint SDK.

Download the Android Library

The IPQS Android SDK is packaged into an AAR library file. This file needs to be loaded into your gradle instance. We'll cover the settings you'll need to setup in gradle below to make this work.

Click here to login and setup an app to be able to download this library.
Gradle Setup

Step #1: In your app's top level build.gradle file you'll need to add two entries to your repositories list.

As an example your repository list should now look like this:

Step #2: In your app's module build.gradle file you'll need to add a few different entries to your dependencies list:

Step #3: Remember to sync your file by clicking on the "lightbulb" and selecting "Sync Now".

Step #4: (Optional) The IPQS SDK can take advantage of the following permissions if you add them to your app. Permissions are added to the «mainifest» section of your AndroidManifest.xml file. These permissions help us provide better results and create a better overall picture of your users. We highly recommend adding at least the ACCESS_NETWORK_STATE, ACCESS_WIFI_STATE and READ_PHONE_STATE permissions listed below. The location permissions are only useful if you intend to use the allowLocationRequest() system or your app already collects location data from your users.

App Integration

Now you're ready to configure the IPQualityScore SDK.

Please login or create an account to access your API Key.

You'll want to configure the SDK inside of your android app's activity, preferably your main activity. This may change based on the way you wish to implement the SDK:

Device Fingerprinting

At this point you'll be able to call our mobile device fingerprinting anywhere inside your application's activities. Here's an example of how to retrieve the fraud score for a given device using the SDK:

Sample App

Here's a complete "sample app". The app will close if the user's fraud score is greater than 85.

Additional Settings

Our SDK allows you to specify that you'd like us to attempt to capture location information from your user via a permission request check. You can enable this like such:

Result Methods

Our SDK offers a wide range of result methods/functions to enhance your experience and help prevent fraudulent activity. The variable "result" below signifies an object of com.ipqualityscore.FraudEngine.Results.MobileTrackerResult.

Name Function Description Type
getRaw result.getRaw() Get the raw json string response from our API. This can be useful for debugging purposes, providing feedback and long term storage. String
getMessage result.getMessage() Get the response message string for this request. This is generally 'Success', but can include administrator level information on why a request failed. (Out of credits, etc...) String
getSuccess result.getSuccess() A boolean containing the request's success or failure status. True on success, false on failure. Boolean
getRequestID result.getRequestID() The unique ID associated with this request. Helpful for debugging and postbacks. String
getFraudScore result.getFraudScore() Number 0 - 100 describing how likely this device is to commit fraud. 0 being not at all, 100 being definitively fraud. We suggest blocking users greater than 85. Float
getCountryCode result.getCountryCode() A two character country code based on this user's IP address. String
getRegion result.getRegion() A string describing the region this user's IP is from. String
getCity result.getCity() A string describing the city this user's IP is from. String
getISP result.getISP() A string describing the ISP this user's IP belongs to. String
getOrganization result.getOrganization() A string describing the Organization this user's IP belongs to. String
getASN result.getASN() The ASN assigned to the ISP this user's IP belongs to. Integer
getLatitude result.getLatitude() The latitude this user's IP is at. Float
getLongitude result.getLongitude() The longitude this user's IP is at. Float
getIsCrawler result.getIsCrawler() Returns true if this user's IP is from a known search engine crawler. Boolean
getTimezone result.getTimezone() Returns the timezone this user's IP is from. String
getHost result.getHost() Returns the hostname of this user's IP address. String
getIsProxy result.getIsProxy() Returns true if this user's IP is a known proxy. Boolean
getIsVPN result.getIsVPN() Returns true if this user's IP is a known VPN. Boolean
getIsTOR result.getIsTOR() Returns true if this user's IP is a known or suspected TOR node. Boolean
getRecentAbuse result.getRecentAbuse() Returns true if this user's IP has been reported for being abusive recently or if this device has been seen preforming abusive actions. Boolean
getBotStatus result.getBotStatus() Returns true if this user's IP has been reported for botting or if this device has been seen preforming bot like actions. Boolean
getConnectionType result.getConnectionType() Classification of the IP address connection type as "Residential", "Corporate", "Education", "Mobile", or "Data Center". String
getDeviceSuspicious result.getDeviceSuspicious() Returns true if this device has suspicious properties or if this device has been seen preforming suspicious activities recently. Boolean
getDeviceEmulated result.getDeviceEmulated() Returns true if this device has been emulated or appears to have been emulated. Boolean
getDeviceID result.getDeviceID() A unique identifier for this device. String

Please explore our other APIs which are also helpful in user validation and fraud scoring, such as the IP Reputation SDK and Email Validation SDK.