iOS React Native SDK quick start

This guide describes how to integrate Fraud Prevention into your iOS React Native application. It helps you set up the Mosaic SDK wrapper for React Native, enabling you to enhance your mobile applications' security with Fraud Prevention.

How it works

The flow starts with the user navigating to the app (1). The SDK gets initialized and starts sending telemetry to Mosaic (2). When a user performs an action, for example, clicks a login button (3), the SDK triggers an action event (4) and obtains an action token (5) which then forwards to the backend (6). Having received an action token, the application backend uses it to fetch recommendation from Mosaic (7 & 8) and instructs the client to act accordingly (9) in order to complete the login procedure (10). Upon successful login, the client sets the user (11). As a last optional step, your server can report the action result back to Mosaic (12).

Step 1: Get client credentials

Client credentials are used to identify your app and generate access tokens for authorizing Mosaic 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 an OIDC client, specify the client secret as an authentication method, and your website URL as a redirect URI (e.g., https://your-domain.com ).

   Note

   These fields are required for all Mosaic apps, but won’t be used for Fraud Prevention.

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

Step 2: Install the wrapper

Install the Mosaic SDK wrapper for React Native:

npm install react-native-ts-accountprotection

Step 3: Configure the plugin

Install CocoaPods dependencies

Navigate to your iOS project directory and run pod install.

Create TransmitSecurity.plist

Create a file named TransmitSecurity.plist in your native iOS Xcode project and add the following content:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>credentials</key>
    <dict>
        <key>baseUrl</key>
        <string>https://api.transmitsecurity.io/</string>
        <key>clientId</key>
        <string>[CLIENT_ID]</string>
    </dict>
</dict>
</plist>

Step 4: Initialize the SDK

In your main application file, initialize the SDK when your app component is ready:

import TSAccountProtectionSDKModule, { TSAccountProtectionSDK } from 'react-native-ts-accountprotection';

componentDidMount(): void {
    // Setup the module when the component is ready
    await TSAccountProtectionSDKModule.initializeSDK();
}

Step 5: Use the React Native wrapper

The example below demonstrates triggering a login event from a login button, setting and clearing a user.

• triggerActionEvent() receives an action type and returns a response that includes the actionToken that you should pass to the backend. To obtain risk recommendations for sensitive actions, your application should report these actions. To do this, add the code below to relevant user interactions (such as the Login button click event handler). The wrapper allows reporting on events with specific action types. Replace [ACTION_TYPE] with the appropriate action type from our list of actions . To improve Fraud Prevention, optionally pass the correlation ID, and claimed user ID and its type (for users that haven't authenticated yet).

private handleTriggerActionLoginExample = async () => {
    const triggerActionResponse = await TSAccountProtectionSDKModule.triggerAction(
        TSAccountProtectionSDK.TSAction.login,
        {
            correlationId: "CORRELATION_ID",
            claimUserId: "CLAIM_USER_ID",
            referenceUserId: "REFERENCE_USER_ID",
            transactionData: undefined
        }
    );
    const actionToken = triggerActionResponse.actionToken;
    console.log("Action Token: ", actionToken); // Use the action token to invoke the recommendation API.
};

• setUserId() sets the user context for all subsequent events for the session (or until the user is explicitly cleared). It should be set only after you've fully authenticated the user (including, for example, any 2FA that was required). For the complete list of action types, see our recommendations page.
  Copy

  Copied

  await TSAccountProtectionSDKModule.setUserId(username);

• clearUser() clears the user context for all subsequent events in the mobile session. The user gets automatically cleared once the session expires or in case of the a login action.
  Copy

  Copied

  await TSAccountProtectionSDKModule.clearUser();

Step 6: Fetch recommendations

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

Mosaic 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:

  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 in Step 5.

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]',
    },
  }
);