# Liveness

## Submit Liveness Check

> Submit a liveness check video or image. This is used to verify that the person submitting the verification is physically present and not using a photo or video. It helps prevent identity fraud.

```json
{"openapi":"3.1.0","info":{"title":"BeetleLabs","version":"1.0.0"},"servers":[{"url":"https://beetlelabs.ai/beetlelabs-verification","description":"Local development server"}],"paths":{"/liveness/":{"post":{"tags":["Liveness"],"summary":"Submit Liveness Check","description":"Submit a liveness check video or image. This is used to verify that the person submitting the verification is physically present and not using a photo or video. It helps prevent identity fraud.","operationId":"submit_liveness_check_liveness__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LivenessCheckCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"LivenessCheckCreate":{"properties":{"video_url":{"type":"string","title":"Video Url"},"image_url":{"type":"string","title":"Image Url"},"session_id":{"type":"string","format":"uuid4","title":"Session Id"},"passed":{"type":"boolean","title":"Passed"},"confidence_score":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Confidence Score"}},"type":"object","required":["video_url","image_url","session_id","passed"],"title":"LivenessCheckCreate"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Liveness Check

> Get the liveness check results for a specific session. This shows whether the person has successfully completed the liveness verification process.

```json
{"openapi":"3.1.0","info":{"title":"BeetleLabs","version":"1.0.0"},"servers":[{"url":"https://beetlelabs.ai/beetlelabs-verification","description":"Local development server"}],"paths":{"/liveness/{session_id}":{"get":{"tags":["Liveness"],"summary":"Get Liveness Check","description":"Get the liveness check results for a specific session. This shows whether the person has successfully completed the liveness verification process.","operationId":"get_liveness_check_liveness__session_id__get","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.beetlelabs.ai/liveness.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.