@alicloud/cloudauth20190307 3.13.2 → 3.13.4

package/src/models/DeleteCustomizeFlowStrategyResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteCustomizeFlowStrategyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * HTTP status code.
+   * The HTTP status code.
    * 
    * @example
    * Success
@@ -13,7 +13,7 @@ export class DeleteCustomizeFlowStrategyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Returned data.
+   * The returned data.
    * 
    * @example
    * -
@@ -21,7 +21,7 @@ export class DeleteCustomizeFlowStrategyResponseBody extends $dara.Model {
   data?: number;
   /**
    * @remarks
-   * HTTP status code.
+   * The HTTP status code.
    * 
    * @example
    * 200
@@ -29,7 +29,7 @@ export class DeleteCustomizeFlowStrategyResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * Return message.
+   * The returned message.
    * 
    * @example
    * success
@@ -37,7 +37,7 @@ export class DeleteCustomizeFlowStrategyResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * ID of this request.
+   * The request ID.
    * 
    * @example
    * 5A6229C0-E156-48E4-B6EC-0F528BDF60D2
@@ -45,7 +45,7 @@ export class DeleteCustomizeFlowStrategyResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Whether the response was successful.
+   * Indicates whether the response is successful.
    * 
    * @example
    * true

package/src/models/DeleteFaceVerifyResultRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteFaceVerifyResultRequest extends $dara.Model {
   /**
    * @remarks
-   * Unique identifier for real-person authentication.
+   * The unique identifier for real-person authentication.
    * 
    * @example
    * shae18209d29ce4e8ba252caae98ab15
@@ -13,10 +13,10 @@ export class DeleteFaceVerifyResultRequest extends $dara.Model {
   certifyId?: string;
   /**
    * @remarks
-   * Whether deletion depends on having already obtained relevant data from the corresponding authentication process.
+   * Specifies whether deletion depends on having retrieved the relevant data from the corresponding authentication process.
    * 
-   * - Y: Required. To successfully delete the related data, you must have obtained the processing result through the DescribeFaceVerify interface.
-   * - N: Not required (default). For pure server-side API integration, you can directly pass N.
+   * - Y: Required. To successfully delete the relevant data, you must have already obtained the processing result through the DescribeFaceVerify API.
+   * - N: Not required (default). You can directly pass N when integrating through the pure server-side API mode.
    * 
    * @example
    * Y

package/src/models/DeleteFaceVerifyResultResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteFaceVerifyResultResponseBodyResultObject extends $dara.Model {
   /**
    * @remarks
-   * Unique identifier for real-person authentication.
+   * The unique identifier for real-person authentication.
    * 
    * @example
    * sha58aeae7ea2f5ed069530f58df4e6d
@@ -13,7 +13,7 @@ export class DeleteFaceVerifyResultResponseBodyResultObject extends $dara.Model
   certifyId?: string;
   /**
    * @remarks
-   * Deletion result. Possible values are as follows:
+   * The deletion result. Valid values:
    * 
    * - Y: Deletion successful.
    * - N: Deletion failed.
@@ -24,10 +24,10 @@ export class DeleteFaceVerifyResultResponseBodyResultObject extends $dara.Model
   deleteResult?: string;
   /**
    * @remarks
-   * Reason for deletion failure
+   * The reason for deletion failure.
    * 
-   * - NOT_DELETE_REPEATEDLY: Cannot be deleted repeatedly
-   * - NEED_QUERY_VERIFY_RESULT: Need to query the verification result first, then delete
+   * - NOT_DELETE_REPEATEDLY: The data cannot be deleted repeatedly.
+   * - NEED_QUERY_VERIFY_RESULT: You must query the authentication result before deleting.
    * 
    * @example
    * NOT_DELETE_REPEATEDLY
@@ -61,7 +61,7 @@ export class DeleteFaceVerifyResultResponseBodyResultObject extends $dara.Model
 export class DeleteFaceVerifyResultResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Return code: 200 for success, others for failure.
+   * Return code. A value of 200 indicates success. Other values indicate failure.
    * 
    * @example
    * 200
@@ -77,7 +77,7 @@ export class DeleteFaceVerifyResultResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * ID of the request
+   * Id of the request
    * 
    * @example
    * 5A6229C0-E156-48E4-B6EC-0F528BDF60D2
@@ -85,7 +85,7 @@ export class DeleteFaceVerifyResultResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Returned result information.
+   * The returned result.
    */
   resultObject?: DeleteFaceVerifyResultResponseBodyResultObject;
   static names(): { [key: string]: string } {

package/src/models/DeleteSceneConfigRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteSceneConfigRequest extends $dara.Model {
   /**
    * @remarks
-   * ID of the intent authentication configuration.
+   * The ID of the ID Verification scenario configuration.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteSceneConfigResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteSceneConfigResponseBody extends $dara.Model {
   /**
    * @remarks
-   * ID of this request.
+   * The request ID.
    * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368

package/src/models/DeleteWhitelistSettingRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteWhitelistSettingRequest extends $dara.Model {
   /**
    * @remarks
-   * List of rule IDs to be deleted.
+   * The list of rule IDs to delete.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,9 @@ export class DeleteWhitelistSettingRequest extends $dara.Model {
   ids?: string;
   /**
    * @remarks
-   * Specify the language of the user information to be deleted. Values: -**zh**: Chinese. -**en**: English.
+   * The language of the user information to delete. Valid values:
+   * - **zh**: Chinese.
+   * - **en**: English.
    * 
    * @example
    * zh
@@ -23,7 +25,7 @@ export class DeleteWhitelistSettingRequest extends $dara.Model {
   lang?: string;
   /**
    * @remarks
-   * ServiceCode for the real-person cloud product, only takes the value: **antcloudauth**.
+   * The service code of the ID Verification product. Set the value to **antcloudauth**.
    * 
    * This parameter is required.
    * 
@@ -33,7 +35,7 @@ export class DeleteWhitelistSettingRequest extends $dara.Model {
   serviceCode?: string;
   /**
    * @remarks
-   * Set the source IP address of the visitor. Supports IP addresses in CIDR and IPv4 formats. Example: 10.0.3.0/24.
+   * The source IP address of the visitor. CIDR format and IPv4 format are supported. Example: 10.0.3.0/24.
    * 
    * @example
    * 120.25.41.25

package/src/models/DeleteWhitelistSettingResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteWhitelistSettingResponseBody extends $dara.Model {
   /**
    * @remarks
-   * ID of this request.
+   * The request ID.
    * 
    * @example
    * D6163397-15C5-419C-9ACC-B7C83E0B4C10
@@ -13,7 +13,7 @@ export class DeleteWhitelistSettingResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Return result.
+   * The returned result.
    * 
    * @example
    * true

package/src/models/DescribeAntAndCloudAuthUserStatusResponseBody.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAntAndCloudAuthUserStatusResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether financial-grade real-person authentication is activated. Values:
-   * - **true**: Activated
-   * - **false**: Not activated
+   * Indicates whether financial-grade ID Verification is activated. Valid values:
+   * - **true**: Activated.
+   * - **false**: Not activated.
    * 
    * @example
    * true
@@ -15,9 +15,9 @@ export class DescribeAntAndCloudAuthUserStatusResponseBody extends $dara.Model {
   antcloudauthEnabled?: boolean;
   /**
    * @remarks
-   * Indicates whether real-person authentication is activated. Values:
-   * - **true**: Activated
-   * - **false**: Not activated
+   * Indicates whether ID Verification is activated. Valid values:
+   * - **true**: Activated.
+   * - **false**: Not activated.
    * 
    * @example
    * false
@@ -25,9 +25,9 @@ export class DescribeAntAndCloudAuthUserStatusResponseBody extends $dara.Model {
   cloudauthEnabled?: boolean;
   /**
    * @remarks
-   * Indicates whether the enhanced version of real-person authentication is activated. Values:
-   * - **true**: Activated
-   * - **false**: Not activated
+   * Indicates whether enhanced ID Verification is activated. Valid values:
+   * - **true**: Activated.
+   * - **false**: Not activated.
    * 
    * @example
    * true
@@ -35,9 +35,9 @@ export class DescribeAntAndCloudAuthUserStatusResponseBody extends $dara.Model {
   cloudauthstEnabled?: boolean;
   /**
    * @remarks
-   * Indicates whether information verification is activated. Values:
-   * - **true**: Activated
-   * - **false**: Not activated
+   * Indicates whether information verification is activated. Valid values:
+   * - **true**: Activated.
+   * - **false**: Not activated.
    * 
    * @example
    * false
@@ -45,7 +45,7 @@ export class DescribeAntAndCloudAuthUserStatusResponseBody extends $dara.Model {
   inforverifyEnabled?: boolean;
   /**
    * @remarks
-   * The ID of this request.
+   * The ID of the request.
    * 
    * @example
    * 3FE07CCE-DF47-51C2-9D32-CD70ED62C91B

package/src/models/DescribeAuthVerifyRequest.ts

@@ -5,6 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAuthVerifyRequest extends $dara.Model {
   /**
    * @remarks
+   * The unique identifier for ID Verification.
+   * Obtain this value by calling InitAuthVerify to initiate an OCR request.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +16,8 @@ export class DescribeAuthVerifyRequest extends $dara.Model {
   certifyId?: string;
   /**
    * @remarks
+   * The authentication scenario ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeAuthVerifyResponseBody.ts

@@ -3,20 +3,92 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeAuthVerifyResponseBodyResult extends $dara.Model {
+  /**
+   * @remarks
+   * - Card information read by OCR (ocrIdCardInfo)
+   * - Card information photo edited by the client (ocrIdEditInfo)
+   * - OSS storage location and link of the OCR photo (ocrPictureFront).
+   * 
+   * @example
+   * "ocrIdCardInfo": {
+   *     "certName": "张先生",
+   *     "sex": "男",
+   *     "nationality": "汉",
+   *     "birth": "20010213",
+   *     "address": "XXX省XX市XXX区XX街道X号",
+   *     "certNo": "4****************X",
+   *     "authority": "XXX公安局XXX分局",
+   *     "startDate": "20250523",
+   *     "endDate": "20450523"
+   *   },
+   * "ocrIdEditInfo": {
+   *     "certName": "张先生",
+   *     "sex": "男",
+   *     "nationality": "汉",
+   *     "birth": "20010213",
+   *     "address": "XXX省XX市XXX区XX街道X号",
+   *     "certNo": "4****************X",
+   *     "authority": "XXX公安局XXX分局",
+   *     "startDate": "20250523",
+   *     "endDate": "20450523"
+   *   },
+   *   "ocrPictureFront": {
+   *     "ossBucketName": "cn-shanghai-aliyun-cloudauth-12********",
+   *     "ossIdFaceObjectName": "verify/1234567890/f7ed1ef80ad1234fdsd95c********cd_ocridface_b749.jpeg",
+   *     "ossIdFaceUrl": "http://cn-shanghai-aliyun-cloudauth-1234567890.oss-cn-shanghai.aliyuncs.com/verify/1234567890/f7ed1ef80ad1234fdsd95c66d83340cd_ocridface_b749.jpeg?security-token=CAISjdfgeJ1q6F...",
+   *     "ossIdNationalEmblemObjectName": "verify/1234567890/f7ed1ef80ad1234fdsd95c********cd_ocridnationalemblem_a3hf.jpeg",
+   *     "ossIdNationalEmblemUrl": "http://cn-shanghai-aliyun-cloudauth-1234567890.oss-cn-shanghai.aliyuncs.com/verify/1234567890/f7ed1ef80ad1234fdsd95c66d83340cd_ocridnationalemblem_a3hf.jpeg?security-token=CAISjgJ1q6..."
+   *   }
+   */
   materialInfo?: string;
   /**
+   * @remarks
+   * The anti-spoofing detection result for the back side of the document, including the risk determination result and risk type:
+   * > - 
+   * Card front anti-spoofing detection is enabled only when IdSpoof = Y is set in the Initialize operation. Otherwise, spoofRiskResult returns N by default, and spoofType is empty.
+   * 
+   * spoofRiskResult:
+   * - Y: Risk detected.
+   *  - N: No risk detected.
+   * 
+   * spoofType:
+   * - SCREEN_REMARK: Recaptured photo.
+   * - PHOTO_COPY: Photocopy.
+   * - TAMPER: Digitally tampered.
+   * 
+   * > - This is an algorithm prediction result. This field may not be returned. Avoid setting a mandatory dependency on this field in your business logic.
+   * 
    * @example
    * spoofRiskResult：Y
    * spoofType：SCREEN_REMARK
    */
   spoofBackInfo?: string;
   /**
+   * @remarks
+   * The anti-spoofing detection result for the front side of the document, including the risk determination result and risk type:
+   * > - 
+   * Card front anti-spoofing detection is enabled only when IdSpoof = Y is set in the Initialize operation. Otherwise, spoofRiskResult returns N by default, and spoofType is empty.
+   * 
+   * spoofRiskResult:
+   * - Y: Risk detected.
+   *  - N: No risk detected.
+   * 
+   * spoofType:
+   * - SCREEN_REMARK: Recaptured photo.
+   * - PHOTO_COPY: Photocopy.
+   * - TAMPER: Digitally tampered.
+   * 
+   * > - This is an algorithm prediction result. This field may not be returned. Avoid setting a mandatory dependency on this field in your business logic.
+   * 
    * @example
    * spoofRiskResult：Y
    * spoofType：SCREEN_REMARK
    */
   spoofInfo?: string;
   /**
+   * @remarks
+   * The result description.
+   * 
    * @example
    * 200
    */
@@ -50,20 +122,33 @@ export class DescribeAuthVerifyResponseBodyResult extends $dara.Model {
 
 export class DescribeAuthVerifyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The return code.
+   * 
    * @example
    * Success
    */
   code?: string;
   /**
+   * @remarks
+   * The return message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The result.
+   */
   result?: DescribeAuthVerifyResponseBodyResult;
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeCardVerifyRequest.ts

@@ -5,8 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCardVerifyRequest extends $dara.Model {
   /**
    * @remarks
-   * Authentication request ID.
-   * You must first call the initialization interface InitCardVerify to submit an authentication request in order to get the authentication request ID.
+   * The verification request ID.
+   * You must first call the InitCardVerify operation to submit a verification request before you can obtain the verification request ID.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeCardVerifyResponseBody.ts

@@ -5,10 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCardVerifyResponseBodyResultObject extends $dara.Model {
   /**
    * @remarks
-   * Identity verification result:
-   * - 1: Consistent
-   * - 2: Inconsistent
-   * - 3: No Record Found
+   * The identity verification result. Valid values:
+   * - 1: consistent
+   * - 2: inconsistent
+   * - 3: no record found.
    * 
    * @example
    * 1
@@ -16,7 +16,7 @@ export class DescribeCardVerifyResponseBodyResultObject extends $dara.Model {
   bizCode?: string;
   /**
    * @remarks
-   * Submitted ID card information for verification.
+   * The ID card information submitted for verification.
    * 
    * @example
    * {"address":"浙江省杭州市余杭区文一西路969号","birthDate":"19901226","certName":"张三","certNo":"1234561990122*****","nationality":"汉","authority":"xxx公安局","startDate":"20201130","endDate":"20301130"}
@@ -24,7 +24,7 @@ export class DescribeCardVerifyResponseBodyResultObject extends $dara.Model {
   cardInfo?: string;
   /**
    * @remarks
-   * Image comparison score.
+   * The image comparison score.
    * 
    * @example
    * {
@@ -34,7 +34,7 @@ export class DescribeCardVerifyResponseBodyResultObject extends $dara.Model {
   faceDetail?: string;
   /**
    * @remarks
-   * ID card information read by OCR.
+   * The ID card information read by OCR.
    * 
    * @example
    * {"address":"浙江省杭州市余杭区文一西路969号","birthDate":"19901226","certName":"张三","certNo":"1234561990122*****","nationality":"汉","authority":"xxx公安局","startDate":"20201130","endDate":"20301130"}
@@ -42,9 +42,9 @@ export class DescribeCardVerifyResponseBodyResultObject extends $dara.Model {
   ocrCardInfo?: string;
   /**
    * @remarks
-   * Returned photo URLs.
-   * - certUrl  Front side
-   * - certNationalUrl  National emblem side
+   * The returned photo URLs.
+   * - certUrl: front side
+   * - certNationalUrl: national emblem side.
    * 
    * @example
    * {
@@ -85,10 +85,10 @@ export class DescribeCardVerifyResponseBodyResultObject extends $dara.Model {
 export class DescribeCardVerifyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Return code: 200 indicates success, all others indicate failure.
-   * Important
-   * - This parameter indicates whether the interface was called correctly. For detailed return code explanations, please refer to the error codes.
-   * - Please check the business verification results through the fields in ResultObject.
+   * The response code. 200 indicates success. Other values indicate failure.
+   * > **Important**
+   * > - This parameter indicates whether the operation is called correctly. For more information about return codes, refer to error codes.
+   * > - Check the business verification result by viewing the fields in ResultObject.
    * 
    * @example
    * 200
@@ -96,9 +96,9 @@ export class DescribeCardVerifyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Interface call return message.
-   * Important
-   * - This parameter only indicates whether there was an exception with the interface.
+   * The response message of the operation.
+   * > **Important**
+   * > - This parameter only indicates whether the operation is abnormal.
    * 
    * @example
    * success
@@ -106,7 +106,7 @@ export class DescribeCardVerifyResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 130A2C10-B9EE-4D84-88E3-5384FF03****
@@ -114,7 +114,7 @@ export class DescribeCardVerifyResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Result object.
+   * The result object.
    */
   resultObject?: DescribeCardVerifyResponseBodyResultObject;
   static names(): { [key: string]: string } {

package/src/models/DescribeCloudauthstSceneListRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCloudauthstSceneListRequest extends $dara.Model {
   /**
    * @remarks
-   * Product Code
+   * The commodity code.
    * 
    * @example
    * SMART_CARD

package/src/models/DescribeCloudauthstSceneListResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCloudauthstSceneListResponseBodyItems extends $dara.Model {
   /**
    * @remarks
-   * Creation time.
+   * The creation time.
    * 
    * @example
    * 2023-01-04 19:56:04
@@ -13,7 +13,7 @@ export class DescribeCloudauthstSceneListResponseBodyItems extends $dara.Model {
   gmtCreate?: string;
   /**
    * @remarks
-   * Modification time.
+   * The modification time.
    * 
    * @example
    * 2023-01-04 19:56:04
@@ -21,7 +21,7 @@ export class DescribeCloudauthstSceneListResponseBodyItems extends $dara.Model {
   gmtModified?: string;
   /**
    * @remarks
-   * Cloud marketplace product code.
+   * The Alibaba Cloud Marketplace commodity code.
    * 
    * @example
    * SMART_VERIFY
@@ -29,7 +29,7 @@ export class DescribeCloudauthstSceneListResponseBodyItems extends $dara.Model {
   productCode?: string;
   /**
    * @remarks
-   * Product name
+   * The product name.
    * 
    * @example
    * -
@@ -37,7 +37,7 @@ export class DescribeCloudauthstSceneListResponseBodyItems extends $dara.Model {
   productName?: string;
   /**
    * @remarks
-   * Scene ID.
+   * The scenario ID.
    * 
    * @example
    * 20**40
@@ -45,7 +45,7 @@ export class DescribeCloudauthstSceneListResponseBodyItems extends $dara.Model {
   sceneId?: string;
   /**
    * @remarks
-   * Scene name.
+   * The scenario name.
    * 
    * @example
    * 测试场景
@@ -53,9 +53,9 @@ export class DescribeCloudauthstSceneListResponseBodyItems extends $dara.Model {
   sceneName?: string;
   /**
    * @remarks
-   * Whether to deliver the files generated by the authentication to the customer\\"s OSS:
-   * - **Y**: Enabled
-   * - **N**: Disabled
+   * Specifies whether to deliver files generated during authentication to the customer\\"s OSS. Valid values:
+   * - **Y**: Enabled.
+   * - **N**: Disabled.
    * 
    * @example
    * N
@@ -97,12 +97,12 @@ export class DescribeCloudauthstSceneListResponseBodyItems extends $dara.Model {
 export class DescribeCloudauthstSceneListResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Scene list
+   * The list of scenarios.
    */
   items?: DescribeCloudauthstSceneListResponseBodyItems[];
   /**
    * @remarks
-   * The ID of this request.
+   * The ID of the request.
    * 
    * @example
    * CEC88747-2F3E-539E-91A6-84E321CAA12B