Face Search -Group API Guide

Overview

Add or create a group to register the faces and combine relevant identities. One-to-many matching of faces. Identifies and matches a face to a group of faces in a repository with high accuracy...

Details

Request URL:-https://faceapi.mxface.ai/api/v3/Group

Method Type:-POST

Headers:-

Content-Type : application/json

Subscriptionkey : xxxxxxxxxxxx

Request Body

{
  "groupId": 0,
  "groupName": "string",
  "createdDate": "2021-10-21T15:23:52+00:00",
  "updatedDate": "2021-10-29T17:32:10+00:00",
  "errorCode": 0,
  "errorMessage": "string"
}

Request Parameters

Fields Type Description
groupName String Unique group name. Only \\, _,[,],(,),- special characters and space is allowed in group name. Maximum length of 255.

Response Body

{
  "groupId": 0,
  "groupName": "string",
  "createdDate": "2021-10-21T15:23:52+00:00",
  "updatedDate": "2021-10-29T17:32:10+00:00",
  "errorCode": 0,
  "errorMessage": "string"
}

Response Parameters

Field Type Description
groupId Int Unique group id associated with a group name.
groupName String Group Name
cretaedDate Datetime UTC Datetime of creation
updatedDate Datetime UTC Datetime of last update
errorCode Int Error code determine the nature of an error.
errorMessage String A human readable description of error.

Face Search - Identity API Guide

Overview

User can create identity by registering face into group. When user do 1-to-n search, system will find closest match of the identity. For each registered face unique identity will be created. Quality score of face must be greater than 80. Refer manage face to add multiple faces of identity. One default face will be created when create new identity. Verifies people's identities using a face picture from large databases. Identifies people from images or videos in a matter...

Details

Request URL:- https://faceapi.mxface.ai/api/v3/FaceIdentity

Method Type:-POST

Headers:-

Content-Type : application/json

Subscriptionkey : xxxxxxxxxxxx

Request Body

{
  "groupIds": [
    0
  ],
  "encoded_Image": "string",
  "externalId": "string"
}

Request Parameters

Fields Type Description
groupId Int Array IDs of any groups that the new identities belong to.
encoded_Image String Base64 encoded string of image.
externalId String Unqiue External ID of the identity.
qualityThreshold Int Optional integer value between 21 and 100. If this parameter added in request then uploaded faces quality will be compared from request qualityThreshold value, otherwise quality check as per defined MXFace standard.

Response Body

{
  "faceIdentityId": 0,
  "faces": [
    {
      "faceId": "string",
      "createdDate": "2021-10-21T15:23:52+00:00"
    }
  ],
  "groups": [
    {
      "groupId": 0,
      "groupName": "string",
      "createdDate": "2022-01-03T04:56:18.260Z",
      "updatedDate": "2022-01-03T04:56:18.260Z"
    }
  ],
  "createdDate": "2021-10-21T15:23:52+00:00",
  "updatedDate": "2021-10-29T17:32:10+00:00",
  "errorCode": 0,
  "errorMessage": "string"
}

Response Parameters

Field Type Description
faceIdentityId Int Unique id associated with identity.
groups Array Array of group details, the identities belong to.
faces face Array Face Details.
faceId Int Unique id associated with face.
cretaedDate Datetime UTC Datetime of creation.
updatedDate Datetime UTC Datetime of last update.
errorCode Int Error code determine the nature of an error.
errorMessage String A human readable description of error.