Connect iOS SDK

The Finicity Connect iOS SDK allows you to integrate Finicity Connect into your mobile applications.

The SDKs feature Connect in a web view so that you can implement it anywhere you want within your own mobile applications. You can also use the events feature to monitor when consumers start and complete the Connect application, when it’s canceled or if an error has occurred.

Compatibility

The Connect iOS SDK supports the following iOS versions:

  • iOS 11 or later

Download the SDK

Step 1—Add the SDK to your project

Import Connect into your code.

Example:

.import connect

Step 2—Create callback functions

Create callback functions for loaded, done, cancel, and error events. These callbacks correspond to events in Connect’s data flow.

Example
 func connectLoaded() {
self.connectNavController = UINavigationController(rootViewController: self.connectViewController)
self.connectNavController.modalPresentationStyle = .fullScreen
self.present(self.connectNavController, animated: false)
}
Callbacks
loaded
Called when the Connect web page is loaded and ready to display.
doneCalled when the user successfully completes the Connect flow. It also has an unlabeled NSDictionary? parameter containing event information.
cancelCalled when the user cancels the Connect flow.
errorCalled when there is an error during the Connect flow. It also has an unlabeled NSDictionary? parameter containing event information.

Step 3—Create a ConnectViewConfig Object and ConnectViewController Class

  • 1

    Using a valid Connect URL and callback functions, create a ConnectViewConfig object. See Generate Connect URL All Types.

  • 2

    Create an instance of the ConnectViewController class, providing the ConnectViewConfig class when calling its load method.

  • 3

    In the loaded callback, present the ConnectViewController using a UINavigationController with the ConnectViewcontroller as its rootViewController.

  • 4

    The ConnectViewController automatically dismisses when the Connect flow is completed, cancelled early by the user, or if an error has occurred. 

Example
 func openConnect(url: String) {
let config = ConnectViewConfig(connectUrl: url, loaded: self.connectLoaded, done: self.connectDone, cancel: self.connectCancelled, error: self.connectError)

self.connectViewController = ConnectViewController()
self.connectViewController.load(config: config)
}
func connectLoaded() {
self.connectNavController = UINavigationController(rootViewController: self.connectViewController)
self.connectNavController.modalPresentationStyle = .fullScreen
self.present(self.connectNavController, animated: false)
}
func connectDone(_ data: NSDictionary?) {
// Connect flow completed
}

func connectCancelled() {
// Connect flow exited prematurely
}

func connectError(_ data: NSDictionary?) {
// Error encountered in Connect flow
}