Skip to main content
Version: v1.9.x

types

Microblink Platform SDK


Microblink Platform SDK / components/types

components/types

Type Aliases​

CustomScreenStep​

CustomScreenStep = object

Properties​

id​

id: number

isCompleted​

isCompleted: boolean

type​

type: InstructionType

wfStepDescription?​

optional wfStepDescription: string

wfStepName?​

optional wfStepName: string


EndScreenActions​

EndScreenActions = object

Properties​

finish()​

finish: () => void

Returns​

void


EndScreenState​

EndScreenState = object

Properties​

status​

status: VerificationStatus | undefined

transactionId​

transactionId: string | undefined


ProgressScreenActions​

ProgressScreenActions = object

Properties​

cancel()​

cancel: () => void

Returns​

void

continueFlow()​

continueFlow: () => void

Triggers the continuation of the flow, allowing users to move from the progress screen to the next step in the verification process.

IMPORTANT: Do NOT immediately invoke this action within progressScreen callback, as it may cause unintended side effects such as inability for user to exit step execution.

Returns​

void


ProgressScreenState​

ProgressScreenState = object

Properties​

steps​

steps: CustomScreenStep[]


StartScreenActions​

StartScreenActions = object

Properties​

cancel()​

cancel: () => void

Returns​

void

start()​

start: () => void

Returns​

void


StartScreenState​

StartScreenState = object

Properties​

steps​

steps: CustomScreenStep[]