Flow Version - v1.2

Setup Sdk

Launch Flow

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

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

} 

Method name: launchKYCVerification

Parameters:

• config: Instance of DigitalIdentityKYCVerificationConfig
  • baseUrl: DigitalIdentity BE url received from the DigitalIdentity team
  • token: DigitalIdentity token received from the DigitalIdentity authentication API
  • correlationId: Unique identifier for the KYC Verification flow.
  • language: App language.
  • theme: The DigitalIdentityKYCVerificationFlowTheme class is an optional parameter that can be used to customize the theme of the KYC Verification flow screens. Theme customization values can be passed as an instance of this class to modify the KYC Verification flow screens. More information on theme customization can be found in the theme customization section.
• viewcontroller: View controller instance to present the KYC 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: KYC 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 launchKYCVerification method call.
  • status: KYC Verification flow completion status. Its DigitalIdentityDocumentVerificationResultStatus enum type and has following values
    • completed: KYC Verification is done
    • error: Error in KYC Verification
    • notCompleted: User dropped from KYC Verification flow screens
  • submissionId: Optional value. Reference number for KYC 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
    • errorMessage: More details about the error

Theming Reference

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

KYC Onboarding

Class name: DigitalIdentityOnboardingScreenTheme

Screen Annotations	Mapped Properties
	background backButton card title subtitle ktpInstructionImage otherInstructions 7.1. background 7.2. icon 7.3. description footerView termsInfo captureButton

KTP Camera

Class name: DigitalIdentityCameraScreenTheme

Screen Annotations

Mapped Properties

progressBar ktp.background ktp.backButton ktp.viewGuide ktp.title ktp.captureIndicatorViewColor: While tapping the Capture button in manual capture mode, a fraction of a second camera screen background color will updated to a different color to indicate the image captured. To customize this color we can use this property ktp.feedback 7.1. background 7.2. neutral/error/success & feedbacks ktp.changeCaptureMode 8.1. closeButton 8.2. card 8.3. title 8.4. description 8.5. primaryCTA 8.6. secondaryCTA ktp.shutterButton

Selfie Camera

Class name: DigitalIdentityCameraScreenTheme

Screen Annotations	Mapped Properties
	selfie.backButton selfie.viewGuide selfie.title selfie.feedback 4.1. background 4.2. error/success & feedbacks selfie.prepareCard 5.1. background 5.2. title 5.3. infoItems 5.4. primaryCTA 5.5. secondaryCTA selfie.captureExhausted 6.1. background 6.2. title 6.3. infoItems 6.4. primaryCTA 6.5. secondaryCTA

KTP 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

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 Uploading & Document Upload Failure

Class name: DigitalIdentityDocumentUploadStatusScreenTheme

Screen Annotations	Mapped Properties
	background backButton uploadingCard 3.1. background 3.2. icon 3.3. title 3.4. description 3.5. spinner

Common Dialogs