Face Verification

Flow Version - v1.2

Setup Sdk

Set up the SDK

Launch Flow


let config = DigitalIdentitySelfieVerificationConfig(
                           baseUrl: <DigitalIdenity BE Base Url>,
                           token: <DigitalIdenity Token>,
                           correlationId: <Coorrelation Id>,
                           language: <App Language>,
                           theme: <Selfie Verification flowtheme>)

DigitalIdentitySdk.shared.launchSelfieVerification(
                            config: config,
                            viewcontroller: <viewcontroller instance>,
                            helpCenter: DigitalIdentityHelpCenterDelegate)
{ result in

}

Method name: `launchSelfieVerification`

Parameters:

config: Instance of DigitalIdentitySelfieLivenessConfig
- baseUrl: DigitalIdentity BE url received from the OneKyc team
- token: DigitalIdentity token received from the DigitalIdentity authentication API
- correlationId: Unique identifier for the Selfie Verification flow.
- language: App language.
- theme: The DigitalIdentitySelfieFlowTheme class is an optional parameter that can be used to customize the theme of the Selfie Verification flow screens. Theme customization values can be passed as an instance of this class to modify the Selfie Verification flow screens. More information on theme customization can be found in the theme customization section.
viewcontroller: View controller instance to present the Selfie Verification flow-related screens
helpCenter: An instance of a class that conforms to DigitalIdentityHelpCenterDelegate delegate. Help center option-related actions will be triggered via this delegate. Refer to this section for more details.
completion: Selfie Verification flow completion status block. In completion we will get instance of the DigitalIdentityDocumentVerificationResult class. It has following properties
- correlationId: Correlation Id value which passed in the launchSelfieVerification method call.
- status: Selfie Verification flow completion status. Its DigitalIdentityDocumentVerificationResultStatus enum type and has following values
  - completed: Selfie Verification is done
  - error: Error in Selfie Verification
  - notCompleted: User dropped from Selfie Verification flow screens
- submissionId: Optional value. Reference number for Selfie Verification documents. We will get this value when user made the submission
- extra: Optional value and type of DigitalIdentityResultExtraData class. Sdk will send this property when the user drops from the flow. It has the following properties
  - errorCode: It's a DigitalIdentityFlowErrorCode enum type and it has following values
    - CAMERA - User dropped the flow from the camera error bottom sheet
    - PERMISSION - User denied camera permission
    - NETWORK - User dropped the flow from the api error bottom sheet
    - USER_CANCELLED - User dismissed the flow
    - VERIFICATION - Document verification has been completed with errors
  - errorMessage: More details about the error

Theming Reference

The following screens can be customized using the SDK’s theming system.

Selfie Camera

Class name: DigitalIdentitySelfieCameraScreenTheme

Screen Annotations	Mapped Properties
	backButton viewGuide title feedback 4.1. error/success & feedbacks captureExhausted 5.1. background 5.2. title 5.3. infoItems 5.4. primaryCTA 5.5. secondaryCTA

Selfie Guideline

Class name: DigitalIdentityGuidelineScreenTheme

Screen Annotations	Mapped Properties
	background closeButton guideline.autoCaptureTitle / guideline.manualCaptureTitle guideline.autoCaptureInfoView guideline.autoCaptureInfoTitle guideline.autoCaptureInfoDescription guideline.allowedCard guideline.allowedCardTitle guideline.notAllowedCard guideline.notAllowedCardTitle guideline.autoCaptureInstructions / guideline.manualCaptureInstructions guideline.bulletPoint

Document Verification Inprogress & Document Verification time exceed

Class name: DigitalIdentityDocumentVerificationScreenTheme

Screen Annotations	Mapped Properties
	background containerCard backButton inprogressTitle verificationTimer timeExceedTitle timeExceedImage

Verification Failed & Verification Limit Exhausted

Class name: DigitalIdentityDocumentVerificationFailedScreenTheme

Screen Annotations	Mapped Properties
	background backButton headerView headerTitle infoCard failureLogo failureTitle failureDescription attemptExhaustedTitle attemptExhaustedDescription guidelineInfo 11.1. icon 11.2. title 11.3. description attemptLeft retakeButton helpPrimaryButton helpSecondaryButton