/onfido-capacitor

Primary LanguageSwift

Onfido Capacitor Plugin

A capacitor based wrapper for Onfido mobile SDKs

API

start(...)

start(options: OnfidoConfig) => Promise<OnfidoResult | OnfidoError>
Param Type
options OnfidoConfig

Returns: Promise<OnfidoResult | OnfidoError>

Interfaces

OnfidoError

Prop Type
code string

Type Aliases

OnfidoResult

{ document?: { front: { id: string; }; back?: { id: string; }; nfcMediaId?: { id: string; }; }; face?: { id: string; variant: OnfidoCaptureType; }; }

OnfidoConfig

{ sdkToken: string; workflowRunId?: string; flowSteps: OnfidoFlowSteps; hideLogo?: boolean; logoCoBrand?: boolean; enableNFC?: boolean; localisation?: { ios_strings_file_name?: string; }; }

OnfidoFlowSteps

{ welcome?: boolean; captureDocument?: { countryCode?: string; alpha2CountryCode?: string; docType?: OnfidoDocumentType; }; captureFace?: { type: OnfidoCaptureType; }; }

Enums

OnfidoCaptureType

Members Value
PHOTO 'PHOTO'
VIDEO 'VIDEO'
MOTION 'MOTION'

OnfidoDocumentType

Members Value
PASSPORT 'PASSPORT'
DRIVING_LICENCE 'DRIVING_LICENCE'
NATIONAL_IDENTITY_CARD 'NATIONAL_IDENTITY_CARD'
RESIDENCE_PERMIT 'RESIDENCE_PERMIT'
VISA 'VISA'
WORK_PERMIT 'WORK_PERMIT'
GENERIC 'GENERIC'