POST api/Biometric/Identify

Identify a member through biometric match, by comparing against all enrolled biometric records.

Request Information

Body Parameters

BiometricRequest
NameDescriptionTypeAdditional information
CustomerKey

Customer-specific key provided by the vendor.

 string

Required
EngineName

The biometric modality for which the customer subscribed. The engine name for face biometrics is "FACE01".

 string

Required
BiometricXml

The biometric template with XML formatting. The template data should be a base64 encoded string of the original face image. The number of face images might be 1 to 3. When use only one image, use the SOURCE='FRONT' one. Supported image formats: JPG, BMP, PNG

 string

Required.

Request Formats

application/json, text/json

Sample: 
{
  "CustomerKey": "652CA711-F0E4-48A0-AC29-09E32C3CB39F",
  "EngineName": "FACE01",
  "BiometricXml": "<IMAGES>\r\n    <IMAGE TYPE='FACE' SOURCE='FRONT' FORMAT='JPEG'>base64String of Face image</IMAGE>\r\n    <IMAGE TYPE='FACE' SOURCE='LEFT' FORMAT='JPEG'>base64String of Face image</IMAGE>\r\n    <IMAGE TYPE='FACE' SOURCE='RIGHT' FORMAT='JPEG'>base64String of Face image</IMAGE>\r\n</IMAGES>"
}

application/xml, text/xml

Sample: 
<BiometricRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/M2SYS.Cloud.FaceAPI">
  <BiometricXml>
    <IMAGES>
      <IMAGE TYPE="FACE" SOURCE="FRONT" FORMAT="JPEG">base64String of Face image</IMAGE>
      <IMAGE TYPE="FACE" SOURCE="LEFT" FORMAT="JPEG">base64String of Face image</IMAGE>
      <IMAGE TYPE="FACE" SOURCE="RIGHT" FORMAT="JPEG">base64String of Face image</IMAGE>
    </IMAGES>
  </BiometricXml>
  <CustomerKey>652CA711-F0E4-48A0-AC29-09E32C3CB39F</CustomerKey>
  <EngineName>FACE01</EngineName>
</BiometricRequest>

Response Information

Operation-specific OperationResult values:

    Identify: MATCH_FOUND - Match found. (The submitted biometric data matched that of an enrolled member.)

    Identify: NO_MATCH_FOUND - No match found. (No enrolled members matched against the submitted biometric data.)

    Identify: POOR_IMAGE_QUALITY - The submitted face image(s) were not good enough quality to fulfill the request.

General OperationResult values:

    INVALID_TEMPLATE: The submitted BiometricXml was not correctly formatted.

    CUSTOMER_INFO_NOT_FOUND: The specified CustomerKey was not found in the system. Please contat your vendor for assistance.

    INVALID_ENGINE: The specified EngineName was not valid.

    INVALID_REQUEST: The submitted request was not correctly formatted.

    LICENSE_ERROR: A system license limitation prevented your request from being fulfilled. Please contact your vendor for assistance.

    INTERNAL_ERROR: An unexpected system error was encountered. Please contact your vendor for assistance.

    CACHE_NOT_AVAILABLE: The requested record is not available in the system. Please contact your vendor for assistance.

Resource Description

MatchingResult
NameDescriptionTypeAdditional information
CustomerID

Customer Key that was used to make the request.

 string

None.
OperationName

Name of operation that was requested.

 OperationNameEnum

None.
Status

The operation execution status.

 EnumOperationStatus

None.
OperationResult

The result of the operation.

 string

None.
BestResult

Biometric matched record with the highest confidence score.

 ScoreResult

None.
DetailResult

All biometric matched records.

 Collection of ScoreResult

None.
MatchCount

Number of biometric matched records.

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "CustomerID": "652CA711-F0E4-48A0-AC29-09E32C3CB39F",
  "OperationName": "3",
  "Status": "1",
  "OperationResult": "MATCH_FOUND",
  "BestResult": "{'Score': 210,'ID': 'Jhon123'}",
  "DetailResult": "[{'Score': 210,'ID': 'Jhon123'}]",
  "MatchCount": "1"
}

application/xml, text/xml

Sample: 
<MatchingResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/M2SYS.Cloud.FaceAPI">
  <BestResult>
    <ScoreResult>
      <ID></ID>
      <Score>0</Score>
    </ScoreResult>
  </BestResult>
  <CustomerID>652CA711-F0E4-48A0-AC29-09E32C3CB39F</CustomerID>
  <DetailResult>
    <ScoreResult>
      <ID></ID>
      <Score>0</Score>
    </ScoreResult>
  </DetailResult>
  <MatchCount>1</MatchCount>
  <OperationName>3</OperationName>
  <OperationResult>MATCH_FOUND</OperationResult>
  <Status>1</Status>
</MatchingResult>