@alicloud/cloudauth20190307 3.9.5 → 3.11.0

package/src/models/DescribeVerifyResultResponseBody.ts

@@ -3,36 +3,84 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeVerifyResultResponseBodyMaterialIdCardInfo extends $dara.Model {
+  /**
+   * @remarks
+   * Address.
+   * 
+   * @example
+   * 浙江省杭州市余杭区文一西路969号
+   */
   address?: string;
+  /**
+   * @remarks
+   * Issuing authority.
+   * 
+   * @example
+   * 杭州市公安局
+   */
   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.
+   * 
    * @example
    * http://image-demo.img-cn-hangzhou.aliyuncs.com/example3.jpg
    */
   backImageUrl?: string;
   /**
+   * @remarks
+   * Date of birth.
+   * 
    * @example
    * 19900101
    */
   birth?: string;
   /**
+   * @remarks
+   * The end date of the document\\"s validity period. Format: yyyymmdd.
+   * 
    * @example
    * 20201101
    */
   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.
+   * 
    * @example
    * http://image-demo.img-cn-hangzhou.aliyuncs.com/example2.jpg
    */
   frontImageUrl?: string;
+  /**
+   * @remarks
+   * Name.
+   * 
+   * @example
+   * 张三
+   */
   name?: string;
+  /**
+   * @remarks
+   * Nationality.
+   * 
+   * @example
+   * 汉
+   */
   nationality?: string;
   /**
+   * @remarks
+   * ID card number.
+   * 
    * @example
    * 02343218901123****
    */
   number?: string;
   /**
+   * @remarks
+   * Start date of the document\\"s validity. Format: yyyymmdd.
+   * 
    * @example
    * 20201101
    */
@@ -78,32 +126,72 @@ export class DescribeVerifyResultResponseBodyMaterialIdCardInfo extends $dara.Mo
 
 export class DescribeVerifyResultResponseBodyMaterial extends $dara.Model {
   /**
+   * @remarks
+   * The global camera image captured by the real-person authentication 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.
+   * 
    * @example
    * http://image-demo.img-cn-hangzhou.aliyuncs.com/face-global-example.jpg
    */
   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.
+   * 
    * @example
    * http://image-demo.img-cn-hangzhou.aliyuncs.com/face-image-example.jpg
    */
   faceImageUrl?: string;
   /**
+   * @remarks
+   * Whether the face is wearing a mask. Values:
+   * - **true**: Wearing a mask
+   * - **false**: Not wearing a mask
+   * 
    * @example
    * false
    */
   faceMask?: boolean;
   /**
+   * @remarks
+   * The quality of the frontal face image. Values:
+   * - **UNQUALIFIED**: Poor quality
+   * - **LOW**: Low
+   * - **NORMAL**: Normal
+   * - **HIGH**: High
+   * 
    * @example
    * NORMAL
    */
   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.
+   */
   idCardInfo?: DescribeVerifyResultResponseBodyMaterialIdCardInfo;
+  /**
+   * @remarks
+   * Name.
+   * 
+   * @example
+   * 张三
+   */
   idCardName?: string;
   /**
+   * @remarks
+   * ID number.
+   * 
    * @example
    * 02343218901123****
    */
   idCardNumber?: string;
+  /**
+   * @remarks
+   * The URL addresses of the recorded videos returned by the historical RPH5BioOnly solution.
+   */
   videoUrls?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -148,27 +236,64 @@ 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.
+   * 
    * @example
    * 97
    */
   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**.
+   * 
+   * 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.
+   * 
    * @example
    * 97
    */
   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**.
+   * 
+   * 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.
+   * 
    * @example
    * 97
    */
   idCardFaceComparisonScore?: number;
+  /**
+   * @remarks
+   * Authentication materials.
+   */
   material?: DescribeVerifyResultResponseBodyMaterial;
   /**
+   * @remarks
+   * The ID of this request.
+   * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368
    */
   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.
+   * 
    * @example
    * 1
    */

package/src/models/DescribeVerifySdkrequest.ts

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

package/src/models/DescribeVerifySdkresponseBody.ts

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

package/src/models/DescribeVerifySearchPageListRequest.ts

@@ -0,0 +1,200 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeVerifySearchPageListRequest extends $dara.Model {
+  /**
+   * @remarks
+   * ID number.
+   * 
+   * @example
+   * 3203212000XXXX701X
+   */
+  certNo?: string;
+  /**
+   * @remarks
+   * Authentication ID.
+   * 
+   * @example
+   * shadbdd3dbacd001cfa892a5e2b98dxx
+   */
+  certifyId?: string;
+  /**
+   * @remarks
+   * Current page number.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 3
+   */
+  currentPage?: string;
+  /**
+   * @remarks
+   * End date of the query. The format is a Unix timestamp, in milliseconds.
+   * 
+   * @example
+   * 2025-10-16 23:59:59 +0800
+   */
+  endDate?: string;
+  /**
+   * @remarks
+   * Whether there is device risk (pass true if root = 1 or simulator = 1 or virtual_video = 1).
+   * 
+   * @example
+   * true
+   */
+  hasDeviceRisk?: boolean;
+  /**
+   * @remarks
+   * Liveness detection model.
+   * 
+   * @example
+   * LIVENESS
+   */
+  model?: string;
+  /**
+   * @remarks
+   * Unique identifier for the customer request.
+   * 
+   * @example
+   * e0c34a77f5ac40a5aa5e6ed20c353888
+   */
+  outerOrderNo?: string;
+  /**
+   * @remarks
+   * Number of items per page.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 20
+   */
+  pageSize?: string;
+  /**
+   * @remarks
+   * Whether the authentication passed:
+   * - **T**: Passed
+   * - **F**: Not passed
+   * 
+   * @example
+   * F
+   */
+  passed?: string;
+  /**
+   * @remarks
+   * Product code.
+   * 
+   * @example
+   * ID_PRO
+   */
+  productCode?: string;
+  /**
+   * @remarks
+   * Whether it is rooted (pass 1 if selected, otherwise do not pass; corresponds to identity label risk type).
+   * 
+   * @example
+   * 1
+   */
+  root?: number;
+  /**
+   * @remarks
+   * Scene ID.
+   * 
+   * @example
+   * 10000072xx
+   */
+  sceneId?: string;
+  /**
+   * @remarks
+   * Whether it is a simulator (pass 1 if selected, otherwise do not pass; corresponds to device label risk type).
+   * 
+   * @example
+   * 1
+   */
+  simulator?: number;
+  /**
+   * @remarks
+   * Start date of the query.
+   * 
+   * @example
+   * 2025-10-10 00:00:00 +0800
+   */
+  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).
+   * 
+   * @example
+   * 201
+   */
+  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).
+   * 
+   * @example
+   * 201,202
+   */
+  subCodes?: string;
+  /**
+   * @remarks
+   * Whether it is a virtual adaptation (pass 1 if selected, otherwise do not pass; corresponds to behavior label risk type).
+   * 
+   * @example
+   * 1
+   */
+  virtualVideo?: number;
+  static names(): { [key: string]: string } {
+    return {
+      certNo: 'CertNo',
+      certifyId: 'CertifyId',
+      currentPage: 'CurrentPage',
+      endDate: 'EndDate',
+      hasDeviceRisk: 'HasDeviceRisk',
+      model: 'Model',
+      outerOrderNo: 'OuterOrderNo',
+      pageSize: 'PageSize',
+      passed: 'Passed',
+      productCode: 'ProductCode',
+      root: 'Root',
+      sceneId: 'SceneId',
+      simulator: 'Simulator',
+      startDate: 'StartDate',
+      subCode: 'SubCode',
+      subCodes: 'SubCodes',
+      virtualVideo: 'VirtualVideo',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      certNo: 'string',
+      certifyId: 'string',
+      currentPage: 'string',
+      endDate: 'string',
+      hasDeviceRisk: 'boolean',
+      model: 'string',
+      outerOrderNo: 'string',
+      pageSize: 'string',
+      passed: 'string',
+      productCode: 'string',
+      root: 'number',
+      sceneId: 'string',
+      simulator: 'number',
+      startDate: 'string',
+      subCode: 'string',
+      subCodes: 'string',
+      virtualVideo: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeVerifySearchPageListResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeVerifySearchPageListResponseBody } from "./DescribeVerifySearchPageListResponseBody";
+
+
+export class DescribeVerifySearchPageListResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeVerifySearchPageListResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: DescribeVerifySearchPageListResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+