Flow Version - v1.2

Setup Sdk

Launch Flow

Future<bool> launchKYCVerification({
  required DigitalIdentityKYCVerificationConfig config,
  required DigitalIdentityHelpCenter helpCenter,
  required Function(DocumentVerificationResult)? resultCallback,
}) async { }

Properties:

• Config (DigitalIdentityKYCVerificationConfig): This class contains the required configuration to launch
  the Identity Verification verification flow using the DigitalIdentity SDK. that contains the following
  information:
  • baseUrl: This is the server URL specific to the partner using the format https://<domain>.
    Example: https://onekyc.ky.id.sandbox.gopayapi.com/
  • token: The unique token for Digital Identity KYC, provided by the user token API for the
    specific partner.
  • correlationId: A unique identifier used to track and correlate events throughout the Identity
    Verification flow. It helps in debugging, logging, and monitoring user sessions.
  • language: The language setting of the KYC SDK, defined by the UserLanguage type, which
    controls localization and translations during the Kyc Verification flow.
  • theme: The theme parameter is optional, and its default value is null. If not provided, the SDK
    uses the default theme.
    The theme parameter is an instance of the DigitalIdentityKYCVerificationFlowTheme class. It allows you
    to customize the look and feel of the KYC flow screens. By providing a custom theme, you can
    modify various UI elements, such as colors, fonts, and styles, to match your application's
    branding requirements.
    Here's what each property represents:
    • onboarding (DigitalIdentityOnboardingScreenTheme?): Defines the theme for the
      KTP Scan onboarding screen.
    • camera (DigitalIdentityCameraScreenTheme?): Defines the theme for the KTP And
      Selfie camera screen, where users take their KTP for scan And Selfie For Identification.
      Also Allowed to customised the progress bar
    • ktpGuideline (DigitalIdentityGuidelineScreenTheme?): Controls the theme for the
      KTP guideline screen, which provides instructions on taking a proper KTP.
    • selfieGuideline (DigitalIdentityGuidelineScreenTheme?): Controls the theme for the
      selfie guideline screen, which provides instructions on taking a proper selfie.
    • uploadStatus (DigitalIdentityDocumentUploadStatusScreenTheme?): Manages the
      theme for the upload screen, where users see the document uploading progress.
    • commonDialog (DigitalIdentityCommonDialogTheme?): Handles the theme for Error /
      Informative dialogs used throughout the KYC Verification process.
• helpCenter: [Optional] Interface for help center option-related actions. Refer to the Help Center section for more details.
• resultCallback: A redirect link that the SDK uses to notify about the status of the KYC submission
  when it succeeds.
  • correlationId: A unique identifier for tracking the document verification request.
  • submissionId (String): The submission ID assigned if the document verification is successful.
  • status (DocumentVerificationResultStatus): Enum that depicts if any user completed the flow
    or dropped out in between. It has the following values:
    • COMPLETED
    • ERROR
    • NOT_COMPLETED
  • extras (DigitalIdentityExtraData): This class contains error-related information for failed
    document verification attempts that contains the following information:
    • errorCode (DigitalIdentityFlowErrorCode?): Represents the type of error encountered
      in the kyc verification flow
      • CAMERA: Error related to the camera.
      • PERMISSION: Error due to permission issues.
      • NETWORK: Network-related error.
      • USER_CANCELLED: The user canceled the KYC flow.
      • VERIFICATION: When Document verification has errors.
      • MLMODEL_DOWNLOAD: When user dropped from ML download failure error
        dialog.
    • detailedErrorCode (String?): String depicting detailed information regarding the error
      (could be used to log and analyse)
    • errorMessage (String?): String depicting detailed information regarding the error
      (could be used to log and analyse)

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