POST
/
liveliness
Liveliness Check
curl --request POST \
  --url https://sandbox.cashfree.com/verification/liveliness \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --form verification_id=test_verification_id \
  --form 'image=<image_file>' \
  --form strict_check=true
{
  "reference_id": 1357,
  "verification_id": "123456",
  "status": "SUCCESS",
  "liveliness": true,
  "score": 0.95
}

Authorizations

​
x-client-id
string
header
required

Client ID. You can find your ID in the Merchant Dashboard.

​
x-client-secret
string
header
required

Client secret key. You can find your secret key in the Merchant Dashboard.

Headers

​
x-cf-signature
string

Send the signature if IP is not whitelisted

Body

multipart/form-data

Find the request parameters to verify if the customer is genuine and not a bot

Find the request parameters to check the liveliness in an image

Response

200
application/json

Success response for checking the liveliness of your customer

Success response for Liveliness Check API