---
title: "GET /detectLiveness-sessions/{sessionId}"
method: GET
path: "/detectLiveness-sessions/{sessionId}"
---

# GET /detectLiveness-sessions/{sessionId}

`GET /detectLiveness-sessions/{sessionId}`

Get session result of detectLiveness/singleModal call.

## Path parameters

- `sessionId` string, required

## Response `200`

The request has succeeded.

- LivenessSession — Session result of detect liveness.
  - `sessionId` string, required — The unique ID to reference this session.
  - `authToken` string, required — Bearer token to provide authentication for the Vision SDK running on a client application. This Bearer token has limited permissions to perform only the required action and expires after the TTL time. It is also auditable.
  - `status` 'NotStarted' | 'Running' | 'Succeeded' | 'Failed' | 'Canceled', required — Enum describing allowed operation states.
  - `modelVersion` '2024-11-15' — The model version used for liveness classification.
  - `isAbuseMonitoringEnabled` object — Denotes if the abuse monitoring feature was enabled during this session.
  - `expectedClientIpAddress` string — The expected IP address or CIDR block of the client that runs the liveness check.
  - `results` LivenessSessionResults, required — The results of the liveness session.
    - `attempts` LivenessSessionAttempt[], required — The attempts data of underlying liveness call with the session.
      - `attemptId` integer, required — The attempt ID, start from 1.
      - `attemptStatus` 'NotStarted' | 'Running' | 'Succeeded' | 'Failed' | 'Canceled', required — Enum describing allowed operation states.
      - `result` LivenessResult — The results of the liveness classification.
        - `livenessDecision` 'uncertain' | 'realface' | 'spoofface' — The outcome of the liveness classification.
        - `targets` LivenessDecisionTargets, required — The targets used for liveness classification.
          - `color` LivenessColorDecisionTarget, required — The target from color image used for liveness classification.
            - `faceRectangle` FaceRectangle, required — A rectangle within which a face can be found.
              - …
        - `digest` string, required — The server calculated digest for this request. If the client reported digest differs from the server calculated digest, then the message integrity between the client and service has been compromised and the result should not be trusted. For more information, see how to guides on how to leverage this value to secure your end-to-end solution.
        - `sessionImageId` string — The image ID of the session request.
      - `error` LivenessError — The error of the liveness classification.
        - `code` string, required — The error code.
        - `message` string, required — The error message.
        - `targets` LivenessDecisionTargets, required — The targets used for liveness classification.
          - `color` LivenessColorDecisionTarget, required — The target from color image used for liveness classification.
            - `faceRectangle` FaceRectangle, required — A rectangle within which a face can be found.
              - …
      - `clientInformation` ClientInformation[] — The client information gathered during the liveness attempt.
        - `ip` string, required — The client ip address seen during the liveness attempt.
      - `abuseMonitoringResult` AbuseMonitoringResult — The abuse monitoring result for the liveness attempt.
        - `isAbuseDetected` object, required — Denotes if abuse detection triggered during this liveness attempt.
        - `otherFlaggedSessions` OtherFlaggedSessions[], required — Denotes if abuse detection triggered during this liveness attempt.
          - `attemptId` integer, required — The attempt ID, start from 1.
          - `sessionId` string, required — The unique session ID of the flagged session.
          - `sessionImageId` string — The image ID from the flagged session.

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/azure/apis/ai-face.md) · [All operations](https://skmtc.net/azure/apis/ai-face/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/ai-face/revisions/e9a68c525be6/schema)
