Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465453454.1 KB

This API operation initiates a Face Liveness session. It returns a <code>SessionId</code>, which you can use to start streaming Face Liveness video and get the results for a Face Liveness session. You can use the <code>OutputConfig</code> option in the Settings parameter to provide an Amazon S3 bucket location. The Amazon S3 bucket stores reference images and audit images. You can use <code>AuditImagesLimit</code> to limit of audit images returned. This number is between 0 and 4. By default, it is set to 0. The limit is best effort and based on the duration of the selfie-video.

post/#X-Amz-Target=RekognitionService.CreateFaceLivenessSession

Headers

X-Amz-Target'RekognitionService.CreateFaceLivenessSession' required

Request body

KmsKeyIdstring

The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt audit images and reference images.

ClientRequestTokenstring

Idempotent token is used to recognize the Face Liveness request. If the same token is used with multiple <code>CreateFaceLivenessSession</code> requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.

Response

Success

SessionIdstring required

A unique 128-bit UUID identifying a Face Liveness session.