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>"
}
'
{
  "status": "failed",
  "data": [
    "<unknown>"
  ],
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.smartcomply.com/llms.txt

Use this file to discover all available pages before exploring further.

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