Home

Liveness

Submit Liveness Check

post

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.

Body
video_urlstringRequired
image_urlstringRequired
session_idstring · uuid4Required
passedbooleanRequired
confidence_scoreany ofOptional
integerOptional
or
nullOptional
Responses
200
Successful Response
application/json
Responseany
post
POST /beetlelabs-verification/liveness/ HTTP/1.1
Host: beetlelabs.ai
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "video_url": "text",
  "image_url": "text",
  "session_id": "text",
  "passed": true,
  "confidence_score": 1
}
No content

Get Liveness Check

get

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

Path parameters
session_idstringRequired
Responses
200
Successful Response
application/json
Responseany
get
GET /beetlelabs-verification/liveness/{session_id} HTTP/1.1
Host: beetlelabs.ai
Accept: */*

No content
PreviousID,Address Document ProofNextBusiness details(KYB)