Constructor Detail

• OnboardingListenerWrapper

  OnboardingListenerWrapper(IncodeWelcome.OnboardingListener onboardingListener, Boolean isSubmitOnlyMode)

Method Detail

• onSuccess

   Unit onSuccess()

  Called when onboarding succeeds

• onEvent

   Unit onEvent(Event event, HashMap<String, Object> eventData)

  Since:

  Deprecated in 5.17.0

• onEvent

   Unit onEvent(InterviewEventResult eventResult)

• onUserCancelled

   Unit onUserCancelled()

  This method is called when user cancels the flow by pressing back

• onInterrupted

   Unit onInterrupted()

  Called when Android destroys the SDK's hosted Activity stack externally (not a configuration change), for example when the app is backgrounded and Android destroys the Activity to reclaim memory.

• onOnboardingSectionCompleted

   Unit onOnboardingSectionCompleted(String flowTag)

  Called when an onboarding section is completed.

• onAntifraudCompleted

   Unit onAntifraudCompleted(AntifraudResult antifraudResult)

• onDynamicFormsCompleted

   Unit onDynamicFormsCompleted(DynamicFormsResult dynamicFormsResult)

• onGlobalWatchlistProcessed

   Unit onGlobalWatchlistProcessed(GlobalWatchlistResult globalWatchlistResult)

  Called when the global watchlist is processed

• onOnboardingSessionCreated

   Unit onOnboardingSessionCreated(String token, String interviewId, String region)

  Called when onboarding session is created successfully

• onQRScanCompleted

   Unit onQRScanCompleted(QRScanResult qrScanResult)

  Called when QR scan is completed

• onIdValidationCompleted

  @Deprecated(message = "Superseded in 4.1.1 by the per-side callbacks `onIdFrontCompleted(IdScanResult)` and `onIdBackCompleted(IdScanResult)` on `OnboardingListener`. Override those instead to receive each side individually as it's scanned. `IdValidationResult` is itself deprecated.") Unit onIdValidationCompleted(IdValidationResult idValidationResult)

  Since:

  Deprecated in 4.1.1

• onCurpValidationCompleted

   Unit onCurpValidationCompleted(CurpValidationResult curpValidationResult)

  This method is called when CURP validation is finished

• onDocumentValidationCompleted

   Unit onDocumentValidationCompleted(DocumentType documentType, DocumentValidationResult documentValidationResult)

  Called when address validation is completed

• onSelfieScanReady

   Unit onSelfieScanReady(NonUiSelfieScanController controller)

  Called when selfie scan controller is ready to be used.

• onSelfieScanCompleted

   Unit onSelfieScanCompleted(SelfieScanResult selfieScanResult)

  Called when selfie scan step is completed

  For per-attempt reporting that fires after every individual capture attempt (including intermediate failures), use onSelfieScanAttemptCompleted.

• onSelfieScanAttemptCompleted

   Unit onSelfieScanAttemptCompleted(SelfieScanResult selfieScanResult)

  Called after every individual selfie capture attempt, including intermediate failures such as spoof detection, lenses, mask, closed eyes, head cover, or insufficient brightness.

  The terminal attempt is signaled when SelfieScanResult.allAttemptsExhausted is true or when the attempt succeeds; for terminal-only reporting, use onSelfieScanCompleted instead.

• onFaceMatchCompleted

   Unit onFaceMatchCompleted(FaceMatchResult faceMatchResult)

  Called when selfie scan step is completed

• onFaceAuthenticationCompleted

   Unit onFaceAuthenticationCompleted(FaceAuthenticationResult faceAuthenticationResult)

  Called when com.incode.welcome_sdk.modules.FaceAuthentication is completed

  Since:

  5.40.0

• onGovernmentValidationCompleted

   Unit onGovernmentValidationCompleted(Boolean success)

  Called when Government validation is completed

  true if the validation was successful, false otherwise

• onSignatureCollected

   Unit onSignatureCollected(SignatureFormResult signatureFormResult)

  Called when collect signature is completed

• onUserConsentCompleted

   Unit onUserConsentCompleted()

  Called when add user consent is completed

• onCombinedConsentCompleted

   Unit onCombinedConsentCompleted(CombinedConsentResult combinedConsentResult)

• onMachineLearningConsentCompleted

   Unit onMachineLearningConsentCompleted(MachineLearningConsentResult result)

• onCustomWatchlistProcessed

   Unit onCustomWatchlistProcessed(CustomWatchlistResult customWatchlistResult)

• onAddPhoneCompleted

   Unit onAddPhoneCompleted(PhoneNumberResult phoneNumberResult)

  Called when add phone is completed

• onAddEmailCompleted

   Unit onAddEmailCompleted(EmailAddressResult emailAddressResult)

  Called when add email is completed

• onEstimatedWaitingTime

   Unit onEstimatedWaitingTime(Integer waitingTimeInSeconds)

  Called only once with the estimated waiting time in the queue. Waiting time is in seconds.

• onGeolocationFetched

   Unit onGeolocationFetched(GeolocationResult geolocationResult)

  Called when the geolocation is fetched

• onIntroCompleted

   Unit onIntroCompleted()

  Called when intro is completed

• onAddNameCompleted

   Unit onAddNameCompleted(NameResult nameResult)

  Called when add name is completed

• onApproveCompleted

   Unit onApproveCompleted(ApproveResult approveResult)

  This method is called when user approval is completed

• onResultsShown

   Unit onResultsShown(UserScoreResult userScoreResult)

  This method is called when show results is completed

• onUserAcceptedVideoSelfie

   Unit onUserAcceptedVideoSelfie()

  This method is called when user accepts video selfie recording

• onVideoRecorded

   Unit onVideoRecorded(VideoSelfieResult videoSelfieResult)

  This method is called when video selfie recording is finished and uploaded.

• onCaptchaCollected

   Unit onCaptchaCollected(CaptchaResult captchaResult)

  This method is called when captcha is entered

• onQueuePositionChanged

   Unit onQueuePositionChanged(Integer newQueuePosition)

  Called when queue position is updated. 0 means its your turn, 1 means there is one person in queue in front of you etc.

• onConferenceEnded

   Unit onConferenceEnded()

  Called when video conference ends

• onGeolocationUnavailable

   Unit onGeolocationUnavailable(Throwable error)

  Called when the user geolocation is not available

• onIdFrontCompleted

   Unit onIdFrontCompleted(IdScanResult frontIdScanResult)

  Called when the front of an ID or a Passport Photo page scan is completed.

  For per-attempt reporting that fires after every individual capture attempt (including intermediate failures), use onIdFrontAttemptCompleted.

• onIdBackCompleted

   Unit onIdBackCompleted(IdScanResult backIdScanResult)

  Called when the back of an ID scan is completed.

  For per-attempt reporting that fires after every individual capture attempt (including intermediate failures), use onIdBackAttemptCompleted.

• onIdFrontAttemptCompleted

   Unit onIdFrontAttemptCompleted(IdScanResult frontIdScanResult)

  Called after every individual front ID or Passport capture attempt, including intermediate failures such as glare, blur, wrong document side, or spoof detection.

  The terminal attempt is signaled when IdScanResult.allAttemptsExhausted is true or when the attempt succeeds; for terminal-only reporting, use onIdFrontCompleted instead.

• onIdBackAttemptCompleted

   Unit onIdBackAttemptCompleted(IdScanResult backIdScanResult)

  Called after every individual back ID capture attempt, including intermediate failures such as glare, blur, wrong document side, or spoof detection.

  The terminal attempt is signaled when IdScanResult.allAttemptsExhausted is true or when the attempt succeeds; for terminal-only reporting, use onIdBackCompleted instead.

• onIdScanReady

   Unit onIdScanReady(NonUiIdScanController controller)

  Called when the NonUiIdScanController is ready to be used.

• onIdProcessed

   Unit onIdProcessed(IdProcessResult idProcessResult)

• onNfcScanCompleted

   Unit onNfcScanCompleted(NfcScanResult nfcScanResult)

  Called when the NFC chip on an ID's scan is completed.

• onSSLPinningFailed

   Unit onSSLPinningFailed()

  This method is called when SSL Pinning Certificate fails

• onEKYCChecksCompleted

   Unit onEKYCChecksCompleted(EKYCResult ekycResult)

• onAESCompleted

   Unit onAESCompleted(AESResult aesResult)

  Called when AES module is completed

• onQESCompleted

   Unit onQESCompleted(QESResult qesResult)

  Called when QES module is completed

• onError

   Unit onError(Throwable error)

  Forwards to the primary onboardingListener in all modes (including submit-only).

  Mirrors onSuccess, onUserCancelled, onEvent, and onOnboardingSectionCompleted, which all route through the primary listener rather than the optional delegatedOnboardingListener. In non-submit-only mode delegatedOnboardingListener is the same instance as onboardingListener, so this is behavior-preserving; in submit-only mode delegatedOnboardingListener is null, and prior to this change onError was silently swallowed.

• onEKYBChecksCompleted

   Unit onEKYBChecksCompleted(EKYBResult ekybResult)

  Called when EKYB checks are completed

• onIdInfoCompleted

   Unit onIdInfoCompleted(IdInfoResult idInfoResult)

• onTaxIdValidationCompleted

   Unit onTaxIdValidationCompleted(Boolean isSuccess)

  Called when Tax ID validation is completed.

  true if the validation was successful, false otherwise.

• onCustomModuleStarted

   Unit onCustomModuleStarted(String callbackName, Function1<CustomModuleStatus, Unit> onCustomModuleCompleted)

  Called when a custom module is encountered in the onboarding workflow.

  Since:

  5.42.0