m2pfintech
API LibraryMl falcon fly

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

ParameterTypeLocationRequiredDescription
apikeystringHeaderYesAPI key provided by Syntizen. Pass 0 to skip encryption.
authkeystringHeaderYesAuthentication token obtained from the /userauthentication endpoint.
enrollmentidstringBodyYesThe unique ID of the enrolled face record to be deleted.
rrnstringBodyYesRequest Reference Number — any unique identifier for the transaction.
groupnamestringBodyYesThe group name under which the face was enrolled (e.g., "sofibank").
txnidstringBodyYesA 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.

POST
/FaceDelete

Authorization

AuthKeyAuth
authkey<token>

Authentication token obtained from /userauthentication endpoint

In: header

Header Parameters

apikey*string

API key provided by Syntizen

authkey*string

Authentication token obtained from /userauthentication endpoint

Request Body

application/json

enrollmentid*string

Enrollment ID to be deleted

rrn*string

Request Reference Number, any unique number for the identification of transaction

groupname*string

Group name

txnid*string

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"
}

On this page