Constructor Detail

• IncodeWelcome.OnboardingListener

  IncodeWelcome.OnboardingListener()

Method Detail

• 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

• onOnboardingSessionCreated

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

  Called when onboarding session is created successfully

• onIntroCompleted

   Unit onIntroCompleted()

  Called when intro is completed

• onAddPhoneCompleted

   Unit onAddPhoneCompleted(PhoneNumberResult phoneNumberResult)

  Called when add phone is completed

• onAddEmailCompleted

   Unit onAddEmailCompleted(EmailAddressResult emailAddressResult)

  Called when add email is completed

  Parameters:

  emailAddressResult - Result of Email module

• onAddNameCompleted

   Unit onAddNameCompleted(NameResult nameResult)

  Called when add name is completed

  Parameters:

  nameResult - Result of Name Capture module

• onQRScanCompleted

   Unit onQRScanCompleted(QRScanResult qrScanResult)

  Called when QR scan is completed

• onIdValidationCompleted

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

• 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

• onGeolocationFetched

   Unit onGeolocationFetched(GeolocationResult geolocationResult)

  Called when the geolocation is fetched

• onGeolocationUnavailable

   Unit onGeolocationUnavailable(Throwable error)

  Called when the user geolocation is not available

• 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

• onSelfieScanReady

   Unit onSelfieScanReady(NonUiSelfieScanController controller)

  Called when selfie scan controller is ready to be used.

  Parameters:

  controller - Instance of NonUiSelfieScanController

• onFaceMatchCompleted

   Unit onFaceMatchCompleted(FaceMatchResult faceMatchResult)

  Called when selfie scan step is completed

• onFaceAuthenticationCompleted

   Unit onFaceAuthenticationCompleted(FaceAuthenticationResult faceAuthenticationResult)

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

• onCaptchaCollected

   Unit onCaptchaCollected(CaptchaResult captchaResult)

  This method is called when captcha is entered

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

• 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

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

• onEstimatedWaitingTime

   Unit onEstimatedWaitingTime(Integer waitingTimeInSeconds)

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

• onConferenceEnded

   Unit onConferenceEnded()

  Called when video conference ends

• onSuccess

   Unit onSuccess()

  Called when onboarding succeeds

• onError

   Unit onError(Throwable error)

  Called when there is an error

• onUserCancelled

   Unit onUserCancelled()

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

• onOnboardingSectionCompleted

   Unit onOnboardingSectionCompleted(String flowTag)

  Called when an onboarding section is completed.

• onIdScanReady

   Unit onIdScanReady(NonUiIdScanController controller)

  Called when the NonUiIdScanController is ready to be used.

  Parameters:

  controller - Instance of NonUiIdScanController

• 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

• onIdProcessed

   Unit onIdProcessed(IdProcessResult idProcessResult)

• onEKYBChecksCompleted

   Unit onEKYBChecksCompleted(EKYBResult ekybResult)

  Called when EKYB checks are completed

  Parameters:

  ekybResult - containing each check result for the form data.

• onEKYCChecksCompleted

   Unit onEKYCChecksCompleted(EKYCResult ekycResult)

• onEvent

  @Deprecated(message = "Use onEvent(eventResult: InterviewEventResult) instead.") 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)

• onCustomWatchlistProcessed

   Unit onCustomWatchlistProcessed(CustomWatchlistResult customWatchlistResult)

• onGlobalWatchlistProcessed

   Unit onGlobalWatchlistProcessed(GlobalWatchlistResult globalWatchlistResult)

  Called when the global watchlist is processed

  Parameters:

  globalWatchlistResult - global watchlist result

• onMachineLearningConsentCompleted

   Unit onMachineLearningConsentCompleted(MachineLearningConsentResult result)

• 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()

  This method is called when SSL Pinning Certificate fails

• onIdInfoCompleted

   Unit onIdInfoCompleted(IdInfoResult idInfoResult)

• onAntifraudCompleted

   Unit onAntifraudCompleted(AntifraudResult antifraudResult)

• onTaxIdValidationCompleted

   Unit onTaxIdValidationCompleted(Boolean isSuccess)

  Called when Tax ID validation is completed.

  true if the validation was successful, false otherwise.

• onDynamicFormsCompleted

   Unit onDynamicFormsCompleted(DynamicFormsResult dynamicFormsResult)