BrandKwikID Documentation
API SuiteFace & Biometrics (ML)

Liveness Detection

Detect liveness using image and/or video with enhanced multi-frame analysis and face matching capabilities.

Try itLoading playground…
Loading…
AuthorizationBearer <token>

JWT Bearer token authentication. Obtain a token from the KwikID dashboard.

In: header

image?string
video?string
frame_sampling_rate?string

Frame sampling interval for video analysis

max_frames_to_analyze?string

Maximum number of frames to analyze

Response Body

curl -X POST "https://__mock__/liveness"
{
  "result": "real",
  "confidence": 1,
  "blink_detection": true,
  "image_input": true,
  "video_input": true,
  "facematch_result": "True",
  "facematch_confidence": 1,
  "facematch_frames_tested": 0,
  "overall_result": "True",
  "overall_confidence": 1,
  "image_result": "real",
  "image_confidence": 1,
  "video_frames_analyzed": 0,
  "real_video_frames": 0,
  "total_video_frames": 0,
  "enhanced_detection": true,
  "frame_sampling_rate": 0,
  "max_frames_analyzed": 0
}
{
  "detail": {
    "<location>": {
      "<field_name>": [
        "string"
      ]
    }
  },
  "message": "string"
}
{
  "detail": {},
  "message": "string"
}