GoSaffeCapture Flutter

Usage

To use GoSaffeCapture in your application, follow these steps:

1. Import the package:

import 'package:go_saffe_flutter/go_saffe_flutter.dart';

2. Create an instance of GoSaffeCapture with the necessary parameters. Note: location must be enabled in our panel.

GoSaffeCapture(
  '<CAPTURE_KEY>',              // capture key (sandbox or production)
  '<USER_IDENTIFIER>',          // end-user identifier (either email or CPF)
  'verification | onboarding',         // 'onboarding' or 'verification'
  '<END_TO_END_ID>',              // identifier to keep consistency between front and backend
  () { print('Finish event received'); },
  () { print('Close event received'); },
  () { print('Timeout event received'); },
  () { print('Error received'); },
),

3. Add the widget where desired:

Scaffold(
  appBar: AppBar(
    title: Text('Example of GoSaffeCapture'),
  ),
  body: Center(
    child: GoSaffeCapture(
      'your_api_key',
      'user_identifier',
      'verification | onboarding',
      'end_to_end_id',
      () {
        print('Finish event received');
      },
      () {
        print('Close event received');
      },
      () {
        print('Timeout event received');
      },
      () {
        print('Error received');
      },
    ),
  ),
),

The extraData parameter

The extraData parameter is optional and allows for dynamic changes specific to the transaction, such as language and colors. It's a named parameter, so you only need to include it when you want to customize the widget. If you don't want any customization, simply omit it.

Primary and secondary colors should be informed in hexadecimal code. Possible values for the key "lang" at the moment are "en" so that the capture interface is presented in english, "pt" for the language to be portuguese, and "es" for spanish.

Example of ExtraData usage

All attributes in Settings are optional and you can inform only the fields you need.

// Example with all settings
final extraData = ExtraData(
  settings: Settings(
    primaryColor: '#00ABAB',
    secondaryColor: '#6A6A6A',
    lang: 'en',
  ),
);

// Example with only primary color
final extraDataMinimal = ExtraData(
  settings: Settings(
    primaryColor: '#00ABAB',
  ),
);

// Example with only language
final extraDataLang = ExtraData(
  settings: Settings(
    lang: 'en',
  ),
);

Informing ExtraData

Simply add the extraData parameter as a named parameter when creating the GoSaffeCapture widget:

GoSaffeCapture(
  'your_api_key',
  'user_identifier',
  'verification',
  'end_to_end_id',
  () { print('Finish event received'); },
  () { print('Close event received'); },
  () { print('Timeout event received'); },
  () { print('Error received'); },
  extraData: extraData, // Add this line to customize
),

Complete Example with ExtraData

final extraData = ExtraData(
  settings: Settings(
    primaryColor: '#00ABAB',
    secondaryColor: '#6A6A6A',
    lang: 'pt',
  ),
);

Scaffold(
  appBar: AppBar(
    title: Text('GoSaffeCapture with Custom Settings'),
  ),
  body: Center(
    child: GoSaffeCapture(
      'your_api_key',
      'user_identifier',
      'verification',
      'end_to_end_id',
      () { print('Finish event received'); },
      () { print('Close event received'); },
      () { print('Timeout event received'); },
      () { print('Error received'); },
      extraData: extraData,
    ),
  ),
),

Native Configuration

This widget uses a WebView that requires native permissions for camera and location access.
Make sure to update the native configuration in your app and note that location must be enabled in our panel.

iOS (Info.plist)

<key>NSCameraUsageDescription</key>
<string>We need camera access</string>
<key>NSLocationWhenInUseUsageDescription</key>
<string>We need location access</string>

Android (AndroidManifest.xml)

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

Support

If you have any questions or issues, feel free to open an issue in this repository.

License

MIT

Libraries

go_saffe_flutter