Face Delete
Remove an individual's enrolled facial data from the system by enrollment ID. Use this to manage data privacy, revoke access, or clean up stale identity records.
The Face Delete API removes an individual's enrolled facial data from the system. Use this API to manage data privacy, revoke access, or clean up stale records in your facial recognition or authentication system.
How It Works
Provide the enrollmentid of the face record to delete, along with the groupname it belongs to and a unique txnid to track the deletion transaction. On success, the enrolled face data is permanently removed.
Request Parameters
| Parameter | Type | Location | Required | Description |
|---|---|---|---|---|
apikey | string | Header | Yes | API key provided by Syntizen. Pass 0 to skip encryption. |
authkey | string | Header | Yes | Authentication token obtained from the /userauthentication endpoint. |
enrollmentid | string | Body | Yes | The unique ID of the enrolled face record to be deleted. |
rrn | string | Body | Yes | Request Reference Number — any unique identifier for the transaction. |
groupname | string | Body | Yes | The group name under which the face was enrolled (e.g., "sofibank"). |
txnid | string | Body | Yes | A unique transaction ID to track this deletion request. |
Response
On success, returns respcode: "200" and respdesc: "Face deleted successfully". If the groupname does not match the enrolled record, returns S-535: GroupName is not matched.
Authorization
AuthKeyAuth Authentication token obtained from /userauthentication endpoint
In: header
Header Parameters
API key provided by Syntizen
Authentication token obtained from /userauthentication endpoint
Request Body
application/json
Enrollment ID to be deleted
Request Reference Number, any unique number for the identification of transaction
Group name
Transaction ID
Response Body
application/json
application/json
application/json
curl -X POST "https://api.syntizen.com/FaceDelete" \ -H "apikey: 0" \ -H "authkey: string" \ -H "Content-Type: application/json" \ -d '{ "enrollmentid": "sdsdsds", "rrn": "123456", "groupname": "sofibank", "txnid": "272556" }'{
"respcode": "200",
"respdesc": "Face deleted successfully",
"rrn": "123456"
}{
"respcode": "400",
"respdesc": "Bad Request - Missing or invalid request parameters"
}{
"respcode": "401",
"respdesc": "Unauthorized - Invalid or expired auth key"
}Face Liveness Pro POST
Face Liveness Pro API distinguishes live persons from spoofing attacks, deepfakes, and Generative AI avatars using a single image — no action or movement required.
Face Enroll POST
Register a person's facial image into the system under a specified group. The enrolled identity is used as the reference for future face verification and matching operations.
