Functions

▸ triggerAction(action, options?, locationConfig?, customAttributes?): Promise<TSSetActionResponse>

Reports a user action event and returns an action token. The action token should be passed to your backend to fetch risk recommendations via the Recommendation API.

Promise<TSSetActionResponse>

import { triggerAction, TSAction, TSClaimedUserIdType } from 'react-native-ts-accountprotection';

const response = await triggerAction(
  TSAction.login,
  {
    correlationId: "CORRELATION_ID",
    claimedUserId: "91e25bea0c...", // hashed email
    claimedUserIdType: TSClaimedUserIdType.email,
    referenceUserId: "REFERENCE_USER_ID"
  },
  { mode: "default" },
  { userLevel: "premium" }
);
const actionToken = response.actionToken;

▸ setAuthenticatedUser(userId): Promise<boolean>

Sets the user context for all subsequent events in the session (or until the user is explicitly cleared). It should be called only after you've fully authenticated the user (including, for example, any 2FA that was required).

Promise<boolean>

Indicates if the call succeeded

import { setAuthenticatedUser } from 'react-native-ts-accountprotection';

await setAuthenticatedUser(username);

▸ clearUser(): Promise<boolean>

Clears the user context for all subsequent events in the mobile session. The user is automatically cleared once the session expires or in case of a new login action.

Promise<boolean>

Indicates if the call succeeded

import { clearUser } from 'react-native-ts-accountprotection';

await clearUser();

▸ getSessionToken(): Promise<string>

Returns a device session token that can be used to trigger action events via the Backend API. The session token binds user interactions to their device and is required for backend integrations. Call this after SDK initialization and before triggering events.

Promise<string>

The session token.

import { getSessionToken } from 'react-native-ts-accountprotection';

const sessionToken = await getSessionToken();

▸ logPageLoad(pageName): Promise<void>

Tracks screen navigation events for behavioral data collection. Call this whenever the user navigates to a new screen in your app.

Promise<void>

import { logPageLoad } from 'react-native-ts-accountprotection';

await logPageLoad("login-page");
await logPageLoad("dashboard");

▸ setLogLevel(isLogEnabled): Promise<void>

Enables or disables verbose SDK logging for debugging purposes.

Promise<void>