@alicloud/cloudauth20190307 3.13.3 → 3.13.4

package/src/models/Id3metaVerifyResponseBody.ts

@@ -5,11 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export 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
@@ -17,7 +17,7 @@ export class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
   bizCode?: string;
   /**
    * @remarks
-   * Image comparison score.
+   * The face comparison score.
    * 
    * @example
    * {
@@ -25,10 +25,16 @@ export class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
    * }
    */
   faceDetail?: string;
+  /**
+   * @example
+   * 101
+   */
+  subCode?: string;
   static names(): { [key: string]: string } {
     return {
       bizCode: 'BizCode',
       faceDetail: 'FaceDetail',
+      subCode: 'SubCode',
     };
   }
 
@@ -36,6 +42,7 @@ export class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
     return {
       bizCode: 'string',
       faceDetail: 'string',
+      subCode: 'string',
     };
   }
 
@@ -51,10 +58,12 @@ export class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
 export 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
@@ -62,11 +71,11 @@ export 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
@@ -74,7 +83,7 @@ export class Id3MetaVerifyResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 130A2C10-B9EE-4D84-88E3-5384FF03****
@@ -82,7 +91,7 @@ export class Id3MetaVerifyResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Result object.
+   * The result object.
    */
   resultObject?: Id3MetaVerifyResponseBodyResultObject;
   static names(): { [key: string]: string } {

package/src/models/Id3metaVerifyWithOcradvanceRequest.ts

@@ -6,7 +6,7 @@ import * as $dara from '@darabonba/typescript';
 export 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
    * 无
@@ -14,7 +14,7 @@ export 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
    * 无
@@ -22,7 +22,7 @@ export 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
@@ -30,7 +30,7 @@ export 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/src/models/Id3metaVerifyWithOcrrequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export 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
    * 无
@@ -13,7 +13,7 @@ export 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
    * 无
@@ -21,7 +21,7 @@ export 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
@@ -29,7 +29,7 @@ export 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/src/models/Id3metaVerifyWithOcrresponseBody.ts

@@ -5,11 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export 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
@@ -17,15 +17,15 @@ export class Id3MetaVerifyWithOCRResponseBodyResultObject extends $dara.Model {
   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
    * {
@@ -61,10 +61,10 @@ export class Id3MetaVerifyWithOCRResponseBodyResultObject extends $dara.Model {
 export 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
@@ -72,7 +72,7 @@ export 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
@@ -80,7 +80,7 @@ export class Id3MetaVerifyWithOCRResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 130A2C10-B9EE-4D84-88E3-5384FF03****
@@ -88,7 +88,7 @@ export class Id3MetaVerifyWithOCRResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Result object.
+   * The result object.
    */
   resultObject?: Id3MetaVerifyWithOCRResponseBodyResultObject;
   static names(): { [key: string]: string } {

package/src/models/InitAuthVerifyRequest.ts

@@ -4,17 +4,31 @@ import * as $dara from '@darabonba/typescript';
 
 export 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
@@ -23,6 +37,8 @@ export class InitAuthVerifyRequest extends $dara.Model {
   cardPageNumber?: string;
   /**
    * @remarks
+   * The document type. Set the value to IDENTITY_CARD.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -30,17 +46,30 @@ export 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
@@ -58,6 +87,10 @@ export 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
@@ -66,6 +99,8 @@ export class InitAuthVerifyRequest extends $dara.Model {
   outerOrderNo?: string;
   /**
    * @remarks
+   * The product solution to use. Set the value to ID_OCR.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -74,6 +109,8 @@ export class InitAuthVerifyRequest extends $dara.Model {
   productCode?: string;
   /**
    * @remarks
+   * The China Chinese authentication scenario ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/InitAuthVerifyResponseBody.ts

@@ -4,6 +4,10 @@ import * as $dara from '@darabonba/typescript';
 
 export 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
    */
@@ -31,20 +35,33 @@ export class InitAuthVerifyResponseBodyResult extends $dara.Model {
 
 export 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 } {
     return {

package/src/models/InitCardVerifyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export 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
@@ -13,10 +13,9 @@ export 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
@@ -24,10 +23,11 @@ export 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.
    * 
@@ -37,8 +37,8 @@ export 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.
    * 
@@ -48,10 +48,10 @@ export 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
@@ -59,8 +59,7 @@ export 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.
    * 
@@ -70,7 +69,7 @@ export 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.
    * 
@@ -80,8 +79,8 @@ export 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.
    * 
@@ -91,10 +90,10 @@ export 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.
    * 
@@ -104,8 +103,8 @@ export 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/src/models/InitCardVerifyResponseBody.ts

@@ -5,10 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class InitCardVerifyResponseBodyResultObject extends $dara.Model {
   /**
    * @remarks
-   * Verification request ID, a unique identifier for the verification service\\"s authentication request.
-   * - When querying the authentication result, the authentication request ID must be provided.
+   * 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 a billing statistics field. To facilitate subsequent bill reconciliation, please retain this field information locally. The CertifyId returned by the initialization interface is valid for 30 minutes and can only be submitted once for authentication. Please apply it within the validity period to avoid reuse.
+   * - 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.
    * 
    * @example
    * 91707dc296d469ad38e4c5efa6a0****
@@ -38,10 +38,9 @@ export class InitCardVerifyResponseBodyResultObject extends $dara.Model {
 export class InitCardVerifyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Return code: 200 for success, others for failure.
-   * Important
-   * - This parameter indicates whether the interface was called correctly. For detailed return code descriptions, see the error codes.
-   * - Business results should be viewed through the fields in ResultObject.
+   * 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.
    * 
    * @example
    * 200
@@ -49,7 +48,7 @@ export class InitCardVerifyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * Return message.
+   * The response message.
    * 
    * @example
    * success
@@ -57,7 +56,7 @@ export class InitCardVerifyResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 130A2C10-B9EE-4D84-88E3-5384FF039795
@@ -65,7 +64,7 @@ export class InitCardVerifyResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Return result.
+   * The returned result.
    */
   resultObject?: InitCardVerifyResponseBodyResultObject;
   static names(): { [key: string]: string } {