Flow Version - v1.2

Setup Sdk

Launch Flow

fun launchSelfieVerification(
    activity: Activity,
    config: DigitalIdentitySelfieVerificationConfig,
    helpCenter: DigitalIdentityHelpCenter
)

Properties:

• activity: Host activity.

• config: Data required by the Digital Identity SDK. DigitalIdentitySelfieVerificationConfig contains the following properties:

  • baseUrl: OneKYC BE URL received from the OneKYC team.
  • token: OneKYC token received from the OneKYC authentication API.
  • correlationId: Unique identifier for the Face Verification flow.
  • theme: [Optional] It is an instance of the DigitalIdentitySelfieVerificationFlowTheme class. If we need to customize the themes for the Face Verification flow screens, then we need to pass the customized theme values. Refer to the theme customization section for more details.

• helpCenter: [Optional] Interface for help center option-related actions. Refer to the Help Center section for more details.

data class DigitalIdentitySelfieVerificationConfig(
    val baseUrl: String,
    val token: String,
    val correlationId: String,
    val theme: DigitalIdentitySelfieVerificationFlowTheme
)

Observe Callback

fun observeSelfieVerification(
    owner: LifecycleOwner, 
    resultCallback: (DocumentVerificationResult) -> Unit
)

Properties:

• owner: Lifecycle owner for callback observers.

• resultCallback: Face Verification flow completion status callback. On completion, we will get an instance of the DocumentVerificationResult class. It has the following properties:

  • correlationId: Correlation Id value which passed in the launchSelfieVerification method call.

  • status: Face Verification flow completion status. It is DocumentVerificationResultStatus enumeration type and has the following values:

    • COMPLETED: Face Verification is done.
    • NOT_COMPLETED: User dropped from Face Verification flow screens.
    • ERROR: Error in Face Verification verification.

  • submissionId: [Optional] Reference number for Face Verification documents. We will get this value when the status is COMPLETED.

  • extra: [Optional] Type of DigitalIdentityExtraData class. It has the following properties:

    • errorCode: It's a DigitalIdentityFlowErrorCode enum type.
      • CAMERA - User dropped the flow from the camera error bottom sheet
      • PERMISSION - User denied camera permission
      • NETWORK - User dropped the flow from the network error bottom sheet
      • API - User dropped the flow from the api error bottom sheet
      • USER_CANCELLED - User dismissed the flow
      • VERIFICATION - Document verification has been completed with errors
    • detailedErrorCode: Subcategory of main errorCode.
    • errorMessage: More details about the error.

DocumentVerificationResult(
    correlationId: String,
    status: DocumentVerificationResultStatus,
    submissionId: String,
    extra: DigitalIdentityExtraData?
)

DigitalIdentityExtraData(
    errorCode: DigitalIdentityFlowErrorCode,
    detailedErrorCode: String,
    errorMessage: String
)

enum class DocumentVerificationResultStatus {
    COMPLETED, NOT_COMPLETED, ERROR
}

Theming Reference

The following screens can be customized using the SDK’s theming system. See Theming Overview for more details.

Selfie Camera

Class name: DigitalIdentitySelfieCameraScreenTheme

Screen Annotations	Mapped Properties
	closeIcon guidelineText title captureStartText cameraScanFeedbacks capturePrepareCard & captureExhaustedCard 6.1. background 6.2. title 6.3. infoList 6.3.1. topImage 6.3.2. text 6.4. primaryCTA 6.5. helpCTA 6.6. secondaryCTA

Selfie Capture Guideline

Class name: DigitalIdentityGuidelineDialogTheme

Screen Annotations	Mapped Properties
	closeButton background title autoCaptureinfoBackground autoCaptureInfoTitle autoCaptureInfoDescription allowedIllustration allowedCardTitle notAllowedIllustration notAllowedCardTitle captureInstructions

Selfie Verification

Class name: DigitalIdentityVerificationScreenTheme

Screen Annotations	Mapped Properties
	statusBar closeIcon background verificationTitle timerBackground timerText timeOutTitle timerLoaderIcon

Selfie Failure

Class name: DigitalIdentityChallengeFailureScreenTheme

Screen Annotations	Mapped Properties
	statusBar appBar 2.1. navigationIcon 2.2. title headerBackground widgetIcon widgetBackground failureCard 6.1. cardBackground 6.2. title 6.3. description 6.4. guideOne & guideTwo 6.4.1. title 6.4.2. icon 6.4.3. description 6.5. separator exhaustedCard (has same configuration as failureCard) retryButton helpButton

Common Dialogs