Class FaceVerification

Namespace

NuvTools.Security.Biometrics

Assembly

NuvTools.Security.dll

Result of comparing a captured face with the one on record.

public sealed record FaceVerification : IEquatable<FaceVerification>

Inheritance

object

FaceVerification

Implements

IEquatable<FaceVerification>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FaceVerification(bool, double, string?, FaceVerificationFailureType)

Result of comparing a captured face with the one on record.

public FaceVerification(bool Matched, double Similarity, string? Liveness, FaceVerificationFailureType Failure)

Parameters

Matched bool

Whether the capture was accepted as the person: similarity at or above the configured minimum and, when liveness is enforced, a liveness the application accepts.

Similarity double

How alike the two faces are (0.0 = different, 1.0 = identical). Zero when no comparison happened.

Liveness string

What the provider reported about the capture being of a live person, in its own words, or null when it reported nothing.

Failure FaceVerificationFailureType

Why the capture was not accepted, or None.

Properties

Failure

Why the capture was not accepted, or None.

public FaceVerificationFailureType Failure { get; init; }

Property Value

FaceVerificationFailureType

Liveness

What the provider reported about the capture being of a live person, in its own words, or null when it reported nothing.

public string? Liveness { get; init; }

Property Value

string

Matched

Whether the capture was accepted as the person: similarity at or above the configured minimum and, when liveness is enforced, a liveness the application accepts.

public bool Matched { get; init; }

Property Value

bool

Similarity

How alike the two faces are (0.0 = different, 1.0 = identical). Zero when no comparison happened.

public double Similarity { get; init; }

Property Value

double

Methods

Failed(FaceVerificationFailureType)

Creates the result of a verification that never reached a comparison.

public static FaceVerification Failed(FaceVerificationFailureType failure)

Parameters

failure FaceVerificationFailureType

Why it failed.

Returns

FaceVerification