Intro

The Intro module displays an introduction screen. It lists the documents and checks the user will need to complete.

There is no Dashboard equivalent for this module, so you cannot use integration Pattern 3 to add it. You must use Pattern 1 or 2, adding the module to a FlowConfig in code as shown on this page.

Add Intro

Add the module with addIntro(intro). Intro is meant to run first, so add it before your capture modules.

flowConfigBuilder.addIntro(intro)

flowConfigBuilder.addIntro(intro);

Example

The example below builds an Intro listing the ID and selfie checks, adds it as the first step in the flow, and continues once the user finishes the screen.

val intro = Intro.Builder()
    .setIntroChecks(listOf(IntroChecks.ID, IntroChecks.SELFIE))
    .build()

val flowConfig = FlowConfig.Builder()
    .addIntro(intro)
    // ... add your capture modules after it
    .build()

val onboardingListener = object : OnboardingListener() {
    override fun onIntroCompleted() {
        // The user finished the intro screen. Continue the flow.
    }
}

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener)

Intro intro = new Intro.Builder()
    .setIntroChecks(Arrays.asList(IntroChecks.ID, IntroChecks.SELFIE))
    .build();

FlowConfig flowConfig = new FlowConfig.Builder()
    .addIntro(intro)
    // ... add your capture modules after it
    .build();

IncodeWelcome.OnboardingListener onboardingListener = new IncodeWelcome.OnboardingListener() {
    @Override
    public void onIntroCompleted() {
        // The user finished the intro screen. Continue the flow.
    }
};

IncodeWelcome.getInstance()
    .startOnboarding(activityContext, sessionConfig, flowConfig, onboardingListener);

Configuration Options

Configure the module with Intro.Builder. At least one intro check is required, or the module fails configuration.

The intro checks you list should reflect the capture modules you add to the same flow, so the screen matches what the user is actually asked to complete.

For the complete option set, see Intro.Builder and the IntroChecks values in API Reference.

Result

Intro does not deliver a result payload to the OnboardingListener. It signals completion through the no-argument onIntroCompleted() callback, which fires when the user finishes the intro screen.

If the module cannot complete, errors surface through OnboardingListener.onError(Throwable).