Add or create a group to register faces and combine relevant identities. Groups enable one-to-many matching — a face is identified and matched against a repository of faces with high accuracy.
Request URL
https://faceapi.mxface.ai/api/v3/Group
Method type
Headers
Content-Type : application/json
Subscriptionkey : xxxxxxxxxxx
{
"groupName": "My Group"
}groupName
String
Unique group name. Only \ , _ [ ] ( ) - special characters and spaces are allowed. Maximum length 255.
{
"groupId": 0,
"groupName": "string",
"createdDate": "2021-10-21T15:23:52+00:00",
"updatedDate": "2021-10-29T17:32:10+00:00",
"errorCode": 0,
"errorMessage": "string"
}groupId
Int
Unique group id associated with a group name.
groupName
String
Group name
createdDate
Datetime
UTC datetime of creation
updatedDate
Datetime
UTC datetime of last update
errorCode
Int
Error code determining the nature of an error.
errorMessage
String
A human readable description of the error.
Create an identity by registering a face into a group. On a 1-to-N search the system finds the closest match for that identity. Every registered face gets a unique identity, and the face quality score must be above 80.
Request URL
https://faceapi.mxface.ai/api/v3/FaceIdentity
Method type
Headers
Content-Type : application/json
Subscriptionkey : xxxxxxxxxxx
{
"groupIds": [
0
],
"encoded_Image": "string",
"externalId": "string"
}groupId
Int Array
IDs of any groups that the new identity belongs to.
encoded_Image
String
Base64 encoded string of image.
externalId
String
Unique external ID of the identity.
qualityThreshold
Int
Optional integer between 21 and 100. If supplied, uploaded face quality is compared against it, otherwise the quality check follows the defined MxFace standard.
{
"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"
}faceIdentityId
Int
Unique id associated with the identity.
groups
Array
Array of group details the identity belongs to.
faces
Face Array
Face details.
faceId
Int
Unique id associated with the face.
createdDate
Datetime
UTC datetime of creation.
updatedDate
Datetime
UTC datetime of last update.
errorCode
Int
Error code determining the nature of an error.
errorMessage
String
A human readable description of the error.
Try it on your own images
Free trial key unlocks every model.
Verify to continue
Captcha does not match. Please try again.