Skip to main content
@capgo/capacitor-verisoul Auth & Security Open source

Verisoul Capacitor plugin

Collect Verisoul native fraud-prevention sessions from Capacitor apps on iOS and Android

Install

bun add @capgo/capacitor-verisoul bunx cap sync
npm, pnpm or yarn
  • npm install @capgo/capacitor-verisoul
  • pnpm add @capgo/capacitor-verisoul
  • yarn add @capgo/capacitor-verisoul

Guide

How to use Verisoul in Capacitor

Test on device

Download the Capgo app, then scan the QR code.

Verisoul plugin preview QR code

Using @capgo/capacitor-verisoul

@capgo/capacitor-verisoul connects Capacitor apps to Verisoul native fraud-prevention sessions on iOS and Android.

Install

npm install @capgo/capacitor-verisoul
npx cap sync

What This Plugin Exposes

  • configure - Initializes the native Verisoul SDK with your environment and project ID.
  • getSessionId - Returns the current Verisoul session ID for backend risk assessment.
  • reinitialize - Starts a fresh Verisoul session after account context changes.
  • recordTouchEvent - Sends Android touch events to Verisoul touch-signal collection.

Example Usage

import { Verisoul } from '@capgo/capacitor-verisoul';

await Verisoul.configure({
  environment: 'prod',
  projectId: 'YOUR_PROJECT_ID',
});

const { sessionId } = await Verisoul.getSessionId();

await fetch('/api/risk/verisoul', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ sessionId }),
});

Reset Sessions

Call reinitialize() when a user logs out or switches accounts:

await Verisoul.reinitialize();

Full Reference

Keep going from Using @capgo/capacitor-verisoul

If you are using Using @capgo/capacitor-verisoul to add fraud-prevention signals, connect it with @capgo/capacitor-verisoul for the implementation detail, Getting Started for install steps, iOS setup for App Attest notes, Android setup for Gradle setup, and Capgo Security for the broader security workflow.

FAQ

Verisoul plugin FAQ

How do I install the Verisoul plugin in a Capacitor app?

Run "bun add @capgo/capacitor-verisoul" (or "npm install @capgo/capacitor-verisoul"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-verisoul" in your app code.

Does @capgo/capacitor-verisoul work with React, Vue and Angular?

Yes. Verisoul is a Capacitor package, so it works with any web framework that runs inside Capacitor, including Ionic, React, Vue, Angular, Svelte and plain JavaScript.

Which Capacitor version does @capgo/capacitor-verisoul support?

Capgo plugins follow Capacitor's major version: use the plugin major version that matches your Capacitor major version (for example plugin v8 with Capacitor 8). The compatibility table in the GitHub README lists the maintained versions.

Is @capgo/capacitor-verisoul free and open source?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-verisoul/ and the package is free to install from npm. Bug reports and pull requests are welcome.

Can I update code that uses Verisoul without an App Store review?

Installing or upgrading the plugin changes native code, so it needs a new store build. After that, JavaScript, HTML and CSS changes that call the plugin can ship instantly with Capgo live updates.

Ship Verisoul changes without waiting for app review

Once the plugin is in your store build, Capgo live updates push your JavaScript, HTML and CSS changes to users in minutes.

Start with Capgo