ID Verification:eKYC_MIN

Name

Type

Required

Description

Example

ProductCode

String

Yes

The product solution to integrate. Set the value to eKYC_MIN.

eKYC_MIN

SceneCode

String

No

A custom authentication scenario ID. You can use this ID to query related records in the console. The ID can be up to 10 characters in length and can contain letters, digits, and underscores (_).

1234567890

MerchantBizId

String

Yes

A unique business identifier that you customize. It is used to locate and troubleshoot issues. The identifier can be up to 32 characters in length and can contain letters and digits. Make sure that the identifier is unique.

e0c34a77f5ac40a5aa5e6ed20c35****

MerchantUserId

String

Yes

A custom user ID or another identifier that can identify a specific user, such as a mobile phone number or an email address. We strongly recommend that you desensitize the value of this field in advance, for example, by hashing the value.

Y

DocType

String

Yes

The certificate type, which is uniquely identified by an 8-digit number. For more information, see Certificate types.

01000000

DocName

String

No

The user's real name.

Zhang San

DocNo

String

No

The user's certificate number.

411xxxxxxxxxxx0001

IdOcrPictureBase64

String

No

The Base64 encoding of the certificate image.

Base64 encoding

IdOcrPictureUrl

String

No

The URL of the certificate image. The URL must be an HTTP or HTTPS link accessible over the public network.

https://***

FacePictureBase64

String

No

The Base64 encoding of the portrait image.

Base64 encoding

FacePictureUrl

String

No

The URL of the portrait image. The URL must be an HTTP or HTTPS link accessible over the public network.

https://***

Crop

String

No

Specifies whether to crop the face image:

• T: Allows cropping.

• F: Disallows cropping. (Default)

F

Authorize

String

No

Specifies whether to enable identity verification against the official database:

• T: Enable.

• F: Disable. (Default)

F

IdThreshold

String

No

0

Name

Type

Description

Example

HTTP Status Code

Integer

The HTTP status code.

200

HTTP Body

RequestId

String

The request ID.

130A2C10-B9EE-4D84-88E3-5384FF0****

Code

String

Back to Code.

Success

Message

String

A detailed description of the response code.

success

Result.Passed

String

The final authentication result. Valid values:

• Y: Passed

• N: Failed

Y

Result.SubCode

String

A description of the authentication result. For more information, see Error codes for ResultObject.SubCode.

200

Result.ExtFaceInfo

String

Information about the face liveness verification result. For the JSON format, see the example on the right. For more information, see ExtFaceInfo.

{
  "faceAttack": "N",
  "faceComparisonScore": 52.57,
  "facePassed": "N",
  "authorityComparisonScore": 80.39
}

Result.ExtIdInfo

String

Information about the certificate detection result.

For the JSON format, see the example on the right. For more information, see ExtIdInfo.

{
  "ocrIdInfo": {
    "expiryDate": "",
    "originOfIssue": "Exit and Entry Administration of the Ministry of Public Security",
    "englishName": "LI SI",
    "sex": "Male",
    "name": "Li Si",
    "idNumber": "H11111112",
    "issueDate": "2013-01-02",
    "birthDate": "1990-02-21"
  },
  "ocrIdPassed": "N",
  "spoofInfo": {
    "spoofResult": "Y",
    "spoofType": [
      "SCREEN_REMARK"
    ]
  }
}