🚧

Attention

Before utilizing Fisherman, install the package with the following command via NPM first and the only time:

npm i @sumsub/fisherman --save

To use Fisherman 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.

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 key actions such as login, signup, password change, etc.

await fisherman.fingerprint();

4. Confirm applicant platform event.
5. Terminate the Fisherman library to free your browser resources by the following command: 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 three-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 Fisherman:

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

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.