@alicloud/cloudauth20190307 3.13.3 → 3.14.0

package/dist/models/InitFaceVerifyRequest.d.ts

@@ -2,16 +2,16 @@ import * as $dara from '@darabonba/typescript';
 export declare class InitFaceVerifyRequest extends $dara.Model {
     /**
      * @remarks
-     * Whether the SDK enables strict face quality detection:
+     * Specifies whether the SDK enables strict face quality detection:
      *
-     * - **Y**: Enable
+     * - **Y**: Enabled.
      *
-     * - **N** (default): Disable
+     * - **N**: Disabled (default).
      *
      *
      * >
-     * > - If this parameter is enabled, the SDK needs to integrate the [strict face quality detection module](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/description-of-sdk-package-clipping?spm=a2c4g.11186623.0.0.1a9d35c6ySFUPW). Enabling strict quality detection may decrease the success rate of user face recognition.
-     * > - Only supported in Android SDK version 2.3.24 and above.
+     * > - If this parameter is enabled, the SDK must integrate the [strict face quality detection module](https://www.alibabacloud.com/help/en/id-verification/financial-grade-id-verification/description-of-sdk-package-clipping). Strict quality detection may reduce the face recognition success rate.
+     * > - Only Android SDK 2.3.24 and later versions are supported.
      *
      * @example
      * N
@@ -19,7 +19,7 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     appQualityCheck?: string;
     /**
      * @remarks
-     * User authorization ID, with a maximum length of 64 characters.
+     * The user authorization ID. Maximum length: 64 characters.
      *
      * @example
      * 92d46b9e9e2d703f2897f350d5bd4149
@@ -27,9 +27,9 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     authId?: string;
     /**
      * @remarks
-     * Date of birth on the document.
+     * The date of birth on the certificate.
      *
-     * This field is required when the document type **CertType** is **PASSPORT** and **Mode** is **3**.
+     * This field is required when the certificate type **CertType** is set to **PASSPORT** and **Mode** is set to **3**.
      *
      * @example
      * 1993-10-10
@@ -37,9 +37,9 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     birthday?: string;
     /**
      * @remarks
-     * Security token, generated by you, used for preventing duplication and tampering.
+     * The security token that you generate to prevent duplication and tampering.
      *
-     * If this value is set, the **CallbackToken** field will be displayed in the callback address.
+     * If this value is set, the **CallbackToken** field is displayed in the callback URL.
      *
      * @example
      * NMjvQanQgplBSaEI0sL86WnQplB
@@ -47,13 +47,13 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     callbackToken?: string;
     /**
      * @remarks
-     * Callback notification address for the authentication result, with the default callback request method being GET. The callback address must start with `https`. After completing the authentication, the platform will call back this address and automatically add the `certifyId` and `passed` fields, where the value of the `passed` field is the subcode, for example: `https://www.aliyun.com?callbackToken=1000004826&certifyId=shaxxxx&passed=200`.
+     * The callback notification URL for the authentication result. The default callback request method is GET, and the callback URL must start with `https`. After authentication is complete, the platform calls back this URL and automatically appends the `certifyId` and `passed` fields. The `passed` field returns the subcode value. Example: `https://www.aliyun.com?callbackToken=1000004826&certifyId=shaxxxx&passed=200.`
      *
      * <notice>
      *
-     * - Callbacks are triggered only when the authentication is completed (including both successful and unsuccessful authentications). If the authentication is abandoned, interrupted abnormally, or not performed, no notification will be sent. It is recommended that you retrieve detailed authentication information through a query interface if needed after receiving the callback notification.
-     * - The accessibility of the provided address will be verified before the API call. If the address cannot be accessed over the public network, a 401 error will be returned.
-     * - The callback interface must return an HTTP status code of 200; otherwise, it will trigger a retry, with two callbacks within 3 seconds.
+     * - The callback is triggered only when authentication is complete (including both passed and failed). If authentication is abandoned, abnormally breaks, or is not performed, no notification is sent. After receiving the callback notification, you can use the query operation to obtain authentication details if needed.
+     * - The accessibility of the provided URL is verified before the operation is invoked. If the URL cannot be accessed through public network access, error 401 is returned.
+     * - After receiving the callback, your service must return HTTP status code 200. Otherwise, a retry is triggered with two callbacks within 3 seconds.
      *
      * </notice>
      *
@@ -63,13 +63,13 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     callbackUrl?: string;
     /**
      * @remarks
-     * Whether to enable the camera selection feature:
+     * Specifies whether to enable the camera selection feature:
      *
-     * - **Y**: Enable
+     * - **Y**: Enabled.
      *
-     * - **N** (default): Disable
+     * - **N**: Disabled (default).
      *
-     * > This feature only takes effect in PC integration mode. When enabled, it allows users to select the camera for authentication.
+     * > This feature takes effect only for PC integration mode. After it is enabled, users can select a camera for authentication.
      *
      * @example
      * N
@@ -77,15 +77,15 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     cameraSelection?: string;
     /**
      * @remarks
-     * Real name.
+     * The real name.
      *
      * @example
-     * 张三
+     * Wang Shanshan
      */
     certName?: string;
     /**
      * @remarks
-     * Document number.
+     * The certificate number.
      *
      * @example
      * 330103xxxxxxxxxxxx
@@ -93,8 +93,8 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     certNo?: string;
     /**
      * @remarks
-     * Document type.
-     * Currently, only IDENTITY_CARD (ID card) is supported.
+     * The certificate type.
+     * Currently, only ID cards are supported. Set this parameter to IDENTITY_CARD.
      *
      * @example
      * IDENTITY_CARD
@@ -102,11 +102,11 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     certType?: string;
     /**
      * @remarks
-     * >Warning: To be deprecated
+     * >Warning: This parameter will be deprecated.</warning>
      *
-     * Previously passed CertifyId for real-person authentication, where the photo taken during authentication is used as the comparison photo.
+     * The CertifyId from a previous successful ID Verification session. The photo from that authentication is used as the comparison photo.
      *
-     * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.
+     * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, and OSS), select only one.
      *
      * @example
      * 0bfa7c493f850e5178b9f8613634c9xx
@@ -114,11 +114,11 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     certifyId?: string;
     /**
      * @remarks
-     * Types of **CertifyUrl** returned, including:
+     * The type of the returned **CertifyUrl**. Valid values:
      *
-     * - **L**: Original long link
+     * - **L**: Original long URL.
      *
-     * - **S** (default): Short link
+     * - **S** (default): Short URL.
      *
      * @example
      * L
@@ -126,7 +126,7 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     certifyUrlStyle?: string;
     /**
      * @remarks
-     * Web SDK device type, with values **WEB** or **H5**.
+     * The Web SDK device type. Valid values: **WEB** or **H5**.
      *
      * > Only Web SDK device types are supported.
      *
@@ -136,28 +136,31 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     certifyUrlType?: string;
     /**
      * @remarks
-     * Whether to allow cropping of the face image, with the default being not allowed.
+     * Specifies whether to allow cropping of face images. Cropping is not allowed by default.
      *
-     * - T: Indicates allowing cropping.
+     * - T: Cropping is allowed.
      *
-     * - F: Indicates not allowing cropping.
+     * - F: Cropping is not allowed.
      *
-     * > If the image you are requesting is not from a standard liveness detection SDK, it is recommended to allow face image cropping. When this feature is enabled, the requested image will first undergo face cropping and alignment, and then the service request will be initiated.
+     * > If the requested image is not captured by a standard liveness detection SDK, allow cropping of face images. After this feature is enabled, the requested image is first cropped and corrected before the request is sent to the service.
      *
      * @example
      * T
      */
     crop?: string;
     /**
+     * @remarks
+     * Specifies whether to enable beauty mode: Y/N.
+     *
      * @example
      * Y
      */
     enableBeauty?: string;
     /**
      * @remarks
-     * Encryption algorithm to be used, currently supporting only the SM2 national encryption algorithm.
+     * The encryption algorithm. Currently, only the SM2 national cryptographic algorithm is supported.
      *
-     * After enabling encrypted transmission, you need to pass in the encrypted CertName and CertNo. For how to encrypt, please refer to [Parameter Encryption Instructions](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/description-of-parameter-encryption?spm=a2c4g.11186623.0.0.1a9d566eWdqwy8#task-2229332).
+     * After encrypted transmission is enabled, pass in the encrypted CertName and CertNo. For encryption instructions, refer to [Parameter encryption description](https://www.alibabacloud.com/help/en/id-verification/financial-grade-id-verification/description-of-parameter-encryption#task-2229332).
      *
      * @example
      * SM2
@@ -165,9 +168,9 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     encryptType?: string;
     /**
      * @remarks
-     * Base64 encoded photo.
+     * The Base64-encoded photo.
      *
-     * > Choose one of the following methods to upload the image: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.
+     * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, and OSS), select only one.
      *
      * @example
      * /9j/4AAQSkZJRgABAQAASxxxxxxx
@@ -175,9 +178,9 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     faceContrastPicture?: string;
     /**
      * @remarks
-     * OSS photo address, currently only supports authorized OSS photo addresses.
+     * The OSS photo URL. Currently, only authorized OSS photo URLs are supported.
      *
-     * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.
+     * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, and OSS), select only one.
      *
      * @example
      * https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg
@@ -185,11 +188,11 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     faceContrastPictureUrl?: string;
     /**
      * @remarks
-     * Device assistant label type, with the value: **DeviceRisk**.
+     * The device assistant tag type. Valid values: **DeviceRisk**.
      *
      * >
-     * > - Choosing to output the device assistant will incur additional costs. For details, see [Paid Value-Added Services](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/face-guard?spm=a2c4g.11186623.0.0.443e5522rbHsR4).
-     * > - If you do not need to output the device assistant label, you can either not pass the parameter or pass an empty value.
+     * > - Selecting device assistant output incurs additional fees. For more information, refer to [Paid value-added services](https://www.alibabacloud.com/help/en/id-verification/financial-grade-id-verification/face-guard).
+     * > - If you do not need device assistant tag output, do not pass this parameter or pass an empty value.
      *
      * @example
      * DeviceRisk
@@ -197,10 +200,9 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     faceGuardOutput?: string;
     /**
      * @remarks
-     * H5 Downgrade Confirmation Button Switch:
-     *
-     * - **Y**: Enabled (On)
-     * - **N (default)**: Disabled (Off)
+     * Specifies whether to display the "I have completed authentication" button on the H5 degradation page after authentication is complete:
+     * - **Y**: Enabled.
+     * - **N** (default): Disabled.
      *
      * @example
      * Y
@@ -208,7 +210,7 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     h5DegradeConfirmBtn?: string;
     /**
      * @remarks
-     * User\\"s IP address.
+     * The IP address of the user.
      *
      * @example
      * 114.xxx.xxx.xxx
@@ -216,7 +218,7 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     ip?: string;
     /**
      * @remarks
-     * Metainfo environment parameter, which needs to be obtained through the client SDK.
+     * The Metainfo environment parameter, which must be obtained through the client SDK.
      *
      * @example
      * {"zimVer":"3.0.0","appVersion": "1","bioMetaInfo": "4.1.0:11501568,0","appName": "com.aliyun.antcloudauth","deviceType": "ios","osVersion": "iOS 10.3.2","apdidToken": "","deviceModel": "iPhone9,1"}
@@ -224,7 +226,7 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     metaInfo?: string;
     /**
      * @remarks
-     * User\\"s phone number.
+     * The mobile phone number of the user.
      *
      * @example
      * 130xxxxxxxx
@@ -232,13 +234,13 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     mobile?: string;
     /**
      * @remarks
-     * Method to obtain passport NFC verification elements:
+     * The method for obtaining passport NFC verification elements:
      *
-     * - **1**: User input, where the end-user manually inputs the document information using the UI interface provided by the Alibaba Cloud SDK.
+     * - **1**: User input. The end user manually enters certificate element information using the UI provided by the Alibaba Cloud SDK.
      *
-     * - **3**: External parameter input, where the document information is passed through external parameters.
+     * - **3**: External parameter input. Certificate element information is passed in externally.
      *
-     * > When decoding the encrypted information from the passport chip using NFC, three elements of the passport need to be obtained, including name, date of birth, and document expiration date.
+     * > NFC decoding of passport chip encrypted information requires three passport elements: name, date of birth, and certificate expiration date.
      *
      * @example
      * 1
@@ -246,28 +248,28 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     mode?: string;
     /**
      * @remarks
-     * Liveness detection type, with values:
-     * > Only the following liveness detection types are supported; custom actions or combinations are not supported at this time.
+     * The liveness detection type. Valid values:
+     * > The liveness detection type supports only the following values. Custom actions or combinations are not supported.
      *
-     * Note
-     * Only the following liveness detection types are supported; custom actions or combinations are not supported at this time.
+     * Note:
+     * The liveness detection type supports only the following values. Custom actions or combinations are not supported.
      *
-     * - **LIVENESS** (default): Blinking
+     * - **LIVENESS** (default): Blink.
      *
-     * - **PHOTINUS_LIVENESS**: Blinking + Colorful Light
+     * - **PHOTINUS_LIVENESS**: Blink + colorful light.
      *
-     * - **MULTI_ACTION**: Blinking + Head Shaking (the order of blinking and head shaking is random)
+     * - **MULTI_ACTION**: Blink + head shake (the order of blink and head shake is random).
      *
-     * - **MOVE_ACTION** (recommended): Moving Closer and Farther + Blinking
+     * - **MOVE_ACTION** (recommended): Move closer/farther + blink.
      *
-     * - **MOVE_PHOTINUS**: Moving Closer and Farther + Colorful Light
+     * - **MOVE_PHOTINUS**: Move closer/farther + colorful light.
      *
      * >
-     * >- The **default liveness detection type** is supported in the following versions:
-     * >   - Android SDK 1.2.6 and above
-     * >   - iOS SDK 1.2.4 and above
-     * >   - Harmony SDK 1.0.0 and above
-     * >- Other types are supported in the latest SDK versions for Android/iOS/Harmony. It is recommended to integrate the latest version.
+     * >- **The default liveness detection type** is supported in the following versions:
+     * >   - Android SDK 1.2.6 and later
+     * >   - iOS SDK 1.2.4 and later
+     * >   - Harmony SDK 1.0.0 and later
+     * >- Other types are supported in the latest Android/iOS/Harmony SDK versions. Integrate the latest version.
      *
      * @example
      * MOVE_ACTION
@@ -275,11 +277,11 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     model?: string;
     /**
      * @remarks
-     * Whether to intercept when multiple faces are detected, with the following values:
+     * Specifies whether to block authentication when multiple faces are detected on the device. Valid values:
      *
-     * - **Y**: Intercept, and the client prompts the user to re-scan their face.
+     * - **Y**: Block. The client prompts the user to redo face recognition.
      *
-     * - **N** (default): Do not intercept, and send the largest face in the scanned image to the server for security checks.
+     * - **N** (default): Do not block. The largest face in the frame is sent to the server for security detection.
      *
      * @example
      * Y
@@ -287,9 +289,9 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     needMultiFaceCheck?: string;
     /**
      * @remarks
-     * Authorized OSS bucket name.
+     * The bucket name of the authorized OSS space.
      *
-     * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.
+     * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, and OSS), select only one.
      *
      * @example
      * cn-shanghai-aliyun-cloudauth-xxxxx
@@ -297,9 +299,9 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     ossBucketName?: string;
     /**
      * @remarks
-     * Authorized OSS object name.
+     * The file name in the authorized OSS space.
      *
-     * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.
+     * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, and OSS), select only one.
      *
      * @example
      * verify/xxxxx/xxxxxx.jpeg
@@ -307,9 +309,9 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     ossObjectName?: string;
     /**
      * @remarks
-     * Unique identifier for the merchant\\"s request.
+     * The unique identifier of the merchant request.
      *
-     * The value is a 32-character alphanumeric combination. The first few characters are a custom abbreviation defined by the merchant, followed by a period, and the latter part can be a random or incremental sequence.
+     * The value is a 32-character alphanumeric string. The first few characters are a custom abbreviation defined by the merchant, the middle part can use a time segment, and the last part can use a random or incremental sequence.
      *
      * @example
      * e0c34a77f5ac40a5aa5e6ed20c353888
@@ -317,19 +319,19 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     outerOrderNo?: string;
     /**
      * @remarks
-     * Degradation configuration for mobile H5 authentication when WebRTC or Webassembly is incompatible.
+     * The degradation configuration when WebRTC or WebAssembly incompatibility occurs during mobile H5 authentication.
      *
-     * - **keep**: Does not support degradation, returns directly.
+     * - **keep**: Degradation is not supported. The system returns directly.
      *
-     * - **url** (default): Supports degradation, returns an authentication URL. Users can use this URL to open or switch browsers for authentication.
+     * - **url** (default): Degradation is supported. An authentication URL is returned. The user opens or switches to a browser to authenticate using this URL.
      *
-     * - **video**: Supports degradation, uses the system camera to record a 3~5 second blinking video for authentication.
+     * - **video**: Degradation is supported. The system camera is used to record a 3-5 second blink video for authentication.
      *
      *
      * >
-     * > When the degradation mode is Video, the following functions will be disabled, and the product security will decrease. It is recommended to configure it only for secure scenarios.
-     * > - Liveness detection type settings will not take effect.
-     * > - The VideoEvidence function is not supported.
+     * > When the degradation mode is Video, the following features become ineffective and product security is reduced. Configure this mode only for security scenarios.
+     * > - The liveness detection type setting does not take effect.
+     * > - The VideoEvidence feature is not supported.
      *
      * @example
      * url
@@ -337,10 +339,10 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     procedurePriority?: string;
     /**
      * @remarks
-     * Fixed value. The parameter value differs based on the product solution:
-     * - APP Authentication Scheme: Fixed value is ID_PRO
-     * - Live Face Verification Scheme: Fixed value is PV_FV
-     * - Liveness Detection Scheme: Fixed value is LR_FR
+     * A fixed value. This parameter varies depending on the product plan:
+     * - APP authentication plan: The fixed value is ID_PRO.
+     * - Face liveness verification plan: The fixed value is PV_FV.
+     * - Liveness detection plan: The fixed value is LR_FR.
      *
      * @example
      * ID_PRO
@@ -348,11 +350,11 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     productCode?: string;
     /**
      * @remarks
-     * Whether to enable rare character mode:
+     * Specifies whether to enable the rare character mode:
      *
-     * - **Y**: Enable. A message input box will pop up before the user authenticates, requiring the input of the rare character name and ID number. The user must agree to the terms before starting the authentication process.
+     * - **Y**: Enabled. An information input box pops up before authentication, requiring the user to enter the rare character name and ID card number and agree to the agreement before starting the authentication process.
      *
-     * - **N**: Not enabled (default)
+     * - **N**: Disabled (default).
      *
      * @example
      * Y
@@ -360,13 +362,13 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     rarelyCharacters?: string;
     /**
      * @remarks
-     * Whether to read the document photo:
+     * Specifies whether to read the certificate photo:
      *
-     * - **Y**: Read
+     * - **Y**: Read.
      *
-     * - **N**: Do not read
+     * - **N**: Do not read.
      *
-     * > If the document face photo is needed in subsequent authentication steps, it is recommended to set this parameter to Y.
+     * > If the certificate face photo is needed in subsequent authentication steps, set this parameter to Y.
      *
      * @example
      * Y
@@ -374,7 +376,7 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     readImg?: string;
     /**
      * @remarks
-     * Target URL for the merchant\\"s business page to redirect to.
+     * The target URL to which the merchant business page redirects.
      *
      * @example
      * www.aliyun.com
@@ -382,7 +384,7 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     returnUrl?: string;
     /**
      * @remarks
-     * Authentication Scene ID.
+     * The authentication scene ID.
      *
      * @example
      * 1000000006
@@ -390,18 +392,18 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     sceneId?: number;
     /**
      * @remarks
-     * Aging-friendly configuration parameters that take effect for each authentication request. You can choose different parameters based on your app\\"s business attributes, customer distribution, operational characteristics, etc., for each authentication request. The options include the following, with the default being 0.
+     * The elderly-friendly configuration parameter. This parameter takes effect for each authentication request. You can select different parameters for each authentication request based on the business attributes, customer distribution, and operational characteristics of your app. Valid values:
      *
-     * - **0**: Not enabled, indicating that the current authentication request does not enable aging-friendly mode.
+     * - **0** (default): Disabled. The current authentication request does not enable elderly-friendly mode.
      *
-     * - **1**: Enabled, indicating that the current authentication request enables aging-friendly mode.
+     * - **1**: Enabled. The current authentication request enables elderly-friendly mode.
      *
      * - **2**: User choice.
      *
      *
-     * Supports end-users in choosing the authentication mode. The product guide page provides two authentication entry points: \\"Enable Authentication\\" and \\"Elderly Authentication Mode\\". When the user selects \\"Elderly Authentication Mode\\", the system enters aging-friendly mode.
+     * Allows end users to select the authentication mode. The product guide page provides two authentication entries: "Start Authentication" and "Senior Authentication Mode". When the user selects "Senior Authentication Mode", the system enters elderly-friendly mode.
      * >
-     * > - Aging-friendly parameters are only effective when the liveness detection type **Model** is set to **LIVENESS** or **MULTI_ACTION**.
+     * > - The elderly-friendly parameter takes effect only when the liveness detection type **Model** is set to **LIVENESS** or **MULTI_ACTION**.
      *
      * @example
      * 0
@@ -409,9 +411,9 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     suitableType?: string;
     /**
      * @remarks
-     * UI configuration file URL.
+     * The UI configuration file URL.
      *
-     * You can view the complete configuration in the [Web SDK UI Customization Description](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/web-sdk-ui-custom-configuration-description?spm=a2c4g.11186623.0.0.4c683f5c8K3I9p).
+     * You can view the complete configuration in [Web SDK UI custom configuration](https://www.alibabacloud.com/help/en/id-verification/financial-grade-id-verification/web-sdk-ui-custom-configuration-description).
      *
      * @example
      * www.aliyundoc.com
@@ -419,7 +421,7 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     uiCustomUrl?: string;
     /**
      * @remarks
-     * Custom user ID for the customer\\"s business, please ensure it is unique.
+     * The custom user ID defined by the business. Keep this value unique.
      *
      * @example
      * 123456789
@@ -427,9 +429,9 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     userId?: string;
     /**
      * @remarks
-     * Document expiration date.
+     * The certificate expiration date.
      *
-     * This field is required when the document type **CertType** is **PASSPORT** and **Mode** is **3**.
+     * This field is required when the certificate type **CertType** is set to **PASSPORT** and **Mode** is set to **3**.
      *
      * @example
      * 2039-06-10
@@ -437,13 +439,13 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     validityDate?: string;
     /**
      * @remarks
-     * Whether to enable video evidence:
+     * Specifies whether to enable video evidence:
      *
-     * - **true**: Enable
+     * - **true**: Enabled.
      *
-     * - **false** (default): Disable
+     * - **false**: Disabled (default).
      *
-     * > Due to the large size of video files, when the network is unstable, the system will discard the video file to prioritize the transmission of necessary images for authentication. It is recommended that your business set a weak dependency on the video.
+     * > Because video files are large, the system discards video files to prioritize the transmission of essential authentication images when the network is unstable. Set video as a weak dependency in your business logic.
      *
      * @example
      * false
@@ -451,14 +453,14 @@ export declare class InitFaceVerifyRequest extends $dara.Model {
     videoEvidence?: string;
     /**
      * @remarks
-     * Customized content. Required when personalized settings are enabled. The format is a JSON String of a String List.
+     * The custom voluntary content. This parameter is required when personalized settings are enabled. The format is a JSON string of a String List.
      *
-     * - For the follow-reading scenario: It should not exceed 60 Chinese characters (excluding punctuation), and the List contains only one element.
+     * - For read-aloud scenarios: The content cannot exceed 60 Chinese characters (excluding punctuation), and the List contains only 1 element.
      *
-     * - For the Q&A scenario: Up to 3 questions can be set, with each question not exceeding 30 Chinese characters, and each question being an element in the List.
+     * - For Q&A scenarios: A maximum of 3 questions can be set. Each question cannot exceed 30 Chinese characters. Each question is a separate element in the List.
      *
      * @example
-     * ["本人王先生同意***协议。"]
+     * ["I, Mr. Wang, agree to the *** agreement."]
      */
     voluntaryCustomizedContent?: string;
     static names(): {

package/dist/models/InitFaceVerifyRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"InitFaceVerifyRequest.js","sourceRoot":"","sources":["../../src/models/InitFaceVerifyRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,qBAAsB,SAAQ,KAAK,CAAC,KAAK;IA8cpD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,iBAAiB;YAClC,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,UAAU;YACpB,aAAa,EAAE,eAAe;YAC9B,WAAW,EAAE,aAAa;YAC1B,eAAe,EAAE,iBAAiB;YAClC,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,UAAU;YACpB,SAAS,EAAE,WAAW;YACtB,eAAe,EAAE,iBAAiB;YAClC,cAAc,EAAE,gBAAgB;YAChC,IAAI,EAAE,MAAM;YACZ,YAAY,EAAE,cAAc;YAC5B,WAAW,EAAE,aAAa;YAC1B,mBAAmB,EAAE,qBAAqB;YAC1C,sBAAsB,EAAE,wBAAwB;YAChD,eAAe,EAAE,iBAAiB;YAClC,mBAAmB,EAAE,qBAAqB;YAC1C,EAAE,EAAE,IAAI;YACR,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,kBAAkB,EAAE,oBAAoB;YACxC,aAAa,EAAE,eAAe;YAC9B,aAAa,EAAE,eAAe;YAC9B,YAAY,EAAE,cAAc;YAC5B,iBAAiB,EAAE,mBAAmB;YACtC,WAAW,EAAE,aAAa;YAC1B,gBAAgB,EAAE,kBAAkB;YACpC,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,WAAW;YACtB,OAAO,EAAE,SAAS;YAClB,YAAY,EAAE,cAAc;YAC5B,WAAW,EAAE,aAAa;YAC1B,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,cAAc;YAC5B,aAAa,EAAE,eAAe;YAC9B,0BAA0B,EAAE,4BAA4B;SACzD,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,QAAQ;YACzB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,QAAQ;YAClB,aAAa,EAAE,QAAQ;YACvB,WAAW,EAAE,QAAQ;YACrB,eAAe,EAAE,QAAQ;YACzB,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,QAAQ;YACnB,eAAe,EAAE,QAAQ;YACzB,cAAc,EAAE,QAAQ;YACxB,IAAI,EAAE,QAAQ;YACd,YAAY,EAAE,QAAQ;YACtB,WAAW,EAAE,QAAQ;YACrB,mBAAmB,EAAE,QAAQ;YAC7B,sBAAsB,EAAE,QAAQ;YAChC,eAAe,EAAE,QAAQ;YACzB,mBAAmB,EAAE,QAAQ;YAC7B,EAAE,EAAE,QAAQ;YACZ,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,QAAQ;YACf,kBAAkB,EAAE,QAAQ;YAC5B,aAAa,EAAE,QAAQ;YACvB,aAAa,EAAE,QAAQ;YACvB,YAAY,EAAE,QAAQ;YACtB,iBAAiB,EAAE,QAAQ;YAC3B,WAAW,EAAE,QAAQ;YACrB,gBAAgB,EAAE,QAAQ;YAC1B,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,QAAQ;YACjB,YAAY,EAAE,QAAQ;YACtB,WAAW,EAAE,QAAQ;YACrB,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,QAAQ;YACtB,aAAa,EAAE,QAAQ;YACvB,0BAA0B,EAAE,QAAQ;SACrC,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA/iBD,sDA+iBC"}
+{"version":3,"file":"InitFaceVerifyRequest.js","sourceRoot":"","sources":["../../src/models/InitFaceVerifyRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,qBAAsB,SAAQ,KAAK,CAAC,KAAK;IAgdpD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,iBAAiB;YAClC,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,UAAU;YACpB,aAAa,EAAE,eAAe;YAC9B,WAAW,EAAE,aAAa;YAC1B,eAAe,EAAE,iBAAiB;YAClC,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,UAAU;YACpB,SAAS,EAAE,WAAW;YACtB,eAAe,EAAE,iBAAiB;YAClC,cAAc,EAAE,gBAAgB;YAChC,IAAI,EAAE,MAAM;YACZ,YAAY,EAAE,cAAc;YAC5B,WAAW,EAAE,aAAa;YAC1B,mBAAmB,EAAE,qBAAqB;YAC1C,sBAAsB,EAAE,wBAAwB;YAChD,eAAe,EAAE,iBAAiB;YAClC,mBAAmB,EAAE,qBAAqB;YAC1C,EAAE,EAAE,IAAI;YACR,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,kBAAkB,EAAE,oBAAoB;YACxC,aAAa,EAAE,eAAe;YAC9B,aAAa,EAAE,eAAe;YAC9B,YAAY,EAAE,cAAc;YAC5B,iBAAiB,EAAE,mBAAmB;YACtC,WAAW,EAAE,aAAa;YAC1B,gBAAgB,EAAE,kBAAkB;YACpC,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,WAAW;YACtB,OAAO,EAAE,SAAS;YAClB,YAAY,EAAE,cAAc;YAC5B,WAAW,EAAE,aAAa;YAC1B,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,cAAc;YAC5B,aAAa,EAAE,eAAe;YAC9B,0BAA0B,EAAE,4BAA4B;SACzD,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,QAAQ;YACzB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,QAAQ;YAClB,aAAa,EAAE,QAAQ;YACvB,WAAW,EAAE,QAAQ;YACrB,eAAe,EAAE,QAAQ;YACzB,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,QAAQ;YACnB,eAAe,EAAE,QAAQ;YACzB,cAAc,EAAE,QAAQ;YACxB,IAAI,EAAE,QAAQ;YACd,YAAY,EAAE,QAAQ;YACtB,WAAW,EAAE,QAAQ;YACrB,mBAAmB,EAAE,QAAQ;YAC7B,sBAAsB,EAAE,QAAQ;YAChC,eAAe,EAAE,QAAQ;YACzB,mBAAmB,EAAE,QAAQ;YAC7B,EAAE,EAAE,QAAQ;YACZ,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,QAAQ;YACf,kBAAkB,EAAE,QAAQ;YAC5B,aAAa,EAAE,QAAQ;YACvB,aAAa,EAAE,QAAQ;YACvB,YAAY,EAAE,QAAQ;YACtB,iBAAiB,EAAE,QAAQ;YAC3B,WAAW,EAAE,QAAQ;YACrB,gBAAgB,EAAE,QAAQ;YAC1B,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,QAAQ;YACjB,YAAY,EAAE,QAAQ;YACtB,WAAW,EAAE,QAAQ;YACrB,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,QAAQ;YACtB,aAAa,EAAE,QAAQ;YACvB,0BAA0B,EAAE,QAAQ;SACrC,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAjjBD,sDAijBC"}