onfido-sdk-ui/types/capture-api/callbacks/error.d.ts

JavaScript SDK view layer for Onfido identity verification

declare enum ErrorCategory {
    Authentication = "Authentication",
    DeviceCapabilities = "DeviceCapabilities",
    General = "General",
    Initialisation = "Initialisation",
    Network = "Network",
    Permissions = "Permissions",
    Processing = "Processing"
}
export type Error = {
    uuid: string;
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export type ErrorCallback = (error: Error) => void;
export declare enum ErrorType {
    BiometricTokenRetrievalException = "BiometricTokenRetrievalException",
    CameraException = "CameraException",
    CameraNotDetected = "CameraNotDetected",
    CrossDeviceDesktopError = "CrossDeviceDesktopError",
    CrossDeviceRestartError = "CrossDeviceRestartError",
    CrossDeviceVerificationAbortError = "CrossDeviceVerificationAbortError",
    CrossDeviceVerificationInvalidError = "CrossDeviceVerificationInvalidError",
    DuplicateGenericDocument = "DuplicateGenericDocument",
    DuplicateStep = "DuplicateStep",
    ExpiredToken = "ExpiredToken",
    ExpiredTrial = "ExpiredTrial",
    FeaturesNotAuthorized = "FeaturesNotAuthorized",
    GenericException = "GenericException",
    GeoBlocked = "GeoBlocked",
    InitialisationInvalid = "InitialisationInvalid",
    InvalidCountryCode = "InvalidCountryCode",
    InvalidCustomTranslations = "InvalidCustomTranslations",
    InvalidDocumentFormatAndCountryCombination = "InvalidDocumentFormatAndCountryCombination",
    InvalidDocumentTitle = "InvalidDocumentTitle",
    InvalidDocumentTypeException = "InvalidDocumentTypeException",
    InvalidImageData = "InvalidImageData",
    InvalidSdkParameter = "InvalidSdkParameter",
    InvalidToken = "InvalidToken",
    MissingLogoCobrandingParameter = "MissingLogoCobrandingParameter",
    MissingSteps = "MissingSteps",
    ModuleLoadError = "ModuleLoadError",
    NetworkException = "NetworkException",
    PermissionsUnavailable = "PermissionsUnavailable",
    SdkVersionInsufficient = "SdkVersionInsufficient",
    UnsupportedError = "UnsupportedError",
    UnsupportedFeatureError = "UnsupportedFeatureError",
    UploadError = "UploadError",
    WelcomeMustBeFirstStep = "WelcomeMustBeFirstStep",
    WorkflowBiometricTokenStorageException = "WorkflowBiometricTokenStorageException",
    WorkflowInputError = "WorkflowInputError",
    WorkflowTaskAbandoned = "WorkflowTaskAbandoned",
    WorkflowTaskError = "WorkflowTaskError",
    WorkflowVersionMismatch = "WorkflowVersionMismatch"
}
export declare const BiometricTokenRetrievalException: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const CameraException: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const CameraNotDetected: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const CrossDeviceDesktopError: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const CrossDeviceRestartError: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const CrossDeviceVerificationAbortError: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const CrossDeviceVerificationInvalidError: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const DuplicateGenericDocument: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const DuplicateStep: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const ExpiredToken: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const ExpiredTrial: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const FeaturesNotAuthorized: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const GenericException: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const GeoBlocked: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const InitialisationInvalid: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const InvalidCountryCode: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const InvalidCustomTranslations: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const InvalidDocumentFormatAndCountryCombination: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const InvalidDocumentTitle: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const InvalidDocumentTypeException: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const InvalidImageData: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const InvalidSdkParameter: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const InvalidToken: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const MissingLogoCobrandingParameter: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const MissingSteps: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const ModuleLoadError: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const NetworkException: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const PermissionsUnavailable: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const SdkVersionInsufficient: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const UnsupportedError: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const UnsupportedFeatureError: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const UploadError: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const WelcomeMustBeFirstStep: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const WorkflowBiometricTokenStorageException: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const WorkflowInputError: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const WorkflowTaskAbandoned: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const WorkflowTaskError: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export declare const WorkflowVersionMismatch: {
    type: ErrorType;
    category: ErrorCategory;
    message: string;
};
export {};