Get started with Fisherman



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.

    * Access token that you generated on the backend in the previous step
    token: string,
    * An optional device session ID.
    * Used to distinguish between device sessions and track them in monitoring.
    * If left empty, a unique identifier will be generated.
    deviceSessionId?: string,
     * An optional error callback
     * @param FishermanError error
    onError?: (error: FishermanError) => void
  1. Confirm applicant platform event.

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



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.

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.



Once you have got the applicant event check results, you can terminate the Fisherman library to free your browser resources by the following command: