Find User Id by Face

This method is used to find if there's a single Biometrid Id that match the face sent on the request.

Find-by-Face

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

Find Biometrid Id by face.

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

// Find Id by Face
    {
      "status": true,
      "data": {
        "message": "FACE_RECOGNIZED_WITH_SUCCESS"
        "verified": true,
        "userId": '5be3000bd3adgd3e152724f2',
        "confidence": '0.78'
      }
  }
// Find Id by Face failed.
  {
      "status": false,
      "data": {
          "message": "FACE_ENROLLMENT_FAILED",
          "reason": "No faces found on 'photo'"
        }
  }

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.
verified	Boolean	If present, indicates the status for the verification process.
userId	String	Biometrid Id return by the process if face match an already enrolled user.
confidence	String	Confidence returned by the engine regarding the face verification. (between 0-1)