Flutter quickstart

1. 1

   Add the dependency

   yamlCopy

   # pubspec.yaml
   dependencies:
     neetix_liveliness:
       git:
         url: https://github.com/neetixai/liveliness-sdks.git
         path: packages/flutter
         ref: "0.2.0"

   bashCopy

   flutter pub get

2. 2

   Get a test key

   bashCopy

   curl -X POST https://liveliness.neetix.in/v1/signup \
     -H 'Content-Type: application/json' \
     -d '{"email":"you@company.com"}'

   The client can also mint one with no auth at all:

   dartCopy

   final s = await NeetixClient().signup('you@company.com');
   // s.apiKey is shown once — 1,000 free credits

   A key in a Flutter app is extractable

   Dart compiles to a bundle an attacker can read, on mobile and on web. Use a test key while building; in production mint short-lived keys from your own backend.

3. 3

   Make the call

   dartCopy

   import 'dart:io';
   import 'package:neetix_liveliness/neetix_liveliness.dart';
   
   final nx = NeetixClient(apiKey: 'YOUR_KEY');
   
   final selfie = await File('selfie.jpg').readAsBytes();
   final card = await File('id.jpg').readAsBytes();
   
   final res = await nx.faceMatch(selfie, card, clientRefId: 'application-4821');
   
   print(res.verdict);        // "approved" | "review" | "declined"
   print(res.isSameFace);
   print(res.warnings.length);

   With image_picker, the bytes come straight from the picked file:

   dartCopy

   final picked = await ImagePicker().pickImage(source: ImageSource.camera);
   final selfie = await picked!.readAsBytes();

4. 4

   Branch on the verdict

   dartCopy

   switch (res.verdict) {
     case 'approved':
       continueJourney();
     case 'review':
       queueForReview(res.warnings);
     case 'declined':
       stop(res.warnings);
   }

Liveliness on its own

final live = await nx.liveness(selfie);
print(live.status);          // "Approved" | "Declined" | "Not Finished"
print(live.livenessScore);

What else is available

Next

• Get started — verdicts, warnings and credits.
• REST API — what the client calls underneath.