Skip to main content
POST
/
api
/
onboarding
/
biometrics
/
face
/
liveliness_check
/
Face Liveness Check
curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/biometrics/face/liveliness_check/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "image": "<string>"
}
'
import requests

url = "https://adhere-api.smartcomply.com/api/onboarding/biometrics/face/liveliness_check/"

payload = { "image": "<string>" }
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({image: '<string>'})
};

fetch('https://adhere-api.smartcomply.com/api/onboarding/biometrics/face/liveliness_check/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://adhere-api.smartcomply.com/api/onboarding/biometrics/face/liveliness_check/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'image' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://adhere-api.smartcomply.com/api/onboarding/biometrics/face/liveliness_check/"

payload := strings.NewReader("{\n \"image\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://adhere-api.smartcomply.com/api/onboarding/biometrics/face/liveliness_check/")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"image\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://adhere-api.smartcomply.com/api/onboarding/biometrics/face/liveliness_check/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"image\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "failed",
  "data": [
    "<unknown>"
  ],
  "message": "<string>"
}
{
"status": "failed",
"message": "Authentication credentials were not provided."
}
The Face Liveness Check endpoint analyzes a facial image to confirm physical presence. It returns a confidence score and a verification status to help you distinguish real users from spoofing attempts.

Endpoint

POST /api/onboarding/biometrics/face/liveliness_check/

Request

Headers

HeaderValueRequired
x-access-tokenYour API secret keyYes
Content-Typeapplication/jsonYes

Body Parameters

ParameterTypeRequiredDescription
imagestringYesURL of the facial image to check for liveness

Example

curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/biometrics/face/liveliness_check/" \
  -H "x-access-token: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"image": "https://example.com/photo.jpg"}'

Response

200 OK

FieldTypeDescription
data.statusbooleantrue if liveness detected, false otherwise
data.detailstringHuman-readable liveness result
data.response_codestring"00" indicates success
data.confidencenumberRaw confidence score (0–1)
data.confidence_in_percentagenumberConfidence as a percentage
data.verification.statusstring"VERIFIED" or "FAILED"
data.verification.referencestringUnique reference for this check
{
  "status": "success",
  "data": {
    "status": true,
    "detail": "Liveliness Detected",
    "response_code": "00",
    "confidence": 0.9999987030029297,
    "confidence_in_percentage": 99.99987030029297,
    "verification": {
      "status": "VERIFIED",
      "reference": "067cbed9-acda-4d30-97c2-7f8e0c2ad687"
    },
    "widget_info": {},
    "session": {}
  },
  "message": "Face Liveliness successful"
}

400 Bad Request

{
  "status": "failed",
  "data": [],
  "message": "Missing required fields"
}

401 Unauthorized

{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}

Authorizations

x-access-token
string
header
required

Your Adhere API secret key

Body

application/json
image
string
required

URL of the image to check for liveness

Response

Liveness check successful