Image Passive Liveliness advanced
Introduction
The Image Passive Liveliness Service offers a wide range of versatile capabilities that revolve around facial intelligence. This makes it an indispensable tool for various applications where understanding and analyzing faces are paramount. It excels in tasks such as precise emotion recognition, accurate face positioning, detecting any face cover or head gear and detecting masks on subjects' faces.
Additionally, it provides age prediction with exceptional precision and ensures that the face remains properly oriented. This comprehensive suite of features is designed to enhance your ability to work with faces, injecting intelligence and enthusiasm into your projects.
In addition to its impressive face-related capabilities, this service also delivers powerful image-related features. It excels in tasks such as background assessment, ensuring high-quality images, and distinguishing live content from static imagery.
With its background analysis, it can identify the suitability of the surroundings, while its image quality validation guarantees that your images are picture-perfect.
This innovative tool takes your projects to new heights by seamlessly integrating both face and image-related intelligence, transforming your work into an exhilarating adventure.
API details
Endpoint
POST https://api.signzy.app/api/v3/passive-liveliness/advancedPOST https://api-preproduction.signzy.app/api/v3/passive-liveliness/advancedRequest 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 | String | Input image URL | Mandatory |
acceptanceThreshold | Number | Floating number between 0 and 1 to set a threshold for liveliness detection | Mandatory |
{
"image": "https://persist.signzy.tech/api/files/812228677/download/xxxx.jpeg",
"acceptanceThreshold": 0.6
}Code samples
curl --location 'https://api.signzy.app/api/v3/image/passive_liveliness' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Access-Token>' \
--data '{
"image": "input-image-url",
"acceptanceThreshold": 0.6
}'Response body parameters
Parameter | Data Type | Description |
|---|---|---|
imageUrl | String | URL of the query image |
imageQualityAttributes | Object | Information about the image quality |
imageQualityAttributes.result | Object | Object containing the Image Attributes results in terms of quality of the image |
imageQualityAttributes.result.quality | String | The quality of the image |
imageQualityAttributes.result.score | Float | A quality score for the image |
faceValid | Boolean | Indicates whether a face is present |
faceAttributes | Object | Details about the detected face |
faceAttributes.faceCover | Object | Details about the face cover |
faceAttributes.faceCover.isFaceCovered | Boolean | Indicates whether a face cover is present or not |
faceAttributes.faceCover.faceGears | List | Gives a list of face gears present on the person in the image |
faceAttributes.faceEmotion | Object | Information about the Emotion detected on the face |
faceAttributes.faceEmotion.emotion | String | The detected emotion (e.g., "neutral") |
faceAttributes.faceEmotion.confidence | Float | Confidence level in the emotion detection |
faceAttributes.age | Number | The estimated age of the person |
faceAttributes.faceOrientation | String | Orientation of the detected face - back facing, left facing, right facing |
faceAttributes.faceToBgRatio | Float | The ratio of the face to the background |
faceAttributes.faceMask | Object | Information about a mask on the face |
faceAttributes.faceMask.found | Boolean | Whether a mask is found |
faceAttributes.faceMask.confidence | Float | Confidence level in mask detection |
faceAttributes.headTillShoulders | Boolean | Indicates presence from head to shoulders. |
liveness | Boolean | Information about liveliness detection |
liveness.liveliness | Boolean | Indicates if liveliness is detected (true or false) |
liveliness.score | Float | Liveliness score of the input image. The value can be between 0 and 1. |
isBackgroundSolid | Boolean | ndicates if the background is solid in terms of color or has mixed colors (not solid) |
status | String | The overall status of the entire operation (e.g., "success") |
{
"imageUrl": "https://persist.signzy.tech/api/files/xx/download/xxxx.jpeg",
"imageQualityAttributes": {
"result": {
"quality": "good",
"score": 0.96
}
},
"faceValid": true,
"faceAttributes": {
"faceCover": {
"isFaceCovered": true,
"faceGears": [
"sunglasses"
]
},
"faceEmotion": {
"emotion": "neutral",
"confidence": 0.55
},
"age": 20,
"faceOrientation": "FRONT_FACING",
"faceToBgRatio": 0.29,
"faceMask": {
"found": false,
"confidence": 0.0
},
"headTillShoulders": true
},
"liveliness": {
"liveliness": true,
"score": 0.99
},
"isBackgroundSolid": true,
"status": "success"
}
// Multiple Face Found
{
"imageUrl": "https://persist.signzy.tech/api/files/810713505/download/xxxxx.jpg",
"imageQualityAttributes": {
"result": {
"quality": "good",
"score": 1
}
},
"faceValid": false,
"status": "reject",
"reason": "MULTIPLE_FACES_FOUND"
}
// No Face Found
{
"imageUrl": "https://staging-persist.signzy.tech/api/files/5031849/download/xxxxx.png",
"imageQualityAttributes": {
"result": {
"quality": "good",
"score": 1
}
},
"faceValid": false,
"status": "reject",
"reason": "NO_FACE_DETECTED"
}
// bad image quality
{
"imageUrl": "https://persist.signzy.tech/api/files/810713505/download/xxxxx.jpg",
"imageQualityAttributes": {
"result": {
"quality": "bad",
"score": 0.2
}
},
"status": "reject",
"reason": "BAD_IMAGE_QUALITY"
}Document related constraints
- 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!