Basic Identify

Biometric identification consists of determining the identity of a person. The aim is to capture an item of biometric data from this person. It can be a photo of their face, a record of their voice, or an image of their fingerprint. This data is then compared to the biometric data of several other persons kept in a database. In this mode, the question ​is simple: “Who are you?”

Face Identification #

To perform a face identification check and create a new enrolment if a duplicate is not found.

This API currently supports basic authentication. All endpoints require an Authentication header in the following form:

Authorization: 'Basic ' + Base64.encode(username + ':' + password)

Send a HTTP POST request to:

• /api/v1/basic/face/identify

The following parameters are used for requests and responses:

Request:
{
  "faceImageBase": "data:image/png;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAMEBgUGBgYFBgYGBwkIBgcJBwYGCAsICQoKCgoKBggLDAsKDAkKCgr
...
+SSyDCtmmrGoXzc8AcrURjKEjNOK6DII0ZyJFVgepUdKv26X0WVhuGcMPlBP3RVeFluDiNdvY8VbEUnO2UjaOTnrXoUZc8dTOdSUZEotL7A/eD/AL6oqVLJCoJmk6f3qKv2Rz+0if/Z",
  "sessionId": "bbbf9002-c3a2-4308-b103-d80b9f5a2b84",
  "subjectId": "John Doe-12345-23124",
  "passiveLiveness": true
}

Response - passive liveness passed, no duplicates, person enrolled:
{
  "sessionId": "bbbf9002-c3a2-4308-b103-d80b9f5a2b84",
  "subjectId": "John Doe-12345-23124",
  "passiveLivenessScore": 0.9997104,
  "isUnique": true,
  "hasError": false
}

Response - passive liveness passed, duplicate found, no enrollment:
{
  "sessionId": "bbbf9002-c3a2-4308-b103-d80b9f5a2b84",
  "subjectId": "John Doe-12345-23124",
  "passiveLivenessScore": 0.9997104,
  "isUnique": false,
  "hits": [
  {
    "subjectId": "John Smith-55555-23222",
    "score": 144
  }
],
  "hasError": false
}

Response - passive liveness not passed
{
"sessionId": "bbbf9002-c3a2-4308-b103-d80b9f5a2b84",
"subjectId": "John Doe-12345-23124",
"passiveLivenessScore": 2.1067458E-06,
"hasError": false
}

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

List of errors #

TrustHub Face Quality Requirements for Uncontrolled Face Capture #

As biometrics is an inherently probabilistic operation, ensuring high quality images are sent to our API is important to achieve the best possible accuracy. Below is a description of the basic requirements for accurate biometric operation. Don’t worry - the system likely won’t return errors if some of these requirements are not exactly met; rather the accuracy will proportionally drop. If too many requirements are not met, the API may return an error message.