flutter_checkmobi 0.0.7

A Flutter plugin for phone number verification using Checkmobi's missed call-based verification system.

flutter checkmobi Plugin Documentation

flutter_checkmobi is a Flutter plugin for integrating Checkmobi SDK for phone number verification in your Flutter application. This plugin provides a method to start the phone number verification process using Checkmobi's verification service.

Features

• Phone Number Verification: Provides an easy way to integrate phone number verification through the Checkmobi platform.
• API Key Integration: Set your Checkmobi API key for the verification process.
• Missed Call Verification: Leverages missed calls for phone number verification.
• Error Handling: Includes proper error handling and user feedback (e.g., toast messages).

Checkmobi Website

For more information, visit the Checkmobi website.

Support the Project

If you like this project and would like to support it, your support means a lot!

Buy Me a Coffee ☕️

You can support this project by clicking the button below to make a donation. Thank you for your support! 🙏

Installation

1. Add the plugin to your pubspec.yaml file:

dependencies:
  flutter:
    sdk: flutter
  flutter_checkmobi:

2. Run flutter pub get to install the plugin.

Platform Support

• Android

Usage

To use the plugin, follow these steps:

1. Set API Key

Before using any feature of the plugin, you need to set the API key provided by Checkmobi.

import 'package:flutter_checkmobi/flutter_checkmobi.dart';

void setApiKey(String apiKey) {
  FlutterCheckmobi.setApiKey(apiKey);
}

2. Initialize and Start Verification

To initialize and start the phone number verification process, call the callIInitialize method with the required parameters:

import 'package:flutter_checkmobi/flutter_checkmobi.dart';

void startVerification(String phoneNumber, String countryCode) {
  FlutterCheckmobi.callIInitialize(
    phoneNumber: phoneNumber,
    countryCode: countryCode,
  ).then((result) {
    print('Verification process started: $result');
  }).catchError((error) {
    print('Error: $error');
  });
}

3. Check User Status

To check whether the user has been verified, use the checkUser method. It returns the phone number and server ID if verified.

import 'package:flutter_checkmobi/flutter_checkmobi.dart';

void checkUser() {
  FlutterCheckmobi.checkUser().then((result) {
    print('Verified User: $result');
  }).catchError((error) {
    print('Error: $error');
  });
}

Methods

setApiKey

Sets the API key for the Checkmobi SDK.

Arguments:

• api_key (String) - The API key provided by Checkmobi.

Usage:

FlutterCheckmobi.setApiKey('your-api-key');

callIInitialize

Starts the phone number verification process.

Arguments:

• phoneNumber (String) - The phone number to verify.
• countryCode (String) - The country code of the phone number.

Returns:

• A result indicating whether the verification process started successfully.

checkUser

Checks whether the user has been verified.

Returns:

• A JSON string containing the phone number and server ID if the user is verified.

Listening for Data

You can listen for data, including any errors or verification events, using the listenForData method.

dataRetrive.listenForData(
  onComplete: (val) {
    print(val); // Log the verification result.
  },
  onData: (val) {},
  onError: (val) {
    print(val); // Handle error
    Fluttertoast.showToast(msg: val); // Display error message
  },
  onnVerifyPin: (val) {},
);

Errors

• 401: API key not set.
• 404: Account not found.
• 409: An error occurred during the user verification process.

Key Methods in the Example:

• setApiKey: Sets the API key for Checkmobi.
• createMissedCall: Starts the phone number verification process via missed call.
• listenForData: Listens for events like verification completion or errors.

Error Handling

• If the API key is not set correctly, errors will be shown in the console.
• Any verification errors are caught and displayed using Fluttertoast.showToast.

---

Key Changes in the Code:

1. Navigation to VerificationScreen:

   • After calling the createMissedCall method to verify the phone number, the app navigates to the /verification_screen using Navigator.pushNamed(context, '/verification_screen').

2. Verification Screen UI (VerificationScreen):

   • This screen is displayed when the user starts the verification process. It shows a loading indicator (CircularProgressIndicator) and a message indicating that verification is in progress.

3. Back Button Action:

   • The back button on the VerificationScreen will exit the app using SystemNavigator.pop().

---

What Happens:

1. User enters the phone number and country code.
2. When the user presses "Verify Now", the app starts the verification process using createMissedCall.
3. The app then navigates to the VerificationScreen, where a loading indicator is shown while the verification process is ongoing.
4. If the user presses the back button, the app will exit.

---

This documentation will guide users through the steps needed to set up and utilize the flutter_checkmobi plugin for phone number verification in their Flutter applications.

Support the Project

(Again) If you like this project and would like to support it, your support means a lot!

Buy Me a Coffee ☕️

You can support this project by clicking the button below to make a donation. Thank you for your support! 🙏

Overview

CheckMobi Remote Config SDK for Android enables users to integrate CheckMobi’s verification methods in a flexible, time-saving way, eliminating the need to write custom validation logic.

Features

• Quick integration with minimal code.
• Supports theme customization.
• Allows real-time updates to the verification flow directly from the CheckMobi website, without requiring a new app release.
• Offers a suite of verification options (SMS, Voice, Missed Call) that can be tested immediately with minimal code.
• Enables customized validation flows based on country, operator, or number, and supports A/B testing for optimization.
• Open-source, allowing for full UI customization if needed.

Testing

A demo app is available in the repository to test the SDK without integrating it into a new project. To use it:

1. Clone the repository.
2. Open the project in Android Studio.
3. Open StartActivity.java and set the variable CHECKMOBI_SECRET_KEY to your CheckMobi Secret Key from the web portal. Alternatively, you can store it in native code by adding it to /src/main/cpp/api_key.h.
4. Run the project on a device.

Integrate the SDK into your project

To integrate the SDK (using Android Studio), follow these steps:

1. Clone the project.
2. In Android Studio, navigate to: File -> New -> Import Module.
3. Select the module source (<path to cloned project>/checkmobi) and press Finish.

Setting the API Secret Key

Before using the SDK, set the CheckMobi Secret Key obtained from the web portal. This should be done before calling any SDK method:

CheckmobiSdk.getInstance().setApiKey("YOUR_SERET_KEY_HERE");

Securing the Secret Key

While client-side security is never foolproof, there are several methods to secure a secret key on the client side, making it significantly harder to break:

• Use DexGuard for code obfuscation and protection.
• Store the key on your own backend instead of in the client.
• Embed the key within native code using the NDK.

A strong approach for client-side protection is to embed the secret key within native code using NDK. Here's a quick guide to implementing this:

• Copy the cpp folder from /src/main into your project.
• Place your secret key in api_key.h by modifying the following line:

#define ANDROID_HIDE_SECRETS_API_KEY_H "YOUR_SECRET_KEY_HERE"

• Create a Java class to retrieve the key from native code. For example (as shown in StartActivity.java) and add the following:

static {
    System.loadLibrary("native-lib");
}

public native String stringFromJNI(); // intentionally we didn't used an explicit name like getSecretKey

• Update the method signature in cpp/native-lib.cpp to reflect your package and class names. For example, change:

Java_com_checkmobi_checkmobisample_ui_StartActivity_stringFromJNI

to

Java_[your_package_name]_[your_class_name]_[your_java_function_name]

• Modify your build.gradle file to include native build settings:

defaultConfig {
    ...
    externalNativeBuild {
        cmake {
            cppFlags ""
        }
    }
}

externalNativeBuild {
    cmake {
        path "src/main/cpp/CMakeLists.txt"
    }
}

Integrating the Phone Validation Process

To check if a user has already verified their phone number:

String verifiedNumber = CheckmobiSdk.getInstance().getVerifiedNumber(<context>);

If verifiedNumber is not null, the user has verified their number and can continue using the app. Otherwise, start the validation process:

startActivityForResult(
    CheckmobiSdk.getInstance()
        .createVerificationIntentBuilder()
        .build(StartActivity.this), VERIFICATION_RC);

Override onActivityResult to handle the verification result:

@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
    super.onActivityResult(requestCode, resultCode, data);
    if (requestCode == VERIFICATION_RC) {
        if (resultCode == RESULT_OK) {
            //The user has verified his phone number successfully
        } else {
            //The user canceled the verification process
        }
    }
}

Optional Server to Server Validation

For an extra layer of security, you can check from your backend that the phone number verification actually happened. For this, you will need the server id of the verification request. You can obtain it like this after a succesful phone number verification:

String verifiedNumberServerId = CheckmobiSdk.getInstance().getVerifiedNumberServerId(<context>);

You should send this id from the app to your backend and the backend should call the checkmobi api with it. You can find more details on how to check the status of a verification request from your backend here.

Customizations

You can change the theme used in the activities by setting you theme in the VerificationIntentBuilder before you start it like so:

startActivityForResult(
    CheckmobiSdk.getInstance()
        .createVerificationIntentBuilder()
        .setTheme(<your theme>)
        .build(StartActivity.this), VERIFICATION_RC);

Since this is an Android module, if you need to customize it even more, you are free to change the code.

Behind the scene

Behind the scene the SDK is using the CheckMobi REST API.

First is doing a call to Get Remote Config Profile which returns the validation flow for the specified destination as configured in the CheckMobi Web Portal.

Then based on the profile received the app it's using the Request Validation API and Verify PIN API to implement the desired validation processes.

The select country picker is populated using the information received from Get Countries API.