Face Enroll
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.
The Face Enroll API registers a person's facial image into the system under a specified group, creating an enrolled identity record. This enrollment is used as the reference for future face verification and matching operations.
How It Works
Submit a live face image (Base64-encoded) along with a group name and optional enrollment ID. The API stores the facial features and returns an enrollmentid that uniquely identifies the registered face within the group.
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. |
rrn | string | Body | Yes | Request Reference Number — any unique identifier for the transaction (e.g., "TXN001"). |
groupname | string | Body | Yes | The group under which the face should be enrolled (e.g., "test2"). Groups logically segregate enrolled identities. |
enrollmentid | string | Body | Yes | A unique ID for this enrollment. Pass an empty string "" to auto-generate one. |
livefaceimage | string | Body | Yes | Base64-encoded live face image. Supported formats: JPG, PNG. |
Image Guidelines
- Supported formats: JPG, PNG.
- The image must contain exactly one clearly visible, forward-facing face.
- The face should be well-lit with no heavy occlusions (glasses, masks, hats).
- Use camera-captured images only — screenshots or cropped document photos may reduce matching accuracy.
Response
On success, returns respcode: "200" along with the enrollmentid assigned to the registered face, which should be stored for future verification or deletion operations.
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
Request Reference Number, any unique number for the identification of transaction
Group name for face enrollment
Enrollment ID (can be empty for auto-generation)
Base64 encoded live face image
Response Body
application/json
application/json
application/json
curl -X POST "https://api.syntizen.com/FaceEnroll" \ -H "apikey: 0" \ -H "authkey: string" \ -H "Content-Type: application/json" \ -d '{ "rrn": "21424235", "groupname": "test2", "enrollmentid": "", "livefaceimage": "N0zQhjSMu1yvL4yu1J778+Dv89zf/hT/+8Vu0vOwG+z7ex/v458bbqPZ9vI/38avj3Wjex/v4jePdaN7H+/iN491o3sf7+I3jH8tsxcJYh1bDAAAAAElFTkSuQmCC" }'{
"respcode": "200",
"respdesc": "Face enrolled successfully",
"rrn": "21424235",
"txnid": "45078",
"enrollmentid": "kssskj"
}{
"respcode": "400",
"respdesc": "Bad Request - Missing or invalid request parameters"
}{
"respcode": "401",
"respdesc": "Unauthorized - Invalid or expired auth key"
}Face Delete POST
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.
Face Extraction POST
Automatically detect and extract a human face from an image, returning it as a Base64-encoded string for use in identity verification and biometric workflows.