PIN authentication

Use a PIN to perform specific operations when biometric authentication is not necessary

For authentication scenarios that don't require biometric recognition, you can use PIN as an alterntative.

PIN authentication only supports Operation info

Keyless requires at least one of the following authentication mechanisms to be present for each user:

• biometric authentication

• PIN

Enrollment with PIN

To use PIN during enrollment, add the PIN parameter to the builder configuration:

Android

val configuration = EnrollmentConfiguration.builder
  .withPin("myPin")
  .build()

iOS

let configuration = Keyless.EnrollmentConfiguration.builder
  .withPin("myPin")
  .build()

Flutter

final configuration = EnrollmentConfig(
    pin: "myPin"
);

try {
    await Keyless.instance.enroll(configuration);
    print("Enrollment successful");
} catch (error) {
    print("Enrollment failed: $error");
}

To enroll multiple authentication mechanisms, call EnrollmentConfiguration once for each mechanism.

Authentication with PIN

To use PIN during authentication, add the PIN parameter to the builder configuration:

PIN authentication only supports Operation info

Android

val configuration = AuthenticationConfiguration.builder
  .withPin("myPin")
  .build()

iOS

let configuration = Keyless.AuthenticationConfiguration.builder
  .withPin("myPin")
  .build()

Flutter

final configuration = PinAuthConfig(
    pin: "myPin"
);

try {
    final result = await Keyless.instance.authenticate(configuration);
    print("Authentication successful");
} catch (error) {
    print("Authentication failed: $error");
}

De-enrollment with PIN

To de-enroll your user using the PIN authentication mechanism, specify the dedicated builder parameter:

Note that de-enrolling deletes the user biometrics as well as the PIN. If you just want to remove the PIN authentication mechanism, use the PIN utilities instead.

Android

val configuration =
DeEnrollmentConfiguration.builder
  .withPin("myPin")
  .build()

iOS

let configuration =
Keyless.DeEnrollmentConfiguration.builder
  .withPin("myPin")
  .build()

Flutter

final configuration = PinDeEnrollConfig(
    pin: "myPin"
);

try {
    await Keyless.instance.deEnroll(configuration);
    print("De-enrollment successful");
} catch (error) {
    print("De-enrollment failed: $error");
}

PIN utilities

To change the PIN use the Keyless.changePin API:

Android

fun changePin(
  oldPin: String,
  newPin: String,
  onCompletion: (KeylessResult<KeylessSdkSuccess, KeylessSdkError>) -> Unit
)

iOS

public static func changePin(
  oldPin: String,
  newPin: String,
  completionHandler: @escaping (KeylessSDKError?) -> Void
)

Flutter

Future<void> changePin({
  required String oldPin,
  required String newPin
})

To remove the PIN mechanism and keep the user enrolled use the Keyless.removePin API:

Android

fun removePin(
  pin: String,
  onCompletion: (KeylessResult<KeylessSdkSuccess, KeylessSdkError>) -> Unit
)

iOS

public static func removePin(
  pin: String,
  completionHandler: @escaping (KeylessSDKError?) -> Void
)

Flutter

Future<void> removePin({
  required String pin
})