blinkid-verify-core/com.microblink.blinkidverify.core

Package-level declarations

Types

data class BlinkIdSdkSettings @JvmOverloads constructor(val licenseKey: String, val licensee: String? = null, val resourcesConfig: ResourcesConfig = ResourcesConfig(), val otaResourcesConfig: OtaResourcesConfig = OtaResourcesConfig(), val microblinkProxyUrl: String? = null) : Parcelable

Settings for initialization of the BlinkID SDK.

BlinkIdVerifyClient

class BlinkIdVerifyClient(settings: BlinkIdVerifyServiceSettings)

Client for the BlinkID Verify Cloud API (v3).

BlinkIdVerifySdk

class BlinkIdVerifySdk : AutoCloseable

BlinkIdVerifySdkSettings

data class BlinkIdVerifySdkSettings @JvmOverloads constructor(val licenseKey: String, val licensee: String? = null, val downloadResources: Boolean = true, val resourceDownloadUrl: String = defaultResourceDownloadUrl, val resourceLocalFolder: String = defaultResourcesLocalFolder, val resourceRequestTimeout: RequestTimeout = RequestTimeout.DEFAULT, val microblinkProxyUrl: String? = null) : Parcelable

Settings for initialization of the BlinkID Verify SDK.

CorruptedAssetsException

class CorruptedAssetsException(corruptedAssets: List<ResourceCheckResult>) : InitializationException

One or more assets required by the SDK are corrupted.

ErrorReason

enum ErrorReason : Enum<ErrorReason>

InitializationException

sealed class InitializationException : RuntimeException

Represents an exception that occurred during the initialization process. Extends RuntimeException.

InvalidLicenseKeyException

class InvalidLicenseKeyException(message: String) : InitializationException

Provided license key is invalid.

JavaFriendlyApi

annotation class JavaFriendlyApi

LicenseLockedException

class LicenseLockedException : InitializationException

Provided license is remotely locked and unable to be used.

MbProduct

enum MbProduct : Enum<MbProduct>

NativeLibraryLoader

object NativeLibraryLoader

OtaResourceDownloadException

class OtaResourceDownloadException(corruptedAssets: List<OtaResource>) : InitializationException

One or more OTA assets required by the SDK are corrupted or missing.

RemoteLicenseCheckException

class RemoteLicenseCheckException : InitializationException

Error during the remote license check was encountered.

ResourceDownloadException

class ResourceDownloadException(corruptedAssets: List<ResourceCheckResult>) : InitializationException

One or more resources required by the SDK failed to download properly.

ResourceLoadError

data class ResourceLoadError(val description: String, val loadResult: ResourceLoadResult)

ResourceLoadResult

enum ResourceLoadResult : Enum<ResourceLoadResult>

Represents the result of attempting to load a resource file.

Response

sealed interface Response<out T>

Response of the document verification. In case when document is successfully verified Success response with verification result is returned. In case of any error, Error with reason is returned.

SdkInitError

sealed class SdkInitError

Represents an error that occurred during the initialization of the SDK.

SdkInitializationException

class SdkInitializationException(val reason: SdkInitError) : InitializationException

SDK failed to initialize due to a specific error.

ServiceEndpoint

enum ServiceEndpoint : Enum<ServiceEndpoint>