Skip to main content
POST
/
v3
/
passive-liveness
Passive Liveness
curl --request POST \
  --url https://verification.didit.me/v3/passive-liveness/ \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form user_image='@example-file' \
  --form face_liveness_score_decline_threshold=123 \
  --form rotate_image=true \
  --form save_api_request=true \
  --form 'vendor_data=<string>'
"{\n  \"request_id\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\",\n  \"liveness\": {\n    \"status\": \"Approved\",\n    \"method\": \"PASSIVE\",\n    \"score\": 95,\n    \"user_image\": {\n      \"entities\": [\n        {\n          \"age\": 22.16,\n          \"bbox\": [\n            156,\n            234,\n            679,\n            898\n          ],\n          \"confidence\": 0.717775046825409,\n          \"gender\": \"male\"\n        }\n      ],\n      \"best_angle\": 0\n    },\n    \"warnings\": [],\n    \"face_quality\": 85.0,\n    \"face_luminance\": 50.0\n  },\n  \"created_at\": \"2025-05-01T13:11:07.977806Z\"\n}"

Authorizations

​
x-api-key
string
header
required

Body

multipart/form-data
​
user_image
file
required

User's face image to perform the passive liveness. Allowed formats: JPEG, PNG, WebP, TIFF. Maximum file size: 5MB.

​
face_liveness_score_decline_threshold
integer

Results with liveness score below this will be declined. Must be between 0-100.

​
rotate_image
boolean

If true, attempts to rotate the input images in 90-degree increments (0, 90, 180, 270) to ensure the detected face is upright before performing the face match. Note: This is only recommended if you are unsure about the orientation of the face.

​
save_api_request
boolean
default:true

Whether to save this API request. If true, then it will appear on the Manual Checks section in the Business Console.

​
vendor_data
string

A unique identifier for the vendor or user, such as a UUID or email. This field enables proper session tracking and user data aggregation across multiple verification sessions.

Response