@alicloud/cloudauth20190307 3.14.0 → 3.14.1

package/dist/models/VerifyMaterialResponseBody.d.ts

@@ -5,7 +5,7 @@ export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.
      * The address.
      *
      * @example
-     * 浙江省杭州市余杭区文一西路969号
+     * No. 969 Wenyi West Road, Yuhang District, Hangzhou City, Zhejiang Province
      */
     address?: string;
     /**
@@ -13,12 +13,12 @@ export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.
      * The issuing authority.
      *
      * @example
-     * 杭州市公安局
+     * Hangzhou Municipal Public Security Bureau
      */
     authority?: string;
     /**
      * @remarks
-     * The HTTP or HTTPS URL of the national emblem side of the ID card. The URL is valid for 5 minutes. Save the image to your own storage to avoid access issues.
+     * The HTTP or HTTPS URL of the image for the back side of the ID card. The URL is valid for 5 minutes. Store the image in your own storage to prevent usage issues.
      *
      * @example
      * http://image-demo.img-cn-hangzhou.aliyuncs.com/example3.jpg
@@ -34,7 +34,7 @@ export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.
     birth?: string;
     /**
      * @remarks
-     * The expiration date of the ID card. Format: yyyymmdd.
+     * The end date of the ID card validity period. Format: yyyymmdd.
      *
      * @example
      * 20201101
@@ -42,7 +42,7 @@ export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.
     endDate?: string;
     /**
      * @remarks
-     * The HTTP or HTTPS URL of the portrait side of the ID card. The URL is valid for 5 minutes. Save the image to your own storage to avoid access issues.
+     * The HTTP or HTTPS URL of the image for the front side of the ID card. The URL is valid for 5 minutes. Store the image in your own storage to prevent usage issues.
      *
      * @example
      * http://image-demo.img-cn-hangzhou.aliyuncs.com/example2.jpg
@@ -53,7 +53,7 @@ export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.
      * The name.
      *
      * @example
-     * 张三
+     * Zhang San
      */
     name?: string;
     /**
@@ -61,7 +61,7 @@ export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.
      * The ethnicity.
      *
      * @example
-     * 汉
+     * Han
      */
     nationality?: string;
     /**
@@ -94,9 +94,9 @@ export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.
 export declare class VerifyMaterialResponseBodyMaterial extends $dara.Model {
     /**
      * @remarks
-     * The global camera image captured by the ID Verification SDK.
+     * The global image captured by the camera and collected by the ID Verification SDK.
      *
-     * > This parameter takes effect only after configuration. If you need to use this parameter, [submit a ticket](https://selfservice.console.aliyun.com/ticket/category/cloudauth/today) to contact us.
+     * > This parameter takes effect only after it is configured. If you need to use this parameter, submit a [ticket](https://selfservice.console.aliyun.com/ticket/category/cloudauth/today) to contact us.
      *
      * @example
      * http://image-demo.img-cn-hangzhou.aliyuncs.com/face-global-example.jpg
@@ -104,7 +104,7 @@ export declare class VerifyMaterialResponseBodyMaterial extends $dara.Model {
     faceGlobalUrl?: string;
     /**
      * @remarks
-     * The HTTP or HTTPS URL of the front-facing facial photo, corresponding to the request parameter **FaceImageUrl**. The URL is valid for 5 minutes. Save the image to your own storage to avoid access issues.
+     * The HTTP or HTTPS URL of the front-facing portrait photo, which corresponds to the **FaceImageUrl** request parameter. The URL is valid for 5 minutes. Store the image in your own storage to prevent usage issues.
      *
      * @example
      * http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg
@@ -112,9 +112,9 @@ export declare class VerifyMaterialResponseBodyMaterial extends $dara.Model {
     faceImageUrl?: string;
     /**
      * @remarks
-     * Indicates whether the face is wearing a mask. Valid values:
-     * - **true**: A mask is detected.
-     * - **false**: No mask is detected.
+     * Specifies whether the face is wearing a mask. Valid values:
+     * - **true**: A mask is worn.
+     * - **false**: No mask is worn.
      *
      * @example
      * false
@@ -122,11 +122,11 @@ export declare class VerifyMaterialResponseBodyMaterial extends $dara.Model {
     faceMask?: string;
     /**
      * @remarks
-     * The quality of the front-facing facial photo. Valid values:
-     * - **UNQUALIFIED**: poor quality
-     * - **LOW**: low quality
-     * - **NORMAL**: moderate quality
-     * - **HIGH**: high quality.
+     * The quality of the front-facing portrait photo. Valid values:
+     * - **UNQUALIFIED**: Poor photo quality.
+     * - **LOW**: Low.
+     * - **NORMAL**: Normal.
+     * - **HIGH**: High.
      *
      * @example
      * NORMAL
@@ -136,20 +136,20 @@ export declare class VerifyMaterialResponseBodyMaterial extends $dara.Model {
      * @remarks
      * The OCR result of the ID card information.
      *
-     * > If the front and back photos of the ID card are not provided during verification, the OCR result of the ID card information is not returned. Even if both photos are provided, not all information on the ID card is guaranteed to be returned. OCR may fail to recognize certain information due to issues such as poor photo quality. We recommend that your business logic does not strictly depend on the ID card OCR information.
+     * > If the front and back sides of the ID card are not provided during the authentication process, the OCR result of the ID card information is not returned. Even if the front and back sides of the ID card are provided, the system does not guarantee that all information on the ID card is returned. If OCR fails to recognize certain information due to photo quality issues, the OCR information may be incomplete. Do not strongly rely on the ID card OCR information in your business.
      */
     idCardInfo?: VerifyMaterialResponseBodyMaterialIdCardInfo;
     /**
      * @remarks
-     * The name, corresponding to the request parameter **Name**.
+     * The name, which corresponds to the **Name** request parameter.
      *
      * @example
-     * 张三
+     * Zhang San
      */
     idCardName?: string;
     /**
      * @remarks
-     * The ID card number, corresponding to the request parameter **IdCardNumber**.
+     * The ID card number, which corresponds to the **IdCardNumber** request parameter.
      *
      * @example
      * 02343218901123****
@@ -169,15 +169,15 @@ export declare class VerifyMaterialResponseBodyMaterial extends $dara.Model {
 export declare class VerifyMaterialResponseBody extends $dara.Model {
     /**
      * @remarks
-     * The comparison score between the facial photo submitted during verification and the authoritative data. Value range: **0** to **100**.
+     * The comparison score between the submitted face photo and the authoritative data during the authentication process. Valid values: **0** to **100**.
      *
-     * Confidence thresholds for reference:
-     * - At a false acceptance rate of 0.001%, the corresponding threshold is 95.
-     * - At a false acceptance rate of 0.01%, the corresponding threshold is 90.
-     * - At a false acceptance rate of 0.1%, the corresponding threshold is 80.
-     * - At a false acceptance rate of 1%, the corresponding threshold is 60.
+     * Refer to the following confidence thresholds:
+     * - When the false acceptance rate (FAR) is 0.001%, the corresponding threshold is 95.
+     * - When the FAR is 0.01%, the corresponding threshold is 90.
+     * - When the FAR is 0.1%, the corresponding threshold is 80.
+     * - When the FAR is 1%, the corresponding threshold is 60.
      *
-     * > This field only represents the comparison result between the face and the authoritative data and serves as a reference score. We do not recommend using this score alone as the pass/fail criterion. For the comprehensive verification result, refer to the **VerifyStatus** field. The **VerifyStatus** result combines the face-to-authoritative-data comparison with multiple other strategies to improve the security level.
+     * > This field only indicates the comparison result between the face and the authoritative data and serves as a reference score. Do not use this score alone as the pass or fail criterion. For the comprehensive authentication result, refer to the **VerifyStatus** field. The **VerifyStatus** result combines the face and authoritative data comparison with various other strategies to improve the security level.
      *
      * @example
      * 97
@@ -185,13 +185,13 @@ export declare class VerifyMaterialResponseBody extends $dara.Model {
     authorityComparisionScore?: number;
     /**
      * @remarks
-     * The comparison score between the facial photo submitted during verification and the face on the portrait side of the ID card. Value range: **0** to **100**.
+     * The comparison score between the submitted face photo and the face on the front side of the ID card during the authentication process. Valid values: **0** to **100**.
      *
-     * Confidence thresholds for reference:
-     * - At a false acceptance rate of 0.001%, the corresponding threshold is 95.
-     * - At a false acceptance rate of 0.01%, the corresponding threshold is 90.
-     * - At a false acceptance rate of 0.1%, the corresponding threshold is 80.
-     * - At a false acceptance rate of 1%, the corresponding threshold is 60.
+     * Refer to the following confidence thresholds:
+     * - When the false acceptance rate (FAR) is 0.001%, the corresponding threshold is 95.
+     * - When the FAR is 0.01%, the corresponding threshold is 90.
+     * - When the FAR is 0.1%, the corresponding threshold is 80.
+     * - When the FAR is 1%, the corresponding threshold is 60.
      *
      * @example
      * 97
@@ -199,7 +199,7 @@ export declare class VerifyMaterialResponseBody extends $dara.Model {
     idCardFaceComparisonScore?: number;
     /**
      * @remarks
-     * The verification materials.
+     * The authentication materials.
      */
     material?: VerifyMaterialResponseBodyMaterial;
     /**
@@ -212,10 +212,10 @@ export declare class VerifyMaterialResponseBody extends $dara.Model {
     requestId?: string;
     /**
      * @remarks
-     * The verification status. Valid values:
+     * The authentication status. Valid values:
      *
-     * - **1**: Verification passed.
-     * - **2** to **n**: Verification failed due to various reasons. For detailed descriptions, see **Verification status description** below.
+     * - **1**: The authentication is passed.
+     * - **2** to **n**: The authentication fails due to various reasons. For detailed descriptions, see **Authentication status description** below.
      *
      * @example
      * 1
@@ -223,7 +223,7 @@ export declare class VerifyMaterialResponseBody extends $dara.Model {
     verifyStatus?: number;
     /**
      * @remarks
-     * The token for this verification, used to correlate the various operations within a verification request. The token is valid for 30 minutes.
+     * The token for this authentication. It is used to link various APIs in the authentication request and is valid for 30 minutes.
      *
      * @example
      * c302c0797679457685410ee51a5ba375

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alicloud/cloudauth20190307",
-  "version": "3.14.0",
+  "version": "3.14.1",
   "description": "",
   "main": "dist/client.js",
   "scripts": {