ZOLOZZOLOZDOCS

Face Compare - Async Checkresult API

Important Notice:

  • All request and response parameters are strictly subject to the official API documentation.
  • The API response may contain fields not defined in the documentation. These fields are for internal debugging purposes only and are not guaranteed to be stable or compatible. Do not rely on these fields in production environments. ZOLOZ reserves the right to modify or remove these fields at any time without prior notice.

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

copy
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

Note: The system will only return the transactionId after the transaction enters the processing stage. If an error occurs before the transaction begins processing, the system will not return a transactionId. This includes, but is not limited to, the following situations:

  • Invalid request parameters, such as incorrect input format or missing required parameters.
  • The request fails to reach the server successfully, such as due to network issues or gateway failures.
  • The request is denied due to system rate limiting.

"G000000005FID20200304000000000001570702"

face1ImageQualityResult

string

true

The image quality result for Face 1.

  • PASS: Qualified
  • FAIL: Unqualified

Note: If the value of eitherface1ImageQualityResult orface2ImageQualityResult isFAIL, samePersonwill return false.

"PASS"

face2ImageQualityResult

string

true

The image quality result for Face 2.

  • PASS: Qualified
  • FAIL: Unqualified

Note: If the value of eitherface1ImageQualityResult orface2ImageQualityResult isFAIL, samePersonwill return false.

"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

transactionId is null or empty string;

PROCESSING

Processing in Progress；

UNABLE_GET_IMAGE

  • NO_FACE: The algorithm detects no faces in the image or video.
  • IMAGE_CHECK_FAILED: The image is empty, the pre-check for image format is unsupported, or the image is too large (greater than 10 MB).
  • FACE_IMAGE_VIDEO_TYPE_NOT_SUPPORTED: The algorithm detects an unsupported image format during execution.

SUCCESS

The comparison result is successfully returned, regardless whether face1 and face2 indicate the same person;

SYSTEM_ERROR

Other internal errors;

Response Sample

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