ID Verification:eKYC_MIN.

Parameter

Type

Required

Description

Example

ProductCode

String

Yes

The solution that you want to use. Set the value to eKYC_MIN.

eKYC_MIN

SceneCode

String

No

A custom ID for the verification scenario, used to query related records in the ID Verification console. The ID can be up to 10 characters long and can contain letters, digits, and underscores (_).

1234567890

MerchantBizId

String

Yes

The unique identifier of your business, which is used for troubleshooting. You can specify a custom value that is 32 characters in length and contains letters and digits. Make sure that the value is unique.

e0c34a77f5ac40a5aa5e6ed20c35****

MerchantUserId

String

Yes

The ID of a customer. You can specify a custom value, such as a mobile phone number or an email address. Before you specify a custom value, we recommend that you perform data masking. For example, you can perform hashing.

Y

DocType

String

Yes

The document type. You can specify an 8-digit value to uniquely identify a document type. For more information, see Document types.

01000000

DocName

String

No

The real name of the customer.

Alice

DocNo

String

No

The ID card number of the customer.

411xxxxxxxxxxx0001

IdOcrPictureBase64

String

No

The Base64-encoded document image.

Base64-encoded content

IdOcrPictureUrl

String

The URL of the document image. The URL can be an HTTP or HTTPS URL that can be accessed over the Internet.

https://***

IdOcrPictureFile

InputStream

ID document image file stream.

For specific integration methods, see File uploads with the Advance interface.

FacePictureBase64

String

No

The Base64-encoded face image.

Base64-encoded content

FacePictureUrl

String

The URL of the face image. The URL can be an HTTP or HTTPS URL that can be accessed over the Internet.

https://***

FacePictureFile

InputStream

File stream of the portrait image.

For specific integration methods, see File uploads with the Advance interface.

Crop

String

No

Specifies whether to crop the face from the image:

• T: Allows cropping.

• F: Disallows cropping (Default)

F

Authorize

String

No

Specifies whether to enable verification against an official database:

• T: Enables verification.

• F: Disables verification (Default)

F

IdThreshold

String

No

3

Parameter

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

Return code: For more information, see Server-side HTTP status codes.

Success

Message

String

A detailed description of the returned error code.

success

Result.Passed

String

The final verification result. Valid values:

• Y: Passed

• N: Failed

Y

Result.SubCode

String

A description of the verification result. For more information, see ResultObject.SubCode error codes.

200

Result.ExtFaceInfo

String

The result of face liveness verification. The value is in the JSON format. For more information, see ExtFaceInfo.

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

Result.ExtIdInfo

String

The result of document verification.

The value is in the JSON format. For more information, see ExtIdInfo.

{
  "ocrIdInfo": {
    "expiryDate": "",
    "originOfIssue": "National Immigration Administration",
    "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"
    ]
  }
}