@alicloud/cloudauth20190307 3.14.0 → 3.14.2

package/src/models/InitCardVerifyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class InitCardVerifyRequest extends $dara.Model {
   /**
    * @remarks
-   * The security token used for anti-replay and anti-tampering verification. If you specify this parameter, the CallbackToken field is included in the callback URL.
+   * The security token used for anti-replay and anti-tampering verification. If you specify this parameter, the CallbackToken field is displayed in the callback URL.
    * 
    * @example
    * NMjvQanQgplBSaEI0sL86WnQplB
@@ -13,9 +13,8 @@ export class InitCardVerifyRequest extends $dara.Model {
   callbackToken?: string;
   /**
    * @remarks
-   * The callback URL for authentication results. The URL must start with https. After the authentication is complete, the system sends a callback to this URL with the certifyId and passed fields automatically appended. Example: https://www.aliyun.com?certifyId=xxxx&passed=T
-   * 
-   * > **Warning** The callback is triggered only when the authentication is complete. No notification is sent if the authentication is abandoned, interrupted, or not performed. After you receive the callback notification, call the query operation to obtain the authentication details if needed.
+   * The callback URL for authentication results. The URL must start with https. After the authentication is completed, the platform calls back this URL and automatically adds the certifyId and passed fields. Example: https://www.aliyun.com?certifyId=xxxx&passed=T.
+   * Warning: The callback is triggered only when the authentication is completed. If the authentication is abandoned, abnormally interrupted, or not performed, no notification is sent. When you receive the callback notification, call the query API to obtain the authentication details if needed.
    * 
    * @example
    * https://www.aliyun.com
@@ -23,11 +22,10 @@ export class InitCardVerifyRequest extends $dara.Model {
   callbackUrl?: string;
   /**
    * @remarks
-   * The number of card pages to be collected by the SDK. Valid values:
-   * - 1: collects the front side only.
-   * - 2: collects both the front and back sides.
-   * 
-   * - If the verification type is ID card validity period (VerifyMeta is set to ID_PERIOD), set this parameter to 2.
+   * The number of pages of the ID document collected by the SDK. Valid values:
+   * - 1: collects the front side.
+   * - 2: collects the front and back sides.
+   * If the verification type is the validity period of the ID document (VerifyMeta is set to ID_PERIOD), you must set this parameter to 2.
    * 
    * This parameter is required.
    * 
@@ -37,8 +35,8 @@ export class InitCardVerifyRequest extends $dara.Model {
   cardPageNumber?: string;
   /**
    * @remarks
-   * The document type. Valid values:
-   * - IDENTITY_CARD: resident identity card.
+   * The type of the ID document. Valid values:
+   * - IDENTITY_CARD: second-generation resident ID card.
    * 
    * This parameter is required.
    * 
@@ -48,9 +46,9 @@ export class InitCardVerifyRequest extends $dara.Model {
   cardType?: string;
   /**
    * @remarks
-   * The photo capture mode (manual or automatic). Valid values:
-   * - shoot: manual capture
-   * - scan: scan mode 
+   * The photo capture mode. Valid values:
+   * - shoot: photo capture.
+   * - scan: scanning.
    * - auto: automatic switchover.
    * 
    * @example
@@ -59,7 +57,7 @@ export class InitCardVerifyRequest extends $dara.Model {
   docScanMode?: string;
   /**
    * @remarks
-   * A custom business unique identifier that you define for subsequent troubleshooting. The value is a combination of letters and digits up to 32 characters in length. Make sure the value is unique.
+   * The custom unique business identifier used for subsequent troubleshooting. The value must be a unique combination of up to 32 letters and digits.
    * 
    * This parameter is required.
    * 
@@ -69,7 +67,7 @@ export class InitCardVerifyRequest extends $dara.Model {
   merchantBizId?: string;
   /**
    * @remarks
-   * The MetaInfo environment parameter. Obtain this value by using the client SDK.
+   * The MetaInfo environment parameter, which must be obtained by using the client SDK.
    * 
    * This parameter is required.
    * 
@@ -79,7 +77,7 @@ export class InitCardVerifyRequest extends $dara.Model {
   metaInfo?: string;
   /**
    * @remarks
-   * The verification mode. Valid values:
+   * The verification method. Valid values:
    * - OCR_VERIFY: OCR recognition and authentication mode.
    * 
    * This parameter is required.
@@ -90,10 +88,9 @@ export class InitCardVerifyRequest extends $dara.Model {
   model?: string;
   /**
    * @remarks
-   * Specifies whether to temporarily store images collected by the app. Valid values:
-   * - Y: Yes.
-   * - N: No.
-   * - If you set this parameter to Y, the query operation returns card image information.
+   * Specifies whether to temporarily store the image information collected by the app. Valid values:
+   * - Y: yes. If you select this value, the query API can return the image information of the ID document.
+   * - N: no.
    * 
    * This parameter is required.
    * 
@@ -104,7 +101,7 @@ export class InitCardVerifyRequest extends $dara.Model {
   /**
    * @remarks
    * The verification type. Valid values:
-   * - ID_2_META: two-factor identity verification (name + ID card number).
+   * - ID_2_META: two identity elements (name and ID number).
    * 
    * This parameter is required.
    * 

package/src/models/InitCardVerifyResponseBody.ts

@@ -5,10 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class InitCardVerifyResponseBodyResultObject extends $dara.Model {
   /**
    * @remarks
-   * The verification request ID, which is the unique identifier of the verification service authentication request.
-   * - You must specify the authentication request ID when you query the authentication result.
-   * 
-   * - The CertifyId field is used for billing statistics. Save this field locally for future bill reconciliation. The CertifyId returned by the initialization operation is valid for 30 minutes and can be submitted for authentication only once. Use it within the validity period and do not reuse it.
+   * The verification request ID, which is the unique identifier of the authentication request in the verification service.
+   * - When you query the authentication result, you must specify the authentication request ID.
+   * - The CertifyId field is used for billing statistics. To facilitate subsequent bill reconciliation, store the field information locally. The CertifyId returned by the initialization API is valid for 30 minutes and can be submitted for authentication only once. Use it within the validity period to avoid repeated use.
    * 
    * @example
    * 91707dc296d469ad38e4c5efa6a0****
@@ -38,9 +37,10 @@ export class InitCardVerifyResponseBodyResultObject extends $dara.Model {
 export class InitCardVerifyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response code. A value of 200 indicates success. Other values indicate failure.
-   * 
-   * > **Important** This parameter indicates whether the operation is called correctly. For more information about return codes, see error codes. Check the fields in ResultObject for the business result.
+   * The return code. A value of 200 indicates success, and other values indicate failure.
+   * Important:
+   * - This parameter indicates whether the API is called successfully. For more information about return codes, see Error codes.
+   * - To view the business result, check the fields in ResultObject.
    * 
    * @example
    * 200
@@ -48,7 +48,7 @@ export class InitCardVerifyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response message.
+   * The returned message.
    * 
    * @example
    * success