types

Microblink Platform SDK

---

Microblink Platform SDK / api/types

api/types

Enumerations

InstructionType

Enumeration Members

Enumeration Member	Value
BlinkCard	"BlinkCard"
BlinkId	"BlinkId"
DocVer	"DocVer"
FaceMatch	"FaceMatch"
Form	"Form"

---

TransactionEventType

Enumeration Members

ERROR_SCAN_TIMEOUT

ERROR_SCAN_TIMEOUT: "ERROR_SCAN_TIMEOUT"

Interfaces

BlinkCardInteractiveFeedback

Extends

• CardVerificationResult

Properties

$type

$type: "BlinkCard"

cardData

cardData: object

Name	Type
expirationDate?	string
number?	string
owner?	string

Inherited from

CardVerificationResult.cardData

cardData.ImageBack?

optional cardData.ImageBack: object

Name	Type
contentType	string
fileName	string
rawImage	Uint8Array

Inherited from

CardVerificationResult.cardData.ImageBack

cardData.ImageFront?

optional cardData.ImageFront: object

Name	Type
contentType	string
fileName	string
rawImage	Uint8Array

Inherited from

CardVerificationResult.cardData.ImageFront

isCardNumberValid?

optional isCardNumberValid: boolean

Inherited from

CardVerificationResult.isCardNumberValid

livenessResult

livenessResult: object

Name	Type
back	object
back.handPresenceCheck	CheckResult
back.photocopyCheck	CheckResult
back.screenCheck	CheckResult
front	object
front.handPresenceCheck	CheckResult
front.photocopyCheck	CheckResult
front.screenCheck	CheckResult

Inherited from

CardVerificationResult.livenessResult

---

BlinkCardInteractiveInstruction

Properties

$type

$type: "BlinkCard"

anonymizationSettings

anonymizationSettings: AnonymizationSettings

licenseKey

licenseKey: string

sendCardImages

sendCardImages: boolean

---

BlinkIdInteractiveFeedback

Properties

$type

$type: "BlinkId"

extraction

extraction: ExtractionModel

extraction.FaceImage?

optional extraction.FaceImage: object

Name	Type
contentType	string
fileName	string
rawImage	Uint8Array

extraction.FullDocumentBackImage?

optional extraction.FullDocumentBackImage: object

Name	Type
contentType	string
fileName	string
rawImage	Uint8Array

extraction.FullDocumentFrontImage?

optional extraction.FullDocumentFrontImage: object

Name	Type
contentType	string
fileName	string
rawImage	Uint8Array

extraction.SignatureImage

extraction.SignatureImage: object

Name	Type
contentType	string
fileName	string
rawImage	Uint8Array

signedExtraction?

optional signedExtraction: SignedExtractionModel

---

BlinkIdInteractiveInstruction

Properties

$type

$type: "BlinkId"

isClientSideProcessing

isClientSideProcessing: boolean

licenseKey

licenseKey: string

---

DocVerInteractiveFeedback

Properties

$type

$type: "DocVer"

ImageBack?

optional ImageBack: object

Name	Type
contentType	string
fileName	string
rawImage	Uint8Array

ImageBarcode?

optional ImageBarcode: object

Name	Type
contentType	string
fileName	string
rawImage	Uint8Array

ImageFront?

optional ImageFront: object

Name	Type
contentType	string
fileName	string
rawImage	Uint8Array

---

DocVerInteractiveInstruction

Properties

$type

$type: "DocVer"

licenseKey

licenseKey: string

---

FaceMatchInteractiveFeedback

Extends

• FaceCaptureResult

Properties

$type

$type: "FaceMatch"

CapturedImage

CapturedImage: object

Name	Type
contentType	string
fileName	string
rawImage	Uint8Array

Inherited from

FaceCaptureResult.CapturedImage

EncryptedFile

EncryptedFile: object

Name	Type
contentType	string
fileName	string
rawImage	Uint8Array

Inherited from

FaceCaptureResult.EncryptedFile

---

FaceMatchInteractiveInstruction

Properties

$type

$type: "FaceMatch"

---

FormInteractiveFeedback

Extends

• ManualInputResult

Indexable

[key: string]: string | Record<string, string> | { contentType: string; fileName: string; rawImage: Uint8Array; }

Properties

$type

$type: "Form"

---

ManualInputInteractiveInstruction

Properties

$type

$type: "Form"

formFields

formFields: FormField[]

---

TransactionPositionResponse

Properties

createdOn

createdOn: Date

modifiedOn

modifiedOn: Date

organizationId

organizationId: string

processingStatus

processingStatus: ProcessingStatus

transactionId

transactionId: string

verificationStatus

verificationStatus: VerificationStatus

workflowId

workflowId: string

workflowInfo

workflowInfo: TransactionWorkflowInfo

workflowVersionId

workflowVersionId: string

---

TransactionResumeResponse

Properties

interactive?

optional interactive: InstructionParams

processingStatus

processingStatus: ProcessingStatus

retryDelay?

optional retryDelay: string

statusCode?

optional statusCode: StatusCode

statusSubcode?

optional statusSubcode: StatusSubcode

transactionId

transactionId: string

verificationStatus

verificationStatus: VerificationStatus

workflowInfo

workflowInfo: TransactionWorkflowInfo

---

TransactionStartResponse

Properties

authorization

authorization: string

createdOn

createdOn: Date

edgeApiUrl

edgeApiUrl: string

ephemeralKey

ephemeralKey: string

modifiedOn

modifiedOn: Date

organizationId

organizationId: string

transactionId

transactionId: string

workflowId

workflowId: string

workflowInfo

workflowInfo: TransactionWorkflowInfo

workflowVersionId

workflowVersionId: string

---

TransactionWorkflowInfo

Properties

completedInteractiveSteps

completedInteractiveSteps: InstructionType[]

completedStepIds

completedStepIds: number[]

currentStep

currentStep: InstructionType

currentStepAttemptCount

currentStepAttemptCount: 0

currentStepId

currentStepId: number

hasConditionalInteractiveStep

hasConditionalInteractiveStep: boolean

interactiveStepCount

interactiveStepCount: number

interactiveSteps

interactiveSteps: InstructionType[]

isKioskModeEnabled

isKioskModeEnabled: boolean

pendingStepIds

pendingStepIds: number[]

stepCount

stepCount: number

steps

steps: WorkflowStepInfo[]

---

WorkflowStepInfo

Properties

description?

optional description: string

id

id: number

name?

optional name: string

type

type: InstructionType

Type Aliases

D2DSessionInit

D2DSessionInit = object

Properties

expiresOn

expiresOn: string

joinUrl

joinUrl: string

---

D2DSessionState

D2DSessionState = object

Properties

devices

devices: object[]

Name	Type
id	string
isPrimary	boolean
joinKey?	string
lastSeenOn	string
status	"Unknown" | "Pending" | "Active" | "Inactive" | "Lost"

events

events: TransactionEvent[]

startedOn

startedOn: string

---

DocVerSubcode

DocVerSubcode = "DetectionFailed" | "ImagePreprocessingFailed" | "StabilityTestFailed" | "ScanningWrongSide" | "FieldIdentificationFailed" | "MandatoryFieldMissing" | "InvalidCharactersFound" | "ImageReturnFailed" | "BarcodeRecognitionFailed" | "MrzParsingFailed" | "ClassFiltered" | "UnsupportedClass" | "UnsupportedByLicense" | "AwaitingOtherSide" | "NotScanned"

---

FaceMatchSubcode

FaceMatchSubcode = "EYES_CLOSED" | "TOO_MANY_FACES"

---

InstructionFeedback

InstructionFeedback = object

Properties

interactive

interactive: DocVerInteractiveFeedback | BlinkCardInteractiveFeedback | BlinkIdInteractiveFeedback | FaceMatchInteractiveFeedback | FormInteractiveFeedback

---

InstructionParams

InstructionParams = DocVerInteractiveInstruction | BlinkCardInteractiveInstruction | BlinkIdInteractiveInstruction | FaceMatchInteractiveInstruction | ManualInputInteractiveInstruction

---

ProcessingStatus

ProcessingStatus = "Unknown" | "Pending" | "Interactive" | "InProgress" | "Complete" | "Retrying" | "Error"

---

StatusSubcode

StatusSubcode = DocVerSubcode | FaceMatchSubcode

---

TransactionEvent

TransactionEvent = object

Properties

eventId

eventId: string

eventPayload

eventPayload: string

JSON stringified object

eventType

eventType: TransactionEventType

sourceDeviceId

sourceDeviceId: string

timestamp

timestamp: number

---

VerificationStatus

VerificationStatus = "Unknown" | "Accept" | "Reject" | "Review"