fraud_sdk_flutter 1.0.1

The Sign3 SDK is an Android-based fraud prevention toolkit designed to assess device security, detecting potential risks such as rooted devices, VPN connections, or remote access and much more. Provid [...]

Sign3 SDK Integration Guide

The Sign3 SDK is an Android-based fraud prevention toolkit designed to assess device security, detecting potential risks such as rooted devices, VPN connections, or remote access and much more. Providing insights into the device's safety, it enhances security measures against fraudulent activities and ensures a robust protection system.

Adding Sign3SDK to Your Project

Using Project Level Gradle Dependency

1. Add Sign3SDK to the Dependency Block

   • Open your project level build.gradle file and add the following line to the dependencies block. Please collect the username and password from credentials documents.

      repositories {
          google()
          mavenCentral()
          maven { url 'https://jitpack.io' }
          maven {
              url "https://sign3.jfrog.io/artifactory/intelligence-generic-local/"
              credentials {
                  username = "provided in credential doc"
                  password = "provided in credential doc"
              }
          }
      }
     

Using App Level Gradle Dependency

1. Add Sign3SDK to the Dependency Block

   • Open your app's build.gradle file and add the following line to the dependencies block.

     dependencies {
         // For non play store application
         implementation 'com.sign3.intelligence:intelligence:<latest_version>'
      
         // For play store application
         implementation 'com.sign3.intelligence:intelligence-playstore:<latest_version>'
     }
     

   • For the most recent latest version, connect with Sign3.

   • Checkout the latest_version

2. After adding the dependency, sync your project with Gradle files to ensure the library is properly integrated.

App Permission

1. Add the following permissions in the Manifest file.
2. Optional permissions are recommended to achieve higher accuracy.

<uses-permission android:name="android.permission.INTERNET" />
<!-- optional -->
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<!-- Below mentioned optional permissions are taken to calculate sim affinity to the device  -->
<uses-permission android:name="android.permission.READ_PHONE_STATE" />

Initializing the SDK

1. Initialize the SDK in the onCreate() method of your Application class.
2. Use the ClientID and Client Secret shared with the credentials document.
3. to enable a more in-depth root detection, you would need to add enabledSign3Service.
4. The SDK require a minimum SDK version of 23 if your app is targeting below this version must enclose Sign3 API calls within conditional checks.

For Java

Options options = new Options.Builder()
           .setClientId("<SIGN3_CLIENT_ID>")
           .setClientSecret("<SIGN3_CLIENT_SECRET>")
           .setEnvironment(Options.ENV_PROD) // For Prod: Options.ENV_PROD, For Dev: Options.ENV_DEV
           .build();

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
    Sign3Intelligence.getInstance(this).initAsync(options);
}

For Kotlin

val options = Options.Builder()
   .setClientId("<SIGN3_CLIENT_ID>")
   .setClientSecret("<SIGN3_CLIENT_SECRET>")
   .setEnvironment(Options.ENV_PROD) // For Prod: Options.ENV_PROD, For Dev: Options.ENV_DEV
   .build()

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
    Sign3Intelligence.getInstance(this).initAsync(options) {
       // to check if the SDK is initialized correctly or not
       Log.i("AppInstance", "Sign3Intelligence init : $it")
    }
}

Note: If you have any custom Application Class, please add the following code in the onCreate() method of that Application class before any other initialisation code.

For Java

@Override
public void onCreate() {
     super.onCreate();
     if (Sign3Intelligence.Companion.stop()) return;
     // Other initialisation code
}

For Kotlin

override fun onCreate() {
   super.onCreate()
   if (Sign3Intelligence.stop()) return
   // Other initialisation code
}

Optional Parameters

1. You can add optional parameters like UserId, Phone Number, etc., at any time and update the instance of Sign3Intelligence.
2. Once the options are updated, they get reset. Clients need to explicitly update the options again to ingest them, or else the default value of OTHERS in userEventType will be sent to the backend.
3. You need to call getIntelligence() function whenever you update the options.
4. To update the Sign3Intelligence instance with optional parameters, including additional attributes, you can use the following examples.

For Java

// Example of Additional Attributres
Map<String, String> attributes = new HashMap<>();

attributes.put("SIGN_UP_TIMESTAMP", String.valueOf(System.currentTimeMillis()));
attributes.put("SIGNUP_METHOD", "PASSWORD/OTP/SOCIAL/TRUECALLER/OTHERS");
attributes.put("REFERRED_BY", "UserID/Referral Code");
attributes.put("PREFERRED_LANGUAGE", "English/Spanish/etc.");

UpdateOptions updateOptions = new UpdateOptions.Builder()
       .setUserId("<user-id>") // Set user id here, you can reference the result in future
       .setPhoneNumber("<1234567890>") // you can add the customer phone number
       .setPhoneInputType(PhoneInputType.PASTED) //See PhoneInputType class
       .setOtpInputType(OtpInputType.AUTO_FILLED) //See OtpInputType class
       .setUserEventType(UserEventType.SIGNUP) //See UserEventType class
       .setMerchantId("<merchant_id>") // Set Merchant Id
       .setAdditionalAttributes(attributes) // Set attributes to store key-value pairs.    
       .build();

Sign3Intelligence.getInstance(context).updateOptions(updateOptions)

Sign3Intelligence.getInstance(this).getIntelligence(new IntelligenceListener() {
       @Override
       public void onSuccess(IntelligenceResponse response) {
           // Do something with the response
       }

       @Override
       public void onError(IntelligenceError error) {
           // Something went wrong, handle the error message
       }
});

For Kotlin

// Example of Additional Attributres
val attributes = hashMapOf<String, String>()

attributes["TRANSACTION_ID"] = UUID.randomUUID().toString()
attributes["DEPOSIT"] = "<AMOUNT>"
attributes["WITHDRAWAL"] = "<AMOUNT>"
attributes["METHOD"] = "UPI/CARD/NET_BANKING/WALLET"
attributes["STATUS"] = "SUCCESS/FAILURE"
attributes["CURRENCY"] = "USD/INR/GBP/etc."
attributes["TIMESTAMP"] = "${System.currentTimeMillis()}"

val updateOptions = UpdateOptions.Builder()
        .setUserId("<user-id>") // Set user id here, you can reference the result in future
        .setPhoneNumber("<1234567890>") // you can add the customer phone number
        .setPhoneInputType(PhoneInputType.PASTED) // See PhoneInputType class
        .setOtpInputType(OtpInputType.AUTO_FILLED) // See OtpInputType class
        .setUserEventType(UserEventType.TRANSACTION) // See UserEventType class
        .setMerchantId("<merchant_id>") // Set Merchant Id
        .setAdditionalAttributes(attributes) // Set attributes to store key-value pairs.   
        .build()

Sign3Intelligence.getInstance(context).updateOptions(updateOptions)

Sign3Intelligence.getInstance(this).getIntelligence(object : IntelligenceListener {
   override fun onSuccess(response: IntelligenceResponse) {
        // Do something with the response
   }

   override fun onError(error: IntelligenceError) {
        // Something went wrong, handle the error message
   }
})

Get Session ID

1. The Session ID is the unique identifier of a user's app session and serves as a reference point when retrieving the device result for that session.
2. The Session ID follows the OS lifecycle management, in line with industry best practices. This means that a user's session remains active as long as the device maintains it, unless the user terminates the app or the device runs out of memory and has to kill the app.

For Java

String sessionId = Sign3Intelligence.getInstance(this).getSessionId()

For Kotlin

val sessionId = Sign3Intelligence.getInstance(this).getSessionId()

Fetch Device Intelligence Result

1. To fetch the device intelligence data refer to the following code snippet.
2. IntelligenceResponse and IntelligenceError models are exposed by the SDK.

For Java

Sign3Intelligence.getInstance(this).getIntelligence(new IntelligenceListener() {
       @Override
       public void onSuccess(IntelligenceResponse response) {
           // Do something with the response
       }


       @Override
       public void onError(IntelligenceError error) {
           // Something went wrong, handle the error message
       }
});

For Kotlin

Sign3Intelligence.getInstance(this).getIntelligence(object : IntelligenceListener {
   override fun onSuccess(response: IntelligenceResponse) {
        // Do something with the response
   }


   override fun onError(error: IntelligenceError) {
        // Something went wrong, handle the error message
   }
})

Sample Device Result Response

Successful Intelligence Response

{
  "requestId": "9ca5fa19-cc8c-4d67-ac43-ae301e50478a",
  "newDevice": false,
  "deviceId": "6c805eea-cb6a-4a1f-8896-eb7b4804556d",
  "vpn": false,
  "proxy": false,
  "emulator": true,
  "remoteAppProviders": false,
  "mirroredScreen": false,
  "cloned": false,
  "geoSpoofed": false,
  "rooted": false,
  "sessionRiskScore": 12.78,
  "hooking": true,
  "factoryReset": false,
  "appTampering": false
}

Error Response

{
  "requestId": "7e12d131-2d90-4529-a5c7-35f457d86ae6",
  "errorMessage": "Sign3 Server Error"
}

Changelog

3.2.1

• Bug fixing and minor changes.

3.2.0

• Fixed crash issue in android 6 & 7 devices.
• Fixed native code issue on some devices.
• Fixed camera supported FPS, BioMetricStatus issue.
• Sign3 APIs now require a minimum SDK version of 23, apps targeting below this version must enclose Sign3 API calls within conditional checks.

3.1.0

• bug fixing for Root detection.

3.0.3

• Adding the enum field UserEventType.OTHERS using the setUserEventType method.
• Setting the additional attributes using the setAdditionalAttributes method to Update Option.

3.0.2

• Resolve dependency issue with Isolated Service
• Fix ANR issue causing application unresponsiveness

3.0.1

• Temporarily remove Isolated service dependency, to be reintegrated in 3.0.2

3.0.0

• Improved existing detection logic
• Improved stability of device hash
• Add new device signals to generate better fingerprint
• Introducing new detection remote control, screen mirroring, hooking, factory reset, App tampering & current location
• SDK performance improvements and bug fixing