iOS SDK quick start

This guide describes how to quickly integrate Detection and Response services into your iOS application to get started. This includes both the client-side integration using the iOS SDK, as well as the backend API integration required to complete the flow.

Requirements

  • iOS 13+
  • Xcode 11+

Step 1: Get client credentials

Client credentials are used to identify your app and generate access tokens for authorizing Transmit requests. To obtain them, you'll need to create an application in the Admin Portal (if you don’t have one yet).

  1. From Applications , click Add application .
  2. Add the friendly application name to display in the Admin Portal.
  3. Add a client display name, and your website URL as a redirect URI (e.g., https://your-domain.com ).
    Note

    These fields are required for all Transmit apps, but won’t be used for Detection and Response.

  4. Click Add to create your application. This will automatically generate your client credentials.

Step 2: Add SDK to project

Add the SDK to your project so your application can access all the detection and response functionality. To do this, install the SDK as a dependency using Swift Package Manager:

Copy
Copied
dependencies: [
    .package(url: "https://github.com/TransmitSecurity/accountprotection-ios-sdk.git", .upToNextMajor(from: "1.0.1"))

Step 3: Initialize SDK

Start monitoring your end-user risk levels by initializing and configuring the SDK. To do this, add the code below to your Application Class. The [CLIENT_ID] should be replaced with your client ID from step 1.

Note

Make sure to add the import AccountProtection at the top of the implementation class.

UIKit Example:

Copy
Copied
class AppDelegate: UIResponder, UIApplicationDelegate {

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        TSAccountProtection.initialize(baseUrl: "https://collect.riskid.security/device/", clientId: [CLIENT_ID])
        return true
    }
}

SwiftUI Example:

Copy
Copied
struct ExampleApp: App {

    init() {
        TSAccountProtection.initialize(baseUrl: "https://collect.riskid.security/device/", clientId: [CLIENT_ID])
    }

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

Step 4: Set user

A user identifier must be reported to Transmit Security after you've fully authenticated the user (including, for example, any required 2FA that was done). This will set the user for all subsequent events.

To do this, add the code below after your application has authenticated a user (or after SDK initialization if you already have the user context for the authenticated user). The [USER_ID] is an opaque identifier for the user in your system.

Note
  • Make sure to add the import AccountProtection at the top of the implementation class.
  • The user ID must not include personal user identifiers, such as email.
Copy
Copied
TSAccountProtection.setUserId([USER_ID])

Step 5: Report actions

To obtain risk recommendations for sensitive actions, your application should report these actions using the SDK. To do this, add the code below to relevant user interactions (e.g., the Login button click event handler). Replace [ACTION_TYPE] with the appropriate action type from our list of actions.

Note
  • Make sure to add the import AccountProtection at the top of the implementation class.
  • Make sure to pass the received actionToken to your backend along with the actual action invocation to ensure you can leverage the recommendation in the next step.
Copy
Copied
         TSAccountProtection.triggerAction([ACTION_TYPE]) { result in
                    DispatchQueue.main.async {
                        switch result {
                        case .success(let response):
                            let actionToken: String = response.actionToken
                        case .failure(let error):
                            switch error {
                            case .disabled:
                                break
                            case .connectionError:
                                break
                            case .internalError:
                                break
                            case .notSupportedActionError:
                                break
                            @unknown default:
                                break
                            }
                        }
                    }
                }

Step 6: Fetch recommendation

You can fetch recommendations from your backend for the reported action using the Recommendation API. This is the same API that's also used for web integrations.

Transmit Security APIs are authorized using an OAuth access token so you'll need to fetch a token using your client credentials (from step 1). The token should target the following resource: https://risk.identity.security. To do this, send the following request:

Copy
Copied
  const { access_token } = await fetch(
    `https://api.transmitsecurity.io/oidc/token`,
    {
      method: 'POST',
      headers: {
        'Content-Type': 'application/x-www-form-urlencoded'
      }
      body: new URLSearchParams({
        grant_type: client_credentials,
        client_id: [CLIENT_ID],
        client_secret: [CLIENT_SECRET],
        resource: 'https://risk.identity.security'
      })
    }
  );

From your backend, invoke the Recommendation API by sending a request like the one below. The [ACCESS_TOKEN] is the authorization token you obtained using your client credentials and [ACTION_TOKEN] is the actionToken received from the SDK in step 5.

Copy
Copied
const query = new URLSearchParams({
  action_token: '[ACTION_TOKEN]',
}).toString();

const resp = await fetch(
  `https://api.transmitsecurity.io/risk/v1/recommendation?${query}`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer [ACCESS_TOKEN]',
    },
  }
);

Step 7: Clear user

After the user logs out or the user session expires, you should clear the set user so they are not associated with future actions. To clear the user, call the clearUser() method as shown below.

Note

Make sure to add the import AccountProtection at the top of the implementation class.

Copy
Copied
TSAccountProtection.clearUser()