verisync 0.1.2

Verisync simplifies KYC for clients and customers. It's easy to integrate into Flutter projects and supports IOS, Android, Windows, and Web.

Verisync

Introduction

The Verisync Identity Verification Button is a Flutter widget designed to simplify the process of integrating identity verification within your Flutter application. It wraps the complexity of initiating and handling identity verification flows into a simple, easy-to-use button widget.

Features

• Simple Integration: Just drop the VerisyncButton into your widget tree to get started.
• Customizable: Supports customization of button appearance and behavior through parameters.
• Permission Handling: Automatically handles camera permission requests necessary for identity verification.
• Callback Support: Provides onSuccess and onError callbacks to handle the verification result.
• Dialog Presentation: Shows the identity verification process in a dialog for a seamless user experience.

Getting Started

Dependencies

Add the following dependencies to your pubspec.yaml file:

dependencies:
  flutter:
    sdk: flutter
  verisync: ^latest_version

Import

import 'package:your_package/verisync_button.dart'; // Adjust the import path based on your project structure

Usage

To use the VerisyncButton, simply include it in your widget tree and provide the necessary parameters:

VerisyncButton(
  redirectUrl: 'https://example.com/redirect',
  flowId: 'your_flow_id',
  clientId: 'your_client_id',
  email: '[e-mail]', // Optional
  metadata: {'key': 'value'}, // Optional
  onSuccess: (context) {
    // Optional Handle verification success
  },
  onError: (context) {
    // Optional Handle verification error
  },
  style: ButtonStyle(
    backgroundColor: MaterialStateProperty.all(Colors.blue),
  ),
  child: Text('Verify Identity'),  //Optional Customize button child widget
)

If you do not intend to customize the button, simply add only the required parameters like so:

VerisyncButton(
  redirectUrl: 'https://example.com/redirect',
  flowId: 'your_flow_id',
  clientId: 'your_client_id',
  ),

Parameters

• redirectUrl: The URL to which the verification process will redirect upon completion.
• flowId: The flow ID for the verification process.
• clientId: Your client ID for the verification service.
• email: (Optional) The email address to prefill in the verification process.
• metadata: (Optional) Additional metadata to pass along with the verification request.
• onSuccess: (Optional) Callback function that is called upon successful verification.
• onError: (Optional) Callback function that is called upon a verification error.
• style: (Optional) Custom style for the button. child: (Optional) Custom child widget to display inside the button.

Handling Permissions

The VerisyncButton automatically handles camera permissions required for identity verification. If permissions are denied or not granted, it provides guidance to the user for enabling them through the app settings. It depend permission_handler package. Please read the instructions on platform specific requirements from: permission_handler.

Customization

Customize the appearance and behavior of the VerisyncButton by providing custom values for the style and child parameters, as well as handling the onSuccess and onError events according to your application's needs.

Migration Guide: Integrating VerisyncButton

This guide outlines the steps to migrate from manually handling identity verification with VerisyncWidget to using the VerisyncButton widget in your Flutter application.

Changes Overview

• Permission Handling: The new VerisyncButton widget abstracts away the permission handling logic, making your main application code cleaner and focused on business logic.
• Simplification: Direct instantiation and usage of VerisyncWidget within a dialog is replaced by VerisyncButton, simplifying the codebase.
• Initialization: The explicit permission request and camera permission check in the main function are no longer necessary.

Step-by-Step Migration

1. Remove Permission Handling from main Old code in your main function may look like this:

   WidgetsFlutterBinding.ensureInitialized();
   var status = await Permission.camera.status;
   if (status.isDenied) {
   await Permission.camera.request();
   } else if (status.isPermanentlyDenied) {
   openAppSettings();
   }
   

   In the new approach, remove these lines. The updated main function should only contain:

   runApp(const MaterialApp(home: MyApp()));
   

2. Update MyApp Widget Replace the usage of ElevatedButton with VerisyncWidget in a dialog by directly using VerisyncButton in the widget tree.

   Before:

     ElevatedButton(
       onPressed: () {
       showAdaptiveDialog(
       context: context,
       builder: (BuildContext dialogContext) => VerisyncWidget(
         // Parameters
         ),
       );
     },
     child: const Text('Verify your identity'),
     ),
   

   After:

     const VerisyncButton(
     flowId: "<your flowId>",
     redirectUrl: "<your redirectUrl>",
     clientId: "<your clientId>",
   ),
   

3. Remove Unnecessary Imports Since permission handling is encapsulated within the VerisyncButton, remove the permission_handler package import if its no longer used elsewhere in your project.

   Before:

    import 'package:permission_handler/permission_handler.dart';
   

   After:

   Ensure this import is removed if not required.

4. Adjust VerisyncButton Usage

   • If you used additional parameters like email, metadata, callbackSuccess, or callbackError in the old VerisyncWidget, ensure to add them to VerisyncButton.
   • VerisyncButton also provides onSuccess and onError callbacks, similar to callbackSuccess and callbackError. Adjust these according to the new API.

Summary

By following these steps, you will have successfully migrated to using the VerisyncButton widget, simplifying your code and encapsulating complex permission handling and identity verification logic. This migration enhances code maintainability and focuses on your application's core functionality.