@alicloud/cloudauth20190307 3.13.4 → 3.14.1

package/src/models/Id3metaVerifyResponseBody.ts

@@ -7,9 +7,9 @@ export class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
    * @remarks
    * The identity verification result. Valid values:
    * 
-   * - 1: Consistent.
-   * - 2: Inconsistent.
-   * - 3: No record found.
+   * - 1: verification is consistent.
+   * - 2: verification is inconsistent.
+   * - 3: no record found.
    * 
    * @example
    * 1
@@ -26,6 +26,31 @@ export class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
    */
   faceDetail?: string;
   /**
+   * @remarks
+   * The authoritative source verification details. Valid values:
+   * 
+   * - 101: authentication passed.
+   * 
+   * - 201: authentication failed. The name does not match the ID card number.
+   * 
+   * - 202: authentication failed. The person is suspected to be the ID holder.
+   * 
+   * - 203: authentication failed. No photo exists in the database.
+   * 
+   * - 204: authentication failed. The person is not the same individual.
+   * 
+   * - 205: authentication failed. Modeling of the image to be compared failed.
+   * 
+   * - 206: authentication failed. The image format is incorrect.
+   * 
+   * - 207: authentication failed. The uploaded image is too small. Upload a new image.
+   * 
+   * - 208: authentication failed. The quality of the uploaded portrait photo is poor. Upload a new photo.
+   * 
+   * - 301: no record found. The ID number does not exist in the database.
+   * 
+   * - 302: no record found. Verification cannot be performed.
+   * 
    * @example
    * 101
    */
@@ -58,12 +83,12 @@ export class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
 export class Id3MetaVerifyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response code. A value of 200 indicates success. Other values indicate failure.
+   * The response code. 200 indicates success. Other values indicate failure.
    * 
    * **Important**
    * 
-   * - 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.
+   * - This parameter indicates whether the API call is successful. For more information about return codes, see error codes.
+   * - Check the business verification result in the fields of ResultObject.
    * 
    * @example
    * 200
@@ -71,11 +96,11 @@ export class Id3MetaVerifyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response message of the API call.
+   * The response message.
    * 
    * **Important**
    * 
-   * This parameter indicates only whether the API call is abnormal.
+   * This parameter only indicates whether the API call is abnormal.
    * 
    * @example
    * success

package/src/models/Id3metaVerifyWithOcradvanceRequest.ts

@@ -9,7 +9,7 @@ export class Id3MetaVerifyWithOCRAdvanceRequest extends $dara.Model {
    * The input stream of the portrait side image of the ID card. Specify either CertUrl or CertFile.
    * 
    * @example
-   * 无
+   * None.
    */
   certFileObject?: Readable;
   /**
@@ -17,12 +17,12 @@ export class Id3MetaVerifyWithOCRAdvanceRequest extends $dara.Model {
    * The image of the national emblem side of the ID card. Specify either CertNationalUrl or CertNationalFile, or leave both empty.
    * 
    * @example
-   * 无
+   * None.
    */
   certNationalFileObject?: Readable;
   /**
    * @remarks
-   * 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.
+   * The URL of the national emblem side image of the ID card. 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
-   * The image of the portrait side of the ID card. Specify a publicly accessible HTTP or HTTPS URL. Specify either CertUrl or CertFile.
+   * The image of the portrait side of the ID card. A publicly accessible HTTP or HTTPS URL. Specify either CertUrl or CertFile.
    * 
    * @example
    * https://www.aliyun.com/cert.jpeg

package/src/models/Id3metaVerifyWithOcrrequest.ts

@@ -8,7 +8,7 @@ export class Id3MetaVerifyWithOCRRequest extends $dara.Model {
    * The input stream of the portrait side image of the ID card. Specify either CertUrl or CertFile.
    * 
    * @example
-   * 无
+   * None.
    */
   certFile?: string;
   /**
@@ -16,12 +16,12 @@ export class Id3MetaVerifyWithOCRRequest extends $dara.Model {
    * The image of the national emblem side of the ID card. Specify either CertNationalUrl or CertNationalFile, or leave both empty.
    * 
    * @example
-   * 无
+   * None.
    */
   certNationalFile?: string;
   /**
    * @remarks
-   * 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.
+   * The URL of the national emblem side image of the ID card. 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
-   * The image of the portrait side of the ID card. Specify a publicly accessible HTTP or HTTPS URL. Specify either CertUrl or CertFile.
+   * The image of the portrait side of the ID card. A publicly accessible HTTP or HTTPS URL. Specify either CertUrl or CertFile.
    * 
    * @example
    * https://www.aliyun.com/cert.jpeg

package/src/models/Id3metaVerifyWithOcrresponseBody.ts

@@ -7,9 +7,9 @@ export class Id3MetaVerifyWithOCRResponseBodyResultObject extends $dara.Model {
    * @remarks
    * 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,10 +17,10 @@ export class Id3MetaVerifyWithOCRResponseBodyResultObject extends $dara.Model {
   bizCode?: string;
   /**
    * @remarks
-   * {"address":"浙江省杭州市余*****","birthDate":"19901226","certName":"张三","certNo":"1234561990122*****","nationality":"汉","authority":"xxx公安局","startDate":"20201130","endDate":"20301130"}.
+   * {"address":"No. XX, XX Road, Hangzhou, Zhejiang","birthDate":"19901226","certName":"John","certNo":"1234561990122*****","nationality":"Han","authority":"XXX Public Security Bureau","startDate":"20201130","endDate":"20301130"}
    * 
    * @example
-   * OCR读取的身份证信息。
+   * The ID card information extracted by OCR.
    */
   cardInfo?: string;
   /**
@@ -63,8 +63,8 @@ export class Id3MetaVerifyWithOCRResponseBody extends $dara.Model {
    * @remarks
    * The response code. 200 indicates success. Other values indicate failure. **Important**
    * 
-   * - 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.
+   * - This parameter indicates whether the API was called correctly. For more information about return codes, refer to the error codes.
+   * - Check the business verification result in the fields of ResultObject.
    * 
    * @example
    * 200
@@ -72,7 +72,7 @@ export class Id3MetaVerifyWithOCRResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response message of the API call. This parameter indicates only whether an exception occurred during the API call.
+   * The response message. Important: This parameter only indicates whether the API call is abnormal.
    * 
    * @example
    * success

package/src/models/InitAuthVerifyRequest.ts

@@ -5,8 +5,8 @@ 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.
+   * The security token that you generate for anti-replay and anti-tampering verification.
+   * If this parameter is specified, the CallbackToken field is included in the callback request sent to CallbackUrl.
    * 
    * @example
    * NMjvQanQgplBSaEI0sL86WnQplB
@@ -14,10 +14,10 @@ export class InitAuthVerifyRequest extends $dara.Model {
   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.
+   * The callback URL for OCR results. The default callback request method is GET. The callback URL must start with https. After OCR recognition is completed, a callback request is sent to this URL, and the certifyId and subcode fields are automatically appended.
+   * Warning
+   * - The accessibility of this URL is verified before the API is invoked. If the specified URL does not support public network access, a 400 error is returned.
+   * - The callback is executed immediately after the OCR recognition is invoked, but may be delayed due to network or other issues. Accept the request completion notification on 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
@@ -25,9 +25,9 @@ export class InitAuthVerifyRequest extends $dara.Model {
   callbackUrl?: string;
   /**
    * @remarks
-   * The number of card pages collected by the SDK. Valid values:
-   * - "1": front side only
-   * - "2": both front and back sides.
+   * The number of pages of the identity document to be collected by the SDK. Valid values:
+   * - 1: the front side.
+   * - 2: both the front and back sides.
    * 
    * This parameter is required.
    * 
@@ -37,7 +37,7 @@ export class InitAuthVerifyRequest extends $dara.Model {
   cardPageNumber?: string;
   /**
    * @remarks
-   * The document type. Set the value to IDENTITY_CARD.
+   * The type of the identity document. Valid values: IDENTITY_CARD.
    * 
    * This parameter is required.
    * 
@@ -47,10 +47,10 @@ 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.
+   * The OCR identity document scanning pattern. Valid values:
+   * - shoot: takes a photo. This is the default value.
+   * - scan: scans the document.
+   * - auto: automatic switchover between photo and scan patterns.
    * 
    * @example
    * shoot
@@ -58,7 +58,7 @@ export class InitAuthVerifyRequest extends $dara.Model {
   docScanMode?: string;
   /**
    * @remarks
-   * Specifies whether to enable the document anti-forgery detection feature. Valid values:
+   * Specifies whether to enable the anti-counterfeiting detection feature for the identity document. Valid values:
    * - Y: Enabled.
    * - N: Disabled. This is the default value.
    * 
@@ -68,7 +68,7 @@ export class InitAuthVerifyRequest extends $dara.Model {
   idSpoof?: string;
   /**
    * @remarks
-   * The MetaInfo environment parameter, which must be obtained from the client SDK.
+   * The MetaInfo environment parameter, which must be obtained through the client SDK.
    * 
    * This parameter is required.
    * 
@@ -87,9 +87,9 @@ export class InitAuthVerifyRequest extends $dara.Model {
   metaInfo?: string;
   /**
    * @remarks
-   * A custom business unique identifier that you specify for subsequent troubleshooting.
+   * The custom unique business identifier used for subsequent troubleshooting.
    * 
-   * The value can contain letters (both uppercase and lowercase) and digits, with a maximum length of 32 characters.
+   * The value can contain uppercase and lowercase letters and digits, and can be up to 32 characters in length.
    * 
    * This parameter is required.
    * 
@@ -99,7 +99,7 @@ export class InitAuthVerifyRequest extends $dara.Model {
   outerOrderNo?: string;
   /**
    * @remarks
-   * The product solution to use. Set the value to ID_OCR.
+   * The product solution to be integrated. Valid values: ID_OCR.
    * 
    * This parameter is required.
    * 
@@ -109,7 +109,7 @@ export class InitAuthVerifyRequest extends $dara.Model {
   productCode?: string;
   /**
    * @remarks
-   * The China Chinese authentication scenario ID.
+   * The ID of the authentication scene.
    * 
    * This parameter is required.
    * 

package/src/models/InitAuthVerifyResponseBody.ts

@@ -5,8 +5,8 @@ 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.
+   * The verification request ID, which is the unique identifier of the authentication request for the verification service.
+   * This ID is required when you query the authentication result.
    * 
    * @example
    * shif9d1a185b8dde7cd07bf0943a448b
@@ -36,7 +36,7 @@ export class InitAuthVerifyResponseBodyResult extends $dara.Model {
 export class InitAuthVerifyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response code.
+   * The return code.
    * 
    * @example
    * Success
@@ -44,7 +44,7 @@ export class InitAuthVerifyResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response message.
+   * The returned message.
    * 
    * @example
    * success

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