Image Passive Liveliness advanced v2

Introduction

Passive Liveliness Advanced V2 evaluates a face image for liveness and image-quality signals in a single call. Given a publicly accessible image URL, the API detects whether a face is present and returns a validity verdict, with an optional detailed breakdown of the individual prediction checks (spoof detection, pose, occlusion, eyewear, background, and face size).

API details

Endpoint

POST https://api.signzy.app/api/v3/passive-liveliness/advanced-v2

POST https://api-preproduction.signzy.app/api/v3/passive-liveliness/advanced-v2

Request Headers

Name	Value	Required	Description
Content-Type	application/json	Mandatory	The type of content that the request body contains.
Authorization	XXXXXXXXXXXXXXX	Mandatory	An authentication token to authorize the request. Reach out to the Signzy support team to get one created.

Request body parameters

Parameter	Data Type	Description	Required
image_url	String	Input image URL	Mandatory
verbose	Boolean	If set to true, the API will return the detailed response. If set to false or if the parameter is not passed, it will return only the liveliness parameter. By default, the parameter value is false.	Optional

{
    "image_url": "https://example.com/path/to/image.png",
    "verbose": true
}

Code samples

curl --location 'https://api-preproduction.signzy.app/api/v3/passive-liveliness/advanced-v2' \
--header 'Content-Type: application/json' \
--header 'Authorization: {api_key}' \
--data '{
    "image_url": "https://example.com/path/to/image.png",
    "verbose": true
}'

Response body parameters

Parameter	Data Type	Description
faceImageValid	boolean	Derived overall verdict
noFaceDetected	boolean	No face was found in the image
isNotFrontal	boolean	Face not facing the camera directly
faceRotated	boolean	Face is rotated/tilted in-plane
eyesClosed	boolean	One or both eyes closed
eyesOccluded	boolean	Eyes obstructed (e.g. by hair, glare, object)
glassesDetected	boolean	Subject wearing glasses
faceOccluded	boolean	Part of the face obstructed
backgroundNotSolid	boolean	Background is not a plain/solid backdrop
multiplePersons	boolean	More than one face detected
faceTooSmall	boolean	Face too small relative to frame
faceTooLarge	boolean	Face too large relative to frame
notLive	boolean	Spoof detected — not a genuine live capture

// Face Detected
//If verbose = true
{
 "result": {
   "faceImageValid": false,
   "predictions": {
     "noFaceDetected": false,
     "isNotFrontal": false,
     "faceRotated": false,
     "eyesClosed": false,
     "eyesOccluded": false,
     "glassesDetected": false,
     "faceOccluded": false,
     "backgroundNotSolid": true,
     "multiplePersons": false,
     "faceTooSmall": false,
     "faceTooLarge": false,
     "notLive": false
   }
 }
}

// No Face Detected
{
  "result": {
  "detail": "No face detected in the image."
 }
}
//If verbose = false

{
 "result": {
   "faceImageValid": false
 }
}

The size of the document should not exceed 5 MB.

If the quality of the image is below the threshold the image will be rejected

If the image contains no face or mulitple faces it will be rejected

The image should be clicked in a well-lit room, with the face shown clearly to the camera. Extreme darkness/brightness on the face might result in the API behaving unexpectedly.

The complete face should be clearly visible in the image. Tilted faces might result in API behaving unexpectedly.

The minimum size of the detected face should be 224X224 pixels.

Motion Blur might result in API behaving unexpectedly.

Any occlusions on parts of the face like Glasses and masks should be removed while performing a Liveness Check.

The detected Face should occupy at least 20% of the total image area.

The image should be clicked as a selfie (portrait mode only).

No image compression is highly recommended for accurate results.

Contact Us for Any Assistance

If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!