POST api/biometricface/identify

Attempts either an identification operation using the provided photo.

Request Information

URI Parameters

None.

Body Parameters

The model holding the photo, and optional parameters, to attempt the biometric facial identification match against.

IdentifyModel
NameDescriptionTypeAdditional information
Confidence

Optional. The threshold to apply for the facial recogntion match in order to add a potential match to the results list.

decimal number

None.

Count

Optional. The maximum number of results to return for the identification operation.

unsigned integer

None.

Photo

Required. A photo to do the identification against.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Confidence": 1.1,
  "Count": 2,
  "Photo": "sample string 3"
}

application/xml, text/xml

Sample:
<IdentifyModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QikFace.WebApi.Models.Public">
  <Confidence>1.1</Confidence>
  <Count>2</Count>
  <Photo>sample string 3</Photo>
</IdentifyModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A list of SubjectID, match score pairs for matches that meet the specified confidence threshold.

Collection of Pair of string [key] and decimal number [value]

Response Formats

application/json, text/json

Sample:
[
  {
    "Key": "sample string 1",
    "Value": 2.1
  },
  {
    "Key": "sample string 1",
    "Value": 2.1
  }
]

application/xml, text/xml

Sample:
<ArrayOfKeyValuePairOfstringfloat xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
  <KeyValuePairOfstringfloat>
    <key>sample string 1</key>
    <value>2.1</value>
  </KeyValuePairOfstringfloat>
  <KeyValuePairOfstringfloat>
    <key>sample string 1</key>
    <value>2.1</value>
  </KeyValuePairOfstringfloat>
</ArrayOfKeyValuePairOfstringfloat>