@alicloud/cloudauth20190307 3.13.4 → 3.14.0

package/src/models/AigcfaceVerifyRequest.ts

@@ -42,7 +42,7 @@ export class AIGCFaceVerifyRequest extends $dara.Model {
   ossObjectName?: string;
   /**
    * @remarks
-   * The custom business unique identifier on the client side, used for subsequent troubleshooting. The value can contain up to 32 characters, including letters and digits. Make sure the value is unique.
+   * The custom business unique identifier on the client side, which is used for subsequent troubleshooting. The value can contain up to 32 characters, including letters and digits. Make sure the value is unique.
    * 
    * @example
    * e0c34a77f5ac40a5aa5e6ed20c353888
@@ -50,7 +50,7 @@ export class AIGCFaceVerifyRequest extends $dara.Model {
   outerOrderNo?: string;
   /**
    * @remarks
-   * The product plan.
+   * The product solution.
    * 
    * @example
    * LR_FR_AIGC

package/src/models/AigcfaceVerifyResponseBody.ts

@@ -7,7 +7,7 @@ import * as $dara from '@darabonba/typescript';
 export class AIGCFaceVerifyResponseBodyResultObject extends $dara.Model {
   /**
    * @remarks
-   * The unique identifier for ID Verification.
+   * The unique identifier of the ID Verification.
    * 
    * @example
    * 91707dc296d469ad38e4c5efa6a0****
@@ -17,7 +17,7 @@ export class AIGCFaceVerifyResponseBodyResultObject extends $dara.Model {
    * @remarks
    * The detection result. Valid values:
    * 
-   * ●  Y: The face is generated by AIGC.
+   * ●  Y: The face is AIGC-generated.
    * 
    * ●  N: No AIGC-generated face is detected.
    * 
@@ -69,7 +69,7 @@ export class AIGCFaceVerifyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response message.
+   * The message.
    * 
    * @example
    * success

package/src/models/CreateAntCloudAuthSceneRequest.ts

@@ -6,8 +6,8 @@ export class CreateAntCloudAuthSceneRequest extends $dara.Model {
   /**
    * @remarks
    * Specifies whether to enable mini program binding. Valid values:
-   * - **Y**: enabled
-   * - **N (default)**: disabled.
+   * - **Y**: Enabled.
+   * - **N (default)**: Disabled.
    * 
    * @example
    * Y
@@ -26,14 +26,38 @@ export class CreateAntCloudAuthSceneRequest extends $dara.Model {
    * The name of the uploaded verification file.
    * 
    * @example
-   * 测试.txt
+   * test.txt
    */
   checkFileName?: string;
+  /**
+   * @remarks
+   * The iOS app scheme for degradation redirect.
+   * 
+   * @example
+   * cloudauth://callback
+   */
+  degradeAppScheme?: string;
+  /**
+   * @remarks
+   * The SubCode that triggers degradation.
+   * 
+   * @example
+   * 201,202
+   */
+  degradeSubCodes?: string;
+  /**
+   * @remarks
+   * The degradation verification type.
+   * 
+   * @example
+   * ALIPAY
+   */
+  degradeType?: string;
   /**
    * @remarks
    * Specifies whether to enable enhanced device risk detection. Valid values:
-   * - **Y**: enabled
-   * - **N**: disabled.
+   * - **Y**: Enabled.
+   * - **N**: Disabled.
    * 
    * @example
    * N
@@ -44,14 +68,14 @@ export class CreateAntCloudAuthSceneRequest extends $dara.Model {
    * The mini program name.
    * 
    * @example
-   * 测试APP
+   * TestApp
    */
   miniProgramName?: string;
   /**
    * @remarks
    * The mini program platform to bind. Valid values:
-   * - **WECHAT**: WeChat
-   * - **ALIPAY**: Alipay
+   * - **WECHAT**: WeChat.
+   * - **ALIPAY**: Alipay.
    * - **TIKTOK**: TikTok.
    * 
    * @example
@@ -81,12 +105,12 @@ export class CreateAntCloudAuthSceneRequest extends $dara.Model {
    * This parameter is required.
    * 
    * @example
-   * 测试场景
+   * TestScenario
    */
   sceneName?: string;
   /**
    * @remarks
-   * Specifies whether to deliver the files generated during authentication to the customer\\"s OSS. Valid values:
+   * Specifies whether to deliver files generated during verification to the customer\\"s OSS. Valid values:
    * - **Y**: Yes.
    * - **N**: No.
    * 
@@ -94,11 +118,22 @@ export class CreateAntCloudAuthSceneRequest extends $dara.Model {
    * Y
    */
   storeImage?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable degradation.
+   * 
+   * @example
+   * Y
+   */
+  useDegrade?: string;
   static names(): { [key: string]: string } {
     return {
       bindMiniProgram: 'BindMiniProgram',
       checkFileBody: 'CheckFileBody',
       checkFileName: 'CheckFileName',
+      degradeAppScheme: 'DegradeAppScheme',
+      degradeSubCodes: 'DegradeSubCodes',
+      degradeType: 'DegradeType',
       deviceRiskPlus: 'DeviceRiskPlus',
       miniProgramName: 'MiniProgramName',
       platform: 'Platform',
@@ -106,6 +141,7 @@ export class CreateAntCloudAuthSceneRequest extends $dara.Model {
       returnVideoLength: 'ReturnVideoLength',
       sceneName: 'SceneName',
       storeImage: 'StoreImage',
+      useDegrade: 'UseDegrade',
     };
   }
 
@@ -114,6 +150,9 @@ export class CreateAntCloudAuthSceneRequest extends $dara.Model {
       bindMiniProgram: 'string',
       checkFileBody: 'string',
       checkFileName: 'string',
+      degradeAppScheme: 'string',
+      degradeSubCodes: 'string',
+      degradeType: 'string',
       deviceRiskPlus: 'string',
       miniProgramName: 'string',
       platform: 'string',
@@ -121,6 +160,7 @@ export class CreateAntCloudAuthSceneRequest extends $dara.Model {
       returnVideoLength: 'number',
       sceneName: 'string',
       storeImage: 'string',
+      useDegrade: 'string',
     };
   }
 

package/src/models/CreateWhitelistSettingRequest.ts

@@ -32,7 +32,7 @@ export class CreateWhitelistSettingRequest extends $dara.Model {
    * The remarks for the whitelist.
    * 
    * @example
-   * 测试白名单。
+   * Test whitelist
    */
   remark?: string;
   /**
@@ -74,6 +74,9 @@ export class CreateWhitelistSettingRequest extends $dara.Model {
    */
   validDay?: number;
   /**
+   * @remarks
+   * The whitelist type.
+   * 
    * @example
    * SUPER
    */

package/src/models/CreateWhitelistSettingResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateWhitelistSettingResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The ID of this request.
    * 
    * @example
    * CF4979D3-060F-5336-BD9F-0D46ECB66B22

package/src/models/DescribeFaceVerifyRequest.ts

@@ -21,7 +21,7 @@ export class DescribeFaceVerifyRequest extends $dara.Model {
   pictureReturnType?: string;
   /**
    * @remarks
-   * The ID of the verification scenario.
+   * The verification scenario ID.
    * 
    * @example
    * 1000000006

package/src/models/DescribeFaceVerifyResponseBody.ts

@@ -3,6 +3,14 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeFaceVerifyResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * The result of degraded verification.
+   * 
+   * @example
+   * {\\"certifyId\\":\\"ab110b7bbfea6631b37bc472797ac923\\",\\"degradeType\\":\\"ALIPAY\\",\\"passed\\":\\"T\\"}
+   */
+  degradeInfo?: string;
   /**
    * @remarks
    * The device risk label.
@@ -21,7 +29,7 @@ export class DescribeFaceVerifyResponseBodyResultObject extends $dara.Model {
   deviceToken?: string;
   /**
    * @remarks
-   * The identity information of the verification subject. This field is empty in common verification scenarios.
+   * The identity information of the verification subject. This field is empty for common verification scenarios.
    * 
    * @example
    * null
@@ -61,13 +69,13 @@ export class DescribeFaceVerifyResponseBodyResultObject extends $dara.Model {
   success?: string;
   /**
    * @remarks
-   * The identity information and corresponding encoding entered by the user in rare character mode. The value is a JSON-formatted string. An empty string is returned if the name does not contain rare characters.
+   * Records the identity information and corresponding encoding entered by the user in rare character mode. The return data is a JSON-formatted string. An empty string is returned if the name does not contain rare characters.
    * 
    * - name: the name entered by the user.
    * 
-   * - verifyName: the final name encoding that passed verification. For example, if a rare character is verified through transcoding: "王先生", the actual verified name is "王先升".
+   * - verifyName: the final name encoding that passed verification. For example, if a rare character is verified through transcoding: "Wang Xiansheng", the actual verified name is "Wang Xiansheng" (with a different character).
    * 
-   * - number: the ID number entered by the user.
+   * - number: the ID card number entered by the user.
    * 
    * @example
    * {
@@ -79,6 +87,7 @@ export class DescribeFaceVerifyResponseBodyResultObject extends $dara.Model {
   userInfo?: string;
   static names(): { [key: string]: string } {
     return {
+      degradeInfo: 'DegradeInfo',
       deviceRisk: 'DeviceRisk',
       deviceToken: 'DeviceToken',
       identityInfo: 'IdentityInfo',
@@ -92,6 +101,7 @@ export class DescribeFaceVerifyResponseBodyResultObject extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      degradeInfo: 'string',
       deviceRisk: 'string',
       deviceToken: 'string',
       identityInfo: 'string',
@@ -139,7 +149,7 @@ export class DescribeFaceVerifyResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The returned result information.
+   * The result information.
    */
   resultObject?: DescribeFaceVerifyResponseBodyResultObject;
   static names(): { [key: string]: string } {

package/src/models/DescribeInfoCheckExportRecordRequest.ts

@@ -13,7 +13,7 @@ export class DescribeInfoCheckExportRecordRequest extends $dara.Model {
   currentPage?: number;
   /**
    * @remarks
-   * The end time of the query.
+   * The query end time. Format: YYYY-MM-DD HH:mm:ss, for example, 2025-10-11 21:24:48.
    * 
    * @example
    * 2025-10-11 21:24:48
@@ -32,18 +32,18 @@ export class DescribeInfoCheckExportRecordRequest extends $dara.Model {
    * The product type. Valid values:
    * - **ID_CARD_2_META**: ID card two-element verification.
    * - **ID_PERIOD**: ID card validity period verification.
-   * - **MOBILE_ONLINE_LENGTH**: mobile number online duration.
-   * - **MOBILE_ONLINE_STATUS**: mobile number online status.
-   * - **MOBILE_3_META_SIMPLE**: mobile number three-element verification (simple edition).
-   * - **MOBILE_3_META**: mobile number three-element verification (detailed edition).
-   * - **MOBILE_2_META**: mobile number two-element verification.
-   * - **BANK_CARD_N_META**: bank card verification (detailed edition).
-   * - **MOBILE_DETECT**: phone number detection.
-   * - **VEHICLE_N_META**: vehicle element verification (enhanced edition).
-   * - **VEHICLE_PENTA_INFO**: vehicle five-element information recognition.
-   * - **VEHICLE_LICENSE_INFO**: vehicle information recognition.
-   * - **VEHICLE_INSURE_DATE**: vehicle insurance date query.
-   * - **VEHICLE_CHECK**: vehicle element verification.
+   * - **MOBILE_ONLINE_LENGTH**: Mobile number online duration.
+   * - **MOBILE_ONLINE_STATUS**: Mobile number online status.
+   * - **MOBILE_3_META_SIMPLE**: Mobile number three-element verification (simple edition).
+   * - **MOBILE_3_META**: Mobile number three-element verification (detailed edition).
+   * - **MOBILE_2_META**: Mobile number two-element verification.
+   * - **BANK_CARD_N_META**: Bank card verification (detailed edition).
+   * - **MOBILE_DETECT**: Number detection.
+   * - **VEHICLE_N_META**: Vehicle element verification (enhanced edition).
+   * - **VEHICLE_PENTA_INFO**: Vehicle five-element information recognition.
+   * - **VEHICLE_LICENSE_INFO**: Vehicle information recognition.
+   * - **VEHICLE_INSURE_DATE**: Vehicle insurance date query.
+   * - **VEHICLE_CHECK**: Vehicle element verification.
    * 
    * @example
    * ID_CARD_2_META
@@ -51,7 +51,7 @@ export class DescribeInfoCheckExportRecordRequest extends $dara.Model {
   productType?: string;
   /**
    * @remarks
-   * The start time of the query.
+   * The query start time. Format: YYYY-MM-DD HH:mm:ss, for example, 2025-10-11 21:24:48.
    * 
    * @example
    * 2025-10-11 21:24:48

package/src/models/DescribeInfoCheckExportRecordResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeInfoCheckExportRecordResponseBodyItems extends $dara.Model {
   /**
    * @remarks
-   * The download date.
+   * The download time. The value is a UNIX timestamp in milliseconds (ms), for example, 1758250979000.
    * 
    * @example
    * 1758250979000
@@ -48,29 +48,29 @@ export class DescribeInfoCheckExportRecordResponseBodyItems extends $dara.Model
    * The product type name. Valid values:
    * - **ID_CARD_2_META**: ID card two-element verification.
    * - **ID_PERIOD**: ID card validity period verification.
-   * - **MOBILE_ONLINE_LENGTH**: mobile number online duration.
-   * - **MOBILE_ONLINE_STATUS**: mobile number online status.
-   * - **MOBILE_3_META_SIMPLE**: mobile number three-element verification (simple edition).
-   * - **MOBILE_3_META**: mobile number three-element verification (detailed edition).
-   * - **MOBILE_2_META**: mobile number two-element verification.
-   * - **BANK_CARD_N_META**: bank card verification (detailed edition).
-   * - **MOBILE_DETECT**: phone number detection.
-   * - **VEHICLE_N_META**: vehicle element verification (enhanced edition).
-   * - **VEHICLE_PENTA_INFO**: vehicle five-element information recognition.
-   * - **VEHICLE_LICENSE_INFO**: vehicle information recognition.
-   * - **VEHICLE_INSURE_DATE**: vehicle insurance date query.
-   * - **VEHICLE_CHECK**: vehicle element verification.
-   * 
-   * @example
-   * 身份证二要素
+   * - **MOBILE_ONLINE_LENGTH**: Mobile number online duration.
+   * - **MOBILE_ONLINE_STATUS**: Mobile number online status.
+   * - **MOBILE_3_META_SIMPLE**: Mobile number three-element verification (simple edition).
+   * - **MOBILE_3_META**: Mobile number three-element verification (detailed edition).
+   * - **MOBILE_2_META**: Mobile number two-element verification.
+   * - **BANK_CARD_N_META**: Bank card verification (detailed edition).
+   * - **MOBILE_DETECT**: Number detection.
+   * - **VEHICLE_N_META**: Vehicle element verification (enhanced edition).
+   * - **VEHICLE_PENTA_INFO**: Vehicle five-element information recognition.
+   * - **VEHICLE_LICENSE_INFO**: Vehicle information recognition.
+   * - **VEHICLE_INSURE_DATE**: Vehicle insurance date query.
+   * - **VEHICLE_CHECK**: Vehicle element verification.
+   * 
+   * @example
+   * ID_CARD_2_META
    */
   productType?: string;
   /**
    * @remarks
    * The task status. Valid values:
-   * - **1**: The file is being generated.
-   * - **2**: The file has been generated.
-   * - **3**: The file failed to be generated.
+   * - **1**: File is being generated.
+   * - **2**: File generation is complete.
+   * - **3**: File generation failed.
    * 
    * @example
    * 1
@@ -138,12 +138,12 @@ export class DescribeInfoCheckExportRecordResponseBody extends $dara.Model {
   currentPage?: number;
   /**
    * @remarks
-   * The list of results.
+   * The result list.
    */
   items?: DescribeInfoCheckExportRecordResponseBodyItems[];
   /**
    * @remarks
-   * The error code.
+   * The error message.
    * 
    * @example
    * success
@@ -167,7 +167,7 @@ export class DescribeInfoCheckExportRecordResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the response is successful.
    * 
    * @example
    * true

package/src/models/DescribeListAntCloudAuthScenesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeListAntCloudAuthScenesRequest extends $dara.Model {
   /**
    * @remarks
-   * The scene ID.
+   * The scenario ID.
    * 
    * @example
    * 100000xxxx

package/src/models/DescribeListAntCloudAuthScenesResponseBody.ts

@@ -23,10 +23,10 @@ export class DescribeListAntCloudAuthScenesResponseBodyScenes extends $dara.Mode
   bindMiniProgram?: string;
   /**
    * @remarks
-   * The creation time.
+   * The creation time. The value is a UNIX timestamp in milliseconds (ms), such as 1740389697000.
    * 
    * @example
-   * 1260051251634779
+   * 1740389697000
    */
   createTime?: string;
   /**
@@ -37,6 +37,30 @@ export class DescribeListAntCloudAuthScenesResponseBodyScenes extends $dara.Mode
    * 189884094677xxxx
    */
   creator?: string;
+  /**
+   * @remarks
+   * The iOS scheme for degradation.
+   * 
+   * @example
+   * cloudauth://callback
+   */
+  degradeAppScheme?: string;
+  /**
+   * @remarks
+   * The list of SubCodes that trigger degradation.
+   * 
+   * @example
+   * 201,202
+   */
+  degradeSubCodes?: string;
+  /**
+   * @remarks
+   * The degraded authentication type.
+   * 
+   * @example
+   * ALIPAY
+   */
+  degradeType?: string;
   /**
    * @remarks
    * Specifies whether to enable enhanced device risk detection. Valid values:
@@ -60,7 +84,7 @@ export class DescribeListAntCloudAuthScenesResponseBodyScenes extends $dara.Mode
    * The mini program name.
    * 
    * @example
-   * 测试APP
+   * TestApp
    */
   miniProgramName?: string;
   /**
@@ -74,8 +98,8 @@ export class DescribeListAntCloudAuthScenesResponseBodyScenes extends $dara.Mode
   /**
    * @remarks
    * The mini program platform. Valid values:
-   * - **WECHAT**: WeChat
-   * - **ALIPAY**: Alipay
+   * - **WECHAT**: WeChat.
+   * - **ALIPAY**: Alipay.
    * - **TIKTOK**: TikTok.
    * 
    * @example
@@ -84,7 +108,7 @@ export class DescribeListAntCloudAuthScenesResponseBodyScenes extends $dara.Mode
   platform?: string;
   /**
    * @remarks
-   * The number of evidence face photos (1 to 5).
+   * The number of evidence face photos (1-5).
    * 
    * @example
    * 1
@@ -92,7 +116,7 @@ export class DescribeListAntCloudAuthScenesResponseBodyScenes extends $dara.Mode
   returnPicCount?: number;
   /**
    * @remarks
-   * The duration of the evidence video, in seconds.
+   * The evidence video duration in seconds.
    * 
    * @example
    * 1
@@ -100,7 +124,7 @@ export class DescribeListAntCloudAuthScenesResponseBodyScenes extends $dara.Mode
   returnVideoLength?: number;
   /**
    * @remarks
-   * The scene ID.
+   * The scenario ID.
    * 
    * @example
    * 100001xxxx
@@ -108,15 +132,15 @@ export class DescribeListAntCloudAuthScenesResponseBodyScenes extends $dara.Mode
   sceneId?: number;
   /**
    * @remarks
-   * The scene name.
+   * The scenario name.
    * 
    * @example
-   * 测试场景
+   * TestScenario
    */
   sceneName?: string;
   /**
    * @remarks
-   * Indicates whether the scene is enabled. The value 1 indicates enabled.
+   * Indicates whether the scenario is enabled. The value is 1.
    * 
    * @example
    * 1
@@ -134,18 +158,29 @@ export class DescribeListAntCloudAuthScenesResponseBodyScenes extends $dara.Mode
   storeImage?: string;
   /**
    * @remarks
-   * The time when the instance was last updated.
+   * The last update time of the instance. The value is a UNIX timestamp in milliseconds (ms), such as 1740541510000.
    * 
    * @example
-   * 1260051251634779
+   * 1740541510000
    */
   updateTime?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable degraded authentication.
+   * 
+   * @example
+   * Y
+   */
+  useDegrade?: string;
   static names(): { [key: string]: string } {
     return {
       appId: 'AppId',
       bindMiniProgram: 'BindMiniProgram',
       createTime: 'CreateTime',
       creator: 'Creator',
+      degradeAppScheme: 'DegradeAppScheme',
+      degradeSubCodes: 'DegradeSubCodes',
+      degradeType: 'DegradeType',
       deviceRiskPlus: 'DeviceRiskPlus',
       domain: 'Domain',
       miniProgramName: 'MiniProgramName',
@@ -158,6 +193,7 @@ export class DescribeListAntCloudAuthScenesResponseBodyScenes extends $dara.Mode
       status: 'Status',
       storeImage: 'StoreImage',
       updateTime: 'UpdateTime',
+      useDegrade: 'UseDegrade',
     };
   }
 
@@ -167,6 +203,9 @@ export class DescribeListAntCloudAuthScenesResponseBodyScenes extends $dara.Mode
       bindMiniProgram: 'string',
       createTime: 'string',
       creator: 'string',
+      degradeAppScheme: 'string',
+      degradeSubCodes: 'string',
+      degradeType: 'string',
       deviceRiskPlus: 'string',
       domain: 'string',
       miniProgramName: 'string',
@@ -179,6 +218,7 @@ export class DescribeListAntCloudAuthScenesResponseBodyScenes extends $dara.Mode
       status: 'number',
       storeImage: 'string',
       updateTime: 'string',
+      useDegrade: 'string',
     };
   }
 
@@ -194,7 +234,7 @@ export class DescribeListAntCloudAuthScenesResponseBodyScenes extends $dara.Mode
 export class DescribeListAntCloudAuthScenesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * CC1AB3F5-22A2-589F-ABDD-B766694AA671
@@ -202,7 +242,7 @@ export class DescribeListAntCloudAuthScenesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The list of scenes.
+   * The list of scenarios.
    */
   scenes?: DescribeListAntCloudAuthScenesResponseBodyScenes[];
   static names(): { [key: string]: string } {

package/src/models/DescribeListFaceVerifyInfosRequest.ts

@@ -54,6 +54,7 @@ export class DescribeListFaceVerifyInfosRequest extends $dara.Model {
   /**
    * @remarks
    * The authentication status. Valid values:
+   * 
    * - **1**: Authentication passed.
    * - **2**: Authentication failed.
    * 

package/src/models/DescribeListFaceVerifyInfosResponseBody.ts

@@ -37,10 +37,10 @@ export class DescribeListFaceVerifyInfosResponseBodyFaceVerifyInfos extends $dar
   certifyId?: string;
   /**
    * @remarks
-   * The creation time of the facial recognition record.
+   * The creation time of the facial recognition record. The value is a UNIX timestamp in milliseconds (ms), such as 1740389697000.
    * 
    * @example
-   * 2022-10-02T11:16:06Z
+   * 1740389697000
    */
   createTime?: string;
   /**
@@ -54,6 +54,7 @@ export class DescribeListFaceVerifyInfosResponseBodyFaceVerifyInfos extends $dar
   /**
    * @remarks
    * The authentication status. Valid values:
+   * 
    * - **1**: Authentication passed.
    * - **2**: Authentication failed.
    *