ResultData

@Serializable()
public final class ResultData implements Serializable

Parameters

uniqueRequestId

This is the unique key that is echoed back from the request.

verificationResultId

This is the unique Form ID that is generated on the IDmission server for each unique request.

verificationResultDetails

Decision_{DecisionName} – This is a repeating node for each applicable decision and the DecisionName label will vary indicating the decision category from validation processing. DecisionStateCode - Different decision state codes will be returned back based on the servers evaluation of the request. Please refer /master/status-code-list which represents all possible values as the statusCode. DecisionResult - This is the result state of the submission. Please refer /master/status-code-list which represents all possible values shown in the statusCodeDescription for failed decisions. When a decision rule passes, the DecisionResult value will always be "OK".

verificationResult

This is the result state of the submission. Please refer /master/status-code-list which represents all of the values for the Form Create / Form Search APIs.

verificationResultCode

Different status codes will be returned back based on the servers evaluation of the request. Please refer /master/status-code-list which represents all of the values for the Form Create / Form Search APIs.

faceVerificationResult

Verified' if the face matches or 'Not Verified' if the face doesn't match. Matching is based on thresholds set using the biometric match score.

faceVerificationScore

Score associated with the facial biometric match. Values will be 0 to 100.

faceMask

If a face mask is detected in the image, the value will be true, else false.

faceMaskScore

Score associated with the face mask detection. Value range from 0 to 1, 1 being the highest.

liveFace

If a live face is detected in the image(s), the value will be true, else false.

realScore

Score associated with the face liveness. Value range from 0 to 1, 1 being the highest.

headCovering

If a head covering is detected in the image, the value will be true, else false.

headCoveringScore

Score associated with the head covering detection. Value range from 0 to 1, 1 being the highest.

eyeCovering

If any eye covering is detected in the image (e.g. glasses, specticles, patches), the value will be true, else false.

eyeCoveringScore

Score associated with the eye covering detection. Value range from 0 to 1, 1 being the highest.

cellPhone

If a cell phone is detected in the image, the value will be true, else false.

cellPhoneScore

Score associated with the cell phone detection. Value range from 0 to 1, 1 being the highest.

estimatedAge

Estimated age of a subject based on the evaluation of their facial biometrics.

predicatedGender

Predicted gender of a subject based on the evaluation of their facial biometrics.

closedEyes

If closed eyes detected in the image. the value will be true, else false.

videoIDData

Constructors

Link copied to clipboard
public ResultData ResultData(String uniqueRequestId, Long verificationResultId, JsonElement verificationResultDetails, String verificationResult, String verificationResultCode, String faceVerificationResult, Double faceVerificationScore, String faceMask, Double faceMaskScore, String liveFace, Double realScore, String headCovering, Double headCoveringScore, String eyeCovering, Double eyeCoveringScore, String cellPhone, Double cellPhoneScore, Double estimatedAge, String predicatedGender, Boolean closedEyes, VideoIDData videoIDData)

Properties

Link copied to clipboard
private final String cellPhone

Type:string
If a cell phone is detected in the image, the value will be true, else false.

Link copied to clipboard
private final Double cellPhoneScore

Type:Double
Score associated with the cell phone detection. Value range from 0 to 1, 1 being the highest.

Link copied to clipboard
private final Boolean closedEyes

Type:Boolean
If closed eyes detected in the image. the value will be true, else false.

Link copied to clipboard
private final Double estimatedAge

Type:Double
Estimated age of a subject based on the evaluation of their facial biometrics.

Link copied to clipboard
private final String eyeCovering

Type:string
If any eye covering is detected in the image (e.g. glasses, specticles, patches), the value will be true, else false.

Link copied to clipboard
private final Double eyeCoveringScore

Type:Double
Score associated with the eye covering detection. Value range from 0 to 1, 1 being the highest.

Link copied to clipboard
private final String faceMask

Type:string
If a face mask is detected in the image, the value will be true, else false.

Link copied to clipboard
private final Double faceMaskScore

Type:Double
Score associated with the face mask detection. Value range from 0 to 1, 1 being the highest.

Link copied to clipboard

Type:string
This is the result state of the Face Verification. This includes the result - "Not Verified" if selfie not matched with face in ID "Verified" - if selfie matched with face in ID

Link copied to clipboard

Type:Double
Score associated with the facial biometric match. Values will be 0 to 100.

Link copied to clipboard
private final String headCovering

Type:string
If a head covering is detected in the image, the value will be true, else false.

Link copied to clipboard
private final Double headCoveringScore

Type:Double
Score associated with the head covering detection. Value range from 0 to 1, 1 being the highest.

Link copied to clipboard
private final String liveFace

Type:string
If a live face is detected in the image(s), the value will be true, else false.

Link copied to clipboard
private final String predicatedGender

Type:String
Predicted gender of a subject based on the evaluation of their facial biometrics.

Link copied to clipboard
private final Double realScore

Type:Double
Score associated with the face liveness. Value range from 0 to 1, 1 being the highest.

Link copied to clipboard
private final String uniqueRequestId

Type:string
maxLength: 256
example: 56975421474
This is the unique key that is echoed back from the request.

Link copied to clipboard
private final String verificationResult

Type:String
This is the result state of the submission. Please refer /master/status-code-list which represents all of the values for the Form Create / Form Search APIs.

Link copied to clipboard

Different status codes will be returned back based on the servers evaluation of the request. Please refer /master/status-code-list which represents all of the values for the Form Create / Form Search APIs.

Link copied to clipboard
private final transient JsonElement verificationResultDetails

Type:JsonElement
Decision_{DecisionName} – This is a repeating node for each applicable decision and the DecisionName label will vary indicating the decision category from validation processing. DecisionStateCode - Different decision state codes will be returned back based on the servers evaluation of the request. Please refer /master/status-code-list which represents all possible values as the statusCode. DecisionResult - This is the result state of the submission. Please refer /master/status-code-list which represents all possible values shown in the statusCodeDescription for failed decisions. When a decision rule passes, the DecisionResult value will always be "OK".

Link copied to clipboard
private final Long verificationResultId

Type:integer($int64)
example: 1234
This is the unique Form ID that is generated on the IDmission server for each unique request.

Link copied to clipboard
private final VideoIDData videoIDData

Functions

Link copied to clipboard
public final String getCellPhone()

Type:string
If a cell phone is detected in the image, the value will be true, else false.

Link copied to clipboard
public final Double getCellPhoneScore()

Type:Double
Score associated with the cell phone detection. Value range from 0 to 1, 1 being the highest.

Link copied to clipboard
public final Boolean getClosedEyes()

Type:Boolean
If closed eyes detected in the image. the value will be true, else false.

Link copied to clipboard
public final Double getEstimatedAge()

Type:Double
Estimated age of a subject based on the evaluation of their facial biometrics.

Link copied to clipboard
public final String getEyeCovering()

Type:string
If any eye covering is detected in the image (e.g. glasses, specticles, patches), the value will be true, else false.

Link copied to clipboard
public final Double getEyeCoveringScore()

Type:Double
Score associated with the eye covering detection. Value range from 0 to 1, 1 being the highest.

Link copied to clipboard
public final String getFaceMask()

Type:string
If a face mask is detected in the image, the value will be true, else false.

Link copied to clipboard
public final Double getFaceMaskScore()

Type:Double
Score associated with the face mask detection. Value range from 0 to 1, 1 being the highest.

Link copied to clipboard

Type:string
This is the result state of the Face Verification. This includes the result - "Not Verified" if selfie not matched with face in ID "Verified" - if selfie matched with face in ID

Link copied to clipboard

Type:Double
Score associated with the facial biometric match. Values will be 0 to 100.

Link copied to clipboard
public final String getHeadCovering()

Type:string
If a head covering is detected in the image, the value will be true, else false.

Link copied to clipboard

Type:Double
Score associated with the head covering detection. Value range from 0 to 1, 1 being the highest.

Link copied to clipboard
public final String getLiveFace()

Type:string
If a live face is detected in the image(s), the value will be true, else false.

Link copied to clipboard
public final String getPredicatedGender()

Type:String
Predicted gender of a subject based on the evaluation of their facial biometrics.

Link copied to clipboard
public final Double getRealScore()

Type:Double
Score associated with the face liveness. Value range from 0 to 1, 1 being the highest.

Link copied to clipboard
public final String getUniqueRequestId()

Type:string
maxLength: 256
example: 56975421474
This is the unique key that is echoed back from the request.

Link copied to clipboard

Type:String
This is the result state of the submission. Please refer /master/status-code-list which represents all of the values for the Form Create / Form Search APIs.

Link copied to clipboard

Different status codes will be returned back based on the servers evaluation of the request. Please refer /master/status-code-list which represents all of the values for the Form Create / Form Search APIs.

Link copied to clipboard
public final JsonElement getVerificationResultDetails()

Type:JsonElement
Decision_{DecisionName} – This is a repeating node for each applicable decision and the DecisionName label will vary indicating the decision category from validation processing. DecisionStateCode - Different decision state codes will be returned back based on the servers evaluation of the request. Please refer /master/status-code-list which represents all possible values as the statusCode. DecisionResult - This is the result state of the submission. Please refer /master/status-code-list which represents all possible values shown in the statusCodeDescription for failed decisions. When a decision rule passes, the DecisionResult value will always be "OK".

Link copied to clipboard

Type:integer($int64)
example: 1234
This is the unique Form ID that is generated on the IDmission server for each unique request.

Link copied to clipboard
public final VideoIDData getVideoIDData()