Face Verify
Confirm an individual's identity by comparing a live face image against enrolled faces in a group. Returns a match score for each enrolled identity.
The Face Verify API confirms the identity of an individual by comparing a submitted live face image against all enrolled faces within a specified group. It returns a match score for each enrolled identity, indicating the likelihood of a match.
How It Works
Submit a live face image along with a groupname and txnid. The API searches the enrolled faces in the group and returns a ranked list of matches with their enrollid and matchscore. A higher score indicates a stronger match.
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 name to search enrolled faces in (e.g., "sofibank"). |
txnid | string | Body | Yes | A unique transaction ID to track this verification request. |
livefaceimage | string | Body | Yes | Base64-encoded live face image to verify. 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 live camera-captured images only for best verification accuracy.
Response
On success, returns a data array where each item contains:
enrollid— the enrolled face ID that was matched.matchscore— confidence score of the match (e.g.,"99.00"). Higher is better.
Also returns the txnid assigned to the verification transaction.
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 verification
Transaction ID
Base64 encoded live face image
Response Body
application/json
application/json
application/json
curl -X POST "https://api.syntizen.com/FaceVerify" \ -H "apikey: 0" \ -H "authkey: string" \ -H "Content-Type: application/json" \ -d '{ "rrn": "353647", "groupname": "sofibank", "txnid": "45080", "livefaceimage": "iVBORw0KGgoAAAANSUhEUgAAAM0AAAFQCAYAAAAcM/45080+I3jH8tsxcJYh1bDAAAAAElFTkSuQmCC" }'{
"respcode": "200",
"respdesc": "Success",
"rrn": "353647",
"txnid": "45081",
"data": [
{
"enrollid": "kssskj",
"matchscore": "99.00"
}
]
}{
"respcode": "400",
"respdesc": "Bad Request - Missing or invalid request parameters"
}{
"respcode": "401",
"respdesc": "Unauthorized - Invalid or expired auth key"
}