NSCameraUsageDescription We need access to your camera for face liveness detection.

Android Setup

1. Make sure you have the AWS Amplify configuration set up properly in your Android project.

2. Add the following dependencies to your android/app/build.gradle:

dependencies {
    // AWS Amplify Face Liveness SDK
    implementation 'com.amplifyframework.ui:liveness:1.4.0'
    implementation 'com.amplifyframework:core:2.27.0'
    implementation 'com.amplifyframework:aws-auth-cognito:2.27.0'
}

iOS Setup

Important: The AWS Amplify Face Liveness SDK is distributed through Swift Package Manager, not CocoaPods. You need to add the dependencies manually to your iOS project.

Step 1: Add Swift Package Dependencies

1. Open your iOS project in Xcode (ios/Runner.xcworkspace)
2. Go to File > Add Package Dependencies...
3. Add the following packages:

AWS Amplify Swift:

• URL: https://github.com/aws-amplify/amplify-swift
• Version: 2.46.1 or later
• Select these products:
  • Amplify
  • AWSCognitoAuthPlugin

AWS Amplify UI Liveness:

• URL: https://github.com/aws-amplify/amplify-ui-swift-liveness
• Version: 1.3.5 or later
• Select the FaceLiveness product

Step 2: Configure Amplify

Make sure you have the AWS Amplify configuration set up properly in your iOS project as described in the AWS Amplify documentation.

Step 3: Add Configuration Files

Place your amplifyconfiguration.json and awsconfiguration.json files in the iOS directory and add them to your Xcode project.

Usage

1. Initialize AWS Amplify

First, make sure you initialize Amplify in your app as described in the AWS Amplify documentation.

2. Create a Face Liveness Session

You'll need a backend service to create a Face Liveness session. Here's an example of how to get a session ID from your backend:

Future<Map<String, String>> getSessionFromBackend() async {
  final response = await http.post(
    Uri.parse('https://your-backend-url.com/face-liveness/create-session'),
    headers: {'Content-Type': 'application/json'},
  );

  if (response.statusCode == 201) {
    final data = jsonDecode(response.body);
    return {
      'sessionId': data['sessionId'],
      'region': data['region'] ?? 'us-east-1',
    };
  }
  
  throw Exception('Failed to get session');
}

3. Use the FaceLivenessDetector Widget

import 'package:face_liveness_detector/face_liveness_detector.dart';

// ...

FaceLivenessDetector(
  sessionId: sessionId,
  region: 'us-east-1',
  onComplete: () {
    print('Face liveness detection completed successfully');
    // Fetch results from your backend
  },
  onError: (errorCode) {
    print('Face liveness detection error: $errorCode');
  },
)

4. Fetch Liveness Results

After the liveness check is complete, you should verify the results with your backend:

Future<Map<String, dynamic>> fetchLivenessResults({
  required String sessionId,
}) async {
  final response = await http.get(
    Uri.parse('https://your-backend-url.com/face-liveness/results?sessionId=$sessionId'),
    headers: {'Content-Type': 'application/json'},
  );

  if (response.statusCode == 200) {
    return jsonDecode(response.body);
  }
  
  throw Exception('Failed to fetch liveness results');
}

Example

Check the example directory for a complete example app.

Backend Implementation

You'll need a backend service that can:

1. Create Face Liveness sessions using the AWS SDK
2. Fetch Face Liveness results after completion

A simple implementation using Spring Boot is provided in the example directory.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Additional Resources

• AWS Rekognition Documentation
• AWS Amplify Documentation
• AWS Rekognition Face Liveness