Constructor Detail

• IncodeWelcome.OnboardingListener

  IncodeWelcome.OnboardingListener()

Method Detail

• onAESCompleted

   void onAESCompleted(@NonNull() AESResult aesResult)

  Called when AES module is completed

  Parameters:

  aesResult - Result of AES module

• onOnboardingSessionCreated

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

  Called when onboarding session is created successfully

  Parameters:

  token - Incode's token for this session

  interviewId - Id of the onboarding application interview

  region - Deprecated; Do not use.

• onIntroCompleted

   void onIntroCompleted()

  Called when intro is completed

• onAddPhoneCompleted

   void onAddPhoneCompleted(PhoneNumberResult phoneNumberResult)

  Called when add phone is completed

  Parameters:

  phoneNumberResult - Result of Phone module

• onAddEmailCompleted

   void onAddEmailCompleted(EmailAddressResult emailAddressResult)

• onAddNameCompleted

   void onAddNameCompleted(NameResult nameResult)

• onQRScanCompleted

   void onQRScanCompleted(QRScanResult qrScanResult)

  Called when QR scan is completed

  Parameters:

  qrScanResult - Result of QR Scan module

• onIdValidationCompleted

  @Deprecated() void onIdValidationCompleted(IdValidationResult idValidationResult)

• onCurpValidationCompleted

   void onCurpValidationCompleted(CurpValidationResult curpValidationResult)

  This method is called when CURP validation is finished

  Parameters:

  curpValidationResult - Result of CURP validation

• onDocumentValidationCompleted

   void onDocumentValidationCompleted(DocumentType documentType, DocumentValidationResult documentValidationResult)

  Called when address validation is completed

  Parameters:

  documentType - Type of document for which the validation is performed

  documentValidationResult - Result of the document validation

• onGeolocationFetched

   void onGeolocationFetched(GeolocationResult geolocationResult)

  Called when the geolocation is fetched

  Parameters:

  geolocationResult - geolocation results

• onGeolocationUnavailable

   void onGeolocationUnavailable(Throwable error)

  Called when the user geolocation is not available

  Parameters:

  error - exception that occurred

• onSelfieScanCompleted

   void 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

   void onFaceMatchCompleted(FaceMatchResult faceMatchResult)

  Called when selfie scan step is completed

  Parameters:

  faceMatchResult - Result of the selfie scan step that includes face recognition confidence

• onGovernmentValidationCompleted

   void onGovernmentValidationCompleted(boolean success)

  Called when Government validation is completed

  true if the validation was successful, false otherwise

• onSignatureCollected

   void onSignatureCollected(SignatureFormResult signatureFormResult)

  Called when collect signature is completed

  Parameters:

  signatureFormResult - Result of signature collection

• onUserConsentCompleted

   void onUserConsentCompleted()

  Called when add user consent is completed

• onCaptchaCollected

   void onCaptchaCollected(CaptchaResult captchaResult)

  This method is called when captcha is entered

  Parameters:

  captchaResult - Result of captcha entry

• onUserAcceptedVideoSelfie

   void onUserAcceptedVideoSelfie()

  This method is called when user accepts video selfie recording

• onVideoRecorded

   void onVideoRecorded(@NonNull() VideoSelfieResult videoSelfieResult)

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

• onApproveCompleted

   void onApproveCompleted(ApproveResult approveResult)

  This method is called when user approval is completed

  Parameters:

  approveResult - Result of approval process

• onResultsShown

   void onResultsShown(UserScoreResult userScoreResult)

  This method is called when show results is completed

  Parameters:

  userScoreResult - Set of identity scores calculated for a user

• onQueuePositionChanged

   void onQueuePositionChanged(int 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

   void onEstimatedWaitingTime(int waitingTimeInSeconds)

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

• onConferenceEnded

   void onConferenceEnded()

  Called when video conference ends

• onSuccess

   void onSuccess()

  Called when onboarding succeeds

• onError

   void onError(Throwable error)

  Called when there is an error

• onUserCancelled

   void onUserCancelled()

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

• onOnboardingSectionCompleted

   void onOnboardingSectionCompleted(String flowTag)

  Called when an onboarding section is completed.

• onIdFrontCompleted

   void 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

   void onIdBackCompleted(IdScanResult backIdScanResult)

  Called when the back of an ID scan is completed.

  Parameters:

  backIdScanResult - Result from ID scan step

• onIdProcessed

   void onIdProcessed(IdProcessResult idProcessResult)

• onEKYBChecksCompleted

   void onEKYBChecksCompleted(@NonNull() EKYBResult ekybResult)

  Called when EKYB checks are completed

  Parameters:

  ekybResult - containing each check result for the form data.

• onEKYCChecksCompleted

   void onEKYCChecksCompleted(EKYCResult ekycResult)

• onEvent

  @Deprecated() void onEvent(@NonNull() Event event, @Nullable() HashMap<String, Object> eventData)

  Called when event is being sent to the server

  Parameters:

  event -

  • event

  eventData -

  • additional parameters sent within event

• onEvent

   void onEvent(@NonNull() InterviewEventResult eventResult)

• onCustomWatchlistProcessed

   void onCustomWatchlistProcessed(CustomWatchlistResult customWatchlistResult)

• onGlobalWatchlistProcessed

   void onGlobalWatchlistProcessed(GlobalWatchlistResult globalWatchlistResult)

• onMachineLearningConsentCompleted

   void onMachineLearningConsentCompleted(@NonNull() MachineLearningConsentResult result)

• onNfcScanCompleted

   void onNfcScanCompleted(@NonNull() NfcScanResult nfcScanResult)

• onSSLPinningFailed

   void onSSLPinningFailed()

  This method is called when SSL Pinning Certificate fails

• onIdInfoCompleted

   void onIdInfoCompleted(@NonNull() IdInfoResult idInfoResult)

• onAntifraudCompleted

   void onAntifraudCompleted(@NonNull() AntifraudResult antifraudResult)

• onTaxIdValidationCompleted

   void onTaxIdValidationCompleted(boolean success)

  Called when Tax ID validation is completed.

  true if the validation was successful, false otherwise.