Before you get started

Install the package once via NPM using the following command:

npm i @sumsub/fisherman --save

📘

Note

Although the product is called Device Intelligence, the corresponding NPM library is named fisherman.

Use Device Intelligence in a session

To use Device Intelligence for detecting applicant fraudulent activities during a single session:

1. Generate an access token with a corresponding session ID.

2. Initialize our JS script using the acquired token.

   JavaScript

   const fisherman = await init({
   /**
   * Access token that you generated on the backend in the previous step
   */
   token: string,
   /**
   * An optional error callback
   * @param FishermanError error
   */
   onError?: (error: FishermanError) => void,
   /**
   * An optional config to simulate `fingerprint()`
   * @param FpSimulationConf config
   */
   simulationConfig?: FpSimulationConf
   })

3. Capture the fingerprint(s) of the user's device to associate it with the user and enhance fraud detection capabilities during financial transactions and key actions such as login, signup, password change, and so on.
   JavaScript

   await fisherman.fingerprint();

4. Submit the captured device data using one of the relevant API methods:
   • Create an applicant profile (recommended for Sign Up events).
   • Send applicant platform event with captured device.
   • Send financial transaction with captured device.

5. Destroy the SDK instance when finished to release browser resources.
   JavaScript

   fisherman.destroy();

Once the flow above is complete, you can proceed with reviewing the event check results.

📘

Note

To ensure comprehensive fraud detection, repeat this five-step cycle for each applicant platform event such as login, sign up, password reset, and 2FA reset.

Usage example

Below is a minimal setup example for using Device Intelligence:

import { init, destroy } from '@sumsub/fisherman'

const fisherman = await init({ token })

const handleLoginSubmit = async () => {
await fisherman.fingerprint();

// Confirm applicant platform event

destroy();

// Redirect user
}

Review event check results

You can review the applicant event check results on the Transactions page in the Dashboard since these events are considered event transactions.

To view all the events checked via Device Intelligence:

1. In the Dashboard, navigate to Transactions and Travel Rule → Transactions.
2. From the Type filter, select User platform event.
3. Click a transaction record to review its details.

Also, you can use the search bar to find an event transaction by a known applicant name, transaction ID, and so on.