Skip to main content

Requirements

  • Flutter 3.10+
  • Dart 3.0+
  • iOS 13+ / Android API 21+
  • Camera permission (for hosted verification UI)

Installation

Add the SDK to your pubspec.yaml:
pubspec.yaml
Then run:

Two Modes

The SDK provides two distinct clients for different use cases:
Never embed your API key in client-side code. Use VerilockIdentityClient with a session token in your mobile app. Use VerilockApiClient only from a backend server or secure environment.

Hosted Verification UI

The hosted flow uses a session token to guide users through document capture, selfie, and submission — all with built-in camera widgets.

Create a session on your backend

First, create a session from your server and pass the token to your Flutter app:

Use the pre-built verification screen

The fastest integration — a single widget that handles the entire flow:

Programmatic hosted flow

For full control, use VerilockIdentityClient directly:
pollForResult automatically polls getStatus() every 2 seconds until a decision is reached or the timeout expires. You can also call getStatus() manually for custom polling logic.

Server API Client

VerilockApiClient gives you full access to the Verilock API using API key authentication. Use this from your backend or secure server environment.

Sessions

AML Screening

Transaction Screening

Wallet Screening

Credentials


Error Handling

All SDK methods throw VerilockIdentityError on failure:

UI Widgets

The SDK includes pre-built widgets you can compose into your own screens.

VerilockVerificationScreen

Full-screen verification flow with all steps (document capture, selfie, processing, result):

DocumentCaptureWidget

Camera viewfinder with a document frame overlay. Captures front or back of an ID:

SelfieCaptureWidget

Camera viewfinder with a face oval overlay for selfie capture:

ProcessingWidget

Animated progress indicator shown while verification is in progress: