Skip to content

Developer Documentation

Face SDK documentation - Regula

Initializing search

Home
Develop
Resources
Support
Blog
Services Status

Developer Documentation

Home
Develop
Develop
- Overview
- Software Products
  Software Products
  - Document Reader SDK
    
    Document Reader SDK
    
    Overview
    
    Overview
    
    Features
    
    Image Quality Assessment
    
    Image Quality Requirements
    
    Authenticity Control
    
    Architecture
    
    Licensing
    
    Transactions
    
    Supported Languages
    
    OCR Supported Languages
    
    Security Mechanisms for Electronic Documents
    
    Document Types
    
    Digital Travel Credentials
    
    Mobile Driver's License
    
    Accessibility
    
    Mobile
    
    Mobile
    
    Getting Started
    
    Getting Started
    
    Quickstart
    
    Installation
    
    Installation
    
    iOS
    
    Android
    
    Flutter
    
    JavaScript
    
    .NET MAUI
    
    React (Deprecated)
    
    Ionic (Deprecated)
    
    Cordova (Deprecated)
    
    Processing Scenarios
    
    Database
    
    Initialization
    
    Document Processing
    
    RFID Chip Processing
    
    Use External NFC Readers
    
    Security Checks
    
    DTC Reprocessing
    
    mDL Processing
    
    Results
    
    Results
    
    iOS
    
    Android
    
    Flutter
    
    JavaScript
    
    React Native
    
    Ionic
    
    Cordova
    
    .NET MAUI
    
    Deinitialization
    
    Configure Processing
    
    Configure Processing
    
    Transactions
    
    Multipage Processing
    
    Authenticity Checks
    
    RFID Chip Processing
    
    mDL Processing
    
    Processing Modes
    
    Detection
    
    Limitations
    
    Image Quality
    
    Record Processing
    
    Metadata
    
    Output Data
    
    Custom Params
    
    Logging
    
    Version Information
    
    Customize Interface
    
    Customize Interface
    
    Color Theme
    
    Multipage Processing
    
    Liveness Check
    
    RFID Chip Processing
    
    mDL Processing
    
    Camera Frame
    
    Messages
    
    Toolbar
    
    Background
    
    Instructions
    
    Indicators
    
    Custom Layer
    
    Localization
    
    Localization
    
    iOS
    
    Android
    
    Flutter
    
    JavaScript
    
    .NET MAUI
    
    React Native
    
    Ionic
    
    Cordova
    
    Integration with Web API
    
    Integration with Web API
    
    Server-Side Verification
    
    mDL Server-Side Verification
    
    Integration with Face SDK
    
    Online Processing
    
    Optimize Your App
    
    Optimize Your App
    
    Android
    
    Android
    
    Load Modules in Runtime
    
    Remove Unused Strings
    
    Security
    
    Security
    
    Certificate Pinning
    
    Mutual TLS
    
    Mutual TLS
    
    iOS
    
    Android
    
    Prevent Screen Capture
    
    Capture Process Integrity
    
    API Reference
    
    API Reference
    
    iOS
    
    Android
    
    Flutter
    
    JavaScript
    
    FAQ
    
    Web Service
    
    Web Service
    
    Getting Started
    
    Installation
    
    Installation
    
    Containers
    
    Containers
    
    Docker
    
    Helm
    
    Linux
    
    Windows
    
    Clouds
    
    Clouds
    
    AWS Cloud
    
    Administration
    
    Administration
    
    Server Configuration
    
    Processing Parameters
    
    Save Data To Storage
    
    Server-Side Verification
    
    Integration with Face API
    
    Security
    
    Security
    
    SSL
    
    CORS
    
    Demo App
    
    Requests
    
    Metrics Monitoring
    
    Cleaning Up
    
    Performance Optimization
    
    Performance Optimization
    
    High-Load Installation
    
    Testing Techniques
    
    Resources
    
    Logging
    
    Development
    
    Development
    
    Usage
    
    Usage
    
    Processing Scenarios
    
    Document Processing
    
    Transactions
    
    Processing Params
    
    Authenticity Checks
    
    RFID Processing
    
    DTC Reprocessing
    
    Integration with Face API
    
    Response Schema
    
    Enumerations
    
    Enumerations
    
    AuthenticityResultType
    
    BarcodeType
    
    CheckDiagnose
    
    CheckResult
    
    Critical
    
    DocumentFormat
    
    DocumentType
    
    GraphicFieldType
    
    ImageQualityCheckType
    
    LCID
    
    Light
    
    LogLevel
    
    MeasureSystem
    
    MRZDetectMode
    
    MRZFormat
    
    ParsingErrorCodes
    
    ParsingNotificationCodes
    
    ProcessingStatus
    
    Result
    
    RFIDErrorCodes
    
    RfidLocation
    
    RFIDPKDResourceType
    
    Scenario
    
    SecurityFeatureType
    
    Source
    
    TextFieldType
    
    TextPostProcessing
    
    VerificationResult
    
    Visibility
    
    Clients
    
    Upgrade Guide
    
    Troubleshooting
    
    FAQ
    
    Web Components
    
    Web Components
    
    Getting Started
    
    Getting Started
    
    Installation
    
    Processing Scenarios
    
    Events
    
    Results
    
    Configure Processing
    
    Configure Processing
    
    Parameters
    
    Settings and Attributes
    
    Transactions
    
    Multipage Processing
    
    Version Information
    
    Customize Interface
    
    Customize Interface
    
    Settings and Attributes
    
    Styling Layout
    
    Styling Layout
    
    Start Screen
    
    Camera Screen
    
    Wait Screen
    
    Finish Screen
    
    Copyright
    
    Localization
    
    Integration with Web API
    
    Integration with Web API
    
    Server-Side Verification
    
    Switch to Mobile
    
    Security
    
    Security
    
    Content Security Policy
    
    Resources
    
    Advanced
    
    Advanced
    
    API Reference
    
    Examples
    
    Examples
    
    Demo App
    
    Storybook
    
    Sample Projects
    
    FAQ
    
    Desktop
    
    Desktop
    
    Installation
    
    Installation
    
    Linux
    
    Windows
    
    Configuration
    
    Configuration
    
    RFID
    
    Logging
    
    Development
    
    Development
    
    Fingerprint Processing
    
    Administration
    
    Administration
    
    Resources
    
    Third-Party Devices
    
    Release Notes
    
    Release Notes
    
    Release 9.9
    
    Release 9.9
    
    Patch 1
    
    Release 9.8
    
    Release 9.7
    
    Release 9.7
    
    Patch 1
    
    Release 9.6
    
    Release 9.5
    
    Release 9.4
    
    Release 9.3
    
    Release 9.2
    
    Release 9.1
    
    Release 8.4
    
    Release 8.3
    
    Release 8.2
    
    Release 8.1
    
    Previous Versions
    Previous Versions
    
    Release 7.7
    
    Release 7.6
    
    Release 7.5
    
    Release 7.4
    
    Release 7.3
    
    Release 7.2
    
    Release 7.1
    
    Release 6.9
    
    Release 6.8
    
    Release 6.7
    
    Release 6.6
    
    Release 6.5
    
    Release 6.4
    
    Release 6.3
    
    Release 6.2
    
    Release 6.1
    
    Release 5.8
    
    Release 5.7
    
    Release 5.6
    
    Release 5.5
    
    Release 5.4
    
    Release 5.3
    
    Release 5.2
    
    Release 5.1
    
    Release 4.15
    
    Release 4.12
    
    Release 4.11
    
    Release 4.10
    
    Release 4.9
    
    Release 4.8
    
    Release 4.7
    
    Release 4.6
    
    Release 4.5
    
    Migration Guides
    
    Migration Guides
    
    From 9.8 to 9.9
    
    From 9.6 to 9.7
    
    From 9.5 to 9.6
    
    From 9.3 to 9.4
    
    From 9.2 to 9.3
    
    From 9.1 to 9.2
    
    From 8.4 to 9.1
    
    From 8.3 to 8.4
    
    From 8.3 to 8.4
    
    Web Component
    
    React Native
    
    Ionic
    
    Cordova
    
    From 8.2 to 8.3
    
    From 7.7 to 8.1
    
    Previous Versions
    Previous Versions
    
    From 7.5 to 7.6
    
    From 7.4 to 7.5
    
    From 7.2 to 7.3
    
    From 7.1 to 7.2
    
    From 6.x to 7.x
    
    From 6.x to 7.x
    
    Web Service
    
    iOS
    
    Android
    
    Flutter
    
    React Native
    
    Ionic
    
    Cordova
    
    From 5.x to 6.x
    
    From 5.x to 6.x
    
    iOS
    
    Android
    
    From 4.x to 5.x
    
    From 4.x to 5.x
    
    iOS
    
    Android
  - Face SDK
    
    Face SDK
    
    Overview
    
    Overview
    
    Introduction
    
    Introduction
    
    Architecture
    
    Customization
    
    Licensing
    
    Security
    
    Transactions
    
    Mobile
    
    Mobile
    
    Getting Started
    
    Getting Started
    
    Web Service Setup
    
    Web Service Setup
    
    Configuration
    
    Certificate Pinning
    
    Mutual TLS
    
    Mutual TLS
    
    iOS
    
    Android
    
    Installation
    
    Installation
    
    iOS
    
    Android
    
    Flutter
    
    JavaScript
    
    .NET MAUI
    
    React (Deprecated)
    
    Cordova (Deprecated)
    
    Ionic (Deprecated)
    
    Initialization
    
    Permissions
    
    Samples
    
    Feature Usage
    
    Feature Usage
    
    Enroll and Verify
    
    Liveness
    
    Face Capture
    
    Video Upload Status
    
    Video Upload Status
    
    iOS
    
    Android
    
    Face Detection
    
    Face Detection
    
    Basic Detection
    
    Attributes Evaluation
    
    Face Image Quality Assessment
    
    Face Comparison
    
    Face Comparison
    
    Client-Side Match
    
    Face Identification
    
    Customization and Configuration
    
    Customization and Configuration
    
    Transactions
    
    UI Customization
    
    UI Customization
    
    Basic
    
    Basic
    
    Text Localization
    
    Text Localization
    
    iOS
    
    Android
    
    .NET MAUI
    
    JavaScript
    
    Flutter
    
    React Native
    
    Cordova
    
    Ionic
    
    Advanced
    
    Advanced
    
    iOS
    
    Android
    
    HTTP Request Customization
    
    HTTP Request Customization
    
    iOS
    
    Android
    
    .NET MAUI
    
    .NET MAUI
    
    .NET iOS
    
    .NET Android
    
    JavaScript
    
    Flutter
    
    React Native
    
    Cordova
    
    Ionic
    
    Process Customization
    
    Optimization
    
    Optimization
    
    Shrink, Obfuscate, and Optimize your app
    
    API Reference
    
    API Reference
    
    Web Service
    
    Web Service
    
    Getting Started
    
    Installation
    
    Installation
    
    Containers
    
    Containers
    
    Basic Installation
    
    Basic Installation
    
    Docker
    
    Helm
    
    Advanced Installation
    
    Advanced Installation
    
    Docker
    
    Helm
    
    Linux
    
    Linux
    
    Windows
    
    Clouds
    
    Clouds
    
    Administration
    
    Administration
    
    Configuration
    
    Configuration
    
    Vector Database
    
    Storage
    
    Logging
    
    Monitoring
    
    Cleaning Up
    
    Performance Guide
    
    Performance Guide
    
    Constructing High-Load Installation
    
    Testing Framework
    
    Performance Results
    
    Required Endpoints
    
    Security
    
    Backup and Restore
    
    Development
    
    Development
    
    Usage
    
    Usage
    
    Enroll and Verify
    
    Liveness Assessment
    
    Face Identification
    
    Face Detection
    
    Face Detection
    
    Attributes List
    
    Face Image Quality Characteristics
    
    Scenarios
    
    Face Comparison
    
    Enumerations
    
    Enumerations
    
    FaceImageQualityAlignType
    
    FaceAttribute
    
    FaceImageQualityGroups
    
    FaceQualityConfigName
    
    FaceQualityScenarios
    
    FaceImageQualityStatus
    
    FaceSDKResultCode
    
    ImageSource
    
    FaceLivenessStatus
    
    LivenessType
    
    FilterOp
    
    Clients
    
    Upgrade Guide
    
    Troubleshooting
    
    FAQ
    
    Web Components
    
    Web Components
    
    UI Customization
    
    Release Notes
    
    Release Notes
    
    Release 8.4
    
    Release 8.4
    
    Patch 1
    
    Release 8.3
    
    Release 8.2
    
    Release 8.1
    
    Release 7.2
    
    Release 7.1
    
    Release 7.1
    
    Versions 5.2 and Earlier. End of Support
    
    Previous Versions
    Previous Versions
    
    Release 6.4
    
    Release 6.3
    
    Release 6.2
    
    Release 6.2
    
    Patch 1
    
    Release 6.1
    
    Release 5.2
    
    Release 5.2
    
    Patch 3
    
    Patch 2
    
    Patch 1
    
    Release 5.1
    
    Release 5.1
    
    Patch 1
    
    Liveness v.3.2. End of Life
    
    Release 3.2
    
    Release 3.1
    
    Release 3.0
    
    Migration Guides
    
    Migration Guides
    
    From 7.2 to 8.1
    
    From 6.4 to 7.1
    
    From 6.4 to 7.1
    
    React Native
    
    Ionic
    
    Cordova
    
    Previous Versions
    Previous Versions
    
    From 6.1 to 6.2
    
    From 6.1 to 6.2
    
    Flutter
    
    React Native
    
    Ionic
    
    Cordova
    
    From 5.2 to 6.1
    
    From 5.1 to 5.2
    
    From 3.2 to 5.1
  - IDV Platform
    
    IDV Platform
    
    Overview
    
    Overview
    
    Introduction
    
    Architecture
    
    Getting Started
    
    Installation
    
    Administration
    
    Administration
    
    Deployment
    
    Configuration
    
    Role-Based Access Control
    
    Role-Based Access Control
    
    Key Concepts
    
    Permissions
    
    Users
    
    Roles
    
    Groups
    
    Configure Access
    
    Security
    
    Disaster Recovery
    
    Integration
    
    Integration
    
    Microsoft Entra Verified ID
    
    Installation
    
    Installation
    
    Mobile
    
    Mobile
    
    iOS
    
    Android
    
    Flutter
    
    Web Components
    
    Starting Session
    
    Starting Session
    
    Authentication
    
    Authentication
    
    API Keys
    
    Basic Credentials
    
    Token URL
    
    Mobile
    
    Mobile
    
    iOS
    
    Android
    
    Flutter
    
    Web Components
    
    Checking Results
    
    Checking Results
    
    Getting Session Data via API
    
    Session Statuses
    
    Usage
    
    Usage
    
    Profiles
    
    Case Management
    
    Identity Refresh
    
    Risk Predictors
    
    Role-Based Access Control
    
    Role-Based Access Control
    
    Getting Started
    
    Users
    
    Groups
    
    Roles
    
    My Roles and Groups
    
    Use Cases and Scenarios
    
    Use Cases and Scenarios
    
    Basic Scenarios
    
    Multiple Teams Scenarios
    
    Customization
    
    Customization
    
    Client Assets
    
    Reference Lists
    
    Release Notes
    
    Release Notes
    
    Release 3.10
    
    Release 3.9
    
    Release 3.8
    
    Release 3.7.1
    
    Release 3.7
    
    Release 3.6
    
    Release 3.5.1
    
    Release 3.5
    
    Release 3.4
    
    Release 3.3
    
    Release 3.2.2
    
    Release 3.2
    
    Release 3.1
  - Forensic Studio
    
    Forensic Studio
    
    Overview
    
    System Requirements
    
    User Manuals
    
    Release Notes
    
    Release Notes
    
    Release 5.7
    
    Release 5.6
- Hardware Products
  Hardware Products
  - Mobile Document Readers
Resources
Resources
- Overview
- Products
  Products
  - Document Reader SDK
    
    Document Reader SDK
    
    Mobile
    
    Server
    
    Desktop
    
    OpenAPI & Clients
    
    Demo Apps
  - Face SDK
    
    Face SDK
    
    Mobile
    
    Web
  - IDV Platform
    
    IDV Platform
    
    Mobile
    
    Web
Support
Blog
Services Status

v8.4.1

Face SDK Documentation

Overview
Web Service
Mobile Components
Web Components
Release Notes
Migration Guides

Copyright © 1992 - 2026 Regula. All rights reserved