Image Passive Liveness

4 min

Introduction

This API allows you to perform a passive liveness check on a provided image URL for a specific patron ID using a secure, authenticated POST request.

Sample cURL

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/...patronID.../passiveLiveness \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task":"checkLiveness","essentials":{"image":"...image url..."}}'

Parameter	Type	Description
task	string	The task to perform, which in this case is checkLiveness
image	string	The URL of the image to be checked for passive liveness verification

Sample API REsponse

{
            "task": "checkLiveness",
             "essentials": {
                "image": "...image url..."
             }
            }
           // Expected response
           {
             "result": {
                "score": "...score...",
                "quality": "...quality...",
                "probability": "...probability..."
             }
           }

Parameter	Type	Description
result	object	The top-level object that contains the response data
score	string	The liveness score returned by the passive liveness check
quality	string	The quality of the image used for the liveness check
probability	string	The probability of the given image being a genuine face