@capgo/capacitor-verisoul

Detect fake accounts and fraud in your Capacitor app with Verisoul's native SDKs, and send a session ID to your backend for risk checks.

• Setup: configure() with your Verisoul environment and project ID.
• Sessions: getSessionId() returns the session to verify on your server.
• Fresh start: reinitialize() resets signal collection and starts a new session.
• Touch signals: recordTouchEvent() forwards touch events for behavioral analysis on Android. It is a no-op on iOS.
• Platforms: iOS and Android. Uses the Verisoul iOS and Android SDKs. Not available on web.

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-verisoul` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

npm install @capgo/capacitor-verisoul
npx cap sync

Verisoul recommends enabling App Attest for stronger iOS device checks. Add the capability in Xcode and include the entitlement that matches your environment:

<key>com.apple.developer.devicecheck.appattest-environment</key>
<string>production</string>

Use development for test builds.

The plugin adds the Verisoul Maven repository and required network permissions. If your app build cannot resolve ai.verisoul:android, add this repository to your app root Gradle repositories:

maven { url = uri("https://us-central1-maven.pkg.dev/verisoul/android") }

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

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

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

await Verisoul.reinitialize();

On Android, forward touch events when you need Verisoul touch-signal collection:

await Verisoul.recordTouchEvent({
  x: 120,
  y: 240,
  action: 'down',
});

• configure(...)
• getSessionId()
• reinitialize()
• recordTouchEvent(...)
• Interfaces
• Type Aliases

configure(options: ConfigureOptions) => Promise<void>

Initialize Verisoul. Call this once, early in app startup.

getSessionId() => Promise<SessionIdResult>

Return the current Verisoul session identifier.

The value may take a few seconds to become available after configure().

Returns: Promise<SessionIdResult>

reinitialize() => Promise<void>

Reset Verisoul signal collection and create a fresh session.

Use this when account context changes, for example after logout/login.

recordTouchEvent(options: RecordTouchEventOptions) => Promise<void>

Forward a touch event to Verisoul.

Android uses this for bot-detection touch signals. iOS resolves without work because the iOS SDK does not expose a matching public API.

'dev' | 'sandbox' | 'staging' | 'prod' | 'production'

'down' | 'up' | 'move' | 0 | 1 | 2