@alicloud/cloudauth20190307 3.9.4 → 3.10.0

package/src/models/DescribeSmartStatisticsPageListResponseBody.ts

@@ -4,32 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeSmartStatisticsPageListResponseBodyItems extends $dara.Model {
   /**
+   * @remarks
+   * Date. Format: <i>month/day</i>
+   * 
    * @example
    * 11/8
    */
   date?: string;
   /**
+   * @remarks
+   * Pass rate.
+   * 
    * @example
    * 25
    */
   passRate?: string;
   /**
+   * @remarks
+   * Product solution Code, please refer to the Enhanced Real Person Help Documentation.
+   * 
    * @example
    * SMART_VERIFY
    */
   productCode?: string;
   /**
+   * @remarks
+   * Scene ID.
+   * 
    * @example
    * 20**40
    */
   sceneId?: number;
+  /**
+   * @remarks
+   * Scene name.
+   * 
+   * @example
+   * ****实名认证
+   */
   sceneName?: string;
   /**
+   * @remarks
+   * Number of successful calls.
+   * 
    * @example
    * 1
    */
   successCount?: number;
   /**
+   * @remarks
+   * Total count.
+   * 
    * @example
    * 4
    */
@@ -69,27 +94,46 @@ export class DescribeSmartStatisticsPageListResponseBodyItems extends $dara.Mode
 
 export class DescribeSmartStatisticsPageListResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Current page number.
+   * 
    * @example
    * 1
    */
   currentPage?: number;
+  /**
+   * @remarks
+   * Returned data list.
+   */
   items?: DescribeSmartStatisticsPageListResponseBodyItems[];
   /**
+   * @remarks
+   * Number of items displayed per page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * ID of this request.
+   * 
    * @example
    * 96943***4E39F805
    */
   requestId?: string;
   /**
+   * @remarks
+   * Total count.
+   * 
    * @example
    * 29
    */
   totalCount?: number;
   /**
+   * @remarks
+   * Total number of pages.
+   * 
    * @example
    * 3
    */

package/src/models/DescribeVerifyResultRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeVerifyResultRequest extends $dara.Model {
   /**
    * @remarks
+   * Authentication ID. A unique ID that identifies an authentication task, not exceeding 64 characters. For a single authentication task, the system supports an unlimited number of submissions until the final authentication is successful and the task is completed. > You need to use a different BizId for each new authentication task.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DescribeVerifyResultRequest extends $dara.Model {
   bizId?: string;
   /**
    * @remarks
+   * Business scenario identifier for real-person authentication service
+   * 
    * This parameter is required.
    * 
    * @example

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/DescribeVerifyTokenRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeVerifyTokenRequest extends $dara.Model {
   /**
    * @remarks
+   * Verification ID. A unique ID that identifies a verification task, not exceeding 64 characters. For a single verification task, the system supports unlimited submissions until the final verification is passed and the task is completed.
+   * 
+   * > Different BizIds are required for different verification tasks.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +17,8 @@ export class DescribeVerifyTokenRequest extends $dara.Model {
   bizId?: string;
   /**
    * @remarks
+   * Identifier for the business scenario using the real person authentication service. Please refer to [Business Settings](https://help.aliyun.com/document_detail/127885.html) and complete the creation in the console first.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,62 +26,105 @@ export class DescribeVerifyTokenRequest extends $dara.Model {
    */
   bizType?: string;
   /**
+   * @remarks
+   * Callback seed.
+   * 
    * @example
    * -
    */
   callbackSeed?: string;
   /**
+   * @remarks
+   * Callback URL.
+   * 
    * @example
    * -
    */
   callbackUrl?: string;
   /**
+   * @remarks
+   * HTTP or HTTPS link to the retained portrait photo.
+   * 
    * @example
    * http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg
    */
   faceRetainedImageUrl?: string;
   /**
+   * @remarks
+   * Redirect URL for failed verification.
+   * 
    * @example
    * -
    */
   failedRedirectUrl?: string;
   /**
+   * @remarks
+   * HTTP or HTTPS link to the national emblem side of the ID card image.
+   * 
    * @example
    * http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg
    */
   idCardBackImageUrl?: string;
   /**
+   * @remarks
+   * HTTP or HTTPS link to the portrait side of the ID card image.
+   * 
    * @example
    * http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg
    */
   idCardFrontImageUrl?: string;
   /**
+   * @remarks
+   * ID card number.
+   * 
    * @example
    * 330100xxxxxxxxxxxx
    */
   idCardNumber?: string;
+  /**
+   * @remarks
+   * Name.
+   * 
+   * @example
+   * 张三
+   */
   name?: string;
   /**
+   * @remarks
+   * Redirect URL upon successful verification.
+   * 
    * @example
    * -
    */
   passedRedirectUrl?: string;
   /**
+   * @remarks
+   * ID of the end user, such as the account ID of the end user.
+   * 
    * @example
    * user111
    */
   userId?: string;
   /**
+   * @remarks
+   * User IP.
+   * 
    * @example
    * 192.168.***.***
    */
   userIp?: string;
   /**
+   * @remarks
+   * User phone number.
+   * 
    * @example
    * 187********
    */
   userPhoneNumber?: string;
   /**
+   * @remarks
+   * User registration time. Expressed in timestamp format, unit: milliseconds.
+   * 
    * @example
    * 1577808000000
    */

package/src/models/DescribeVerifyTokenResponseBody.ts

@@ -4,36 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeVerifyTokenResponseBodyOssUploadToken extends $dara.Model {
   /**
+   * @remarks
+   * OSS file storage bucket.
+   * 
    * @example
    * cloudauth-zhangjiakou-external
    */
   bucket?: string;
   /**
+   * @remarks
+   * Access endpoint.
+   * 
    * @example
    * https://oss-cn-zhangjiakou.aliyuncs.com
    */
   endPoint?: string;
   /**
+   * @remarks
+   * Expiration time. Expressed in timestamp format, unit: milliseconds.
+   * 
    * @example
    * 1582636610000
    */
   expired?: number;
   /**
+   * @remarks
+   * The key required for file upload.
+   * 
    * @example
    * STS.NU8rUBj****
    */
   key?: string;
   /**
+   * @remarks
+   * File storage path.
+   * 
    * @example
    * prod/RdNLC@Ox2n-1s7NMt
    */
   path?: string;
   /**
+   * @remarks
+   * The secret required for file upload.
+   * 
    * @example
    * FwmnyoqT8dHj7nJLuM67T****
    */
   secret?: string;
   /**
+   * @remarks
+   * The token required for file upload.
+   * 
    * @example
    * uWia500nTS5knZaDzq4/KqpvhcLnO****
    */
@@ -72,18 +93,31 @@ export class DescribeVerifyTokenResponseBodyOssUploadToken extends $dara.Model {
 }
 
 export class DescribeVerifyTokenResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * OSS upload token information.
+   */
   ossUploadToken?: DescribeVerifyTokenResponseBodyOssUploadToken;
   /**
+   * @remarks
+   * The ID of this request.
+   * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368
    */
   requestId?: string;
   /**
+   * @remarks
+   * The entry link for the original H5 verification scheme, which has been discontinued and no longer supports new integrations. If you need to integrate an H5 verification scheme, it is recommended to use the [PC or mobile H5 web integration solution](https://help.aliyun.com/document_detail/173779.html) of financial-grade real-person authentication.
+   * 
    * @example
    * http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg
    */
   verifyPageUrl?: string;
   /**
+   * @remarks
+   * The token for this verification, used to link various interfaces in the verification request, valid for 30 minutes.
+   * 
    * @example
    * c302c0797679457685410ee51a5ba375
    */

package/src/models/DetectFaceAttributesRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DetectFaceAttributesRequest extends $dara.Model {
   /**
+   * @remarks
+   * Identifier for the business scenario using real-person authentication services.
+   * 
    * @example
    * RPBasicTest
    */
   bizType?: string;
   /**
    * @remarks
+   * The photo to be detected, see the instructions for uploading image addresses for format description. A maximum of 5 faces can be detected in a single image.
+   * 
    * This parameter is required.
    * 
    * @example