Installation

This guide will help you install and set up the Azakaw Flutter plugin in your project.

Prerequisites

• Flutter SDK: 3.2.0 or higher
• Dart SDK: 3.2.0 or higher
• iOS: 11.0 or higher
• Android: API 21 (Android 5.0) or higher

Installation Steps

1. Add the dependency to your pubspec.yaml:

dependencies:
  azakaw_kyc_flutter: ^0.0.1

2. Run flutter pub get:

flutter pub get

3. Add required permissions:

For iOS (ios/Runner/Info.plist):

<key>NSCameraUsageDescription</key>
<string>Camera access is required for KYC verification</string>

For Android (android/app/src/main/AndroidManifest.xml):

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.CAMERA"/>

Basic Usage

To start using the plugin, you'll need to call AzakawKyc.start() with the required parameters:

import 'package:azakaw_kyc_flutter/azakaw_kyc_flutter.dart';

// Start the KYC process
AzakawKyc.start(
  context: context,
  config: AzakawKycConfig(
    sessionId: 'your-session-id',
    environment: Environment.sandbox,
    isFullscreen: false, // Optional
  ),
  onComplete: () {
    // Handle completion
  },
  onCancel: () {
    // Handle cancellation
  },
);

Configuration

Learn how to configure the Azakaw KYC Flutter plugin in your application.

Initialization

The plugin provides a main entry point through the AzakawKyc class and uses AzakawKycConfig for configuration.

// Create configuration
final config = AzakawKycConfig(
  sessionId: "your-session-id",
  environment: Environment.sandbox, // or Environment.production
  isFullscreen: false // optional, defaults to false
);

// Start KYC process
AzakawKyc.start(
  context: context,
  config: config,
  onCancel: () {
    // Handle when user cancels
  },
  onComplete: () {
    // Handle when process completes
  }
);