types/index library
Classes
- CafColorConfiguration
- Color theming options for Caf SDK Design System.
- CafConfirmationNextStepContentConfiguration
- Configuration for the confirmation step content in the SDK flow.
- CafDocumentDetectorConfiguration
- Configuration for the CafDocumentDetector module.
- CafDocumentDetectorFlow
- Defines a single step in the document capture flow.
- CafDocumentDetectorMessageCustomization
- Customizable messages displayed during the capture flow.
- CafDocumentDetectorPreviewCustomization
- UI preview settings shown after each capture.
- CafDocumentDetectorProxySettings
- HTTP proxy configuration for document uploads.
- CafDocumentDetectorProxySettingsAuthentication
- Credentials for authenticating against an HTTP proxy.
- CafDocumentDetectorResult
- Result payload for the CafDocumentDetector, containing all captures.
- CafDocumentDetectorRetryCustomization
- Customization options for the document capture retry screen.
- CafDocumentDetectorSecuritySettings
- Security-related feature flags for the capture flow.
- CafDocumentDetectorUIConfiguration
- Top-level configuration for the CafDocumentDetector UI flow. Combines document detector settings with optional instruction and document selection screens.
- CafDocumentDetectorUIDocumentSelectionScreenConfiguration
- Configuration for the document selection screen in the document detector UI flow. Provides a list of document types for the user to choose from.
- CafDocumentDetectorUIInstructionScreenConfiguration
- Types for CAF Document Detector UI module. Configuration for instruction screens in the document detector UI flow. Provides visual guidance during capture and upload steps.
- CafDocumentDetectorUploadCustomization
- Customization options for document upload behavior.
- CafDocumentDetectorUploadMessagesCustomization
- Customization options for the document upload messages.
- CafDocumentDetectorUploadSettings
- Options for configuring document upload behavior.
- CafErrorResponse
- Represents an error response from Caf SDK.
- CafFaceLivenessConfiguration
- Types for CAF Face Liveness module. Configuration for the Face Liveness flow.
- CafFaceLivenessResult
- Result payload for a successful CafFaceLiveness check.
- CafFaceLivenessUIConfiguration
- Combined configuration for the CAF Face Liveness UI module.
- CafFaceLivenessUIInstructionScreenConfiguration
- Types for CAF Face Liveness UI module. Configuration for instruction screens in the face liveness UI flow. Provides visual guidance and instructional content to the user.
- CafFailureResponse
- Represents a failed response from CafFaceLiveness module.
- CafLog
- Structure for a log message emitted by a Caf module.
- CafResponse
- CafSdkBuilderConfiguration
- Builder options for ordering modules and customizing appearance.
- CafSdkConfiguration
- Full SDK configuration passed to the CAF builder.
- CafSdkEventName
- Event name constants emitted by the CafSDK native bridge.
- CafSuccessResponse
- Represents a successful response for any Caf module.
Enums
- CafCountryCodes
- ISO 3166-1 alpha-3 country codes for allowed passport issuance.
- CafDocument
- Types for CAF Document Detector module. Available document types recognized by the CafDocumentDetector module.
- CafEnvironment
- Supported runtime environments for the CafSDK.
- CafErrorType
- Enumerates possible error types emitted by Caf SDK.
- CafFailureType
- Enumerates possible failure scenarios emitted by CafFaceLiveness module.
- CafFileFormat
- Supported file formats for document uploads.
- CafLogLevel
- Log levels used for debugging from Caf modules.
- CafModuleType
- Available Caf module types for inclusion in the SDK flow.