The output of GetFaceLivenessSessionResultsCommand.

interface GetFaceLivenessSessionResultsCommandOutput {
    $metadata: ResponseMetadata;
    AuditImages?: AuditImage[];
    Confidence?: number;
    ReferenceImage?: AuditImage;
    SessionId: undefined | string;
    Status: undefined | LivenessSessionStatus;
}

Hierarchy (view full)

Properties

$metadata: ResponseMetadata

Metadata pertaining to this request.

AuditImages?: AuditImage[]

A set of images from the Face Liveness video that can be used for audit purposes. It includes a bounding box of the face and the Base64-encoded bytes that return an image. If the CreateFaceLivenessSession request included an OutputConfig argument, the image will be uploaded to an S3Object specified in the output configuration. If no Amazon S3 bucket is defined, raw bytes are sent instead.

Confidence?: number

Probabalistic confidence score for if the person in the given video was live, represented as a float value between 0 to 100.

ReferenceImage?: AuditImage

A high-quality image from the Face Liveness video that can be used for face comparison or search. It includes a bounding box of the face and the Base64-encoded bytes that return an image. If the CreateFaceLivenessSession request included an OutputConfig argument, the image will be uploaded to an S3Object specified in the output configuration. In case the reference image is not returned, it's recommended to retry the Liveness check.

SessionId: undefined | string

The sessionId for which this request was called.

Status: undefined | LivenessSessionStatus

Represents a status corresponding to the state of the session. Possible statuses are: CREATED, IN_PROGRESS, SUCCEEDED, FAILED, EXPIRED.