Flow Version - v1.2

Setup Sdk

Launch Flow

let config = DigitalIdentityKTPScanConfig(
    baseUrl: <DigitalIdentity BE Base Url>,
    token: <DigitalIdentity Token>,
    correlationId: <Coorrelation Id>,
    language: <App Language>,
    theme: <KTP Scan flow theme>
)

DigitalIdentitySdk.shared.launchKTPScan(
    config: config,
    viewcontroller: <viewcontroller instance>
) { result in
    // Completion handler
}

Method name: launchKTPScan

Parameters:

• config: Instance of DigitalIdentityKTPScanConfig
  • baseUrl: DigitalIdentity BE URL received from the DigitalIdentity team.
  • token: DigitalIdentity token received from the DigitalIdentity authentication API.
  • correlationId: Unique identifier for the KTP Scan flow.
  • language: App language.
  • theme: The optional DigitalIdentityKTPScanFlowTheme class instance parameter allows for theme customization of the KTP Scan flows screen. Detailed information can be found in the theme customization section.
• viewcontroller: An instance of the view controller used to display the KTP Scan flow screens.
• completion: KTP Scan flow completion status block. In completion, you will get an instance of the DigitalIdentityDocumentVerificationResult class. It has the following properties:
  • correlationId: Correlation Id value which was passed in the launchKTPScan method call.
  • status: KTP Scan flow completion status. Its DigitalIdentityDocumentVerificationResultStatus enum type and has the following values:
    • completed: KTP Scan is done.
    • error: Error in KTP Scan verification.
    • notCompleted: User dropped from KTP Scan flow screens.
  • submissionId: Optional value. A reference number associated with the KTP Scan documents.
  • 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.

KTP 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: DigitalIdentityKTPCameraScreenTheme

Screen Annotations

Mapped Properties

background backButton viewGuide title 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 feedback 6.1. background 6.2. neutral/error/success & feedbacks changeCaptureMode 7.1. closeButton 7.2. card 7.3. title 7.4. description 7.5. primaryCTA 7.6. secondaryCTA shutterButton

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

KTP Verification & KTP Verification Time Exceed

Class name: DigitalIdentityDocumentVerificationScreenTheme

Screen Annotations	Mapped Properties
	background containerCard backButton inprogressTitle verificationTimer timeExceedTitle timeExceedImage

Common Dialogs