Find Face Properties

This method is used to extract some properties from the photo sent on the request. Those properties returned by the algorithm are age, gender, emotions.

Find-face-properties

POST Https://api.biometrid.com/api/1.0/users/find-face-properties

Find face properties.

Headers

Name	Type	Description
Content-type	string	Request content type (This is not required to be set. Referenced only to show how we expect data to be sent). { "Content-Type": "multipart/form-data" }
x-biometrid-key	string	Application Client Key
x-biometrid-secret	string	Application Client Secret

Request Body

Name	Type	Description
liveness	boolean	Optional liveness state flag. For now, just implemented on the biometrid SDK.
photo	object	Image file containing user's face for biometric analysis. File format: jpeg, png or jpg. Maximum file size 1 Mb.

200 Success 200 types

HTTP/1.1 200 OK

// Properties found on photo
    {
      "status": true,
      "data": {
        "message": "FACE_RECOGNIZED_WITH_SUCCESS"
        "properties": {
          "age": 32,
          "gender": 'male',
          "emotions": ['neutral', 'happy']
        },
      }
  }
// Find Id by Face failed.
  {
      "status": false,
      "data": {
          "message": "FACE_PROPERTIES_FAILED",
          "reason": "No faces found on 'photo'"
        }
  }
  
// Find Id by Face failed.
  {
      "status": false,
      "data": {
          "message": "MULTIPLE_FACES_DETECTED"
        }
  }

400 Bad Request types

HTTP/1.1 400 Bad Request

//No photo file detected on request. Not sent or invalid format
    {
        "status": false,
        "data": {
            "message": "NO_FILE_OR_INVALID_FORMAT"
        }
    }
    
// Missing Headers
 {
    "status": false,
    "data": {
        "message": "AUTHENTICATION_HEADERS_MISSING"
    }
}

401 Invalid Headers.

HTTP/1.1 401 Unauthorized

{
    "status": false,
    "data": {
        "message": "INVALID_AUTHENTICATION_HEADERS"
    }
}

402 Payment Required - Request Limit Reached for Client Plan.

HTTP/1.1 402 Payment Required

{
    "status": false,
    "data": {
        "message": "REQUEST_LIMIT_REACHED"
    }
}

404 Not Found request types

HTTP/1.1 404 Not Found

// No active engine configuration for this provider.
    {
        "status": false,
        "data": {
            "message": "NO_FACE_ENGINE_CONFIGURATION_AVAILABLE"
        }
    }

//Client not found by given key.
    {
        "status": false,
        "data": {
            "message": "CLIENT_NOT_FOUND/CHECK_AUTHENTICATION_HEADERS"
        }
    }
 

Example (JSON)

{
    "photo": face.jpeg
    "liveness": true
}

Success 200

Field	Type	Description
status	Boolean	Response status.
data	Object	Response main data.
message	String	Message regarding process status.p
properties	Object	Object containing the properties extracted from the photo.
age	Number	Estimated age returned by the face engine.
gender	String	Gender return by the face engine.
emotions	Array	Array containing a set of emotions return by the algorithm by analysing the photo sent.