ZOLOZZOLOZDOCS

verify

POST /api/v1/zoloz/cnauthority/verify

This API is used to collect face information and verify it with the CN authority database. A unique transaction ID is generated for verifying process.

Structure

Request parameters

Field name

Data type

Max length

Description

bizId

String

32

Required. A unique ID maintained by client for tracing purpose. 

Note: ZOLOZ server does not perform uniqueness check on this field. For better tracing, it is strongly recommended to enable the merchant server to guarantee the uniqueness of the business ID.

sourceTransactionId

String

64

Optional. Specifies the original source of the face image .

If the face image is obtained from a history ZOLOZ transaction, It is recommended that client to set history transaction ID for this parameter for tracing purposes.

base64ImageContent

String

1MB

Required. Specifies the encoding binary data of the image.

Note: The face image should be in JPEG format. Face image needs to be of good quality and face features should be visible.

idNo

String

32

Required. Specifies user's identification number

idName

String

16

Required. Specifies user's identification name

Response parameters

Field name

Data type

Description

result

Result

Required. Contain the result code, result status, and a result message.

transactionId

String

Optional. A unique transaction ID that is generated by the ZOLOZ server for the identity proofing process.

Note: when an error occurs during the process , for example, invalid argument, no transaction ID is returned.

Result

Result process logic

For different request results, different actions are to be performed. See the following for details:

  • If the value of the result.resultStatus is S , the ZOLOZ Cn Authority verify API is invoked successfully and a unique transaction ID is returned.
  • If the value of the result.resultStatus is F , the invocation of the ZOLOZ Cn Authority verify API fails. Check the error code and message for more information about the possible reasons. Error codes

Common result codes

For the full list of common result codes, see the Common error codes section in the Error handling topic. 

API-specific result codes

The following table shows the possible result codes that are specific for this API.

resultCode

resultStatus

Description

SUCCESS

S

The API call is successful.

AUTHORITY_INACTIVE

F

The merchant has not opened the cn authority product

AUTHORITY_INVALID_CERT_NAME

F

The cert name is invalid

AUTHORITY_INVALID_CERT_AGE

F

The cert age is invalid

AUTHORITY_INVALID_CERT_NO

F

The cert no is invalid

AUTHORITY_INVALID_FACE_IMG

F

The face image is invalid

AUTHORITY_PROCESSING

F

Business is in process

AUTHORITY_EXTRACT_FACE_FAIL

F

Extract face fail

AUTHORITY_UNABLE_GET_IMAGE

F

Unable get image

AUTHORITY_NOT_SAME_PERSON

F

Not same person

SYSTEM_ERROR

F 

Other internal errors. For more information about the error details, check the result message that is returned and the related log. 

Sample

Request sample

Here is an example of request.

copy
{
  "bizId":"verify-bizid",
  "idNo":"4205021988122980**",
  "idName":"兰*",
  "base64ImageContent":"/9j/4Axxxxxxxx",
  "sourceTransactionId":"G1647337311928"
}

Response sample

The following sample response will be returned when the cert number is invalid.

copy
{
  "result":{
    "resultCode":"AUTHORITY_INVALID_CERT_NO",
    "resultMessage":"authority invalid cert no.",
    "resultStatus":"F"
  },
  "transactionId":"G1334455667788XXX"
}

Change log

Date

Change log

20 July, 2022

Released.