GetVerified class

Main entry point for the Get Verified SDK

This class provides a simplified, unified API for common verification workflows while still allowing access to lower-level components for advanced use cases.

Quick Start:

// 1. Initialize the SDK
await GetVerified.instance.initialize(
  config: GetVerifiedConfig.minimal(
    license: await rootBundle.load('assets/regula.license'),
    faceApiUrl: 'https://your-face-api.com',
    documentReaderUrl: 'https://your-doc-reader.com',
  ),
);

// 2. Start verification
final result = await GetVerified.instance.startVerification(
  context: context,
  onProgress: (step) => print('Current step: $step'),
);

// 3. Handle result
if (result.isSuccess) {
  print('Verified: ${result.data?.name}');
} else {
  print('Error: ${result.error?.message}');
}

Properties

config → GetVerifiedConfig?

Current configuration (null if not initialized)

no setter

configManager → SDKConfigManager

Access to the configuration manager for advanced use cases

no setter

hashCode → int

The hash code for this object.

no setter, inherited

isInitialized → bool

Whether the SDK has been initialized

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

solution → GetVerifiedSolution

Access to the underlying solution for advanced use cases

no setter

Methods

initialize({required GetVerifiedConfig config}) → Future<VerificationResult<void>>

Initialize the SDK with configuration

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

reset() → void

Reset the SDK to uninitialized state

startVerification({String mode = 'match', void onDocumentScanned(ScanResult)?, void onLivenessCaptured(Uint8List)?, void onFaceMatchComplete(bool matched, double? similarity)?}) → Future<VerificationResult<ScanResult>>

Start the complete verification process

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

instance → GetVerified

Singleton instance

final