Getting Started

Copy a setup prompt with the install steps and the full markdown guide for this plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-verisoul`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/verisoul/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Install

npm install @capgo/capacitor-verisoul
npx cap sync

Configure Verisoul

Call configure() once, early in your app startup. Use sandbox for testing and prod for production traffic.

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

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

Get a session ID

After Verisoul has collected enough native signals, request the session ID and send it to your backend. Your backend should call Verisoul’s server-side API for the risk assessment.

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

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

Reset on account changes

Call reinitialize() when user context changes, such as logout followed by login as another account.

await Verisoul.reinitialize();

Android touch signals

On Android, forward touch events when your app needs Verisoul touch-pattern collection.

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

Platform setup

iOS setup covers App Attest entitlement notes.
Android setup covers the Verisoul Maven repository and permissions.

Keep going from Getting Started

If you are using Getting Started to integrate Verisoul sessions, connect it with @capgo/capacitor-verisoul for the API overview, iOS setup for App Attest notes, Android setup for Gradle setup, and Using @capgo/capacitor-verisoul for the plugin tutorial.