iOS Fingerprinting SDK

Rate this article:

X

Select all that apply:

The content is confusing or hard to follow.

There is missing information or code.

There is inaccurate or outdated information.

This page did not solve my problem.

I would like to speak with someone about this.

Email:

Submit Feedback

About the iOS Fingerprinting SDK

The IPQS Mobile Device Fingerprinting SDK protects iOS apps against sophisticated fraud and abuse from high-level bad actors. IPQS uses a mix of JS device fingerprinting and mobile SDK device fingerprinting to enable your iOS app to accurately identify fraud and abusive behavior with mobile device fingerprinting techniques. Verify new or returning users and identify high-risk behavior, including:

• Mobile emulators
• Residential botnets
• Location spoofing
• GPS tampering
• Bots
• Non-human requests
• Fake accounts
• Install fraud
• and hijacked devices.

IPQS makes it easy to detect duplicate accounts, bonus abuse, fraudulent users, fake installs, and more.

Integrating the SDK

1. Create a Mobile App in IPQS

Before integrating the SDK package, you will need to have created a new mobile app in your IPQS account.

2. Configure Authentication

The SDK is distributed via Swift Package Manager. Before adding the SDK, you will need to configure authentication to allow access to this private repository.

1. Create or edit the ~/.netrc file in your home directory.
2. The ~/.netrc file should have restricted permissions. Set correct permissions for the ~/.netrc file by running chmod 600 ~/.netrc.
3. Add the following to ~/.netrc, replacing YOUR_IPQS_EMAIL and YOUR_SDK_API_KEY with your IPQS email address and the SDK API key created when you made the mobile app in your IPQS account:

machine downloads.ipqualityscore.com
    login YOUR_IPQS_EMAIL
    password YOUR_SDK_API_KEY

3. Add the SDK via Swift Package Manager

1. In Xcode, from the File menu, select Add Package Dependencies....
2. Enter the repository URL:

https://github.com/ipqualityscore/iOS-Mobile-Fingerprinting-SDK

3. Select the latest release.
4. Click Add Package.

4. Add Info.plist Values

If you don't have an Info.plist file:

1. In Xcode, from the Project menu, select the Target submenu, then Info.
2. Add a new line and paste the following into the key value (Xcode will change this to "Queried URL Schemas"):

LSApplicationQueriesSchemes

3. If not done automatically, set the type to array.
4. Expand the newly added line to expose the array values.
5. An empty value will already have been created with type string.
6. Paste the following into the empty value:

undecimus

7. Add a new line with the following value:

cydia

8. Repeat the previous step by adding new lines with the following values:

sileo

zbra

filza

activator

If you already have an Info.plist file:

1. Right click on your Info.plist file and select Open As then Source.
2. Add the following:

    <key>LSApplicationQueriesSchemes</key>
    <array>
        <string>undecimus</string>
        <string>sileo</string>
        <string>zbra</string>
        <string>filza</string>
    </array>

5. Import the Mobile SDK Package

Add import IPQualityScore to the import list at the top of any file in which you want to call the API functions.

6. Set the API Key

Set the API key in any file in which you want to call the API functions:

MobileTracker.apiKey = YOUR_API_KEY_HERE

Usage

Add Custom Tracking Variables

The following code allows for passing custom tracking variables such as a user ID, transaction ID, click ID, and similar identifiers to associate a mobile device fingerprint request with a specific user or action:

// Pass custom variables to pending request
MobileTracker.addCustomVariable("userID", value: "1234");
// then call main mobile fingerprint request which will append the variables above

Mobile Device Fingerprinting

// Call the mobile fingerprint request
MobileTracker.mobileTracker(success: {(result) in
    // From here you can access any of the items in the object
    print(result.message);
}, failure: {(error) in
    print("mobileTracker Error: \(error.localizedDescription)");
})

Email Verification Lookup

// Insert any email you want to test below
MobileTracker.verifyEmail("INSERT_TEST_EMAIL@EXAMPLE.COM") { result in
    // From here you can access any of the items in the object
    print(result.message);
} failure: { error in
    print("emailValidation Error: \(error)");
}

IP Address Reputation Lookup

// You can get the IP address from the Mobile Fingerprint response
MobileTracker.verifyIPaddress("INSERT_TEST_IP_ADDRESS_HERE") { result in
    // From here you can access any of the items in the object
    print(result.message);
} failure: { error in
    print("verifyIPAddress Error: \(error)");
}

Phone Number Verification Lookup

// Insert any phone number to test below
MobileTracker.verifyPhone("INSERT_TEST_PHONE_NUMBER_HERE") { result in
    // From here you can access any of the items in the object
    print(result.message);
} failure: { error in
    print("verifyPhone Error: \(error)");
}

Advanced Options

MobileTracker.customEndpoint = "YOUR_CUSTOM_ENDPOINT"

| | | | | | askLocationPermission | When set to false , IPQS will not collect the user's location regardless of permissions granted to the app. When set to true, IPQS will request to obtain the user's location and collect it if the permission is granted. This variable is set to false by default. | Bool | If not already managing location permissions, you will need to add a usage description in your info.plist file. 1. Add a new line with the key NSLocationWhenInUseUsageDescription. 2. Set the type to string , and add a description for why your app needs access the user's location. |

    <key>NSLocationWhenInUseUsageDescription</key>
    <string>Your reasoning for using location</string> 

 In your app, set the configuration option with: 

MobileTracker.askLocationPermission = true

| | | | | askLocalNetworkPermission | When set to false, IPQS will not collect information on the local network, which will affect the quality of the Score in some cases. When set to true, IPQS will ask the user for local network devices permission. This variable is set to false by default. | Bool |

MobileTracker.askLocalNetworkPermission = true

| | | | | checkClipboard | When set to false, IPQS will not paste from the user's clipboard, which may affect the detection of some fraudulent behaviors. When set to true, IPQS will check the user's clipboard as soon as the mobileTracker function is invoked, which will cause iOS to show a toast message at the top of the screen, informing the user of the event. | Bool |

MobileTracker.checkClipboard = true

| | | | | | captureAdvertisingID | When set to false, IPQS will not attempt to capture the device's advertising ID. When set to true, IPQS will request permission to access the device's advertising ID and collect it if permission is granted. | Bool | Requires the device to have Allow Apps to Request to Track enabled. 1. In Settings > Privacy > Tracking, set Allow Apps to Request to Track to True. 2. You will need to add a usage description in your info.plist file. Add a new line with the key NSUserTrackingUsageDescription. 3. Set the type to string , and add a description for why your app needs access the device's advertising ID. |

    <key>NSUserTrackingUsageDescription</key>
    <string>Your reasoning for using location</string>

In your app, set the configuration option with:

MobileTracker.captureAdvertisingID = true

| |

Retrieve Results

Postback Example to Retrieve Latest Request by UserID

This method uses the Postback API to retrieve requests by userID. Replace XX with the specific user ID you want to retrieve requests for.

https://www.ipqualityscore.com/api/json/postback/XHtctAHRKvJDCu84NmtEltMhwmF0r2Aq?type=mobiletracker&userID=XX

Retrieve multiple requests with the Request List API

This method uses the Request List API to retrieve requests by userID. Replace XX with the specific user ID you want to retrieve requests for.

https://www.ipqualityscore.com/api/json/requests/XHtctAHRKvJDCu84NmtEltMhwmF0r2Aq/list?type=mobiletracker&userID=XX

Result Methods

Our SDK offers various result methods and functions to enhance your experience and help prevent fraudulent activity.

Troubleshooting