Constructor Detail

• IncodeWelcomeAPI

  IncodeWelcomeAPI()

Method Detail

• setCommonConfig

   Unit setCommonConfig(CommonConfig commonConfig)

• getSdkMode

   SdkMode getSdkMode()

• setSdkMode

   Unit setSdkMode(SdkMode sdkMode)

• startOnboarding

   Unit startOnboarding(Context context, SessionConfig sessionConfig, FlowConfig flowConfig, IncodeWelcome.OnboardingListener onboardingListener)

  Starts Incode Welcome flow. This is the main entry point for onboarding driven by FlowConfig.

  Parameters:

  context - Activity context used to start module screens.

  sessionConfig - Session setup used to create or resume onboarding.

  flowConfig - Module sequence and module-level configuration to execute.

  onboardingListener - Callback for success, error, and cancellation.

  Since:

  1.0.0

• setupOnboardingSession

   Unit setupOnboardingSession(SessionConfig sessionConfig, OnboardingSessionListener onboardingSessionListener)

• startOnboardingSection

   Unit startOnboardingSection(Context context, FlowConfig flowConfig, IncodeWelcome.OnboardingListener onboardingListener)

  Starts split-flow onboarding from the first module in flowConfig. This is the main entry point when using split-flow functionality.

  Call finishOnboarding when split-flow execution is complete to close the session on the server.

  Parameters:

  context - Activity context used to start module screens.

  flowConfig - Module sequence and module-level configuration to execute.

  onboardingListener - Callback for success, error, and cancellation.

  Since:

  1.0.0

• startOnboardingSection

   Unit startOnboardingSection(Context context, SessionConfig sessionConfig, FlowConfig flowConfig, IncodeWelcome.OnboardingListener onboardingListener)

  Starts split-flow onboarding with optional sessionConfig overrides. This is the main entry point when using split-flow functionality.

  Call finishOnboarding when split-flow execution is complete to close the session on the server.

  Parameters:

  context - Activity context used to start module screens.

  sessionConfig - Optional split-flow session overrides that are applied to internal configuration before modules start.

  flowConfig - Module sequence and module-level configuration to execute.

  onboardingListener - Callback for success, error, and cancellation.

• syncDelayedOnboardings

   Unit syncDelayedOnboardings(SyncDelayedOnboardingListener syncDelayedOnboardingListener)

• deleteAllDelayedOnboardings

   Unit deleteAllDelayedOnboardings()

• startWorkflow

   Unit startWorkflow(Context context, SessionConfig sessionConfig, IncodeWelcome.OnboardingListener onboardingListener)

  Starts onboarding in workflow mode.

  Creates or resumes onboarding based on sessionConfig. If both configurationId and interviewId are provided, the existing session is resumed. If only configurationId is provided, a new session is created. A valid externalToken can also be used to initialize the session. If startup fails with com.incode.welcome_sdk.commons.exceptions.ModuleConfigurationException, onboardingListener receives it via OnboardingListener.onError.

  Parameters:

  context - Activity context used to start module screens.

  sessionConfig - Session setup used to create or resume onboarding.

  onboardingListener - Callback for success, error, and cancellation.

  Since:

  5.21.0

• startFaceLogin

   Unit startFaceLogin(Context context, SelfieScan selfieScan, SelfieScanListener selfieScanListener)

  Starts the face login process. See the Face Login documentation for more details.

  Parameters:

  context - Activity context used to start module screens.

  selfieScan - SelfieScan module for login.

  selfieScanListener - Callback for login results.

  Since:

  5.2.0

• startFaceLogin

   Unit startFaceLogin(Context context, SessionConfig sessionConfig, SelfieScan selfieScan, SelfieScanListener selfieScanListener)

  Starts the face login process. See the Face Login documentation for more details. Use this overload when you need to pass face login session settings such as E2EE. This overload was introduced later than the base startFaceLogin(context, selfieScan, selfieScanListener) API.

  Parameters:

  context - Activity context used to start module screens.

  sessionConfig - Session configuration that can enable E2EE for face login.

  selfieScan - SelfieScan module for login.

  selfieScanListener - Callback for login results.

  Since:

  Standard Releases: 5.45.0

  Patch Releases: 5.40.2

• startFlow

   Unit startFlow(Context context, SessionConfig sessionConfig, IncodeWelcome.OnboardingListener onboardingListener)

  Starts or resumes an onboarding session based on the provided session configuration. If both configurationId and interviewId are specified in the sessionConfig object, this method attempts to resume the existing onboarding session identified by the interviewId. If only configurationId is specified in the sessionConfig, a new onboarding session is started. A valid externalToken can also be used to initialize the session.

  Parameters:

  context - Activity context used to start module screens.

  sessionConfig - Session setup used to create or resume onboarding.

  onboardingListener - Callback for success, error, and cancellation.

  Since:

  5.24.0

• startFlow

   Unit startFlow(Context context, SessionConfig sessionConfig, Modules startFromModule, IncodeWelcome.OnboardingListener onboardingListener)

  Starts or resumes an onboarding session based on the provided session configuration and starting module. If both configurationId and interviewId are specified in the sessionConfig object, this method attempts to resume the existing onboarding session identified by the interviewId. If only configurationId is specified in the sessionConfig, a new onboarding session is started. A valid externalToken can also be used to initialize the session.

  Parameters:

  context - Activity context used to start module screens.

  sessionConfig - Session setup used to create or resume onboarding.

  startFromModule - Starting module for resumed sessions.

  onboardingListener - Callback for success, error, and cancellation.

  Since:

  5.24.0

• startFlowFromDeeplink

   Unit startFlowFromDeeplink(Context context, String deepLink, IncodeWelcome.OnboardingListener onboardingListener)

  Resumes an onboarding session based on the provided deep link URL. The deep link is used to extract the session configuration settings, including the interview ID, configuration ID, and starting module. Example of a deep link URL: https://example.com/clientid/flow/abc123?utm_source=finish&interviewId=xyz456&module=ID In this example, the configuration ID is 'abc123', the interview ID is 'xyz456', and the starting module is 'ID'. If the module name from the deep link cannot be resolved, onboardingListener receives an IncodeGenericError.

  Parameters:

  context - Activity context used to start module screens.

  deepLink - Deep link associated with the onboarding session.

  onboardingListener - Callback for success, error, and cancellation.

  Since:

  5.24.0

• startFlowFromDeeplink

   Unit startFlowFromDeeplink(Context context, String deepLink, SessionConfig sessionConfig, IncodeWelcome.OnboardingListener onboardingListener)

  Resumes an onboarding session based on the provided deep link URL and session configuration. The deep link is used to extract the session configuration settings, including the interview ID, configuration ID, and starting module. If the sessionConfig parameter contains the configurationId and interviewId, the values extracted from the deep link will override the corresponding values in the session configuration. Example of a deep link URL: https://example.com/clientid/flow/abc123?utm_source=finish&interviewId=xyz456&module=ID In this example, the configuration ID is 'abc123', the interview ID is 'xyz456', and the starting module is 'ID'. If the module name from the deep link cannot be resolved, onboardingListener receives an IncodeGenericError.

  Parameters:

  context - Activity context used to start module screens.

  deepLink - Deep link associated with the onboarding session.

  sessionConfig - Session configuration merged with deep-link values.

  onboardingListener - Callback for success, error, and cancellation.

  Since:

  5.24.0

• finishOnboarding

   Unit finishOnboarding(Context context, FinishOnboardingListener finishOnboardingListener)

  Important: This method needs to be called at the end of the flow, to close the session on server.

  If you are using individual steps in the SDK or startOnboardingSection(), you need to call this method when you're done. If you are using CONFERENCE or RESULTS modules, call finishOnboarding() first.

  If you are using startOnboarding, this method is called automatically, and you do not have to do anything.

  Parameters:

  context - Activity context.

  finishOnboardingListener - Callback for completion (onOnboardingFinished()), error, and cancellation.

  Since:

  1.0.0

• getUserScore

   Unit getUserScore(IncodeWelcome.IDResultsFetchMode idResultsFetchMode, String interviewId, GetUserScoreListener getUserScoreListener)

• getReport

   Unit getReport(String interviewId, ReportListener reportListener)

• getInterviewId

   String getInterviewId()

• getVideoSelfiePath

   String getVideoSelfiePath()

• isTokenInitialized

   Boolean isTokenInitialized()

• faceMatch

   Unit faceMatch(String interviewId, IdCategory idCategory, FaceMatchListener faceMatchListener)

• faceMatch

   Unit faceMatch(String interviewId, FaceMatch.MatchType matchType, IdCategory idCategory, FaceMatchListener faceMatchListener)

• geolocation

   Unit geolocation(Context context, String interviewId, GeolocationListener geolocationListener)

• processId

   Unit processId(String interviewId, IdCategory idCategory, IdProcessListener idProcessListener)

• processLaborHistory

   Unit processLaborHistory(String interviewId, String curp, ProcessLaborHistoryListener laborHistoryListener)

• processPaymentProof

   Unit processPaymentProof(String interviewId, ProcessPaymentProofListener processPaymentProofListener)

• processAntifraud

   Unit processAntifraud(String interviewId, AntifraudListener antifraudListener)

• processCustomWatchlist

   Unit processCustomWatchlist(String interviewId, ProcessCustomWatchlistListener processCustomWatchlistListener)

• getPaymentProofInfo

   Unit getPaymentProofInfo(String interviewId, PaymentProofInfoListener paymentProofInfoListener)

• setStrings

   Unit setStrings(Locale locale, Map<String, CharSequence> strings)

• setStringArray

   Unit setStringArray(Locale locale, Map<String, Array<CharSequence>> stringArray)

• setQuantityStrings

   Unit setQuantityStrings(Locale locale, Map<String, Map<QuantityKeyword, CharSequence>> quantityStrings)

• addNOM151Archive

   Unit addNOM151Archive(String interviewId, AddNOM151ArchiveListener addNOM151ArchiveListener)

• getUserOCRData

   Unit getUserOCRData(String token, GetUserOCRDataListener getUserOCRDataListener)

• setFaces

   Unit setFaces(List<FaceInfo> faceInfoList, FaceEventListener faceEventListener)

• setFaces

  @Deprecated(message = "This method is deprecated and should no longer be used", replaceWith = @ReplaceWith(imports = {}, expression = "setFaces(faceInfoList, faceEventListener)")) Unit setFaces(List<FaceInfo> faceInfoList)

• addFace

   Unit addFace(FaceInfo faceInfo, FaceEventListener faceEventListener)

• addFace

  @Deprecated(message = "This method is deprecated and should no longer be used", replaceWith = @ReplaceWith(imports = {}, expression = "addFace(faceInfo, faceEventListener)")) Unit addFace(FaceInfo faceInfo)

• removeFace

   Unit removeFace(String customerUUID, FaceEventListener faceEventListener)

• removeFace

  @Deprecated(message = "This method is deprecated and should no longer be used", replaceWith = @ReplaceWith(imports = {}, expression = "removeFace(customerUUID, faceEventListener)")) Unit removeFace(String customerUUID)

• removeAllFaces

   Unit removeAllFaces(FaceEventListener faceEventListener)

• getFaces

   Unit getFaces(FaceInfoListener faceInfoListener)

• syncFaceLoginAttempts

   Unit syncFaceLoginAttempts(SyncFaceLoginAttemptsListener syncFaceLoginAttemptsListener)

• setFaceAuthenticationHint

   Unit setFaceAuthenticationHint(String faceAuthenticationHint)

• fetchAllFlows

  @Deprecated(message = "This method is deprecated and should no longer be used.") Unit fetchAllFlows(String adminToken, IncodeWelcome.FetchFlowsListener fetchFlowsListener)

• fetchFlow

  @Deprecated(message = "This method is deprecated and should no longer be used.") Unit fetchFlow(String flowId, String token, IncodeWelcome.FetchFlowListener fetchFlowListener)

• fetchRegions

  @Deprecated(message = "This method is deprecated as the region is no longer necessary in the onboarding flow.") Unit fetchRegions(FetchRegionsListener fetchRegionsListener)

• downloadLibraries

  @Deprecated(message = "Libraries are now bundled with the SDK, and always available. This function should not be used anymore.") Unit downloadLibraries()

• isLibrariesReady

  @Deprecated(message = "Libraries are now bundled with the SDK, and always available. This function always returns true.") Boolean isLibrariesReady()

• subscribeForLibrariesReady

  @Deprecated(message = "Libraries are now bundled with the SDK, and always available. FaceRecognitionPrepareListener#onFaceRecognitionReady() is called immediately") Unit subscribeForLibrariesReady(FaceRecognitionPrepareListener faceRecognitionReadyListener)