@alicloud/cloudauth20190307 3.9.5 → 3.10.0

package/dist/client.d.ts

@@ -146,35 +146,87 @@ export default class Client extends OpenApi {
      */
     compareFaces(request: $_model.CompareFacesRequest): Promise<$_model.CompareFacesResponse>;
     /**
+     * This interface is used to submit authentication materials for verification and comparison, and it synchronously returns the authentication result.
+     *
+     * @remarks
+     * - Interface Name: ContrastFaceVerify.
+     * - Service Address: cloudauth.aliyuncs.com.
+     * - Request Method: HTTPS POST and GET.
+     * - Interface Description: An interface for real person authentication through server-side integration.
+     * #### Image Format Requirements
+     * When performing real person authentication, please ensure that the images you upload meet all of the following conditions:
+     * - Recent photo with a clear, unobstructed, and natural expression, facing the camera directly.
+     * - Clear and properly exposed photo, without overly dark, bright, or haloed faces, and with minimal angle deviation.
+     * - Resolution not exceeding 1920*1080, at least 640*480, with the shorter side recommended to be resized to 720 pixels, and a compression ratio greater than 0.9.
+     * - Photo size: <1MB.
+     * - Supports 90, 180, and 270-degree photos; in cases of multiple faces, the largest face will be selected.
+     *
      * @param request - ContrastFaceVerifyRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns ContrastFaceVerifyResponse
      */
     contrastFaceVerifyWithOptions(request: $_model.ContrastFaceVerifyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ContrastFaceVerifyResponse>;
     /**
+     * This interface is used to submit authentication materials for verification and comparison, and it synchronously returns the authentication result.
+     *
+     * @remarks
+     * - Interface Name: ContrastFaceVerify.
+     * - Service Address: cloudauth.aliyuncs.com.
+     * - Request Method: HTTPS POST and GET.
+     * - Interface Description: An interface for real person authentication through server-side integration.
+     * #### Image Format Requirements
+     * When performing real person authentication, please ensure that the images you upload meet all of the following conditions:
+     * - Recent photo with a clear, unobstructed, and natural expression, facing the camera directly.
+     * - Clear and properly exposed photo, without overly dark, bright, or haloed faces, and with minimal angle deviation.
+     * - Resolution not exceeding 1920*1080, at least 640*480, with the shorter side recommended to be resized to 720 pixels, and a compression ratio greater than 0.9.
+     * - Photo size: <1MB.
+     * - Supports 90, 180, and 270-degree photos; in cases of multiple faces, the largest face will be selected.
+     *
      * @param request - ContrastFaceVerifyRequest
      * @returns ContrastFaceVerifyResponse
      */
     contrastFaceVerify(request: $_model.ContrastFaceVerifyRequest): Promise<$_model.ContrastFaceVerifyResponse>;
     contrastFaceVerifyAdvance(request: $_model.ContrastFaceVerifyAdvanceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ContrastFaceVerifyResponse>;
     /**
+     * Call CreateAuthKey to get the authorization key, which is used for offline face recognition SDK activation.
+     *
+     * @remarks
+     * Request Method: Supports sending requests via HTTPS POST and GET methods.
+     * > The authorization key is valid for 30 minutes and cannot be reused. It is recommended to re-obtain it before each activation.
+     *
      * @param request - CreateAuthKeyRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns CreateAuthKeyResponse
      */
     createAuthKeyWithOptions(request: $_model.CreateAuthKeyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAuthKeyResponse>;
     /**
+     * Call CreateAuthKey to get the authorization key, which is used for offline face recognition SDK activation.
+     *
+     * @remarks
+     * Request Method: Supports sending requests via HTTPS POST and GET methods.
+     * > The authorization key is valid for 30 minutes and cannot be reused. It is recommended to re-obtain it before each activation.
+     *
      * @param request - CreateAuthKeyRequest
      * @returns CreateAuthKeyResponse
      */
     createAuthKey(request: $_model.CreateAuthKeyRequest): Promise<$_model.CreateAuthKeyResponse>;
     /**
+     * Call CreateVerifySetting to create a verification scenario configuration. This operation is equivalent to creating a new verification scenario on the console.
+     *
+     * @remarks
+     * Request Method: Only supports sending requests via HTTPS POST.
+     *
      * @param request - CreateVerifySettingRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns CreateVerifySettingResponse
      */
     createVerifySettingWithOptions(request: $_model.CreateVerifySettingRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateVerifySettingResponse>;
     /**
+     * Call CreateVerifySetting to create a verification scenario configuration. This operation is equivalent to creating a new verification scenario on the console.
+     *
+     * @remarks
+     * Request Method: Only supports sending requests via HTTPS POST.
+     *
      * @param request - CreateVerifySettingRequest
      * @returns CreateVerifySettingResponse
      */
@@ -202,7 +254,7 @@ export default class Client extends OpenApi {
     credentialProductVerifyV2(request: $_model.CredentialProductVerifyV2Request): Promise<$_model.CredentialProductVerifyV2Response>;
     credentialProductVerifyV2Advance(request: $_model.CredentialProductVerifyV2AdvanceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CredentialProductVerifyV2Response>;
     /**
-     * 凭证核验
+     * Credential verification
      *
      * @param tmpReq - CredentialVerifyRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -210,7 +262,7 @@ export default class Client extends OpenApi {
      */
     credentialVerifyWithOptions(tmpReq: $_model.CredentialVerifyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CredentialVerifyResponse>;
     /**
-     * 凭证核验
+     * Credential verification
      *
      * @param request - CredentialVerifyRequest
      * @returns CredentialVerifyResponse
@@ -287,7 +339,10 @@ export default class Client extends OpenApi {
      */
     deleteFaceVerifyResult(request: $_model.DeleteFaceVerifyResultRequest): Promise<$_model.DeleteFaceVerifyResultResponse>;
     /**
-     * 图片要素核验获取认证结果
+     * Obtain Authentication Results from Image Element Verification
+     *
+     * @remarks
+     * After receiving the callback notification, you can use this interface on the server side to obtain the corresponding authentication status and information.
      *
      * @param request - DescribeCardVerifyRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -295,25 +350,38 @@ export default class Client extends OpenApi {
      */
     describeCardVerifyWithOptions(request: $_model.DescribeCardVerifyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeCardVerifyResponse>;
     /**
-     * 图片要素核验获取认证结果
+     * Obtain Authentication Results from Image Element Verification
+     *
+     * @remarks
+     * After receiving the callback notification, you can use this interface on the server side to obtain the corresponding authentication status and information.
      *
      * @param request - DescribeCardVerifyRequest
      * @returns DescribeCardVerifyResponse
      */
     describeCardVerify(request: $_model.DescribeCardVerifyRequest): Promise<$_model.DescribeCardVerifyResponse>;
     /**
+     * Call DescribeDeviceInfo to query device-related information, such as the validity period of authorization, business identifiers customized by the access party, and device ID, etc.
+     *
+     * @remarks
+     * Request Method: Supports sending requests using HTTPS POST and GET methods.
+     *
      * @param request - DescribeDeviceInfoRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DescribeDeviceInfoResponse
      */
     describeDeviceInfoWithOptions(request: $_model.DescribeDeviceInfoRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDeviceInfoResponse>;
     /**
+     * Call DescribeDeviceInfo to query device-related information, such as the validity period of authorization, business identifiers customized by the access party, and device ID, etc.
+     *
+     * @remarks
+     * Request Method: Supports sending requests using HTTPS POST and GET methods.
+     *
      * @param request - DescribeDeviceInfoRequest
      * @returns DescribeDeviceInfoResponse
      */
     describeDeviceInfo(request: $_model.DescribeDeviceInfoRequest): Promise<$_model.DescribeDeviceInfoResponse>;
     /**
-     * 金融级人脸保镖服务
+     * Financial-Grade Face Guard Service
      *
      * @param request - DescribeFaceGuardRiskRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -321,35 +389,50 @@ export default class Client extends OpenApi {
      */
     describeFaceGuardRiskWithOptions(request: $_model.DescribeFaceGuardRiskRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeFaceGuardRiskResponse>;
     /**
-     * 金融级人脸保镖服务
+     * Financial-Grade Face Guard Service
      *
      * @param request - DescribeFaceGuardRiskRequest
      * @returns DescribeFaceGuardRiskResponse
      */
     describeFaceGuardRisk(request: $_model.DescribeFaceGuardRiskRequest): Promise<$_model.DescribeFaceGuardRiskResponse>;
     /**
+     * After the mobile end of the integrator receives the callback, its server can call this interface to obtain the corresponding authentication status and authentication information.
+     *
+     * @remarks
+     * - Service Address: cloudauth.aliyuncs.com.
+     * - Request Method: HTTPS POST and GET.
+     *
      * @param request - DescribeFaceVerifyRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DescribeFaceVerifyResponse
      */
     describeFaceVerifyWithOptions(request: $_model.DescribeFaceVerifyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeFaceVerifyResponse>;
     /**
+     * After the mobile end of the integrator receives the callback, its server can call this interface to obtain the corresponding authentication status and authentication information.
+     *
+     * @remarks
+     * - Service Address: cloudauth.aliyuncs.com.
+     * - Request Method: HTTPS POST and GET.
+     *
      * @param request - DescribeFaceVerifyRequest
      * @returns DescribeFaceVerifyResponse
      */
     describeFaceVerify(request: $_model.DescribeFaceVerifyRequest): Promise<$_model.DescribeFaceVerifyResponse>;
     /**
+     * Call DescribeOssUploadToken to get the Token required for uploading photos to OSS.
+     *
      * @param request - DescribeOssUploadTokenRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DescribeOssUploadTokenResponse
      */
     describeOssUploadTokenWithOptions(runtime: $dara.RuntimeOptions): Promise<$_model.DescribeOssUploadTokenResponse>;
     /**
+     * Call DescribeOssUploadToken to get the Token required for uploading photos to OSS.
      * @returns DescribeOssUploadTokenResponse
      */
     describeOssUploadToken(): Promise<$_model.DescribeOssUploadTokenResponse>;
     /**
-     * Open API新增金融级数据统计API
+     * Open API adds financial-grade data statistics API
      *
      * @param request - DescribePageFaceVerifyDataRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -357,63 +440,153 @@ export default class Client extends OpenApi {
      */
     describePageFaceVerifyDataWithOptions(request: $_model.DescribePageFaceVerifyDataRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribePageFaceVerifyDataResponse>;
     /**
-     * Open API新增金融级数据统计API
+     * Open API adds financial-grade data statistics API
      *
      * @param request - DescribePageFaceVerifyDataRequest
      * @returns DescribePageFaceVerifyDataResponse
      */
     describePageFaceVerifyData(request: $_model.DescribePageFaceVerifyDataRequest): Promise<$_model.DescribePageFaceVerifyDataResponse>;
     /**
+     * Enhanced Real Person Authentication Call Statistics Pagination Query Interface
+     *
      * @param request - DescribeSmartStatisticsPageListRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DescribeSmartStatisticsPageListResponse
      */
     describeSmartStatisticsPageListWithOptions(request: $_model.DescribeSmartStatisticsPageListRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeSmartStatisticsPageListResponse>;
     /**
+     * Enhanced Real Person Authentication Call Statistics Pagination Query Interface
+     *
      * @param request - DescribeSmartStatisticsPageListRequest
      * @returns DescribeSmartStatisticsPageListResponse
      */
     describeSmartStatisticsPageList(request: $_model.DescribeSmartStatisticsPageListRequest): Promise<$_model.DescribeSmartStatisticsPageListResponse>;
     /**
+     * Query the result of real-person authentication.
+     *
+     * @remarks
+     * Prerequisites: Before accessing this API, please ensure that you have completed the necessary preparations. For more details, see [Real Person Authentication Server-side Preparation](https://help.aliyun.com/document_detail/127471.html) and [Liveness Face Verification Server-side Preparation](https://help.aliyun.com/document_detail/127717.html).
+     * > Alibaba Cloud Real Person Authentication only stores authentication data for the last 180 days. For any subsequent business use, please call this interface in a timely manner to retrieve and store the data yourself to avoid any impact on usage.
+     * Request Method: HTTPS POST and GET.
+     * Interface Description: After the mobile end of the access party receives the callback, its server can call this interface to obtain the corresponding authentication status and authentication information.
+     * Applicable Scope: This interface is applicable to the authentication solution with SDK + server-side integration.
+     *
      * @param request - DescribeVerifyResultRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DescribeVerifyResultResponse
      */
     describeVerifyResultWithOptions(request: $_model.DescribeVerifyResultRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeVerifyResultResponse>;
     /**
+     * Query the result of real-person authentication.
+     *
+     * @remarks
+     * Prerequisites: Before accessing this API, please ensure that you have completed the necessary preparations. For more details, see [Real Person Authentication Server-side Preparation](https://help.aliyun.com/document_detail/127471.html) and [Liveness Face Verification Server-side Preparation](https://help.aliyun.com/document_detail/127717.html).
+     * > Alibaba Cloud Real Person Authentication only stores authentication data for the last 180 days. For any subsequent business use, please call this interface in a timely manner to retrieve and store the data yourself to avoid any impact on usage.
+     * Request Method: HTTPS POST and GET.
+     * Interface Description: After the mobile end of the access party receives the callback, its server can call this interface to obtain the corresponding authentication status and authentication information.
+     * Applicable Scope: This interface is applicable to the authentication solution with SDK + server-side integration.
+     *
      * @param request - DescribeVerifyResultRequest
      * @returns DescribeVerifyResultResponse
      */
     describeVerifyResult(request: $_model.DescribeVerifyResultRequest): Promise<$_model.DescribeVerifyResultResponse>;
     /**
+     * Call DescribeVerifySDK to get the offline SDK download address.
+     *
+     * @remarks
+     * Request Method: Supports sending requests via HTTPS POST and GET methods.
+     * Interface Description: Obtain the SDK generation result based on the task ID for generating an offline facial recognition SDK.
+     *
      * @param request - DescribeVerifySDKRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DescribeVerifySDKResponse
      */
     describeVerifySDKWithOptions(request: $_model.DescribeVerifySDKRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeVerifySDKResponse>;
     /**
+     * Call DescribeVerifySDK to get the offline SDK download address.
+     *
+     * @remarks
+     * Request Method: Supports sending requests via HTTPS POST and GET methods.
+     * Interface Description: Obtain the SDK generation result based on the task ID for generating an offline facial recognition SDK.
+     *
      * @param request - DescribeVerifySDKRequest
      * @returns DescribeVerifySDKResponse
      */
     describeVerifySDK(request: $_model.DescribeVerifySDKRequest): Promise<$_model.DescribeVerifySDKResponse>;
     /**
+     * Call DescribeVerifyToken to initiate an authentication request and obtain an authentication Token. This interface is suitable for authentication solutions using SDK + server-side integration.
+     *
+     * @remarks
+     * Preparation for Access: When integrating this API, please ensure that the corresponding preparations have been completed. For details, see [Overview of Real Person Authentication Solution Integration Process](https://help.aliyun.com/document_detail/127536.html) and [Overview of Live Face Verification Solution (Liveness Detection Solution) Integration Process](https://help.aliyun.com/document_detail/127687.html).
+     * Request Method: HTTPS POST and GET
+     * API Description: Before each authentication, use this interface to obtain an authentication Token (VerifyToken), which is used to link various interfaces in the authentication request.
+     * Applicable Scope: This interface is suitable for wireless SDK integration.
+     * Image Address: Use HTTP or HTTPS addresses that are publicly accessible over the Internet. For example, `http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`.
+     * Image Restrictions:
+     * - Relative or absolute paths of local images are not supported.
+     * - The size of a single image should be controlled within 2 MB to avoid algorithm retrieval timeout.
+     * - The face area in the image must be at least 64*64 pixels (px).
+     * - There is an 8 MB size limit for the Body of a single request. Please calculate the total size of all images and other information in the request to ensure it does not exceed the limit.
+     *
      * @param request - DescribeVerifyTokenRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DescribeVerifyTokenResponse
      */
     describeVerifyTokenWithOptions(request: $_model.DescribeVerifyTokenRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeVerifyTokenResponse>;
     /**
+     * Call DescribeVerifyToken to initiate an authentication request and obtain an authentication Token. This interface is suitable for authentication solutions using SDK + server-side integration.
+     *
+     * @remarks
+     * Preparation for Access: When integrating this API, please ensure that the corresponding preparations have been completed. For details, see [Overview of Real Person Authentication Solution Integration Process](https://help.aliyun.com/document_detail/127536.html) and [Overview of Live Face Verification Solution (Liveness Detection Solution) Integration Process](https://help.aliyun.com/document_detail/127687.html).
+     * Request Method: HTTPS POST and GET
+     * API Description: Before each authentication, use this interface to obtain an authentication Token (VerifyToken), which is used to link various interfaces in the authentication request.
+     * Applicable Scope: This interface is suitable for wireless SDK integration.
+     * Image Address: Use HTTP or HTTPS addresses that are publicly accessible over the Internet. For example, `http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`.
+     * Image Restrictions:
+     * - Relative or absolute paths of local images are not supported.
+     * - The size of a single image should be controlled within 2 MB to avoid algorithm retrieval timeout.
+     * - The face area in the image must be at least 64*64 pixels (px).
+     * - There is an 8 MB size limit for the Body of a single request. Please calculate the total size of all images and other information in the request to ensure it does not exceed the limit.
+     *
      * @param request - DescribeVerifyTokenRequest
      * @returns DescribeVerifyTokenResponse
      */
     describeVerifyToken(request: $_model.DescribeVerifyTokenRequest): Promise<$_model.DescribeVerifyTokenResponse>;
     /**
+     * Detect Validity Attributes in Face Photos
+     *
+     * @remarks
+     * Request Method: Only supports sending requests via HTTPS POST.
+     * Interface Description: Detects the validity-related attributes of faces in the input photo, which helps the business side to determine whether the photo meets their own business retention or comparison requirements. The currently supported face validity-related attributes include: whether it is a face, whether it is blurry, whether glasses are worn, face pose, whether it is a smile, etc.
+     * Instructions for Uploading Image Addresses: When passing in images, you need to upload their corresponding HTTP, OSS addresses, or Base64 encoding.
+     * - HTTP Address: A publicly accessible HTTP address. For example, `http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`.
+     * - Base64 Encoding: An image encoded through base64, with the format being `base64://<image base64 string>`.
+     * Image Limitations:
+     * - Does not support relative or absolute paths of local images.
+     * - Please keep the size of a single image within 2 MB to avoid algorithm timeout.
+     * - There is an 8 MB size limit for the Body of a single request; please calculate the total size of all images and other information in the request and do not exceed the limit.
+     * - When using Base64 to pass images, the request method needs to be changed to POST; the header description of the image Base64 string, such as `data:image/png;base64`, should be removed.
+     *
      * @param request - DetectFaceAttributesRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DetectFaceAttributesResponse
      */
     detectFaceAttributesWithOptions(request: $_model.DetectFaceAttributesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DetectFaceAttributesResponse>;
     /**
+     * Detect Validity Attributes in Face Photos
+     *
+     * @remarks
+     * Request Method: Only supports sending requests via HTTPS POST.
+     * Interface Description: Detects the validity-related attributes of faces in the input photo, which helps the business side to determine whether the photo meets their own business retention or comparison requirements. The currently supported face validity-related attributes include: whether it is a face, whether it is blurry, whether glasses are worn, face pose, whether it is a smile, etc.
+     * Instructions for Uploading Image Addresses: When passing in images, you need to upload their corresponding HTTP, OSS addresses, or Base64 encoding.
+     * - HTTP Address: A publicly accessible HTTP address. For example, `http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`.
+     * - Base64 Encoding: An image encoded through base64, with the format being `base64://<image base64 string>`.
+     * Image Limitations:
+     * - Does not support relative or absolute paths of local images.
+     * - Please keep the size of a single image within 2 MB to avoid algorithm timeout.
+     * - There is an 8 MB size limit for the Body of a single request; please calculate the total size of all images and other information in the request and do not exceed the limit.
+     * - When using Base64 to pass images, the request method needs to be changed to POST; the header description of the image Base64 string, such as `data:image/png;base64`, should be removed.
+     *
      * @param request - DetectFaceAttributesRequest
      * @returns DetectFaceAttributesResponse
      */
@@ -495,6 +668,28 @@ export default class Client extends OpenApi {
      */
     id2MetaVerifyWithOCR(request: $_model.Id2MetaVerifyWithOCRRequest): Promise<$_model.Id2MetaVerifyWithOCRResponse>;
     id2MetaVerifyWithOCRAdvance(request: $_model.Id2MetaVerifyWithOCRAdvanceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.Id2MetaVerifyWithOCRResponse>;
+    /**
+     * Identity Three Elements Verification
+     *
+     * @remarks
+     * Input name, ID number, and face photo to verify their authenticity and consistency through authoritative sources.
+     *
+     * @param request - Id3MetaVerifyRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns Id3MetaVerifyResponse
+     */
+    id3MetaVerifyWithOptions(request: $_model.Id3MetaVerifyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.Id3MetaVerifyResponse>;
+    /**
+     * Identity Three Elements Verification
+     *
+     * @remarks
+     * Input name, ID number, and face photo to verify their authenticity and consistency through authoritative sources.
+     *
+     * @param request - Id3MetaVerifyRequest
+     * @returns Id3MetaVerifyResponse
+     */
+    id3MetaVerify(request: $_model.Id3MetaVerifyRequest): Promise<$_model.Id3MetaVerifyResponse>;
+    id3MetaVerifyAdvance(request: $_model.Id3MetaVerifyAdvanceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.Id3MetaVerifyResponse>;
     /**
      * Initiate an authentication request for image verification
      *
@@ -517,7 +712,19 @@ export default class Client extends OpenApi {
      */
     initCardVerify(request: $_model.InitCardVerifyRequest): Promise<$_model.InitCardVerifyResponse>;
     /**
-     * 实人服务端初始化接口
+     * Real-Person Server Initialization Interface
+     *
+     * @remarks
+     * - Service Address: cloudauth.aliyuncs.com
+     * - Request Method: HTTPS POST and GET.
+     * - This interface uses different parameters for different product solutions. For details, please refer to the [official documentation](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/product-overview/introduction/?spm=a2c4g.11186623.help-menu-2401581.d_0_0.13f644ecRzFHfm&scm=20140722.H_99169._.OR_help-T_cn~zh-V_1).
+     * #### Image Format Requirements
+     * When performing real-person authentication, please provide images that meet all of the following conditions:
+     * - Recent photo with a clear, unobstructed face, natural expression, and facing the camera directly.
+     * - Clear photo with normal exposure, no overexposure, underexposure, or halo effects, and no significant angle deviation.
+     * - Resolution not exceeding 1920*1080, at least 640*480, recommended short side scaled to 720 pixels, compression ratio greater than 0.9.
+     * - Photo size: <1MB.
+     * - Supports 90, 180, and 270-degree photos; in the case of multiple faces, the largest face will be selected.
      *
      * @param request - InitFaceVerifyRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -525,7 +732,19 @@ export default class Client extends OpenApi {
      */
     initFaceVerifyWithOptions(request: $_model.InitFaceVerifyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.InitFaceVerifyResponse>;
     /**
-     * 实人服务端初始化接口
+     * Real-Person Server Initialization Interface
+     *
+     * @remarks
+     * - Service Address: cloudauth.aliyuncs.com
+     * - Request Method: HTTPS POST and GET.
+     * - This interface uses different parameters for different product solutions. For details, please refer to the [official documentation](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/product-overview/introduction/?spm=a2c4g.11186623.help-menu-2401581.d_0_0.13f644ecRzFHfm&scm=20140722.H_99169._.OR_help-T_cn~zh-V_1).
+     * #### Image Format Requirements
+     * When performing real-person authentication, please provide images that meet all of the following conditions:
+     * - Recent photo with a clear, unobstructed face, natural expression, and facing the camera directly.
+     * - Clear photo with normal exposure, no overexposure, underexposure, or halo effects, and no significant angle deviation.
+     * - Resolution not exceeding 1920*1080, at least 640*480, recommended short side scaled to 720 pixels, compression ratio greater than 0.9.
+     * - Photo size: <1MB.
+     * - Supports 90, 180, and 270-degree photos; in the case of multiple faces, the largest face will be selected.
      *
      * @param request - InitFaceVerifyRequest
      * @returns InitFaceVerifyResponse
@@ -547,12 +766,22 @@ export default class Client extends OpenApi {
      */
     insertWhiteListSetting(request: $_model.InsertWhiteListSettingRequest): Promise<$_model.InsertWhiteListSettingResponse>;
     /**
+     * Silent Liveness Face (LivenessFaceVerify) refers to a service that performs real face detection by inputting pre-obtained face images through an API. The algorithm primarily identifies whether the face is from a screen recording, printed picture, or other types of liveness attacks. This service is suitable for low-risk business scenarios or in conjunction with offline facial recognition SDKs. If your business has higher requirements for real face security, it is recommended to integrate App or WebSDK mode, or integrate with Deepfake face detection services to assist in identifying more dimensions of face forgery risks.
+     *
+     * @remarks
+     * Invoke the LivenessFaceVerify interface to perform liveness detection on a face image.
+     *
      * @param request - LivenessFaceVerifyRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns LivenessFaceVerifyResponse
      */
     livenessFaceVerifyWithOptions(request: $_model.LivenessFaceVerifyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.LivenessFaceVerifyResponse>;
     /**
+     * Silent Liveness Face (LivenessFaceVerify) refers to a service that performs real face detection by inputting pre-obtained face images through an API. The algorithm primarily identifies whether the face is from a screen recording, printed picture, or other types of liveness attacks. This service is suitable for low-risk business scenarios or in conjunction with offline facial recognition SDKs. If your business has higher requirements for real face security, it is recommended to integrate App or WebSDK mode, or integrate with Deepfake face detection services to assist in identifying more dimensions of face forgery risks.
+     *
+     * @remarks
+     * Invoke the LivenessFaceVerify interface to perform liveness detection on a face image.
+     *
      * @param request - LivenessFaceVerifyRequest
      * @returns LivenessFaceVerifyResponse
      */
@@ -872,12 +1101,44 @@ export default class Client extends OpenApi {
      */
     vehicleQuery(request: $_model.VehicleQueryRequest): Promise<$_model.VehicleQueryResponse>;
     /**
+     * Call VerifyMaterial, in a pure server-side access authentication solution, input name, ID number, portrait photo, and front and back photos of the ID card (optional) for real-person authentication, and return the authentication result synchronously.
+     *
+     * @remarks
+     * Preparation for Access: When integrating this API, please ensure that the corresponding preparatory work has been completed. For details, please refer to [Server-side Access Preparation](https://help.aliyun.com/document_detail/127471.html).
+     * Request Method: HTTPS POST and GET.
+     * API Description: The server of the access party submits the authentication materials to the real-person authentication service for verification and comparison, with the results returned synchronously.
+     * Applicable Scope: This interface is only applicable to pure server-side access authentication solutions.
+     * Image Upload Address Explanation:
+     * - HTTP or HTTPS address: Supports publicly accessible HTTP or HTTPS addresses. For example, `http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`.
+     * - OSS address: If the images from the access party are local files, Alibaba Cloud also provides an upload SDK, supporting the business party to upload the images to the specified OSS bucket of the real-person authentication service, and use the obtained OSS address as the image address parameter in the interface. If your business needs to use the upload SDK, please submit a [ticket](https://selfservice.console.aliyun.com/ticket/category/cloudauth/today) to contact us for acquisition.
+     * Image Limitations:
+     * - Does not support relative or absolute paths of local images.
+     * - Please keep the size of a single image within 2 MB to avoid algorithm retrieval timeout.
+     * - The face area in the image should be at least 64*64 pixels.
+     * - There is an 8 MB size limit for the Body of a single request. Please calculate the total size of all images and other information in the request, and do not exceed the limit.
+     *
      * @param request - VerifyMaterialRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns VerifyMaterialResponse
      */
     verifyMaterialWithOptions(request: $_model.VerifyMaterialRequest, runtime: $dara.RuntimeOptions): Promise<$_model.VerifyMaterialResponse>;
     /**
+     * Call VerifyMaterial, in a pure server-side access authentication solution, input name, ID number, portrait photo, and front and back photos of the ID card (optional) for real-person authentication, and return the authentication result synchronously.
+     *
+     * @remarks
+     * Preparation for Access: When integrating this API, please ensure that the corresponding preparatory work has been completed. For details, please refer to [Server-side Access Preparation](https://help.aliyun.com/document_detail/127471.html).
+     * Request Method: HTTPS POST and GET.
+     * API Description: The server of the access party submits the authentication materials to the real-person authentication service for verification and comparison, with the results returned synchronously.
+     * Applicable Scope: This interface is only applicable to pure server-side access authentication solutions.
+     * Image Upload Address Explanation:
+     * - HTTP or HTTPS address: Supports publicly accessible HTTP or HTTPS addresses. For example, `http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg`.
+     * - OSS address: If the images from the access party are local files, Alibaba Cloud also provides an upload SDK, supporting the business party to upload the images to the specified OSS bucket of the real-person authentication service, and use the obtained OSS address as the image address parameter in the interface. If your business needs to use the upload SDK, please submit a [ticket](https://selfservice.console.aliyun.com/ticket/category/cloudauth/today) to contact us for acquisition.
+     * Image Limitations:
+     * - Does not support relative or absolute paths of local images.
+     * - Please keep the size of a single image within 2 MB to avoid algorithm retrieval timeout.
+     * - The face area in the image should be at least 64*64 pixels.
+     * - There is an 8 MB size limit for the Body of a single request. Please calculate the total size of all images and other information in the request, and do not exceed the limit.
+     *
      * @param request - VerifyMaterialRequest
      * @returns VerifyMaterialResponse
      */