@alicloud/cloudauth20190307 3.13.3 → 3.13.4

package/dist/models/Id3metaVerifyRequest.d.ts

@@ -2,13 +2,13 @@ import * as $dara from '@darabonba/typescript';
 export declare class Id3MetaVerifyRequest extends $dara.Model {
     /**
      * @remarks
-     * Whether to allow cropping of the face image, default is not allowed.
-     * - T: Allow cropping.
-     * - F: Do not allow cropping.
+     * Specifies whether to allow cropping of the facial photo. By default, cropping is not allowed. Valid values:
+     * - T: Cropping is allowed.
+     * - F: Cropping is not allowed.
      *
      * **Note**
      *
-     * If the image you request is not collected from a standard liveness detection SDK, it is recommended to allow cropping of the face image. After enabling this feature, the system will first crop and correct the requested image, then initiate the service request.
+     * If the requested image is not captured by a standard liveness detection SDK, allow cropping of the facial photo. After this feature is enabled, the requested image is first cropped and corrected for the face before the request is sent to the service.
      *
      * @example
      * T
@@ -16,8 +16,7 @@ export declare class Id3MetaVerifyRequest extends $dara.Model {
     crop?: string;
     /**
      * @remarks
-     * Portrait side of the ID card image input stream.
-     * Choose one between `CertUrl` and `CertFile`.
+     * The input stream of the ID card portrait side photo. Specify either CertUrl or CertFile.
      *
      * @example
      * 无
@@ -30,9 +29,7 @@ export declare class Id3MetaVerifyRequest extends $dara.Model {
     facePicture?: string;
     /**
      * @remarks
-     * Portrait side of the ID card image.
-     * Accessible HTTP or HTTPS link on the public network.
-     * Choose one between `CertUrl` and `CertFile`.
+     * The photo of the ID card portrait side. Specify a publicly accessible HTTP or HTTPS URL. Specify either CertUrl or CertFile.
      *
      * @example
      * https://www.aliyun.com/cert.jpeg
@@ -40,10 +37,9 @@ export declare class Id3MetaVerifyRequest extends $dara.Model {
     faceUrl?: string;
     /**
      * @remarks
-     * ID number:
-     * - When `paramType` is `normal`: enter the plaintext ID number.
-     * - When `paramType` is `md5`:
-     * The first 6 digits (plaintext) + date of birth (ciphertext) + last 4 digits (plaintext).
+     * The ID card number:
+     * - If paramType is set to normal: enter the ID card number in plaintext.
+     * - If paramType is set to md5: the first 6 digits of the ID card number (plaintext) + date of birth (ciphertext) + the last 4 digits of the ID card number (plaintext).
      *
      * @example
      * ● 明文：429001********8211
@@ -53,14 +49,14 @@ export declare class Id3MetaVerifyRequest extends $dara.Model {
     identifyNum?: string;
     /**
      * @remarks
-     * Encryption method:
+     * The encryption method. Valid values:
      * - normal: plaintext without encryption
      * - md5: MD5 encryption
      *
      * **Important**
      *
-     * - All encrypted parameters should be in the form of a 32-character lowercase MD5 string.
-     * - The ciphertext generated by different MD5 tools may vary. If the interface works before encryption but not after, try changing the MD5 tool.
+     * - All encrypted parameter values use 32-character lowercase MD5 strings.
+     * - Different MD5 tools may produce different ciphertext. If the API call succeeds with plaintext but fails after encryption, try a different MD5 tool.
      *
      * @example
      * normal
@@ -68,9 +64,9 @@ export declare class Id3MetaVerifyRequest extends $dara.Model {
     paramType?: string;
     /**
      * @remarks
-     * Name:
-     * - When `paramType` is `normal`: enter the plaintext name.
-     * - When `paramType` is `md5`: the first character of the name (ciphertext) + the rest of the name (plaintext).
+     * The name:
+     * - If paramType is set to normal: enter the name in plaintext.
+     * - If paramType is set to md5: the first character of the name (ciphertext) + the remaining characters of the name (plaintext).
      *
      * @example
      * ● 明文：张三

package/dist/models/Id3metaVerifyRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"Id3metaVerifyRequest.js","sourceRoot":"","sources":["../../src/models/Id3metaVerifyRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,oBAAqB,SAAQ,KAAK,CAAC,KAAK;IA+EnD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,UAAU;YACpB,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,SAAS;YAClB,WAAW,EAAE,aAAa;YAC1B,SAAS,EAAE,WAAW;YACtB,QAAQ,EAAE,UAAU;SACrB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,QAAQ;YAClB,WAAW,EAAE,QAAQ;YACrB,OAAO,EAAE,QAAQ;YACjB,WAAW,EAAE,QAAQ;YACrB,SAAS,EAAE,QAAQ;YACnB,QAAQ,EAAE,QAAQ;SACnB,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;AA9GD,oDA8GC"}
+{"version":3,"file":"Id3metaVerifyRequest.js","sourceRoot":"","sources":["../../src/models/Id3metaVerifyRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,oBAAqB,SAAQ,KAAK,CAAC,KAAK;IA2EnD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,UAAU;YACpB,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,SAAS;YAClB,WAAW,EAAE,aAAa;YAC1B,SAAS,EAAE,WAAW;YACtB,QAAQ,EAAE,UAAU;SACrB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,QAAQ;YAClB,WAAW,EAAE,QAAQ;YACrB,OAAO,EAAE,QAAQ;YACjB,WAAW,EAAE,QAAQ;YACrB,SAAS,EAAE,QAAQ;YACnB,QAAQ,EAAE,QAAQ;SACnB,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;AA1GD,oDA0GC"}

package/dist/models/Id3metaVerifyResponseBody.d.ts

@@ -2,11 +2,11 @@ import * as $dara from '@darabonba/typescript';
 export declare class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
     /**
      * @remarks
-     * Identity verification result:
+     * The identity verification result. Valid values:
      *
-     * - 1: Consistent
-     * - 2: Inconsistent
-     * - 3: No record found
+     * - 1: Consistent.
+     * - 2: Inconsistent.
+     * - 3: No record found.
      *
      * @example
      * 1
@@ -14,7 +14,7 @@ export declare class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
     bizCode?: string;
     /**
      * @remarks
-     * Image comparison score.
+     * The face comparison score.
      *
      * @example
      * {
@@ -22,6 +22,11 @@ export declare class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
      * }
      */
     faceDetail?: string;
+    /**
+     * @example
+     * 101
+     */
+    subCode?: string;
     static names(): {
         [key: string]: string;
     };
@@ -36,10 +41,12 @@ export declare class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
 export declare class Id3MetaVerifyResponseBody extends $dara.Model {
     /**
      * @remarks
-     * Return code: 200 indicates success, others indicate failure.
+     * The response code. A value of 200 indicates success. Other values indicate failure.
+     *
      * **Important**
-     * - This parameter indicates whether the interface was called correctly. For detailed return code explanations, please refer to the error codes.
-     * - Check the business verification result through the fields in `ResultObject`.
+     *
+     * - This parameter indicates only whether the API call is successful. For more information about return codes, see error codes.
+     * - Check the fields in ResultObject for the business verification result.
      *
      * @example
      * 200
@@ -47,11 +54,11 @@ export declare class Id3MetaVerifyResponseBody extends $dara.Model {
     code?: string;
     /**
      * @remarks
-     * Interface call return message.
+     * The response message of the API call.
      *
      * **Important**
      *
-     * This parameter only indicates whether there was an exception with the interface.
+     * This parameter indicates only whether the API call is abnormal.
      *
      * @example
      * success
@@ -59,7 +66,7 @@ export declare class Id3MetaVerifyResponseBody extends $dara.Model {
     message?: string;
     /**
      * @remarks
-     * Request ID.
+     * The request ID.
      *
      * @example
      * 130A2C10-B9EE-4D84-88E3-5384FF03****
@@ -67,7 +74,7 @@ export declare class Id3MetaVerifyResponseBody extends $dara.Model {
     requestId?: string;
     /**
      * @remarks
-     * Result object.
+     * The result object.
      */
     resultObject?: Id3MetaVerifyResponseBodyResultObject;
     static names(): {

package/dist/models/Id3metaVerifyResponseBody.js

@@ -41,12 +41,14 @@ class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
         return {
             bizCode: 'BizCode',
             faceDetail: 'FaceDetail',
+            subCode: 'SubCode',
         };
     }
     static types() {
         return {
             bizCode: 'string',
             faceDetail: 'string',
+            subCode: 'string',
         };
     }
     validate() {

package/dist/models/Id3metaVerifyResponseBody.js.map

@@ -1 +1 @@
-{"version":3,"file":"Id3metaVerifyResponseBody.js","sourceRoot":"","sources":["../../src/models/Id3metaVerifyResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,qCAAsC,SAAQ,KAAK,CAAC,KAAK;IAuBpE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,YAAY;SACzB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,OAAO,EAAE,QAAQ;YACjB,UAAU,EAAE,QAAQ;SACrB,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;AA5CD,sFA4CC;AAED,MAAa,yBAA0B,SAAQ,KAAK,CAAC,KAAK;IAqCxD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,WAAW;YACtB,YAAY,EAAE,cAAc;SAC7B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,QAAQ;YACnB,YAAY,EAAE,qCAAqC;SACpD,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,IAAI,CAAC,YAAY,IAAI,OAAQ,IAAI,CAAC,YAAoB,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACjF,IAAI,CAAC,YAAoB,CAAC,QAAQ,EAAE,CAAC;QACxC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAjED,8DAiEC"}
+{"version":3,"file":"Id3metaVerifyResponseBody.js","sourceRoot":"","sources":["../../src/models/Id3metaVerifyResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,qCAAsC,SAAQ,KAAK,CAAC,KAAK;IA4BpE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,YAAY;YACxB,OAAO,EAAE,SAAS;SACnB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,OAAO,EAAE,QAAQ;YACjB,UAAU,EAAE,QAAQ;YACpB,OAAO,EAAE,QAAQ;SAClB,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;AAnDD,sFAmDC;AAED,MAAa,yBAA0B,SAAQ,KAAK,CAAC,KAAK;IAuCxD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,WAAW;YACtB,YAAY,EAAE,cAAc;SAC7B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,QAAQ;YACnB,YAAY,EAAE,qCAAqC;SACpD,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,IAAI,CAAC,YAAY,IAAI,OAAQ,IAAI,CAAC,YAAoB,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACjF,IAAI,CAAC,YAAoB,CAAC,QAAQ,EAAE,CAAC;QACxC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAnED,8DAmEC"}

package/dist/models/Id3metaVerifyWithOcradvanceRequest.d.ts

@@ -3,7 +3,7 @@ import * as $dara from '@darabonba/typescript';
 export declare class Id3MetaVerifyWithOCRAdvanceRequest extends $dara.Model {
     /**
      * @remarks
-     * Input stream for the portrait side of the ID card image. Choose either CertUrl or CertFile.
+     * The input stream of the portrait side image of the ID card. Specify either CertUrl or CertFile.
      *
      * @example
      * 无
@@ -11,7 +11,7 @@ export declare class Id3MetaVerifyWithOCRAdvanceRequest extends $dara.Model {
     certFileObject?: Readable;
     /**
      * @remarks
-     * URL for the national emblem side of the ID card image. Choose either CertNationalUrl or CertNationalFile, or omit both.
+     * The image of the national emblem side of the ID card. Specify either CertNationalUrl or CertNationalFile, or leave both empty.
      *
      * @example
      * 无
@@ -19,7 +19,7 @@ export declare class Id3MetaVerifyWithOCRAdvanceRequest extends $dara.Model {
     certNationalFileObject?: Readable;
     /**
      * @remarks
-     * National emblem side of the ID card image URL. A publicly accessible HTTP or HTTPS link. You can choose either CertNationalUrl or CertNationalFile, or omit both.
+     * The URL of the national emblem side image of the ID card. Specify a publicly accessible HTTP or HTTPS URL. Specify either CertNationalUrl or CertNationalFile, or leave both empty.
      *
      * @example
      * https://www.aliyun.com/cert.jpeg
@@ -27,7 +27,7 @@ export declare class Id3MetaVerifyWithOCRAdvanceRequest extends $dara.Model {
     certNationalUrl?: string;
     /**
      * @remarks
-     * Portrait side of the ID card image. A publicly accessible HTTP or HTTPS link. Choose either CertUrl or CertFile.
+     * The image of the portrait side of the ID card. Specify a publicly accessible HTTP or HTTPS URL. Specify either CertUrl or CertFile.
      *
      * @example
      * https://www.aliyun.com/cert.jpeg

package/dist/models/Id3metaVerifyWithOcrrequest.d.ts

@@ -2,7 +2,7 @@ import * as $dara from '@darabonba/typescript';
 export declare class Id3MetaVerifyWithOCRRequest extends $dara.Model {
     /**
      * @remarks
-     * Input stream for the portrait side of the ID card image. Choose either CertUrl or CertFile.
+     * The input stream of the portrait side image of the ID card. Specify either CertUrl or CertFile.
      *
      * @example
      * 无
@@ -10,7 +10,7 @@ export declare class Id3MetaVerifyWithOCRRequest extends $dara.Model {
     certFile?: string;
     /**
      * @remarks
-     * URL for the national emblem side of the ID card image. Choose either CertNationalUrl or CertNationalFile, or omit both.
+     * The image of the national emblem side of the ID card. Specify either CertNationalUrl or CertNationalFile, or leave both empty.
      *
      * @example
      * 无
@@ -18,7 +18,7 @@ export declare class Id3MetaVerifyWithOCRRequest extends $dara.Model {
     certNationalFile?: string;
     /**
      * @remarks
-     * National emblem side of the ID card image URL. A publicly accessible HTTP or HTTPS link. You can choose either CertNationalUrl or CertNationalFile, or omit both.
+     * The URL of the national emblem side image of the ID card. Specify a publicly accessible HTTP or HTTPS URL. Specify either CertNationalUrl or CertNationalFile, or leave both empty.
      *
      * @example
      * https://www.aliyun.com/cert.jpeg
@@ -26,7 +26,7 @@ export declare class Id3MetaVerifyWithOCRRequest extends $dara.Model {
     certNationalUrl?: string;
     /**
      * @remarks
-     * Portrait side of the ID card image. A publicly accessible HTTP or HTTPS link. Choose either CertUrl or CertFile.
+     * The image of the portrait side of the ID card. Specify a publicly accessible HTTP or HTTPS URL. Specify either CertUrl or CertFile.
      *
      * @example
      * https://www.aliyun.com/cert.jpeg

package/dist/models/Id3metaVerifyWithOcrresponseBody.d.ts

@@ -2,11 +2,11 @@ import * as $dara from '@darabonba/typescript';
 export declare class Id3MetaVerifyWithOCRResponseBodyResultObject extends $dara.Model {
     /**
      * @remarks
-     * Identity verification result:
+     * The identity verification result. Valid values:
      *
-     * - 1: Consistent
-     * - 2: Inconsistent
-     * - 3: No record found
+     * - 1: consistent.
+     * - 2: inconsistent.
+     * - 3: no record found.
      *
      * @example
      * 1
@@ -14,15 +14,15 @@ export declare class Id3MetaVerifyWithOCRResponseBodyResultObject extends $dara.
     bizCode?: string;
     /**
      * @remarks
-     * Card ocr result.
+     * {"address":"浙江省杭州市余*****","birthDate":"19901226","certName":"张三","certNo":"1234561990122*****","nationality":"汉","authority":"xxx公安局","startDate":"20201130","endDate":"20301130"}.
      *
      * @example
-     * {"address":"浙江省杭州市余*****","birthDate":"19901226","certName":"张三","certNo":"1234561990122*****","nationality":"汉","authority":"xxx公安局","startDate":"20201130","endDate":"20301130"}
+     * OCR读取的身份证信息。
      */
     cardInfo?: string;
     /**
      * @remarks
-     * Face comparison score.
+     * The face comparison score.
      *
      * @example
      * {
@@ -44,10 +44,10 @@ export declare class Id3MetaVerifyWithOCRResponseBodyResultObject extends $dara.
 export declare class Id3MetaVerifyWithOCRResponseBody extends $dara.Model {
     /**
      * @remarks
-     * Return code: 200 indicates success, any other value indicates failure. **Important**
+     * The response code. 200 indicates success. Other values indicate failure. **Important**
      *
-     * - This parameter indicates whether the interface was called correctly. For a detailed explanation of return codes, please refer to the error codes.
-     * - The business verification result can be viewed through the fields in ResultObject.
+     * - This parameter indicates only whether the API call was made correctly. For more information about return codes, see error codes.
+     * - Check the fields in ResultObject for the business verification result.
      *
      * @example
      * 200
@@ -55,7 +55,7 @@ export declare class Id3MetaVerifyWithOCRResponseBody extends $dara.Model {
     code?: string;
     /**
      * @remarks
-     * Interface call return message. **Important** This parameter only indicates whether there was an exception with the interface.
+     * The response message of the API call. This parameter indicates only whether an exception occurred during the API call.
      *
      * @example
      * success
@@ -63,7 +63,7 @@ export declare class Id3MetaVerifyWithOCRResponseBody extends $dara.Model {
     message?: string;
     /**
      * @remarks
-     * Request ID.
+     * The request ID.
      *
      * @example
      * 130A2C10-B9EE-4D84-88E3-5384FF03****
@@ -71,7 +71,7 @@ export declare class Id3MetaVerifyWithOCRResponseBody extends $dara.Model {
     requestId?: string;
     /**
      * @remarks
-     * Result object.
+     * The result object.
      */
     resultObject?: Id3MetaVerifyWithOCRResponseBodyResultObject;
     static names(): {

package/dist/models/InitAuthVerifyRequest.d.ts

@@ -1,17 +1,31 @@
 import * as $dara from '@darabonba/typescript';
 export declare class InitAuthVerifyRequest extends $dara.Model {
     /**
+     * @remarks
+     * A security token that you generate to prevent replay attacks and data tampering.
+     * If this value is set, the CallbackToken field is included in the callback to CallbackUrl.
+     *
      * @example
      * NMjvQanQgplBSaEI0sL86WnQplB
      */
     callbackToken?: string;
     /**
+     * @remarks
+     * The callback URL for OCR results. The callback request method is GET by default. The callback URL must start with https. After OCR is completed, a callback is sent to this URL with the certifyId and subcode fields automatically appended.
+     * > Warning
+     * - The URL is validated for public network access before the API is invoked. If the URL is not publicly accessible, a 400 error is returned.
+     * - The callback is executed immediately after the OCR invocation is completed, but may be delayed due to network issues. Accept the request completion notification from the client side first, and then invoke the query API to obtain the result details.
+     *
      * @example
      * https://www.aliyun.com?callbackToken=100000****&certifyId=shaxxxx&subCode=200
      */
     callbackUrl?: string;
     /**
      * @remarks
+     * The number of card pages collected by the SDK. Valid values:
+     * - "1": front side only
+     * - "2": both front and back sides.
+     *
      * This parameter is required.
      *
      * @example
@@ -20,6 +34,8 @@ export declare class InitAuthVerifyRequest extends $dara.Model {
     cardPageNumber?: string;
     /**
      * @remarks
+     * The document type. Set the value to IDENTITY_CARD.
+     *
      * This parameter is required.
      *
      * @example
@@ -27,17 +43,30 @@ export declare class InitAuthVerifyRequest extends $dara.Model {
      */
     cardType?: string;
     /**
+     * @remarks
+     * The OCR document scan pattern. Valid values:
+     * - shoot (default): photo capture
+     * - scan: scan
+     * - auto: automatic switchover between photo capture and scan.
+     *
      * @example
      * shoot
      */
     docScanMode?: string;
     /**
+     * @remarks
+     * Specifies whether to enable the document anti-forgery detection feature. Valid values:
+     * - Y: Enabled.
+     * - N: Disabled. This is the default value.
+     *
      * @example
      * Y
      */
     idSpoof?: string;
     /**
      * @remarks
+     * The MetaInfo environment parameter, which must be obtained from the client SDK.
+     *
      * This parameter is required.
      *
      * @example
@@ -55,6 +84,10 @@ export declare class InitAuthVerifyRequest extends $dara.Model {
     metaInfo?: string;
     /**
      * @remarks
+     * A custom business unique identifier that you specify for subsequent troubleshooting.
+     *
+     * The value can contain letters (both uppercase and lowercase) and digits, with a maximum length of 32 characters.
+     *
      * This parameter is required.
      *
      * @example
@@ -63,6 +96,8 @@ export declare class InitAuthVerifyRequest extends $dara.Model {
     outerOrderNo?: string;
     /**
      * @remarks
+     * The product solution to use. Set the value to ID_OCR.
+     *
      * This parameter is required.
      *
      * @example
@@ -71,6 +106,8 @@ export declare class InitAuthVerifyRequest extends $dara.Model {
     productCode?: string;
     /**
      * @remarks
+     * The China Chinese authentication scenario ID.
+     *
      * This parameter is required.
      *
      * @example

package/dist/models/InitAuthVerifyRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"InitAuthVerifyRequest.js","sourceRoot":"","sources":["../../src/models/InitAuthVerifyRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,qBAAsB,SAAQ,KAAK,CAAC,KAAK;IA8EpD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,aAAa,EAAE,eAAe;YAC9B,WAAW,EAAE,aAAa;YAC1B,cAAc,EAAE,gBAAgB;YAChC,QAAQ,EAAE,UAAU;YACpB,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,UAAU;YACpB,YAAY,EAAE,cAAc;YAC5B,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,SAAS;SACnB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,aAAa,EAAE,QAAQ;YACvB,WAAW,EAAE,QAAQ;YACrB,cAAc,EAAE,QAAQ;YACxB,QAAQ,EAAE,QAAQ;YAClB,WAAW,EAAE,QAAQ;YACrB,OAAO,EAAE,QAAQ;YACjB,QAAQ,EAAE,QAAQ;YAClB,YAAY,EAAE,QAAQ;YACtB,WAAW,EAAE,QAAQ;YACrB,OAAO,EAAE,QAAQ;SAClB,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;AAnHD,sDAmHC"}
+{"version":3,"file":"InitAuthVerifyRequest.js","sourceRoot":"","sources":["../../src/models/InitAuthVerifyRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,qBAAsB,SAAQ,KAAK,CAAC,KAAK;IAmHpD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,aAAa,EAAE,eAAe;YAC9B,WAAW,EAAE,aAAa;YAC1B,cAAc,EAAE,gBAAgB;YAChC,QAAQ,EAAE,UAAU;YACpB,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,UAAU;YACpB,YAAY,EAAE,cAAc;YAC5B,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,SAAS;SACnB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,aAAa,EAAE,QAAQ;YACvB,WAAW,EAAE,QAAQ;YACrB,cAAc,EAAE,QAAQ;YACxB,QAAQ,EAAE,QAAQ;YAClB,WAAW,EAAE,QAAQ;YACrB,OAAO,EAAE,QAAQ;YACjB,QAAQ,EAAE,QAAQ;YAClB,YAAY,EAAE,QAAQ;YACtB,WAAW,EAAE,QAAQ;YACrB,OAAO,EAAE,QAAQ;SAClB,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;AAxJD,sDAwJC"}

package/dist/models/InitAuthVerifyResponseBody.d.ts

@@ -1,6 +1,10 @@
 import * as $dara from '@darabonba/typescript';
 export declare class InitAuthVerifyResponseBodyResult extends $dara.Model {
     /**
+     * @remarks
+     * The verification request ID, which is the unique identifier of the verification service authentication request.
+     * You must pass in the verification request ID when querying the authentication result.
+     *
      * @example
      * shif9d1a185b8dde7cd07bf0943a448b
      */
@@ -18,20 +22,33 @@ export declare class InitAuthVerifyResponseBodyResult extends $dara.Model {
 }
 export declare class InitAuthVerifyResponseBody extends $dara.Model {
     /**
+     * @remarks
+     * The response code.
+     *
      * @example
      * Success
      */
     code?: string;
     /**
+     * @remarks
+     * The response message.
+     *
      * @example
      * success
      */
     message?: string;
     /**
+     * @remarks
+     * The request ID.
+     *
      * @example
      * B506328A-D84B-4750-82C7-6A207C585CF1
      */
     requestId?: string;
+    /**
+     * @remarks
+     * The result.
+     */
     result?: InitAuthVerifyResponseBodyResult;
     static names(): {
         [key: string]: string;

package/dist/models/InitAuthVerifyResponseBody.js.map

@@ -1 +1 @@
-{"version":3,"file":"InitAuthVerifyResponseBody.js","sourceRoot":"","sources":["../../src/models/InitAuthVerifyResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,gCAAiC,SAAQ,KAAK,CAAC,KAAK;IAM/D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,WAAW;SACvB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,QAAQ;SACpB,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;AAzBD,4EAyBC;AAED,MAAa,0BAA2B,SAAQ,KAAK,CAAC,KAAK;IAiBzD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,WAAW;YACtB,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,QAAQ;YACnB,MAAM,EAAE,gCAAgC;SACzC,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,IAAI,CAAC,MAAM,IAAI,OAAQ,IAAI,CAAC,MAAc,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACrE,IAAI,CAAC,MAAc,CAAC,QAAQ,EAAE,CAAC;QAClC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA7CD,gEA6CC"}
+{"version":3,"file":"InitAuthVerifyResponseBody.js","sourceRoot":"","sources":["../../src/models/InitAuthVerifyResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,gCAAiC,SAAQ,KAAK,CAAC,KAAK;IAU/D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,WAAW;SACvB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,SAAS,EAAE,QAAQ;SACpB,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;AA7BD,4EA6BC;AAED,MAAa,0BAA2B,SAAQ,KAAK,CAAC,KAAK;IA8BzD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,WAAW;YACtB,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,QAAQ;YACnB,MAAM,EAAE,gCAAgC;SACzC,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,IAAI,CAAC,MAAM,IAAI,OAAQ,IAAI,CAAC,MAAc,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACrE,IAAI,CAAC,MAAc,CAAC,QAAQ,EAAE,CAAC;QAClC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA1DD,gEA0DC"}

package/dist/models/InitCardVerifyRequest.d.ts

@@ -2,7 +2,7 @@ import * as $dara from '@darabonba/typescript';
 export declare class InitCardVerifyRequest extends $dara.Model {
     /**
      * @remarks
-     * Security Token, used for anti-replay and anti-tampering checks. If this parameter is passed, the CallbackToken field will be displayed in the callback address.
+     * 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.
      *
      * @example
      * NMjvQanQgplBSaEI0sL86WnQplB
@@ -10,10 +10,9 @@ export declare class InitCardVerifyRequest extends $dara.Model {
     callbackToken?: string;
     /**
      * @remarks
-     * - The callback notification address for the authentication result, which must start with https.
-     * - The platform will call back this address after completing the authentication and automatically add 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, interrupted abnormally, or not performed, no notification will be sent. It is recommended that when you receive the callback notification, if necessary, you can obtain detailed authentication information through the query interface.
+     * 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.
      *
      * @example
      * https://www.aliyun.com
@@ -21,10 +20,11 @@ export declare class InitCardVerifyRequest extends $dara.Model {
     callbackUrl?: string;
     /**
      * @remarks
-     * Number of card pages collected by the SDK
-     * - You can input 1 or 2; input 1 to collect the front side, input 2 to collect both the front and back sides.
+     * 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 period (VerifyMeta value is ID_PERIOD), you must input 2.
+     * - If the verification type is ID card validity period (VerifyMeta is set to ID_PERIOD), set this parameter to 2.
      *
      * This parameter is required.
      *
@@ -34,8 +34,8 @@ export declare class InitCardVerifyRequest extends $dara.Model {
     cardPageNumber?: string;
     /**
      * @remarks
-     * Type of identification
-     * - Resident Second Generation ID Card: IDENTITY_CARD
+     * The document type. Valid values:
+     * - IDENTITY_CARD: resident identity card.
      *
      * This parameter is required.
      *
@@ -45,10 +45,10 @@ export declare class InitCardVerifyRequest extends $dara.Model {
     cardType?: string;
     /**
      * @remarks
-     * Enumeration of photo-taking methods (manual/auto)
-     * - Take a photo: shoot
-     * - Scan: scan
-     * - Auto switch: auto
+     * The photo capture mode (manual or automatic). Valid values:
+     * - shoot: manual capture
+     * - scan: scan mode
+     * - auto: automatic switchover.
      *
      * @example
      * shoot
@@ -56,8 +56,7 @@ export declare class InitCardVerifyRequest extends $dara.Model {
     docScanMode?: string;
     /**
      * @remarks
-     * A unique business identifier you define, used for subsequent troubleshooting.
-     * Supports a combination of 32 alphanumeric characters, please ensure uniqueness.
+     * 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.
      *
      * This parameter is required.
      *
@@ -67,7 +66,7 @@ export declare class InitCardVerifyRequest extends $dara.Model {
     merchantBizId?: string;
     /**
      * @remarks
-     * MetaInfo environment parameter, which needs to be obtained through the client SDK.
+     * The MetaInfo environment parameter. Obtain this value by using the client SDK.
      *
      * This parameter is required.
      *
@@ -77,8 +76,8 @@ export declare class InitCardVerifyRequest extends $dara.Model {
     metaInfo?: string;
     /**
      * @remarks
-     * Verification method, value:
-     * - OCR_VERIFY: OCR recognition and verification mode.
+     * The verification mode. Valid values:
+     * - OCR_VERIFY: OCR recognition and authentication mode.
      *
      * This parameter is required.
      *
@@ -88,10 +87,10 @@ export declare class InitCardVerifyRequest extends $dara.Model {
     model?: string;
     /**
      * @remarks
-     * Whether to temporarily store the images collected by the app.
-     * - Y: Yes
-     * - N: No
-     * - If \\"Yes\\" is selected here, the query interface will support returning the card image information.
+     * 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.
      *
      * This parameter is required.
      *
@@ -101,8 +100,8 @@ export declare class InitCardVerifyRequest extends $dara.Model {
     pictureSave?: string;
     /**
      * @remarks
-     * Verification type, value:
-     * - Identity two elements (name + ID number): ID_2_META
+     * The verification type. Valid values:
+     * - ID_2_META: two-factor identity verification (name + ID card number).
      *
      * This parameter is required.
      *

package/dist/models/InitCardVerifyRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"InitCardVerifyRequest.js","sourceRoot":"","sources":["../../src/models/InitCardVerifyRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,qBAAsB,SAAQ,KAAK,CAAC,KAAK;IA+GpD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,aAAa,EAAE,eAAe;YAC9B,WAAW,EAAE,aAAa;YAC1B,cAAc,EAAE,gBAAgB;YAChC,QAAQ,EAAE,UAAU;YACpB,WAAW,EAAE,aAAa;YAC1B,aAAa,EAAE,eAAe;YAC9B,QAAQ,EAAE,UAAU;YACpB,KAAK,EAAE,OAAO;YACd,WAAW,EAAE,aAAa;YAC1B,UAAU,EAAE,YAAY;SACzB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,aAAa,EAAE,QAAQ;YACvB,WAAW,EAAE,QAAQ;YACrB,cAAc,EAAE,QAAQ;YACxB,QAAQ,EAAE,QAAQ;YAClB,WAAW,EAAE,QAAQ;YACrB,aAAa,EAAE,QAAQ;YACvB,QAAQ,EAAE,QAAQ;YAClB,KAAK,EAAE,QAAQ;YACf,WAAW,EAAE,QAAQ;YACrB,UAAU,EAAE,QAAQ;SACrB,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;AApJD,sDAoJC"}
+{"version":3,"file":"InitCardVerifyRequest.js","sourceRoot":"","sources":["../../src/models/InitCardVerifyRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,qBAAsB,SAAQ,KAAK,CAAC,KAAK;IA8GpD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,aAAa,EAAE,eAAe;YAC9B,WAAW,EAAE,aAAa;YAC1B,cAAc,EAAE,gBAAgB;YAChC,QAAQ,EAAE,UAAU;YACpB,WAAW,EAAE,aAAa;YAC1B,aAAa,EAAE,eAAe;YAC9B,QAAQ,EAAE,UAAU;YACpB,KAAK,EAAE,OAAO;YACd,WAAW,EAAE,aAAa;YAC1B,UAAU,EAAE,YAAY;SACzB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,aAAa,EAAE,QAAQ;YACvB,WAAW,EAAE,QAAQ;YACrB,cAAc,EAAE,QAAQ;YACxB,QAAQ,EAAE,QAAQ;YAClB,WAAW,EAAE,QAAQ;YACrB,aAAa,EAAE,QAAQ;YACvB,QAAQ,EAAE,QAAQ;YAClB,KAAK,EAAE,QAAQ;YACf,WAAW,EAAE,QAAQ;YACrB,UAAU,EAAE,QAAQ;SACrB,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;AAnJD,sDAmJC"}