Skip to content

Overview

The flutter_ts_identity_orchestration is a Flutter plugin for Mosaic Orchestration. It enables secure identity verification and authentication flows in your Flutter app using Mosaic. It allows your application to start journeys, handle journey steps, and submit client responses through a stream-based event model.

Note

For platform-specific implementation details and advanced configuration, refer to the native SDK documentation:

Capabilities

  • Start and manage journeys from the client side
  • Handle journey steps and submit client responses
  • Stream-based real-time event handling via journeyResponseStream
  • Support for mobile approve flows
  • Push token management
  • Debug PIN generation for development

Requirements

  • Flutter 3.3.0+, Dart 3.8.1+
  • iOS 13.0+, Xcode 12+
  • Android API 21+ (Android 5.0), compileSdkVersion 35+

Installation

Add the dependency to your pubspec.yaml:

dependencies:
  flutter_ts_identity_orchestration:
    git:
      url: https://github.com/TransmitSecurity/flutter_ts_identity_orchestration.git
      ref: 0.0.3

Install dependencies:

flutter pub get

Platform setup

Add permissions to ios/Runner/Info.plist (if using camera and FaceID):

<key>NSCameraUsageDescription</key>
<string>This app needs camera access for identity verification</string>
<key>NSFaceIDUsageDescription</key>
<string>This app uses Face ID for authentication</string>

Set the minimum iOS version in ios/Podfile:

platform :ios, '13.0'

Initialization

You can initialize the SDK either with a configuration file or with explicit parameters.

import 'package:flutter_ts_identity_orchestration/flutter_ts_identity_orchestration.dart';

final orchestration = FlutterTsIdentityOrchestration();
await orchestration.initializeSDK(configurationFile: 'TransmitSecurity');

Regional base URLs

RegionBase URL
UShttps://api.transmitsecurity.io/
EUhttps://api.eu.transmitsecurity.io/
Canadahttps://api.ca.transmitsecurity.io/
Australiahttps://api.au.transmitsecurity.io/
Japanhttps://api.gasne1-ts01.transmitsecurity.io/
Sandboxhttps://api.sbx.transmitsecurity.io/
Custom domainhttps://<your-domain>.com/ (see Custom domains)

Next steps

Once initialized, implement orchestration flows using the available functions.