Failed to start the face liveness session on Android & IOS

[pdguru81]

Before creating a new issue, please confirm:

• I have searched for duplicate or closed issues.
• I have read the guide for submitting bug reports.

Which UI component?

Liveness

Gradle script dependencies

// Put output below this line
    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:2.0.21"
    implementation 'com.amplifyframework:aws-auth-cognito:2.23.0'
    implementation 'com.amazonaws:aws-android-sdk-mobile-client:2.57.0'
    implementation 'com.amplifyframework:aws-predictions:2.23.0'
    implementation 'com.amplifyframework.ui:liveness:1.3.0'
    implementation 'androidx.compose.material3:material3:1.3.1'
    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:2.1.4'
    implementation 'androidx.activity:activity-compose:1.9.3'
    implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.8.7'
    implementation 'io.github.cdimascio:dotenv-kotlin:6.5.0'

Environment information

# Put output below this line

Build time:   2023-11-29 14:08:57 UTC
Revision:     28aca86a7180baa17117e0e5ba01d8ea9feca598

Kotlin:       1.9.20
Groovy:       3.0.17
Ant:          Apache Ant(TM) version 1.10.13 compiled on January 4 2023
JVM:          1.8.0_411 (Oracle Corporation 25.411-b09)
OS:           Mac OS X 14.3 aarch64

Please include any relevant guides or documentation you're referencing

No response

Describe the bug

We are unable to complete the liveness check on Android or IOS during development.
I can launch a video session however, the liveness UI crashes right after my liveness has been captured.

We are using flutter and leverage Method Channels messages to start the liveness session on native android OS from our flutter app.
It's unclear why everything we've tried hasn't worked.

Reproduction steps (if applicable)

No response

Code Snippet

// Put your code below this line.

Log output

// Put your logs below this line

amplifyconfiguration.json

{
  "auth": {
    "plugins": {
      "awsCognitoAuthPlugin": {
        "CognitoUserPool": {
          "Default": {
            "PoolId": "$cognitoUserPoolId",
            "AppClientId": "$appClientId",
            "Region": "$region"
          }
        },
        "CredentialsProvider": {
          "CognitoIdentity": {
            "Default": {
              "PoolId": "$identityPoolId",
              "Region": "$region"
            }
          }
        },
        "Auth": {
          "Default": {
            "authenticationFlowType": "USER_SRP_AUTH"
          }
        }
      }
    }
  },
  "api": {
    "plugins": {
      "awsAPIPlugin": {
        "endpoint": "$apiGatewayUrl",
        "region": "$region",
        "authorizationType": "AWS_IAM"
      }
    }
  },
  "analytics": {
    "plugins": {
      "awsPinpointAnalyticsPlugin": {
        "pinpointAnalytics": {
          "appId": "$awsPinpointAppId",
          "region": "$region"
        },
        "pinpointTargeting": {
          "region": "$region"
        }
      }
    }
  }
}

Additional information and screenshots

No response

[pdguru81]

Note that someone reported a similar issue here, but the proposed solutions there hasn't worked for us: https://ui.docs.amplify.aws/android/connected-components/liveness

[tylerjroach]

I can only speak on the Android side here. Please open up a Swift ticket if you haven't. Please also send the stacktrace with the included exception. This should tell us why it failed. Any code snippets would also be helpful.

It's most likely an Auth issue looking at your dependencies. You are including both

implementation 'com.amplifyframework:aws-auth-cognito:2.23.0'
implementation 'com.amazonaws:aws-android-sdk-mobile-client:2.57.0'

Amplify v2 and the old AWS Android SDK (Mobile Client here) are not compatible with each other. You need to use one or the other, preferably Amplify v2. If you do choose to use MobileClient instead of Amplify, you will have to write a custom credentials provider that is passed into Liveness so that it can properly fetch credentials. It would look similar to this: https://docs.amplify.aws/gen1/android/sdk/configuration/amplify-compatibility/

[pdguru81]

The compatibility issue is good to know. I added the Mobile Client as a final attempt at implementing a custom credsprovider since all other attempts at using Amplify.configure(config, context) etc didn't work. I've gotten some feedback to attempt setting up a role that allows unauthenticated users to start liveness checks. We might get around the Auth issues that way, but it doesn't seem ideal.

[tylerjroach]

Please provide more information on why auth isn't working for your use case and we can try to help you get it set up correctly (ex: why Amplify isn't working) FaceLivenessDetector will use Amplify.Auth as the credential provider by default, unless you choose to implement with a custom one. And example of this can be found here: https://ui.docs.amplify.aws/android/connected-components/liveness#step-1-configure-auth after clicking on the "Custom Credentials Provider" tab.

[pdguru81]

I will close out this issue. We have resolved it by using an identity pool without relying on creds from cognito pools. As for our original problem, the liveness libs didn't return adequate error details. It makes it tough to debug issues when a generic FaceLivenessDetectionException is thrown.

[github-actions]

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.