Onboarding (KYC/KYB)

This guide explains how to integrate the Footprint onboarding flow for KYC (Know Your Customer) and KYB (Know Your Business) into your android applications. You can find the installation instructions in the previous section.

1. Start the onboarding:

   • Start the onboarding and get an onboarding token, e.g., obtok_UxM6Vbvk2Rcy1gzcSuXgk3sj3L9I0pAnNH, from POST /onboardings.

2. Initialize the Footprint Flow:

   • Trigger Footprint, for example, when a button is clicked. Then, pass the onboardingSessionToken and onComplete callback to the initialize method.

kotlin
1Button(
2    onClick = {
3        Onboarding.initialize(
4            context = context,
5            onboardingSessionToken = "YOUR AUTH TOKEN", 
6            onComplete = { validationToken ->
7                println("Onboarding completed successfully. Validation token: $validationToken")
8            }
9        )
10    }
11) {
12    Text("Launch Footprint onboarding flow")
13}

3. Handle Completion:
   • Once the user completes the flow, you'll receive the validationToken through the onComplete callback. Post this token to your backend for further processing.

Footprint provides several events based on actions performed by the user. To listen to events, pass them from the initialize method.

kotlin
1Button(
2    onClick = {
3        Onboarding.initialize(
4            context = context,
5            onboardingSessionToken = "YOUR AUTH TOKEN",
6            onComplete = { validationToken ->
7                println("Onboarding completed successfully. Validation token: $validationToken")
8            },
9            onCancel = {
10                println("Onboarding was canceled by the user")
11            },
12            onError = { error ->
13                println("Onboarding error: $error")
14            }
15        )
16    }
17) {
18    Text("Launch Footprint onboarding flow")
19}

You can customize the appearance of the onboarding flow by passing an appearance object to the initialize method.

kotlin
1Button(
2    onClick = {
3        Onboarding.initialize(
4            context = context,
5            onboardingSessionToken = "YOUR AUTH TOKEN",
6            onComplete = { validationToken ->
7                println("Onboarding completed successfully. Validation token: $validationToken")
8            },
9            onCancel = {
10                println("Onboarding was canceled by the user")
11            },
12            onError = { error ->
13                println("Onboarding error: $error")
14            },
15            appearance = FootprintAppearance(
16                variables = FootprintAppearanceVariables(
17                    borderRadius = "8px",
18                    buttonPrimaryBg = "#315E4C",
19                    colorSuccess = "#315E4C",
20                    colorError = "#E33D19"
21                )
22            )
23        )
24    }
25) {
26    Text("Launch Footprint onboarding flow")
27}

For more information, including a list of available variables, check out the customization guide.