# DeviceConnect: IOS

Device Connect IOS SDK is used to collect anonymised non-PII data from the devices of the users after taking explicit user consent.

# Requirements

Device Connect IOS SDK works on IOS 16.1 and Xcode 14.1.

# Adding Dependency

Add the SDK to the application using Swift Package Manager (Preferred) or Cocopods.

Swift Package Manager
CocoaPods

In Xcode, select File > Add Packages...
Enter the Risk Manager URL (opens new window) for this repository

NOTE

Following will be shared by FinBox team at the time of integration:

CLIENT_API_KEY

# Create User

Call createUser method to create the user. It takes Client Api Key and Customer Id as the arguments.

IMPORTANT

Please make sure CUSTOMER_ID is not more than 64 characters and is alphanumeric (with no special characters). Also it should never be null or a blank string "".

The response to this method (success or failure) can be captured using the callback.

Swift

Finbox.createUser(apiKey: "API_KEY", customerId: "CUSTOMER_ID") { token in
    // Authentication is success
} error: { code in
    // Authentication failed
}

You can read about the errors in the Error Codes section.

# Start Periodic Sync

This is to be called only on a successful response to createUser method's callback. On calling this the syncs will start for all the data sources configured as per permissions. The method below syncs data in the background at regular intervals.

Swift

let finbox = FinBox()
finbox.startPeriodicSync()

# Cancel Periodic Sync

If you have already set up the sync for the user, cancel the syncs using stopPeriodicSync method.

Swift

finbox.stopPeriodicSync()

# Handle Sync Frequency

By default sync frequency is set to 8 hours, you can modify it by passing preferred time in seconds as an argument to setSyncFrequency method once the user is created.

Swift

finbox.setSyncFrequency(12 * 60 * 60)

# Reset User Data

In case the user data needs to be removed on the device so that you can re-sync the entire data, use the method resetData.

Swift

FinBox.resetData()

# Forget User

In case the user choose to be forgotten, use the method forgetUser. This will delete the user details in our system.

Swift

FinBox.forgetUser()