asynccheckresult
Overview
- API URL:
/api/v1/zoloz/facecompare/asynccheckresult
- API Description: The ZOLOZ Face Compare asynccheckresult API is used to asynchronously obtain facial comparison results. When calling this API, you must pass in the transaction ID returned by the asynccompare API.
Request
Fields Specification
Name | Type | Max Length | Mandatory | Description | Sample Value |
transactionId | string | 64B | true | The transaction ID returned by the asynccompare API. | "G000000005FID2020030400000000000157****" |
Request Sample
POST /api/v1/zoloz/facecompare/asynccheckresult HTTP/1.1
Content-Type: application/json; charset=UTF-8
Client-Id: 5X67656YXXXXXX
Request-Time: 2024-01-04T12:08:56+05:30
Signature: algorithm=RSA256, signature=xxxxxxxxxxxx
{
"transactionId": "G000000005FID2020030400000000000157****"
}
Response
Fields Specification
Name | Type | Mandatory | Value Range | Description | Sample Value |
result.resultCode | string | true | result code | "SUCCESS" | |
result.resultStatus | string | true | result status | "S" | |
result.resultMessage | string | true | result message | "success" | |
transactionId | string | true | transaction id | "G000000005FID20200304000000000001570702" | |
face1ImageQualityResult | string | true | The image quality result for Face 1.
Note: If the value of either | "PASS" | |
face2ImageQualityResult | string | true | The image quality result for Face 2.
Note: If the value of either | "PASS" | |
score | double | true | (0.0, 100.0) | face comparison score | 88.2 |
samePerson | boolean | true | true, false | are the two faces the same person based on algorithm | true |
Result
Name | Type | Mandatory | Value Range | Description | Sample Value |
resultCode | string | true | result code | "SUCCESS" | |
resultStatus | string | true | "S": successful "F": failed | result status | "S" |
resultMessage | string | true | result description | "success" |
The value range of "resultCode" at business level:
resultCode | Description |
INVALID_ARGUMENT |
|
PROCESSING | Processing in Progress; |
UNABLE_GET_IMAGE |
|
SUCCESS | The comparison result is successfully returned, regardless whether face1 and face2 indicate the same person; |
SYSTEM_ERROR | Other internal errors; |
Response Sample
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Response-Time: 2024-01-19T21:56:15-0800
Signature: algorithm=RSA256, signature=xxxxxxxxxxxxxxxxxx
{
"transactionId": "G000000005FID2020030400000000000157****",
"face1ImageQualityResult":"PASS",
"face2ImageQualityResult":"PASS",
"score": 88.2,
"samePerson": true,
"result": {
"resultCode":"SUCCESS",
"resultStatus":"S",
"resultMessage":"Success"
}
}