@alicloud/cloudauth20190307 3.13.3 → 3.13.4

package/src/models/DescribeVerifyResultResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeVerifyResultResponseBodyMaterialIdCardInfo extends $dara.Model {
   /**
    * @remarks
-   * Address.
+   * The address.
    * 
    * @example
    * 浙江省杭州市余杭区文一西路969号
@@ -13,7 +13,7 @@ export class DescribeVerifyResultResponseBodyMaterialIdCardInfo extends $dara.Mo
   address?: string;
   /**
    * @remarks
-   * Issuing authority.
+   * The issuing authority.
    * 
    * @example
    * 杭州市公安局
@@ -21,8 +21,8 @@ export class DescribeVerifyResultResponseBodyMaterialIdCardInfo extends $dara.Mo
   authority?: string;
   /**
    * @remarks
-   * HTTP/HTTPS link to the image of the back side (national emblem side) of the ID card. The link is valid for 5 minutes, and it is recommended to store it for business use to avoid any impact.
-   * > If the HTTP/HTTPS link to the front-facing portrait image expires, you can call DescribeVerifyResult again to get the link.
+   * 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 avoid access issues.
+   * > If the HTTP or HTTPS URL has expired, call DescribeVerifyResult again to obtain a new URL.
    * 
    * @example
    * http://image-demo.img-cn-hangzhou.aliyuncs.com/example3.jpg
@@ -30,7 +30,7 @@ export class DescribeVerifyResultResponseBodyMaterialIdCardInfo extends $dara.Mo
   backImageUrl?: string;
   /**
    * @remarks
-   * Date of birth.
+   * The date of birth.
    * 
    * @example
    * 19900101
@@ -38,7 +38,7 @@ export class DescribeVerifyResultResponseBodyMaterialIdCardInfo extends $dara.Mo
   birth?: string;
   /**
    * @remarks
-   * The end date of the document\\"s validity period. Format: yyyymmdd.
+   * The expiration date of the ID card. Format: yyyymmdd.
    * 
    * @example
    * 20201101
@@ -46,8 +46,8 @@ export class DescribeVerifyResultResponseBodyMaterialIdCardInfo extends $dara.Mo
   endDate?: string;
   /**
    * @remarks
-   * HTTP/HTTPS link to the image of the front side (portrait side) of the ID card. The link is valid for 5 minutes, and it is recommended to store it for business use to avoid any impact.
-   * > If the HTTP/HTTPS link to the front-facing portrait image expires, you can call DescribeVerifyResult again to get the link.
+   * The HTTP or HTTPS URL of the portrait side of the ID card. The URL is valid for 5 minutes. Save the image to avoid access issues.
+   * > If the HTTP or HTTPS URL has expired, call DescribeVerifyResult again to obtain a new URL.
    * 
    * @example
    * http://image-demo.img-cn-hangzhou.aliyuncs.com/example2.jpg
@@ -55,7 +55,7 @@ export class DescribeVerifyResultResponseBodyMaterialIdCardInfo extends $dara.Mo
   frontImageUrl?: string;
   /**
    * @remarks
-   * Name.
+   * The name on the ID card.
    * 
    * @example
    * 张三
@@ -63,7 +63,7 @@ export class DescribeVerifyResultResponseBodyMaterialIdCardInfo extends $dara.Mo
   name?: string;
   /**
    * @remarks
-   * Nationality.
+   * The ethnicity.
    * 
    * @example
    * 汉
@@ -71,7 +71,7 @@ export class DescribeVerifyResultResponseBodyMaterialIdCardInfo extends $dara.Mo
   nationality?: string;
   /**
    * @remarks
-   * ID card number.
+   * The ID card number.
    * 
    * @example
    * 02343218901123****
@@ -79,7 +79,7 @@ export class DescribeVerifyResultResponseBodyMaterialIdCardInfo extends $dara.Mo
   number?: string;
   /**
    * @remarks
-   * Start date of the document\\"s validity. Format: yyyymmdd.
+   * The start date of the ID card validity period. Format: yyyymmdd.
    * 
    * @example
    * 20201101
@@ -127,9 +127,9 @@ export class DescribeVerifyResultResponseBodyMaterialIdCardInfo extends $dara.Mo
 export class DescribeVerifyResultResponseBodyMaterial extends $dara.Model {
   /**
    * @remarks
-   * The global camera image captured by the real-person authentication SDK.
+   * The global camera image captured by the ID Verification SDK.
    * 
-   * > This parameter will only 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
@@ -137,8 +137,8 @@ export class DescribeVerifyResultResponseBodyMaterial extends $dara.Model {
   faceGlobalUrl?: string;
   /**
    * @remarks
-   * The HTTP or HTTPS link to the frontal face image. The link is valid for 5 minutes, and it is recommended to store it elsewhere to avoid any impact on usage.
-   * > If the HTTP or HTTPS link to the frontal face image expires, you can call [DescribeVerifyResult](https://help.aliyun.com/document_detail/154606.html) again to get the link.
+   * The HTTP or HTTPS URL of the face photo. The URL is valid for 5 minutes. Save the image to avoid access issues.
+   * > If the HTTP or HTTPS URL of the face photo has expired, call [DescribeVerifyResult](https://help.aliyun.com/document_detail/154606.html) again to obtain a new URL.
    * 
    * @example
    * http://image-demo.img-cn-hangzhou.aliyuncs.com/face-image-example.jpg
@@ -146,9 +146,9 @@ export class DescribeVerifyResultResponseBodyMaterial 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
@@ -156,11 +156,11 @@ export class DescribeVerifyResultResponseBodyMaterial extends $dara.Model {
   faceMask?: boolean;
   /**
    * @remarks
-   * The quality of the frontal face image. Values:
-   * - **UNQUALIFIED**: Poor quality
-   * - **LOW**: Low
-   * - **NORMAL**: Normal
-   * - **HIGH**: High
+   * The quality of the face photo. Valid values:
+   * - **UNQUALIFIED**: poor quality.
+   * - **LOW**: low quality.
+   * - **NORMAL**: moderate quality.
+   * - **HIGH**: high quality.
    * 
    * @example
    * NORMAL
@@ -168,13 +168,13 @@ export class DescribeVerifyResultResponseBodyMaterial extends $dara.Model {
   faceQuality?: string;
   /**
    * @remarks
-   * OCR results of the ID card information.
-   * > If there is no front and back information of the ID card during the authentication process, the real-person authentication service will not return the OCR results of the ID card. Even if there is front and back information of the ID card during the authentication process, the real-person authentication service does not guarantee to return all the information on the ID card. Due to issues with ID card photography, the OCR may fail to recognize some information, resulting in incomplete OCR information. It is recommended that your business does not strongly rely on the ID card OCR information.
+   * The OCR result of the ID card information.
+   * > If no front or back image of the ID card is provided during verification, the ID Verification service does not return the OCR result. Even if front and back images are provided, the service does not guarantee that all information on the ID card will be returned. OCR information may be incomplete when the ID card photo is blurry or has lighting issues that prevent character recognition. Do not create a strong dependency on the ID card OCR information in your business logic.
    */
   idCardInfo?: DescribeVerifyResultResponseBodyMaterialIdCardInfo;
   /**
    * @remarks
-   * Name.
+   * The name on the ID card.
    * 
    * @example
    * 张三
@@ -182,7 +182,7 @@ export class DescribeVerifyResultResponseBodyMaterial extends $dara.Model {
   idCardName?: string;
   /**
    * @remarks
-   * ID number.
+   * The ID card number.
    * 
    * @example
    * 02343218901123****
@@ -190,7 +190,7 @@ export class DescribeVerifyResultResponseBodyMaterial extends $dara.Model {
   idCardNumber?: string;
   /**
    * @remarks
-   * The URL addresses of the recorded videos returned by the historical RPH5BioOnly solution.
+   * The URL of the recorded video returned by the legacy RPH5BioOnly solution.
    */
   videoUrls?: string[];
   static names(): { [key: string]: string } {
@@ -237,10 +237,16 @@ export class DescribeVerifyResultResponseBodyMaterial extends $dara.Model {
 export class DescribeVerifyResultResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The comparison score between the face photo submitted during the authentication process and the authoritative data, with a value range of **0** to **100**.
-   * Confidence threshold references:
-   * - When the false acceptance rate is 0.001%, the corresponding threshold is 95. - When the false acceptance rate is 0.01%, the corresponding threshold is 90. - When the false acceptance rate is 0.1%, the corresponding threshold is 80. - When the false acceptance rate is 1%, the corresponding threshold is 60.
-   * > This field only indicates the comparison result between the face and the authoritative data, for your reference only. It is generally not recommended to use this value alone as the standard for whether the authentication passes. For a comprehensive authentication result, please refer to the **VerifyStatus** field. The **VerifyStatus** result integrates the comparison of the face with the authoritative data and various other strategies, which can enhance security levels.
+   * The comparison score between the face photo submitted during verification and the authoritative data. Value range: **0** to **100**.
+   * 
+   * Confidence threshold reference:
+   * 
+   * - When the false acceptance rate is 0.001%, the corresponding threshold is 95.
+   * - When the false acceptance rate is 0.01%, the corresponding threshold is 90.
+   * - When the false acceptance rate is 0.1%, the corresponding threshold is 80.
+   * - When the false acceptance rate is 1%, the corresponding threshold is 60.
+   * 
+   * > This field only indicates the comparison result between the face and the authoritative data and is for reference only. Do not use this value alone as the criterion for determining whether the verification is passed. 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 security.
    * 
    * @example
    * 97
@@ -248,14 +254,15 @@ export class DescribeVerifyResultResponseBody extends $dara.Model {
   authorityComparisionScore?: number;
   /**
    * @remarks
-   * The comparison score between the face photo submitted during the authentication process and the face in the retained face image. The value range is **0**~**100**.
+   * The comparison score between the face photo submitted during verification and the face in the retained face image. Value range: **0** to **100**.
+   * 
    * 
    * Confidence threshold reference:
    * 
-   * - When the false recognition rate is 0.001%, the corresponding threshold is 95.
-   * - When the false recognition rate is 0.01%, the corresponding threshold is 90.
-   * - When the false recognition rate is 0.1%, the corresponding threshold is 80.
-   * - When the false recognition rate is 1%, the corresponding threshold is 60.
+   * - When the false acceptance rate is 0.001%, the corresponding threshold is 95.
+   * - When the false acceptance rate is 0.01%, the corresponding threshold is 90.
+   * - When the false acceptance rate is 0.1%, the corresponding threshold is 80.
+   * - When the false acceptance rate is 1%, the corresponding threshold is 60.
    * 
    * @example
    * 97
@@ -263,14 +270,15 @@ export class DescribeVerifyResultResponseBody extends $dara.Model {
   faceComparisonScore?: number;
   /**
    * @remarks
-   * The comparison score between the face photo submitted during the authentication process and the face on the ID card\\"s face side. The value range is **0**~**100**.
+   * The comparison score between the face photo submitted during verification and the face on the ID card photo. Value range: **0** to **100**.
+   * 
    * 
    * Confidence threshold reference:
    * 
-   * - When the false recognition rate is 0.001%, the corresponding threshold is 95.
-   * - When the false recognition rate is 0.01%, the corresponding threshold is 90.
-   * - When the false recognition rate is 0.1%, the corresponding threshold is 80.
-   * - When the false recognition rate is 1%, the corresponding threshold is 60.
+   * - When the false acceptance rate is 0.001%, the corresponding threshold is 95.
+   * - When the false acceptance rate is 0.01%, the corresponding threshold is 90.
+   * - When the false acceptance rate is 0.1%, the corresponding threshold is 80.
+   * - When the false acceptance rate is 1%, the corresponding threshold is 60.
    * 
    * @example
    * 97
@@ -278,12 +286,12 @@ export class DescribeVerifyResultResponseBody extends $dara.Model {
   idCardFaceComparisonScore?: number;
   /**
    * @remarks
-   * Authentication materials.
+   * The verification materials.
    */
   material?: DescribeVerifyResultResponseBodyMaterial;
   /**
    * @remarks
-   * The ID of this request.
+   * The ID of the request.
    * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368
@@ -291,8 +299,11 @@ export class DescribeVerifyResultResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Authentication status, values:
-   * - **-1**: Not authenticated - **1**: Authentication passed - **2** to **n**: Authentication failed for various reasons. For detailed descriptions, see the authentication status explanation.
+   * The verification status. Valid values:
+   * 
+   * - **-1**: not verified.
+   * - **1**: verification passed.
+   * - **2** to **n**: verification failed due to various reasons. For more information, see the verification status description.
    * 
    * @example
    * 1

package/src/models/DescribeVerifySdkrequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeVerifySDKRequest extends $dara.Model {
   /**
    * @remarks
-   * The task ID for generating the SDK.
+   * The ID of the SDK generation task.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeVerifySdkresponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeVerifySDKResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of this request.
+   * The ID of the request.
    * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
@@ -13,7 +13,7 @@ export class DescribeVerifySDKResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The SDK download URL. When not empty, it indicates that the generation is complete.
+   * The download URL of the SDK. A non-empty value indicates that the SDK has been generated.
    * 
    * @example
    * https://www.xxx.com

package/src/models/DescribeVerifySearchPageListRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeVerifySearchPageListRequest extends $dara.Model {
   /**
    * @remarks
-   * ID number.
+   * The ID card number.
    * 
    * @example
    * 3203212000XXXX701X
@@ -13,7 +13,7 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   certNo?: string;
   /**
    * @remarks
-   * Authentication ID.
+   * The certification ID.
    * 
    * @example
    * shadbdd3dbacd001cfa892a5e2b98dxx
@@ -21,7 +21,7 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   certifyId?: string;
   /**
    * @remarks
-   * Current page number.
+   * The current page number.
    * 
    * This parameter is required.
    * 
@@ -31,7 +31,7 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   currentPage?: string;
   /**
    * @remarks
-   * End time of the query. Format is Unix timestamp, in milliseconds.
+   * The query end time. The format is a Unix timestamp in milliseconds.
    * 
    * @example
    * 2025-10-16 23:59:59 +0800
@@ -39,7 +39,7 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   endDate?: string;
   /**
    * @remarks
-   * Whether there is a device risk (pass true if root = 1 or simulator = 1 or virtual_video = 1).
+   * Specifies whether there is a device risk. Setting this parameter to true indicates that root = 1, simulator = 1, or virtual_video = 1.
    * 
    * @example
    * true
@@ -47,7 +47,7 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   hasDeviceRisk?: boolean;
   /**
    * @remarks
-   * Model for liveness detection.
+   * The liveness detection model.
    * 
    * @example
    * LIVENESS
@@ -55,7 +55,7 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   model?: string;
   /**
    * @remarks
-   * Unique identifier for the customer request.
+   * The unique identifier for the customer request.
    * 
    * @example
    * e0c34a77f5ac40a5aa5e6ed20c353888
@@ -63,7 +63,7 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   outerOrderNo?: string;
   /**
    * @remarks
-   * Number of items per page.
+   * The number of entries per page.
    * 
    * This parameter is required.
    * 
@@ -73,9 +73,9 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   pageSize?: string;
   /**
    * @remarks
-   * Whether the authentication passed:
-   * - **T**: Passed
-   * - **F**: Not passed
+   * Specifies whether the authentication passed:
+   * - **T**: Passed.
+   * - **F**: Failed.
    * 
    * @example
    * F
@@ -83,7 +83,7 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   passed?: string;
   /**
    * @remarks
-   * Product code.
+   * The product code.
    * 
    * @example
    * ID_PRO
@@ -91,9 +91,9 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   productCode?: string;
   /**
    * @remarks
-   * Business scenario risk
-   * - **0**: No risk
-   * - **1**: Risk present
+   * The business scenario risk:
+   * - **0**: No risk.
+   * - **1**: Risk detected.
    * 
    * @example
    * 1
@@ -101,9 +101,9 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   riskBizScenario?: number;
   /**
    * @remarks
-   * Device risk:
-   * - **0**: No risk
-   * - **1**: Risk present
+   * The device risk:
+   * - **0**: No risk.
+   * - **1**: Risk detected.
    * 
    * @example
    * 1
@@ -111,9 +111,9 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   riskDevice?: number;
   /**
    * @remarks
-   * DeviceToken risk:
-   * - **0**: No risk
-   * - **1**: Risk present
+   * The DeviceToken risk:
+   * - **0**: No risk.
+   * - **1**: Risk detected.
    * 
    * @example
    * 0
@@ -121,9 +121,9 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   riskDeviceToken?: number;
   /**
    * @remarks
-   * General risk
-   * - **0**: No risk
-   * - **1**: Risk present
+   * The generic risk:
+   * - **0**: No risk.
+   * - **1**: Risk detected.
    * 
    * @example
    * 1
@@ -131,9 +131,9 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   riskGeneric?: number;
   /**
    * @remarks
-   * Large model mining risk
-   * - **0**: No risk
-   * - **1**: Risk present
+   * The large model mining risk:
+   * - **0**: No risk.
+   * - **1**: Risk detected.
    * 
    * @example
    * 1
@@ -141,7 +141,7 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   riskModelMining?: number;
   /**
    * @remarks
-   * Whether it is rooted (pass 1 if selected, otherwise do not pass; corresponds to identity label risk type).
+   * Specifies whether the device is rooted. Set to 1 if selected; otherwise, do not pass this parameter. This parameter corresponds to the identity tag risk type.
    * 
    * @example
    * 1
@@ -149,7 +149,7 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   root?: number;
   /**
    * @remarks
-   * Scene ID.
+   * The scene ID.
    * 
    * @example
    * 10000072xx
@@ -157,7 +157,7 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   sceneId?: string;
   /**
    * @remarks
-   * Whether it is a simulator (pass 1 if selected, otherwise do not pass; corresponds to device label risk type).
+   * Specifies whether the device is a simulator. Set to 1 if selected; otherwise, do not pass this parameter. This parameter corresponds to the device tag risk type.
    * 
    * @example
    * 1
@@ -165,7 +165,7 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   simulator?: number;
   /**
    * @remarks
-   * Start time of the query.
+   * The query start time.
    * 
    * @example
    * 2025-10-10 00:00:00 +0800
@@ -173,7 +173,7 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   startDate?: string;
   /**
    * @remarks
-   * Result Code. For detailed values, please refer to: [SubCode Explanation](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/error-code-person-verify?spm=a2c4g.11186623.0.0.6015566ebArcFw#d88910e172fgg).
+   * The result code. For details, see [SubCode Description](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/error-code-person-verify?spm=a2c4g.11186623.0.0.6015566ebArcFw#d88910e172fgg).
    * 
    * @example
    * 201
@@ -181,7 +181,7 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   subCode?: string;
   /**
    * @remarks
-   * Comma-separated Result Codes. For detailed values, please refer to: [SubCode Explanation](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/error-code-person-verify?spm=a2c4g.11186623.0.0.6015566ebArcFw#d88910e172fgg).
+   * Comma-separated result codes. For details, see [SubCode Description](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/error-code-person-verify?spm=a2c4g.11186623.0.0.6015566ebArcFw#d88910e172fgg).
    * 
    * @example
    * 201,202
@@ -189,7 +189,7 @@ export class DescribeVerifySearchPageListRequest extends $dara.Model {
   subCodes?: string;
   /**
    * @remarks
-   * Whether it is a virtual adaptation (pass 1 if selected, otherwise do not pass; corresponds to behavior label risk type).
+   * Specifies whether virtual video is used. Set to 1 if selected; otherwise, do not pass this parameter. This parameter corresponds to the behavior tag risk type.
    * 
    * @example
    * 1