AWS rekognition: Add high/low-confidence GetFaceLivenessSessionResults examples
Summary
Adds example JSON responses for high-confidence and low-confidence liveness sessions, showing the new Metadata.SDKType field and the Feedback list of codes/messages.
Security assessment
The change only documents API response shape (SDKType metadata and feedback codes) for liveness results; no security control, credential, or vulnerability is addressed.
Evidence
+The following is a response for a low-confidence session. In addition to the confidence score, the response includes a `Feedback` list of one or more codes identifying conditions detected during the session, which you can surface as retry guidance to the end user.
Diff
diff --git a/rekognition/latest/dg/face-liveness-programming-api.md b/rekognition/latest/dg/face-liveness-programming-api.md index ba4309d36..850e340c4 100644 --- a//rekognition/latest/dg/face-liveness-programming-api.md +++ b//rekognition/latest/dg/face-liveness-programming-api.md @@ -85,0 +86,2 @@ The GetFaceLivenessSessionResults API operation retrieves the results of a speci +The following is a response for a high-confidence session. The response includes `Metadata` with the `SDKType` that streamed the session. + @@ -112 +114,49 @@ The GetFaceLivenessSessionResults API operation retrieves the results of a speci - "Status": "SUCCEEDED" + "Status": "SUCCEEDED", + "Metadata": { + "SDKType": "js" + } + } + + +The following is a response for a low-confidence session. In addition to the confidence score, the response includes a `Feedback` list of one or more codes identifying conditions detected during the session, which you can surface as retry guidance to the end user. + + + { + "SessionId": "3b2d1f0a-9c4e-4a7b-8f2d-1e6c5a4b3d2e", + "Confidence": 45.2, + "ReferenceImage": { + "S3Object": { + "Bucket": "s3-bucket-name", + "Name": "file-name", + }, + "BoundingBox": { + "Height": 0.4943420886993408, + "Left": 0.8435328006744385, + "Top": 0.8435328006744385, + "Width": 0.9521094560623169} + }, + "AuditImages": [{ + "S3Object": { + "Bucket": "s3-bucket-name", + "Name": "audit-image-name", + }, + "BoundingBox": { + "Width": 0.6399999856948853, + "Height": 0.47999998927116394, + "Left": 0.1644444465637207, + "Top": 0.17666666209697723} + }], + "Status": "SUCCEEDED", + "Feedback": [ + { + "Code": "LOW_LIGHTING_DETECTED", + "Message": "Please move to a brighter location or add more lighting." + }, + { + "Code": "FACE_NOT_ALIGNED", + "Message": "Please look directly at the camera without tilting your head." + } + ], + "Metadata": { + "SDKType": "js" + }