vornid library
VornID Flutter SDK
Capture-and-transport client for biometric liveness detection, image analysis, and identity verification.
Classes
- AnalysisOptions
- Options for image analysis.
- AnimatedFaceMeshPainter
- Animated face mesh with gradual formation, depth-aware coloring, gradient wireframe, shimmer, detection glows, head-pose reactivity, breathing/pulsing vertices, motion trails, and AI-awareness highlights.
- ApiErrorBody
- Structured error body from the backend API response.
-
ApiResponse<
T> -
Standard API response envelope as defined in
03_api_contracts.mdSection 4. - BiometricMatchResult
- CaptureCompleted
- CaptureMetadata
- CaptureStarted
- ChallengeCaptureStarted
- ChallengeLabels
- Override instruction labels for localization.
- ChallengePerformNow
- ChallengeReceived
- ChallengeRetry
- ConcentricRingsPainter
- Concentric rings expanding outward for the processing overlay.
- ConcentricRingsStyle
- Concentric rings expanding outward for the processing overlay.
- DecisionReasoning
- DetectionThresholds
- Client-side detection thresholds.
- EnrollmentResult
- FaceGuideOverlay
- FaceIconPainter
- Intro screen face icon with circle, eyes, smile, and crosshair guides.
- FaceIconStyle
- Intro screen face icon with circle, eyes, smile, and crosshair guides.
- FaceMeshStyle
- Visual parameters for the animated face mesh (tessellation, vertices, contours, forehead extension, eye/mouth highlights, motion trails).
- FastArcStyle
- Fast partial arc rotating around the face oval.
- FeedbackOverlay
- Frosted glass floating pill for quality feedback messages.
- FrameCaptured
- FrameHash
- IdentityRecord
- ImageAnalysisResult
- ImageClassification
- ImageQualityBreakdown
- IntegrityBlock
- LivenessChallenge
- LivenessOptions
- Liveness check options.
- LivenessResult
- LivenessResultOverlay
- Dark-themed result screen with concentric ring checkmark, waveform, and ID card.
- LivenessScoreBreakdown
- MappedFaceContours
- Face contour data already mapped to widget coordinates for rendering.
- ProcessingStarted
- ProgressRingStyle
- Smooth circular progress ring with gradient fill and glowing leading edge.
- QualityFeedback
- ScanLineStyle
- Vertical scan line that sweeps through the oval.
- ScanningEffectsPainter
- Animated scanning visuals: dashed spinning ring, fast partial arc, sweeping scan line, and face landmark lattice.
- ScanningTheme
- Top-level visual theme for all scanning/liveness UI painters.
- SegmentedProgressRingPainter
- Smooth circular progress ring with gradient fill and glowing leading edge. Subtle tick marks underneath for visual texture.
- SessionTimedOut
- SpinRingStyle
- Dashed spinning ring around the face oval.
- StateTransition
- UploadCompleted
- UploadProgress
- UploadStarted
- VerificationInput
- Input for identity verification.
- VerificationResult
- VornIdCameraController
- VornIdCameraPreview
- VornIdConfig
- Configuration for initializing the VornID SDK.
- VornIdConstants
- SDK version and runtime constants.
- VornIdEvent
- Event types emitted during SDK operations.
- VornIdLivenessScreen
- Pre-built full-screen liveness check experience.
- VornIdProgressIndicator
- VornIdResultView
- VornIdSdk
- Main entry point for the VornID SDK.
- WaveformPainter
- EKG-style waveform decoration for the result screen.
- WaveformStyle
- EKG-style waveform decoration for the result screen.
Enums
- AnalysisType
- Analysis type for image capture.
- CameraFacing
- Camera facing direction.
- ChallengeType
- ClaimType
- Claim type for identity verification.
- IdentityState
- LivenessMode
- VerificationMode
- Verification mode.
- VerificationVerdict
- VornIdEnvironment
- Environment configuration for the VornID SDK.
Exceptions / Errors
- VornIdAuthError
- 401: Authentication errors — missing, invalid, or expired API key.
- VornIdCameraError
- Camera permission denied or unavailable.
- VornIdCertPinError
- Certificate pinning validation failure.
- VornIdDeviceError
- Device security errors — compromised device, emulator in production.
- VornIdError
- Base error type for all VornID SDK errors.
- VornIdForbiddenError
- 403: Authorization errors — tenant suspended, service not entitled.
- VornIdNetworkError
- Connection failures, timeouts, network unreachable.
- VornIdRateLimitError
- 429: Rate limit exceeded.
- VornIdServerError
- 500: Server-side errors — internal error, service unavailable.
- VornIdSessionError
- Session errors — expired session, challenge exhausted.
- VornIdValidationError
- 400/422: Validation errors — invalid image format, face not detected, etc.