Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle.

post/persongroups/{personGroupId}/persons/{personId}/persistedfaces

Path parameters

personGroupIdstring required

Id referencing a particular person group.

personIdstring uuid required

Id referencing a particular person.

Query parameters

userDatastring

User-specified data about the face for any purpose. The maximum length is 1KB.

targetFaceinteger[]

A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image.

Parameters

../../../Common/Parameters.json#/components/parameters/ImageUrl — unresolved $ref

Response

A successful call returns the new persistedFaceId.

persistedFaceIdstring uuid required

The persistedFaceId of the target face, which is persisted and will not expire. Different from faceId created by Face - Detect and will expire in 24 hours after the detection call.

userDatastring

User-provided data attached to the face. The size limit is 1KB.

Changes