nebuia_plugin

Description:

nebuia plugin

NebuIA #

Introduction #
NebuIA Native Core is a library for NebuIA services integration. NebuIA use platform native channels and run over native
languages Objective-C for iOS and Kotlin/Java for Android.
NebuIA is a Deep Learning library and supports:

Face detection and auto crop
Proof of life in real time

Darkened images
Office fluorescent lighting
Office with lighting turned off, illuminated only by natural sunlight
Supported attacks

Printing
2D Mask
2 Replay




Document detection in real time

Faster and best accuracy than conventional ID Detector (95%)
Supports auto cropping


Proof of address

Automatic address extraction


Typical OTP verifications for email and phone number via SMS

Time-Based One-Time Password (TOTP)
HMAC-Based One-Time Password (HOTP)


RFC 4226: "RFC 4226 HOTP: An HMAC-Based One-Time Password Algorithm"
RFC 6238: "TOTP: Time-Based One-Time Password Algorithm"



Requirements #

Flutter 2 - Null safety

Integration #
Add nebuia_plugin to your project:
nebuia_plugin: ^x.x.x
copied to clipboard
Android #
Change the min SDK version to 24 on android/app/build.gradle:
android {
defaultConfig {
minSdkVersion 24
...
}
...
}
copied to clipboard
Add public and private keys to android/app/src/main/res/values/values.xml:
<?xml version="1.0" encoding="UTF-8"?>
<resources>
<string name="nebuia_public_key">S5PS103-RHWM8E8-*******-7GQ0NX1</string>
<string name="nebuia_secret_key">c96d9080-c479-4439-****-b1523c2e0af4</string>
</resources>
copied to clipboard
Add the following property to android/gradle.properties file:
authNebuia=<your-code>
copied to clipboard

Contact NebuIA support to get private keys, public keys and other authentication codes.

iOS #
Add public and private keys to your Info.plist:
<?xml version="1.0" encoding="UTF-8"?>
<plist version="1.0">
<dict>
<key>NebuIAPublicKey</key>
<string>S5PS103-RHWM8E8-*******-7GQ0NX1</string>
<key>NebuIASecretKey</key>
<string>c96d9080-c479-4439-****-b1523c2e0af4</string>
...
</dict>
</plist>
copied to clipboard
Indicate iOS 13 as minimum iOS version on top of ios/Podfile:
platform :ios, '13.0'
copied to clipboard
Add the pod of NebuIA to ios/Podfile:
target 'Runner' do
use_frameworks!
use_modular_headers!

pod 'NebuIA', :git => 'https://github.com/dist-bit/nebuia_native_ios.git'

flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
...
end
copied to clipboard

Contact NebuIA support to get private keys, public keys and other authentication codes.

Troubleshooting #
Every time that NebuIA wants to be updated, the ios/Podfile.lock must be deleted and then in ios folder, run:
pod install
copied to clipboard
Sample Integration #
import 'package:nebuia_plugin/nebuia_plugin.dart';

// Set client endpoint (only if you need custom client installation) - omit for default services.
NebuiaPlugin.setClientURI = 'https://my.endpoint.com/api/v1/services';

// Call your service for temporal code generation.
// Code is response number string.
NebuiaPlugin.setTemporalCode = code;

// Create a new report.
// Store `generatedReport` in your database for future usage.
final String? generatedReport = await NebuiaPlugin.createReport;

// If you already have a report:
NebuiaPlugin.setReport = generatedReport;

// Scan Mexican ID/passport.
final bool wasSuccessful = await NebuiaPlugin.documentDetection;

// Face spoofing test.
final bool? wasSuccessful = await NebuiaPlugin.faceLiveDetection;

// Scan proof of address.
// The result is a `LinkedHashMap` containing all extracted data from
// the address proof sheet.
final LinkedHashMap? address = await NebuiaPlugin.captureAddressProof;

// Save the desired address to NebuIA services.
final LinkedHashMap? address = await NebuiaPlugin.saveAddress(
address,
);

// Scan hand fingers.
// Left hand: 0.
// Right hand: 1.
Fingers? fingers = await NebuiaPlugin.fingerDetection(
0,
false,
);

// Generate WSQ from fingerprint.
// The generated image is returned in bytes.
Uint8List? wsq = await NebuiaPlugin.generateWSQFingerprint(
image,
);

// Save email to generate an OTP later.
final bool wasSuccessful = await NebuiaPlugin.saveEmail(
email,
);
// Send OTP to saved email.
final bool wasSent = await NebuiaPlugin.generateOTPEmail;
// Verify OTP sent to email.
final bool isValid = await NebuiaPlugin.verifyOTPEmail(
code,
);

// Save phone to generate an OTP later.
final bool wasSuccessful = await NebuiaPlugin.savePhone(
phone,
);
// Send OTP to saved phone.
final bool wasSent = await NebuiaPlugin.generateOTPPhone;
// verify OTP phone
final bool isValid = await NebuiaPlugin.verifyOTPPhone(
code,
);

// Generate record.
final String? path = await NebuiaPlugin.recordActivity(
text,
);

// Get face image.
final Uint8List? face = NebuiaPlugin.getFaceImage;

// Get ID front image.
final Uint8List? face = NebuiaPlugin.getIDFrontImage;
// Get ID back image.
final Uint8List? face = NebuiaPlugin.getIDBackImage;
copied to clipboard
Address validation flow sample #
Address model sample - generated with JSON serializer.
LinkedHashMap? _address = await NebuiaPlugin.captureAddressProof;
if (_address != null) {
// check address response
if (_address.containsKey('status')) {
// check status response
if (_address['status']) {
// check if payload is valid response
if (_address['payload'].runtimeType.toString() ==
'_InternalLinkedHashMap<Object?, Object?>') {
var _payload = _address['payload'];
// if valid and status is true save address
if (_payload['valid']) {
// show form address
try {
// try to deserialize address
addressModel = AddressModel.fromJson(Map.from(_payload));
sendEvent(
NebuIAEvent(
action: NebuIAAction.addressVerified),
);
} catch (e) {
sendEvent(
NebuIAEvent(
action: NebuIAAction.addressError,
message: 'address not found'),
);
}
} else {
// verify manual address
_validateAddress(_payload['address'][0]);
}
} else {
sendEvent(
NebuIAEvent(
action: NebuIAAction.addressError,
message: 'address not found'),
);
}
} else {
sendEvent(
NebuIAEvent(
action: NebuIAAction.addressError,
message: 'address not found'),
);
}
} else {
sendEvent(
NebuIAEvent(
action: NebuIAAction.addressError,
message: 'address not found'),
);
}
} else {
// logic for failed address
}
copied to clipboard
part 'address.model.g.dart';

@JsonSerializable()
class AddressModel extends BaseNetworkModel<AddressModel> {
late List<String>? address;
final List<VerificationsAddress> verifications;
final ZoneAddress zone;
final StateAddress state;
final bool valid;

// manual input
late String? street;
late String? outdoor_number;
late String? interior_number;

AddressModel(this.address,
this.verifications, this.zone, this.state, this.valid);

factory AddressModel.fromJson(Map<String, dynamic> json) => _$AddressModelFromJson(json);

@override
AddressModel fromJson(Map<String, dynamic> json) {
return AddressModel.fromJson(json);
}

@override
Map<String, dynamic> toJson() => _$AddressModelToJson(this);
}
copied to clipboard
part 'verifications.address.model.g.dart';

@JsonSerializable()
class VerificationsAddress extends BaseNetworkModel<VerificationsAddress> {
final String description;
final bool status;
String? note;

VerificationsAddress(this.description, this.note, this.status);

factory VerificationsAddress.fromJson(Map<String, dynamic> json) => _$VerificationsAddressFromJson(json);

@override
VerificationsAddress fromJson(Map<String, dynamic> json) {
return VerificationsAddress.fromJson(json);
}

@override
Map<String, dynamic> toJson() => _$VerificationsAddressToJson(this);
}
copied to clipboard
part 'state.address.model.g.dart';

@JsonSerializable()
class StateAddress extends BaseNetworkModel<StateAddress> {
final String complete_name;
final String abbreviation;
final String renapo;
final String two_digits;
final String three_digits_nomenclature;
final String key;

StateAddress(this.complete_name, this.abbreviation, this.renapo,
this.two_digits, this.three_digits_nomenclature, this.key);

factory StateAddress.fromJson(Map<String, dynamic> json) => _$StateAddressFromJson(json);

@override
StateAddress fromJson(Map<String, dynamic> json) {
return StateAddress.fromJson(json);
}

@override
Map<String, dynamic> toJson() => _$StateAddressToJson(this);
}
copied to clipboard
part 'zone.address.model.g.dart';

@JsonSerializable()
class ZoneAddress extends BaseNetworkModel<ZoneAddress> {
final String zip_code;
final String township;
final String township_type;
final String municipality;
final String state;
final String city;
final String cp_id;
final String state_id;
final String office_id;
final String township_type_id;
final String municipality_id;
final String township_zip_type_id;
final String zone;
final String city_id;

ZoneAddress(
this.zip_code,
this.township,
this.township_type,
this.municipality,
this.state,
this.city,
this.cp_id,
this.state_id,
this.office_id,
this.township_type_id,
this.municipality_id,
this.township_zip_type_id,
this.zone,
this.city_id);

factory ZoneAddress.fromJson(Map<String, dynamic> json) => _$ZoneAddressFromJson(json);

@override
ZoneAddress fromJson(Map<String, dynamic> json) {
return ZoneAddress.fromJson(json);
}

@override
Map<String, dynamic> toJson() => _$ZoneAddressToJson(this);
}

copied to clipboard
Fingerprint #
On fingerprint scanner end you can pass any finger image to get WSQ File.
await NebuiaPlugin.generateWSQFingerprint(
image,
);
copied to clipboard