iOS

To run the SDK a Verisoul Project ID is required. Schedule a call here to get started.

System Requirements

iOS 14.0 or higher
Xcode 15.0 or higher
Swift 5.9 or higher
CocoaPods 1.10+ (if using CocoaPods)
SDK Size: ~480 KB

Installation

You can install VerisoulSDK in your iOS project using either CocoaPods or Swift Package Manager.

CocoaPods

To integrate VerisoulSDK with CocoaPods:

Ensure CocoaPods is installed on your machine. If not, run:
sudo gem install cocoapods
Add VerisoulSDK to your Podfile:
pod 'VerisoulSDK', '~> 0.4.71'
Run the following command to install the SDK:
pod install
Open the .xcworkspace file in Xcode and start using the SDK.

Swift Package Manager (SPM)

To integrate VerisoulSDK using Swift Package Manager:

Open your project in Xcode.
Go to File > Add Packages.

Enter the repository URL for VerisoulSDK:

https://github.com/verisoul/ios-sdk.git

Choose the version you wish to use and add the package.

The SDK will automatically integrate into your project.

iOS Device Check

To fully utilize the Verisoul SDK, you must add the App Attest capability to your project. This capability allows the SDK to perform necessary checks and validations to ensure the integrity and security of your application. Update your app’s entitlements file:

<key>com.apple.developer.devicecheck.appattest-environment</key>
<string>production</string>  <!-- Use 'development' for testing -->

Usage

Initialize the SDK

Call configure() before you intend to retrieve a Verisoul session_id.

import VerisoulSDK

Verisoul.shared.configure(env: .prod, projectId: "your-project-id")

The configure() method initializes the Verisoul SDK with your project credentials. Only initialize the SDK if you plan to retrieve a session_id and call the Verisoul API for that session. Parameters:

env: The environment to use .prod for production or .sandbox for testing
projectId: Your unique Verisoul project identifier
reinitialize: Whether to create a new session during configuration. Defaults to false
collectTouchData: Whether to begin touch and motion capture. Defaults to true

Get Session ID

The session() method returns the current session identifier after the SDK has collected sufficient device data. This session ID is required to request a risk assessment from Verisoul’s API. Important Notes:

Session IDs are short-lived and expire after 24 hours
The session ID becomes available once minimum data collection is complete (typically within seconds)
You should send this session ID to your backend, which can then call Verisoul’s API to get a risk assessment

Example:

do {
    let sessionId = try await Verisoul.shared.session()
    // Send sessionId to your backend for risk assessment
    print("Session ID: \(sessionId)")
} catch {
    print("Failed to retrieve session ID: \(error)")
}

Provide Touch Events

Starting in version 0.4.71, the Verisoul SDK captures a small number of touch events together with accelerometer samples without adding any views to your app’s hierarchy. It attaches a UIGestureRecognizer to the key window with cancelsTouchesInView, delaysTouchesBegan, and delaysTouchesEnded all set to false, so your app continues to receive touches without cancellation or delay. Touch and motion capture is enabled by default: collection begins automatically as soon as configure() is called. To configure the SDK without starting touch and motion capture:

Verisoul.shared.configure(
    env: .prod,
    projectId: "your-project-id",
    collectTouchData: false
)

Use setTouchCaptureEnabled(_:) to limit capture to a specific flow such as signup:

Verisoul.shared.configure(
    env: .prod,
    projectId: "your-project-id",
    collectTouchData: false
)

// When signup begins:
Verisoul.shared.setTouchCaptureEnabled(true)

// When signup ends:
Verisoul.shared.setTouchCaptureEnabled(false)

Error Codes

The SDK throws VerisoulException with the following error codes:

Error Code	Description	Recommended Action
INVALID_ENVIRONMENT	The environment parameter passed to `Verisoul.init()` is invalid. Valid values are “dev”, “sandbox”, or “prod”.	Ensure the environment parameter is exactly “dev”, “sandbox”, or “prod” (case-sensitive, no whitespace).
SESSION_UNAVAILABLE	A valid session ID could not be obtained. This typically occurs when Verisoul’s servers are unreachable due to network blocking or a very slow connection.	Implement exponential backoff. Prompt user to check network or disable network blocker.
WEBVIEW_UNAVAILABLE	WebView is not available on the device. This can occur when WebView is disabled, missing, uninstalled, or corrupted on the device.	Prompt user to enable WebView in settings, update Android System WebView, or switch devices.

Exception Structure

All errors are thrown as VerisoulException with the following properties:

Property	Type	Description
code	String	One of the error codes above
message	String	Human-readable error description
cause	Throwable?	The underlying exception that caused the error (if any)

Example

For a complete working example, see the iOS Sample App.

Additional Resource

Verisoul CocoaPods

Overview

Integration

Signals & Scores

Action

Dashboard

Email Intelligence API

Verifications

System Requirements

Installation

CocoaPods

Swift Package Manager (SPM)

iOS Device Check

Usage

Initialize the SDK

Get Session ID

Provide Touch Events

Error Codes

Exception Structure

Example

Additional Resource

​System Requirements

​Installation

​CocoaPods

​Swift Package Manager (SPM)

​iOS Device Check

​Usage

​Initialize the SDK

​Get Session ID

​Provide Touch Events

​Error Codes

​Exception Structure

​Example

​Additional Resource

System Requirements

Installation

CocoaPods

Swift Package Manager (SPM)

iOS Device Check

Usage

Initialize the SDK

Get Session ID

Provide Touch Events

Error Codes

Exception Structure

Example

Additional Resource