@alicloud/cloudauth20190307 3.13.2 → 3.13.4

package/dist/models/VehicleMetaVerifyV2request.d.ts

@@ -2,13 +2,13 @@ import * as $dara from '@darabonba/typescript';
 export declare class VehicleMetaVerifyV2Request extends $dara.Model {
     /**
      * @remarks
-     * ID number.
+     * The ID card number.
      *
-     * This is a required field when VerifyMetaType is VEHICLE_3_META.
+     * This parameter is required when VerifyMetaType is set to VEHICLE_3_META.
      *
      * >
-     * > - When paramType is normal, enter plain text.
-     * > - When paramType is md5, enter the first 6 digits in plain text + MD5 (32 lowercase) of the birth date + the last 4 digits in plain text.
+     * > - If ParamType is set to normal, enter the plaintext value.
+     * > - If ParamType is set to md5, enter the first 6 digits of the ID card number in plaintext + the MD5-encrypted date of birth (32-bit lowercase MD5) + the last 4 digits of the ID card number.
      *
      * @example
      * 4****************1
@@ -16,10 +16,10 @@ export declare class VehicleMetaVerifyV2Request extends $dara.Model {
     identifyNum?: string;
     /**
      * @remarks
-     * Parameter type:
+     * The parameter type. Valid values:
      *
-     * - normal: Unencrypted.
-     * - md5: Md5 encrypted.
+     * - normal: not encrypted.
+     * - md5: MD5-encrypted.
      *
      * @example
      * normal
@@ -27,10 +27,10 @@ export declare class VehicleMetaVerifyV2Request extends $dara.Model {
     paramType?: string;
     /**
      * @remarks
-     * Name
+     * The name.
      * >
-     * > - When paramType is normal, enter plain text.
-     * > - When paramType is md5, enter the first character of the name as MD5 (32 lowercase) + the rest of the name in plain text.
+     * > - If ParamType is set to normal, enter the plaintext value.
+     * > - If ParamType is set to md5, enter the MD5-encrypted first character of the name (32-bit lowercase MD5) + the remaining characters of the name in plaintext.
      *
      * @example
      * 张*
@@ -38,11 +38,11 @@ export declare class VehicleMetaVerifyV2Request extends $dara.Model {
     userName?: string;
     /**
      * @remarks
-     * License plate number
+     * The license plate number.
      *
      * >
-     * > - When paramType is normal, enter plain text.
-     * > - When paramType is md5, enter all but the last two characters in plain text + the last two characters as MD5 (32 lowercase).
+     * > - If ParamType is set to normal, enter the plaintext value.
+     * > - If ParamType is set to md5, enter the license plate number excluding the last two characters in plaintext + the MD5-encrypted last two characters (32-bit lowercase MD5).
      *
      * @example
      * 陕A9****
@@ -50,7 +50,7 @@ export declare class VehicleMetaVerifyV2Request extends $dara.Model {
     vehicleNum?: string;
     /**
      * @remarks
-     * Vehicle type
+     * The vehicle type.
      *
      * @example
      * 02
@@ -58,11 +58,11 @@ export declare class VehicleMetaVerifyV2Request extends $dara.Model {
     vehicleType?: string;
     /**
      * @remarks
-     * Verification type
+     * The verification type.
      *
      * >
-     * > - VEHICLE_2_META: Two-element verification, name + license plate number verification;
-     * > - VEHICLE_3_META: Three-element verification, name + license plate number + ID number verification;
+     * > - VEHICLE_2_META: two-element verification. Verifies the name and license plate number.
+     * > - VEHICLE_3_META: three-element verification. Verifies the name, license plate number, and ID card number.
      *
      * @example
      * VEHICLE_3_META

package/dist/models/VehicleMetaVerifyV2responseBody.d.ts

@@ -2,9 +2,9 @@ import * as $dara from '@darabonba/typescript';
 export declare class VehicleMetaVerifyV2ResponseBodyResultObject extends $dara.Model {
     /**
      * @remarks
-     * Verification result code:
-     * - **1**: Verification consistent.
-     * - **2**: Verification inconsistent.
+     * The verification result code. Valid values:
+     * - **1**: Consistent.
+     * - **2**: Inconsistent.
      * - **3**: No record found.
      *
      * @example
@@ -13,7 +13,7 @@ export declare class VehicleMetaVerifyV2ResponseBodyResultObject extends $dara.M
     bizCode?: string;
     /**
      * @remarks
-     * Detailed vehicle information.
+     * The vehicle details.
      *
      * @example
      * {
@@ -55,7 +55,7 @@ export declare class VehicleMetaVerifyV2ResponseBodyResultObject extends $dara.M
 export declare class VehicleMetaVerifyV2ResponseBody extends $dara.Model {
     /**
      * @remarks
-     * Return code, **200** indicates successful API response.
+     * The return code. **200** indicates that the request was successful.
      *
      * @example
      * 200
@@ -63,7 +63,7 @@ export declare class VehicleMetaVerifyV2ResponseBody extends $dara.Model {
     code?: string;
     /**
      * @remarks
-     * Return message.
+     * The response message.
      *
      * @example
      * success
@@ -71,7 +71,7 @@ export declare class VehicleMetaVerifyV2ResponseBody extends $dara.Model {
     message?: string;
     /**
      * @remarks
-     * Request ID
+     * The request ID.
      *
      * @example
      * 5A6229C0-E156-48E4-B6EC-0F528B******
@@ -79,7 +79,7 @@ export declare class VehicleMetaVerifyV2ResponseBody extends $dara.Model {
     requestId?: string;
     /**
      * @remarks
-     * Returned result
+     * The returned result.
      */
     resultObject?: VehicleMetaVerifyV2ResponseBodyResultObject;
     static names(): {

package/dist/models/VehicleQueryRequest.d.ts

@@ -2,10 +2,10 @@ import * as $dara from '@darabonba/typescript';
 export declare class VehicleQueryRequest extends $dara.Model {
     /**
      * @remarks
-     * Parameter type:
+     * The parameter type. Valid values:
      *
-     * - **normal**: Unencrypted.
-     * - **md5**: MD5 encrypted.
+     * - **normal**: not encrypted.
+     * - **md5**: MD5-encrypted.
      *
      * @example
      * normal
@@ -13,11 +13,11 @@ export declare class VehicleQueryRequest extends $dara.Model {
     paramType?: string;
     /**
      * @remarks
-     * License plate number
+     * The license plate number.
      *
      * >
-     * > - When paramType is set to normal, enter the plain text.
-     * > - When paramType is set to md5, enter the unencrypted part of the license plate number except for the last two characters + the MD5 (32 lowercase) encryption of the last two characters of the license plate.
+     * > - If ParamType is set to normal, enter the plaintext license plate number.
+     * > - If ParamType is set to md5, enter the plaintext of the license plate number excluding the last two characters, concatenated with the MD5-encrypted value of the last two characters (32-bit lowercase MD5).
      *
      * @example
      * 陕A9****
@@ -25,7 +25,7 @@ export declare class VehicleQueryRequest extends $dara.Model {
     vehicleNum?: string;
     /**
      * @remarks
-     * Vehicle type
+     * The vehicle type.
      *
      * @example
      * 02

package/dist/models/VehicleQueryResponseBody.d.ts

@@ -2,11 +2,11 @@ import * as $dara from '@darabonba/typescript';
 export declare class VehicleQueryResponseBodyResultObject extends $dara.Model {
     /**
      * @remarks
-     * Verification result code:
+     * The verification result code. Valid values:
      *
      * >
-     * > - 1: Found (charged)
-     * > - 3: No record found (not charged)
+     * > - 1: match found (billable).
+     * > - 3: no record found (not billable).
      *
      * @example
      * 1
@@ -14,7 +14,7 @@ export declare class VehicleQueryResponseBodyResultObject extends $dara.Model {
     bizCode?: string;
     /**
      * @remarks
-     * Vehicle information.
+     * The vehicle information.
      *
      * @example
      * {
@@ -62,7 +62,7 @@ export declare class VehicleQueryResponseBodyResultObject extends $dara.Model {
 export declare class VehicleQueryResponseBody extends $dara.Model {
     /**
      * @remarks
-     * Return code: 200 for success, others for failure
+     * The return code. A value of 200 indicates success. Other values indicate failure.
      *
      * @example
      * 200
@@ -70,7 +70,7 @@ export declare class VehicleQueryResponseBody extends $dara.Model {
     code?: string;
     /**
      * @remarks
-     * Return message.
+     * The response message.
      *
      * @example
      * success
@@ -78,7 +78,7 @@ export declare class VehicleQueryResponseBody extends $dara.Model {
     message?: string;
     /**
      * @remarks
-     * Request ID
+     * The request ID.
      *
      * @example
      * D6163397-15C5-419C-9ACC-B7C83*******
@@ -86,7 +86,7 @@ export declare class VehicleQueryResponseBody extends $dara.Model {
     requestId?: string;
     /**
      * @remarks
-     * Request result
+     * The request result.
      */
     resultObject?: VehicleQueryResponseBodyResultObject;
     static names(): {

package/dist/models/VerifyMaterialRequest.d.ts

@@ -2,9 +2,9 @@ import * as $dara from '@darabonba/typescript';
 export declare class VerifyMaterialRequest extends $dara.Model {
     /**
      * @remarks
-     * A unique ID that identifies a single authentication task, not exceeding 64 characters. For a single authentication task, the system supports unlimited submissions until the final authentication is passed and the task is completed.
+     * The unique ID that identifies a verification task. The value can be up to 64 characters in length. For a single verification task, the system supports unlimited submissions until the verification is passed and the task is completed.
      *
-     * > Different BizIds are required for different authentication tasks.
+     * > Use a different BizId for each new verification task.
      *
      * This parameter is required.
      *
@@ -14,7 +14,7 @@ export declare class VerifyMaterialRequest extends $dara.Model {
     bizId?: string;
     /**
      * @remarks
-     * Identifier for the business scenario using the real-person authentication service. Please refer to [Business Setup](https://help.aliyun.com/document_detail/127885.html) and complete the creation in the console first.
+     * The business scenario identifier for the ID Verification service. Create one in the console first. For more information, see [Business settings](https://help.aliyun.com/document_detail/127885.html).
      *
      * This parameter is required.
      *
@@ -24,7 +24,7 @@ export declare class VerifyMaterialRequest extends $dara.Model {
     bizType?: string;
     /**
      * @remarks
-     * HTTP or HTTPS link to the frontal face image.
+     * The HTTP or HTTPS URL of the front-facing facial photo.
      *
      * This parameter is required.
      *
@@ -34,7 +34,7 @@ export declare class VerifyMaterialRequest extends $dara.Model {
     faceImageUrl?: string;
     /**
      * @remarks
-     * HTTP or HTTPS link to the national emblem side of the ID card.
+     * The HTTP or HTTPS URL of the national emblem side of the ID card.
      *
      * @example
      * http://image-demo.img-cn-hangzhou.aliyuncs.com/example3.jpg
@@ -42,7 +42,7 @@ export declare class VerifyMaterialRequest extends $dara.Model {
     idCardBackImageUrl?: string;
     /**
      * @remarks
-     * HTTP or HTTPS link to the portrait side of the ID card image.
+     * The HTTP or HTTPS URL of the portrait side of the ID card.
      *
      * @example
      * http://image-demo.img-cn-hangzhou.aliyuncs.com/example2.jpg
@@ -50,7 +50,7 @@ export declare class VerifyMaterialRequest extends $dara.Model {
     idCardFrontImageUrl?: string;
     /**
      * @remarks
-     * ID number.
+     * The ID card number.
      *
      * This parameter is required.
      *
@@ -60,7 +60,7 @@ export declare class VerifyMaterialRequest extends $dara.Model {
     idCardNumber?: string;
     /**
      * @remarks
-     * Name.
+     * The name.
      *
      * This parameter is required.
      *

package/dist/models/VerifyMaterialResponseBody.d.ts

@@ -2,7 +2,7 @@ import * as $dara from '@darabonba/typescript';
 export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.Model {
     /**
      * @remarks
-     * Address.
+     * The address.
      *
      * @example
      * 浙江省杭州市余杭区文一西路969号
@@ -10,7 +10,7 @@ export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.
     address?: string;
     /**
      * @remarks
-     * Issuing authority.
+     * The issuing authority.
      *
      * @example
      * 杭州市公安局
@@ -18,7 +18,7 @@ export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.
     authority?: string;
     /**
      * @remarks
-     * HTTP or HTTPS link to the national emblem side of the ID card. The link is valid for 5 minutes. It is recommended to store it in your business system to avoid any impact on usage.
+     * 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.
      *
      * @example
      * http://image-demo.img-cn-hangzhou.aliyuncs.com/example3.jpg
@@ -26,7 +26,7 @@ export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.
     backImageUrl?: string;
     /**
      * @remarks
-     * Date of birth.
+     * The date of birth.
      *
      * @example
      * 19900101
@@ -34,7 +34,7 @@ export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.
     birth?: string;
     /**
      * @remarks
-     * End date of the document\\"s validity period. Format: yyyymmdd.
+     * The expiration date of the ID card. Format: yyyymmdd.
      *
      * @example
      * 20201101
@@ -42,7 +42,7 @@ export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.
     endDate?: string;
     /**
      * @remarks
-     * HTTP or HTTPS link to the portrait side of the ID card. The link is valid for 5 minutes. It is recommended to store it in your business system to avoid any impact on usage.
+     * 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.
      *
      * @example
      * http://image-demo.img-cn-hangzhou.aliyuncs.com/example2.jpg
@@ -50,7 +50,7 @@ export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.
     frontImageUrl?: string;
     /**
      * @remarks
-     * Name.
+     * The name.
      *
      * @example
      * 张三
@@ -58,7 +58,7 @@ export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.
     name?: string;
     /**
      * @remarks
-     * Nationality.
+     * The ethnicity.
      *
      * @example
      * 汉
@@ -66,7 +66,7 @@ export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.
     nationality?: string;
     /**
      * @remarks
-     * ID number.
+     * The ID card number.
      *
      * @example
      * 02343218901123****
@@ -74,7 +74,7 @@ export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.
     number?: string;
     /**
      * @remarks
-     * Start date of the document\\"s validity period. Format: yyyymmdd.
+     * The start date of the ID card validity period. Format: yyyymmdd.
      *
      * @example
      * 20201101
@@ -94,9 +94,9 @@ export declare class VerifyMaterialResponseBodyMaterialIdCardInfo extends $dara.
 export declare class VerifyMaterialResponseBodyMaterial extends $dara.Model {
     /**
      * @remarks
-     * Global camera image captured by the real-person authentication SDK.
+     * The global camera image captured by the ID Verification SDK.
      *
-     * > This parameter will take effect after configuration. If you need to use this parameter, please submit a [ticket](https://selfservice.console.aliyun.com/ticket/category/cloudauth/today) to contact us.
+     * > 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.
      *
      * @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
-     * HTTP or HTTPS link to the frontal face image, corresponding to the request parameter **FaceImageUrl**. The link is valid for 5 minutes, and it is recommended to store it in your business to avoid affecting usage.
+     * 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.
      *
      * @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
-     * Whether the face is wearing a mask. Values:
-     * - **true**: Wearing a mask
-     * - **false**: Not wearing a mask
+     * Indicates whether the face is wearing a mask. Valid values:
+     * - **true**: A mask is detected.
+     * - **false**: No mask is detected.
      *
      * @example
      * false
@@ -122,11 +122,11 @@ export declare class VerifyMaterialResponseBodyMaterial extends $dara.Model {
     faceMask?: string;
     /**
      * @remarks
-     * The quality of the frontal face image. Possible values:
-     * - **UNQUALIFIED**: Poor quality
-     * - **LOW**: Low
-     * - **NORMAL**: Average
-     * - **HIGH**: High
+     * The quality of the front-facing facial photo. Valid values:
+     * - **UNQUALIFIED**: poor quality
+     * - **LOW**: low quality
+     * - **NORMAL**: moderate quality
+     * - **HIGH**: high quality.
      *
      * @example
      * NORMAL
@@ -134,14 +134,14 @@ export declare class VerifyMaterialResponseBodyMaterial extends $dara.Model {
     faceQuality?: string;
     /**
      * @remarks
-     * OCR result of the ID card information.
+     * The OCR result of the ID card information.
      *
-     * > If there is no front or back of the ID card during the verification process, the OCR result of the ID card information will not be returned. Even if the front and back of the ID card are present during the verification process, it does not guarantee that all the information on the ID card will be returned. Due to issues such as poor ID card photography, the OCR may fail to recognize some information, leading to incomplete OCR results. It is recommended that the business side does not heavily rely on the ID card OCR 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.
      */
     idCardInfo?: VerifyMaterialResponseBodyMaterialIdCardInfo;
     /**
      * @remarks
-     * Name, corresponding to the request parameter **Name**.
+     * The name, corresponding to the request parameter **Name**.
      *
      * @example
      * 张三
@@ -149,7 +149,7 @@ export declare class VerifyMaterialResponseBodyMaterial extends $dara.Model {
     idCardName?: string;
     /**
      * @remarks
-     * ID number, corresponding to the request parameter **IdCardNumber**.
+     * The ID card number, corresponding to the request parameter **IdCardNumber**.
      *
      * @example
      * 02343218901123****
@@ -169,15 +169,15 @@ export declare class VerifyMaterialResponseBodyMaterial extends $dara.Model {
 export declare class VerifyMaterialResponseBody extends $dara.Model {
     /**
      * @remarks
-     * Comparison score between the facial photo submitted during the authentication process and authoritative data, with a range of **0**~**100**.
+     * The comparison score between the facial photo submitted during verification and the authoritative data. Value range: **0** to **100**.
      *
-     * Confidence threshold references:
-     * - False recognition rate 0.001% corresponds to a threshold of 95.
-     * - False recognition rate 0.01% corresponds to a threshold of 90.
-     * - False recognition rate 0.1% corresponds to a threshold of 80.
-     * - False recognition rate 1% corresponds to a threshold of 60.
+     * 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.
      *
-     * > This field only indicates the comparison result between the face and authoritative data, serving as a reference score. It is generally not recommended to use this score alone as the pass/fail criterion. For the comprehensive authentication result, please refer to the **VerifyStatus** field. The **VerifyStatus** result integrates the face-to-authoritative data comparison and other various strategies, enhancing security levels.
+     * > 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.
      *
      * @example
      * 97
@@ -185,13 +185,13 @@ export declare class VerifyMaterialResponseBody extends $dara.Model {
     authorityComparisionScore?: number;
     /**
      * @remarks
-     * Comparison score between the facial photo submitted during the authentication process and the face on the portrait side of the ID card image, with a range of **0**~**100**.
+     * 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**.
      *
-     * Confidence threshold references:
-     * - False recognition rate 0.001% corresponds to a threshold of 95.
-     * - False recognition rate 0.01% corresponds to a threshold of 90.
-     * - False recognition rate 0.1% corresponds to a threshold of 80.
-     * - False recognition rate 1% corresponds to a threshold of 60.
+     * 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.
      *
      * @example
      * 97
@@ -199,12 +199,12 @@ export declare class VerifyMaterialResponseBody extends $dara.Model {
     idCardFaceComparisonScore?: number;
     /**
      * @remarks
-     * Authentication materials.
+     * The verification materials.
      */
     material?: VerifyMaterialResponseBodyMaterial;
     /**
      * @remarks
-     * Request ID.
+     * The request ID.
      *
      * @example
      * 04F0F334-1335-436C-A1D7-6C044FE73368
@@ -212,10 +212,10 @@ export declare class VerifyMaterialResponseBody extends $dara.Model {
     requestId?: string;
     /**
      * @remarks
-     * Authentication status. Values:
+     * The verification status. Valid values:
      *
-     * - **1**: Authentication passed.
-     * - **2**~**n**: Authentication failed due to various reasons. For detailed descriptions, see the **Authentication Status Explanation** below.
+     * - **1**: Verification passed.
+     * - **2** to **n**: Verification failed due to various reasons. For detailed descriptions, see **Verification status description** below.
      *
      * @example
      * 1
@@ -223,7 +223,7 @@ export declare class VerifyMaterialResponseBody extends $dara.Model {
     verifyStatus?: number;
     /**
      * @remarks
-     * Token for this authentication, used to link various interfaces in the authentication request, valid for 30 minutes.
+     * The token for this verification, used to correlate the various operations within a verification request. The token is valid for 30 minutes.
      *
      * @example
      * c302c0797679457685410ee51a5ba375

package/package.json

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