types

Microblink Platform SDK

---

Microblink Platform SDK / state/types

state/types

Enumerations

MachineEventTypes

Enumeration Members

Enumeration Member	Value
ABORT	"abort"
COMPLETE	"complete"
CONTINUE	"continue"
ERROR	"error"
RESET	"reset"
RETRY	"retry"
RUN_D2D	"run_d2d"
SET_STATE	"set_state"
START	"start"
SUBMIT_FEEDBACK	"submit_feedback"
UPDATE_TRANSACTION_STATE	"update_transaction_state"
UPDATE_UPLOAD_PROGRESS_CONTEXT	"update_upload_progress_context"

---

MachineStates

Enumeration Members

Enumeration Member	Value
cameraPermissionError	"cameraPermissionError"
cameraSelection	"cameraSelection"
cameraSelectionError	"cameraSelectionError"
capabilityError	"capabilityError"
d2dAbort	"d2dAbort"
d2dAddNewDevice	"d2dAddNewDevice"
d2dConnect	"d2dConnect"
d2dConnectError	"d2dConnectError"
d2dFlowEnd	"d2dFlowEnd"
d2dIdle	"d2dIdle"
d2dInit	"d2dInit"
d2dInitError	"d2dInitError"
executeCapability	"executeCapability"
executeCapabilityError	"executeCapabilityError"
flowEnd	"flowEnd"
gatherConsent	"gatherConsent"
gatherConsentError	"gatherConsentError"
idle	"idle"
requestCameraPermissions	"requestCameraPermissions"
resumeTransaction	"resumeTransaction"
resumeTransactionError	"resumeTransactionError"
retrySubmitFeedback	"retrySubmitFeedback"
reviewProgress	"reviewProgress"
startFlow	"start"
startTransaction	"startTransaction"
startTransactionError	"startTransactionError"
submitFeedback	"submitFeedback"
submitTransactionError	"submitTransactionError"

Interfaces

MachineContext

Properties

apiConfig

apiConfig: ProxyConfig | TransactionConfig

apiManager

apiManager: ApiManager

backCameraId

backCameraId: string

consentData

consentData: ConsentData

currentInstruction

currentInstruction: InstructionParams

currentInstructionFeedback

currentInstructionFeedback: InstructionFeedback

d2dAbandoned

d2dAbandoned: boolean

d2dQrCodeAutogenCount

d2dQrCodeAutogenCount: number

d2dQrCodeExpiresAt

d2dQrCodeExpiresAt: Date

d2dUrl

d2dUrl: string

deviceId

deviceId: string

enableD2D

enableD2D: boolean

frontCameraId

frontCameraId: string

isCameraGoodEnough

isCameraGoodEnough: boolean

isCameraGranted

isCameraGranted: boolean

isPrefetching

isPrefetching: Promise<void>

mode

mode: WorkingMode

onResult()?

optional onResult: (result) => void

Parameters

Parameter	Type
result	InstructionFeedback

Returns

void

processingStatus

processingStatus: ProcessingStatus

reason?

optional reason: ERROR_SCAN_TIMEOUT

resourcesPath?

optional resourcesPath: string

retryDelay

retryDelay: string

shouldActivateCurrentDevice

shouldActivateCurrentDevice: boolean

showProgress

showProgress: boolean

statusSubcode

statusSubcode: StatusSubcode

uploadProgress

uploadProgress: number

verificationStatus

verificationStatus: VerificationStatus

workflowInfo

workflowInfo: TransactionWorkflowInfo

Type Aliases

MachineEvents

MachineEvents = { type: START; } | { shouldActivateCurrentDevice: boolean; showProgress: boolean; type: CONTINUE; } | { type: RUN_D2D; } | { result: InstructionFeedback; type: SUBMIT_FEEDBACK; } | { type: RETRY; } | { reason?: TransactionEventType; type: ERROR; } | { reason?: TransactionEventType; type: ABORT; } | { data: Partial<MachineContext>; type: SET_STATE; } | { type: RESET; } | { type: COMPLETE; verificationStatus: VerificationStatus; } | { data: { processingStatus: ProcessingStatus; verificationStatus: VerificationStatus; }; type: UPDATE_TRANSACTION_STATE; } | { progress: number; type: UPDATE_UPLOAD_PROGRESS_CONTEXT; }

---

MachineInputs

MachineInputs = object

Properties

apiConfig

apiConfig: IdvFlowProps["apiConfig"]

consentData

consentData: ConsentData

enableD2D?

optional enableD2D: boolean

mode

mode: WorkingMode

resourcesPath?

optional resourcesPath: string

---

WorkingMode

WorkingMode = "classic" | "d2d"