Constructor Detail

• OnboardingListenerWrapper

  OnboardingListenerWrapper(IncodeWelcome.OnboardingListener onboardingListener, Boolean isSubmitOnlyMode)

Method Detail

• onSuccess

   Unit onSuccess()

• onEvent

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

  Called when event is being sent to the server

  Parameters:

  event -

  • event

  eventData -

  • additional parameters sent within event

• onEvent

   Unit onEvent(InterviewEventResult eventResult)

• onUserCancelled

   Unit onUserCancelled()

• onOnboardingSectionCompleted

   Unit onOnboardingSectionCompleted(String flowTag)

• onAntifraudCompleted

   Unit onAntifraudCompleted(AntifraudResult antifraudResult)

• onDynamicFormsCompleted

   Unit onDynamicFormsCompleted(DynamicFormsResult dynamicFormsResult)

• onGlobalWatchlistProcessed

   Unit onGlobalWatchlistProcessed(GlobalWatchlistResult globalWatchlistResult)

  Called when the global watchlist is processed

  Parameters:

  globalWatchlistResult - global watchlist result

• onOnboardingSessionCreated

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

• onQRScanCompleted

   Unit onQRScanCompleted(QRScanResult qrScanResult)

• onIdValidationCompleted

  @Deprecated(message = "") Unit onIdValidationCompleted(IdValidationResult idValidationResult)

• onCurpValidationCompleted

   Unit onCurpValidationCompleted(CurpValidationResult curpValidationResult)

• onDocumentValidationCompleted

   Unit onDocumentValidationCompleted(DocumentType documentType, DocumentValidationResult documentValidationResult)

• onSelfieScanReady

   Unit onSelfieScanReady(NonUiSelfieScanController controller)

  Called when selfie scan controller is ready to be used.

  Parameters:

  controller - Instance of NonUiSelfieScanController

• onSelfieScanCompleted

   Unit onSelfieScanCompleted(SelfieScanResult selfieScanResult)

  Called when selfie scan step is completed

  Parameters:

  selfieScanResult - Result of the face scan step that includes spoof confidence and path to the face img

• onFaceMatchCompleted

   Unit onFaceMatchCompleted(FaceMatchResult faceMatchResult)

• onFaceAuthenticationCompleted

   Unit onFaceAuthenticationCompleted(FaceAuthenticationResult faceAuthenticationResult)

• onGovernmentValidationCompleted

   Unit onGovernmentValidationCompleted(Boolean success)

• onSignatureCollected

   Unit onSignatureCollected(SignatureFormResult signatureFormResult)

• onUserConsentCompleted

   Unit onUserConsentCompleted()

• onCombinedConsentCompleted

   Unit onCombinedConsentCompleted(CombinedConsentResult combinedConsentResult)

• onMachineLearningConsentCompleted

   Unit onMachineLearningConsentCompleted(MachineLearningConsentResult result)

• onCustomWatchlistProcessed

   Unit onCustomWatchlistProcessed(CustomWatchlistResult customWatchlistResult)

• onAddPhoneCompleted

   Unit onAddPhoneCompleted(PhoneNumberResult phoneNumberResult)

• onAddEmailCompleted

   Unit onAddEmailCompleted(EmailAddressResult emailAddressResult)

  Called when add email is completed

  Parameters:

  emailAddressResult - Result of Email module

• onEstimatedWaitingTime

   Unit onEstimatedWaitingTime(Integer waitingTimeInSeconds)

• onGeolocationFetched

   Unit onGeolocationFetched(GeolocationResult geolocationResult)

• onIntroCompleted

   Unit onIntroCompleted()

• onAddNameCompleted

   Unit onAddNameCompleted(NameResult nameResult)

  Called when add name is completed

  Parameters:

  nameResult - Result of Name Capture module

• onApproveCompleted

   Unit onApproveCompleted(ApproveResult approveResult)

• onResultsShown

   Unit onResultsShown(UserScoreResult userScoreResult)

• onUserAcceptedVideoSelfie

   Unit onUserAcceptedVideoSelfie()

• onVideoRecorded

   Unit onVideoRecorded(VideoSelfieResult videoSelfieResult)

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

• onCaptchaCollected

   Unit onCaptchaCollected(CaptchaResult captchaResult)

• onQueuePositionChanged

   Unit onQueuePositionChanged(Integer newQueuePosition)

• onConferenceEnded

   Unit onConferenceEnded()

  Called when video conference ends

• onGeolocationUnavailable

   Unit onGeolocationUnavailable(Throwable error)

• onIdFrontCompleted

   Unit onIdFrontCompleted(IdScanResult frontIdScanResult)

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

  Parameters:

  frontIdScanResult - Result from ID scan step

• onIdBackCompleted

   Unit onIdBackCompleted(IdScanResult backIdScanResult)

  Called when the back of an ID scan is completed.

  Parameters:

  backIdScanResult - Result from ID scan step

• onIdScanReady

   Unit onIdScanReady(NonUiIdScanController controller)

  Called when the NonUiIdScanController is ready to be used.

  Parameters:

  controller - Instance of NonUiIdScanController

• onIdProcessed

   Unit onIdProcessed(IdProcessResult idProcessResult)

• onNfcScanCompleted

   Unit onNfcScanCompleted(NfcScanResult nfcScanResult)

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

  Parameters:

  nfcScanResult - Result from NFC scan step

• onSSLPinningFailed

   Unit onSSLPinningFailed()

• onEKYCChecksCompleted

   Unit onEKYCChecksCompleted(EKYCResult ekycResult)

• onAESCompleted

   Unit onAESCompleted(AESResult aesResult)

  Called when AES module is completed

  Parameters:

  aesResult - Result of AES module

• onQESCompleted

   Unit onQESCompleted(QESResult qesResult)

  Called when QES module is completed

  Parameters:

  qesResult - Result of QES module

• onError

   Unit onError(Throwable error)

  Called when there is an error

• onEKYBChecksCompleted

   Unit onEKYBChecksCompleted(EKYBResult ekybResult)

  Called when EKYB checks are completed

  Parameters:

  ekybResult - containing each check result for the form data.

• 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.

  Parameters:

  callbackName - The name of the method to invoke

  onCustomModuleCompleted - Callback to call with a desired CustomModuleStatus when the method invocation is complete

  Since:

  5.42.0