Face Detect

Detects face and extracts attributes of it.

API Call

To perform face detection and attributes extraction.

Send a HTTP POST request to:

• /api/v1/id-verifications/face/detect

The following parameters are used for requests and responses:

Parameter	Direction	Description
sessionId	request	unique, short-lived code to be generated by the client to track specific sessions
faceImageBase	request	onboarded person photo, Base64 format or URL link to it
returnFaceImage	request	boolean (true, false) to include/exclude detected face rectangle (Base64 format) in response
sessionId	response	unique, short-lived code to be generated by the client to track specific sessions. Same as in request
hasError	response	boolean parameter - true - verification process ended up with some error; false - no errors
face	response	includes face attributes object
face\passiveLivenessScore	response	score of the check. Higher score means higher liveness level, default threshold is set to 0.8
face\rectangle	response	includes left, right, top, bottom coordinates of detected face
faceImageBase	response	cropped person photo, Base64 format
error	response	error message in case of hasError set to true, informing about type of error: FACE_NOT_FOUND

Request

{
    "sessionId": "bbbf9002-c3a2-4308-b103-d80b9f5a2b84",
    "faceImageBase": "data:image/png;base64,/9j/4AAQSkZ...AZ4",
    "returnFaceImage": true
}

Response - Successful Call

{
    "sessionId": "bbbf9002-c3a2-4308-b103-d80b9f5a2b84",
    "hasError": false,
    "face": {
        "age": 29,
        "gender": -10000,
        "passiveLivenessScore": 0.5,
        "rectangle": {
            "top": 17,
            "left": 314,
            "width": 422,
            "height": 528
        }
    },
    "faceImageBase": "/9j/4AAQSkZJRgA...RQI//9k="
}

Response - Error

{
    "sessionId": "bbbf9002-c3a2-4308-b103-d80b9f5a2b84",
    "hasError": true,
    "error": "INTERNAL_ERROR"
}

List of Errors

Error	Meaning	Description
FACE_NOT_FOUND	Failed to detect face	Face detector can’t find face on image. Face detection has probabilistic nature and may have errors. It also has some sensitivity level and very small faces may be ignored.