Skip to content

Commit 4ed306d

Browse files
committed
1 parent 60b9a18 commit 4ed306d

1 file changed

Lines changed: 18 additions & 3 deletions

File tree

liveness.yml

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,22 @@ paths:
77
get:
88
tags:
99
- liveness 2.0
10-
summary: Liveness assessment
10+
summary: 'liveness check'
11+
description: "To verify the presence of a real person in front of a camera, use the GET `/api/v2/liveness` endpoint. When starting, you can specify `tag` which all attempts to read liveness will be bound to. If left unspecified, the application automatically generates one. The calling application returns `tag` and `transactionId`. One session may include many transactions, and from a transaction ID it is clear which session it belongs to.
12+
13+
14+
When specifying `tag`, note that only Latin uppercase and lowercase letters, digits, and symbols `-` and `_` are allowed. The maximum supported number of characters is 127.
15+
16+
17+
The person's selfie and video from the liveness detection session are stored on the backend at:
18+
`faceapi-session/year={year}/month={month}/day={day}/hour={hour}/minute={minute}/{tag}/transactionId`
19+
20+
21+
By default, liveness checks operate with eventual consistency. This means that when you submit a request and receive a response, the associated data (like the selfie and session video) may be saved after the response is sent. If this doesn't meet your requirements, you can switch to strong consistency; refer to the [Architecture page](https://docs.regulaforensics.com/develop/face-sdk/overview/architecture/#consistency-models) for details.
22+
23+
24+
To access the liveness transaction data, use GET `/api/v2/liveness?transactionId={transactionId}`.
25+
"
1126
operationId: get_liveness_transaction_info
1227
responses:
1328
200:
@@ -24,11 +39,11 @@ components:
2439
properties:
2540
code:
2641
type: integer
27-
description: "Result code, one of the FaceSDKResultCode enum values. See the enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/"
42+
description: "Result code, see the [FaceSDKResultCode enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/)."
2843
status:
2944
type: integer
3045
default: null
31-
description: "Whether the liveness detection is confirmed (0) or not (1)."
46+
description: "Whether the liveness detection is confirmed `0` or not `1`."
3247
tag:
3348
type: string
3449
description: "Session identificator, should be unique for each session."

0 commit comments

Comments
 (0)