Mobile SDK

Verifa’s mobile SDKs provide native document capture, selfie collection, and liveness detection for iOS, Android, and React Native applications. The SDK handles the camera UI, image quality checks, and fraud signal collection with a native look and feel.

Platforms

How it works

1. Your server creates a session via the API
2. Pass the session token to the mobile SDK
3. The SDK presents native capture screens
4. On completion, the SDK returns control to your app
5. Your server receives the result via webhook

Integration flow

Step 1: Create a session (server-side)

$
curl -X POST https://api.withverifa.com/api/v1/sessions \
>
  -H "X-API-Key: vk_live_your_key_here" \
>
  -H "Content-Type: application/json" \
>
  -d '{
>
    "external_ref": "user_abc123",
>
    "country": "US"
>
  }'

Pass the session id and token to your mobile app.

Step 2: Initialize the SDK

1
import VerifaSDK
2
3
let config = VerifaConfig(
4
    sessionToken: "tok_abc123...",
5
    environment: .production
6
)
7
8
let verifa = Verifa(config: config)
9
10
verifa.start(from: self) { result in
11
    switch result {
12
    case .completed(let sessionId):
13
        print("Verification completed: \(sessionId)")
14
    case .cancelled:
15
        print("User cancelled")
16
    case .error(let error):
17
        print("Error: \(error)")
18
    }
19
}

Step 3: Handle the result

The SDK callback tells you when capture is complete. The actual verification result comes via your server’s webhook:

1
{
2
  "event": "session.approved",
3
  "data": {
4
    "session_id": "session_abc123",
5
    "external_ref": "user_abc123",
6
    "status": "approved"
7
  }
8
}

Or poll from your server:

$
curl https://api.withverifa.com/api/v1/sessions/session_abc123/result \
>
  -H "X-API-Key: vk_live_your_key_here"

SDK configuration

Fetch runtime config

The SDK fetches its configuration from the server on initialization:

GET /api/v1/sdk/config

This returns theming, feature flags, and required capture steps based on the session’s workflow.

Theming

Customize the SDK appearance to match your app:

1
let config = VerifaConfig(
2
    sessionToken: "tok_abc123...",
3
    environment: .production,
4
    theme: VerifaTheme(
5
        primaryColor: UIColor(hex: "#4f46e5"),
6
        backgroundColor: .white,
7
        cornerRadius: 12
8
    )
9
)

Server-side theming is also available — configure in the dashboard under Settings > Organization (Theming section) and it applies to all SDK sessions.

Native fraud signals

The mobile SDK collects device-specific fraud signals not available in the web capture flow:

These signals are automatically submitted alongside the standard behavioral, device, and network signals.

Capture screens

The SDK presents these screens in sequence:

1. Consent — Biometric processing consent
2. Document type — Select ID type (passport, driver’s license, etc.)
3. Document capture — Native camera with alignment guides, auto-capture, and quality feedback
4. Selfie capture — Front-facing camera with face alignment
5. Liveness challenge — Randomized challenges (blink, smile, head turn)
6. Additional data — Email, phone, address (if required by workflow)

The SDK skips screens that aren’t required by the workflow’s data_requirements.

Permissions

The SDK requires camera permission. Request it before starting the SDK or let the SDK handle the system prompt:

Error handling

Testing

In sandbox mode, the SDK allows you to select verification outcomes manually. Create sessions with a sandbox API key (vk_sandbox_*) to enable this.

Related

• Choosing an Integration Method — Compare SDK vs web capture vs API-only
• Web Capture Flow — Hosted capture for web apps
• Fraud Signals — All signals including mobile-specific
• Sessions — Session lifecycle and result retrieval