Skip to main content

FacerecAddPerson

Request-body reference for POST /facerec_add_person.

Example

{
"person_id": "person-001",
"person_display_name": "Alex Carter",
"person_groups": ["employees"],
"person_images": [
{
"image": "<base64 image>",
"file_path": null,
"capture_time": "2025-03-17T22:27:33Z"
}
]
}

Fields

FieldTypeDescription
person_idstringStable person identifier.
person_display_namestringPerson display name.
person_groupsstring[]Group IDs associated with the person.
person_imagesobject[]Images used for the person profile.
person_images[].imagestringBase64 image. Provide this or file_path.
person_images[].file_pathstringImage path. Provide this or image.
person_images[].capture_timestringCapture time in ISO format.