SDKs

iOS SDK

Integrate biometric verification and identity scanning into your iOS app
View as Markdown

The VLens iOS SDK embeds the full identity verification experience — national ID scanning, liveness detection, and face matching — directly into your iOS app. It supports both SwiftUI and UIKit and uses ARKit face tracking for liveness.

GitHub

vlens-ios-sdk · v1.4.4

iOS

iOS 15.0+, Swift 5.5+

Xcode

Xcode 13.0+, TrueDepth camera required

Liveness detection requires a TrueDepth camera (iPhone X and later, excluding SE models). Devices without TrueDepth will fail unless allowNonTrueDepthFallback is enabled, in which case auto-capture fires every 2 seconds as a fallback.

Installation

  1. In Xcode, go to File → Add Package Dependencies…
  2. Enter the repository URL: https://github.com/Vlens2021/vlens-ios-sdk
  3. Select version 1.4.4 (or latest) and click Add Package

Required permissions

Add the following key to your Info.plist:

<key>NSCameraUsageDescription</key>
<string>Camera is required for identity verification</string>

Quick start — SwiftUI

import SwiftUI
import VLensLib
struct ContentView: View {
    @State private var showVLens = false
    @State private var accessToken = ""
    var body: some View {
        Button("Start Verification") {
            showVLens = true
        }
        .vlensVerification(
            isPresented: $showVLens,
            transactionId: UUID().uuidString,
            apiKey: "YOUR_API_KEY",
            secretKey: "",
            tenancyName: "YOUR_TENANCY_NAME",
            accessToken: accessToken,
            onSuccess: { txnId, userData in
                print("Verified: \(userData?.user?.fullName ?? "")")
            },
            onFailure: { txnId, error in
                print("Error: \(error)")
            }
        )
    }
}

Quick start — UIKit

import UIKit
import VLensLib
class VerificationViewController: UIViewController, VLensDelegate {
    private var vlensManager: VLensManager!
    func startVerification(accessToken: String) {
        vlensManager = VLensManager(
            transactionId: UUID().uuidString,
            apiKey: "YOUR_API_KEY",
            secretKey: "",
            tenancyName: "YOUR_TENANCY_NAME",
            language: "en"
        )
        vlensManager.setAccessToken(accessToken)
        vlensManager.delegate = self
        vlensManager.present(on: self, withLivenessOnly: false)
    }
    func didValidateSuccessfully(transactionId: String,
                                 userData: VerifyIdBackPost.DataClass?) {
        print("Success: \(transactionId)")
        print("Name: \(userData?.user?.fullName ?? "N/A")")
    }
    func didFailToValidate(transactionId: String, error: String) {
        print("Failed: \(error)")
    }
}

Configuration parameters

ParameterTypeRequiredDefaultDescription
transactionIdStringYes—Unique identifier for the transaction
apiKeyStringYes—Your tenant API key
secretKeyStringYes""Secret key — pass empty string when using token auth
tenancyNameStringYes—Your tenant name
accessTokenStringYes—Bearer token from the Login API
languageStringNo"en"UI language — "en" or "ar"
withLivenessOnlyBoolNofalseSkip ID capture — liveness check only
noOfRetriesIntNo5Liveness retry attempts before failure
allowAutoCaptureBoolNotrueEnable automatic document scanning
allowNonTrueDepthFallbackBoolNofalseAllow operation on non-TrueDepth devices
showCloseButtonBoolNo—Show a close/dismiss button
colorsVLensColorsNodefaultCustom colour theme
onDismiss() -> VoidNonilCalled when the close button is tapped

Verification modes

Runs the complete flow: ID front → ID back → liveness.

.vlensVerification(
    isPresented: $showVLens,
    transactionId: transactionId,
    apiKey: "YOUR_API_KEY",
    secretKey: "",
    tenancyName: "YOUR_TENANCY_NAME",
    accessToken: accessToken,
    onSuccess: { txnId, userData in },
    onFailure: { txnId, error in }
)

Custom branding

let customColors = VLensColors(
    light: VLensColorConfig(
        accent: "#007AFF",
        primary: "#1E3A5F",
        secondary: "#666666",
        background: "#FFFFFF",
        dark: "#1C1C1E",
        light: "#F2F2F7"
    ),
    dark: VLensColorConfig(
        accent: "#0A84FF",
        primary: "#FFFFFF",
        secondary: "#ABABAB",
        background: "#1C1C1E",
        dark: "#000000",
        light: "#2C2C2E"
    )
)

Pass customColors to the colors parameter of your VLensColors config.

Obtaining an access token

Call the Login API before launching the SDK:

POST https://api.vlenseg.com/api/DigitalIdentity/Login

Headers:

Content-Type: application/json
ApiKey: YOUR_API_KEY
TenancyName: YOUR_TENANT

Body:

{
  "geoLocation": { "latitude": "30", "longitude": "30" },
  "imei": "device_identifier",
  "phoneNumber": "+20XXXXXXXXXX",
  "password": "your_password",
  "smsProviders": 0
}

Extract data.accessToken from the response and pass it to the SDK.

What’s new in v1.4.4

  • GIF background tinting applies accent colour across all start and loading screens
  • Icon backgrounds tinted consistently behind ID and face vector images
  • loadingTitleLabel outlets wired in NationalIdBack and ValidationMain screens

See all releases on GitHub.

Support

For issues or inquiries, contact support@vlenseg.com with your tenant name, the error message, and the SDK version.