If you want to update face (image + signature) of a person by API, you should specify the target personId or your request may update wrong person's record if those have high similarity.


You can update face of specific person by POST /people with "update-person-id" parameter.

curl -k -X POST "https://127.0.0.1:8081/people?update-person-id=0c4e0e57-7edf-4ffb-a122-660da7fe13a1&update=true&insert=false" -H "accept: application/json;charset=UTF-8" -H "X-RPC-DIRECTORY: main" -H "X-RPC-AUTHORIZATION: $USER:$PASS" -H "Content-Type: image/jpeg" --data-binary @new_face.jpg

If you are confident that the provided face image is correct, you can add -H "X-RPC-FACES-GROUPING-THRESHOLD: 1 to the request so that SAFR replaces the face ignoring the similarity with the "old face".

curl -k -X POST curl "https://127.0.0.1:8081/people?update-person-id=0c4e0e57-7edf-4ffb-a122-660da7fe13a1&update=true&insert=false" -H "accept: application/json;charset=UTF-8" -H "X-RPC-DIRECTORY: main" -H "X-RPC-FACES-GROUPING-THRESHOLD: 1" -H "X-RPC-AUTHORIZATION: $USER:$PASS" -H "Content-Type: image/jpeg" --data-binary @new_face.jpg


The API returns "accountUpdated": true on success.

SAFR External ID Person Property

SAFR supports a property "externalId" on a person record.  You may set this at the time you create a record.  Generally this would be set to the unique id that your system uses to identify a person. The GET /people/external/<externalId> API may be used then to retrieve the SAFR person id of a person record which can then be used during the update calls described above.


For more information, please refer to the SAFR REST APIs at https://covi.real.com/docs/index.html