io.digified.digified_library.api.result

Class FaceMatchResult

java.lang.Object

io.digified.digified_library.api.result.DigifiedResult

io.digified.digified_library.api.result.FaceMatchResult

public class FaceMatchResult
extends DigifiedResult

Constructor Summary

Constructors

Constructor and Description
FaceMatchResult(String message, String nextProcess, Integer overallStatus, Integer result, Boolean shouldTerminate, String error, ArrayList<String> errorCode, Float congruence, Float liveness) Response of the "Face Matching request" of the API Constructor for FaceMatchResult

Method Summary

Modifier and Type	Method and Description
Float	getCongruence() Getter method for congruence: How the two images match (the higher is the better) (value between 0-1).
Float	getLiveness() Getter method for liveness: Detecting the confidence of how much is the selfie is real and not spoofed (the higher is the better) (value between 0-1).

Methods inherited from class io.digified.digified_library.api.result.DigifiedResult

getError, getErrorCode, getMessage, getNextProcess, getOverallStatus, getResult, getShouldTerminate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FaceMatchResult

public FaceMatchResult(String message,
                       String nextProcess,
                       Integer overallStatus,
                       Integer result,
                       Boolean shouldTerminate,
                       String error,
                       ArrayList<String> errorCode,
                       Float congruence,
                       Float liveness)

Response of the "Face Matching request" of the API Constructor for FaceMatchResult

Parameters:

message - "msg" in the API response, represents the recommended action for user

nextProcess - "next" in the API response, represents the next operation

overallStatus - "overall_status" in the API response, Enumeration representing overall status of the session: (FAILED: 0, VERIFIED: 1, IN_PROGRESS: 2, PENDING: 3)

result - "result" in the API response, indicating the session status: (SUCCESS: 0, HAS_ERRORS: -1, HAS_WARNINGS: 1)

shouldTerminate - "should_terminate" in the API response, False if there will be a next op-state / try, True otherwise

error - "Error" in the API response, the error message

errorCode - "code" in the API response, the error code

congruence - "congruence" in the API response, How the two images match (the higher is the better) (value between 0-1).

liveness - "liveness" in the API response, Detecting the confidence of how much is the selfie is real and not spoofed (the higher is the better) (value between 0-1).

Method Detail

getCongruence

public Float getCongruence()

Getter method for congruence: How the two images match (the higher is the better) (value between 0-1).

Returns:

"congruence" in the API response

getLiveness

public Float getLiveness()

Getter method for liveness: Detecting the confidence of how much is the selfie is real and not spoofed (the higher is the better) (value between 0-1).

Returns:

"liveness" in the API response