@alicloud/cloudauth20190307 3.9.2 → 3.9.3

package/src/models/AigcfaceVerifyRequest.ts

@@ -4,36 +4,62 @@ import * as $dara from '@darabonba/typescript';
 
 export class AIGCFaceVerifyRequest extends $dara.Model {
   /**
+   * @remarks
+   * Base64 encoded photo.
+   * > Choose one of the three ways to input images: FaceContrastPicture, FaceContrastPictureUrl, or OSS.
+   * 
    * @example
    * /9j/4AAQSkZJRgABAQAASxxxxxxx
    */
   faceContrastPicture?: string;
   /**
+   * @remarks
+   * Portrait address, accessible via public HTTP or HTTPS link.
+   * 
+   * > Choose one of the three ways to input images: FaceContrastPicture, FaceContrastPictureUrl, or OSS.
+   * 
    * @example
    * https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg
    */
   faceContrastPictureUrl?: string;
   /**
+   * @remarks
+   * Authorized OSS bucket name.
+   * > Choose one of the three ways to input images: FaceContrastPicture, FaceContrastPictureUrl, or OSS.
+   * 
    * @example
    * cn-shanghai-aliyun-cloudauth-xxxxx
    */
   ossBucketName?: string;
   /**
+   * @remarks
+   * Authorized OSS file name.
+   * > Choose one of the three ways to input images: FaceContrastPicture, FaceContrastPictureUrl, or OSS.
+   * 
    * @example
    * verify/xxxxx/xxxxxx.jpeg
    */
   ossObjectName?: string;
   /**
+   * @remarks
+   * A unique business identifier defined by the client side, used for subsequent troubleshooting. The value should be a combination of letters and numbers with a maximum length of 32 characters, please ensure its uniqueness.
+   * 
    * @example
    * e0c34a77f5ac40a5aa5e6ed20c353888
    */
   outerOrderNo?: string;
   /**
+   * @remarks
+   * Product solution
+   * 
    * @example
    * LR_FR_AIGC
    */
   productCode?: string;
   /**
+   * @remarks
+   * Authentication scene ID. This ID is automatically generated after creating an authentication scene in the console. For how to create an authentication scene, see Adding an Authentication Scene.
+   * 
    * @example
    * 100000xxxx
    */

package/src/models/AigcfaceVerifyResponseBody.ts

@@ -1,24 +1,92 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { AIGCFaceVerifyResponseBodyResultObject } from "./AigcfaceVerifyResponseBodyResultObject";
 
 
+/**
+ */
+export class AIGCFaceVerifyResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * Unique real-person authentication identifier.
+   * 
+   * @example
+   * 91707dc296d469ad38e4c5efa6a0****
+   */
+  certifyId?: string;
+  /**
+   * @remarks
+   * Authentication result. Values:
+   * 
+   * ● Y: AIGC-generated face.
+   * 
+   * ● N: Not detected
+   * 
+   * @example
+   * Y
+   */
+  result?: string;
+  /**
+   * @remarks
+   * Detection score
+   * 
+   * @example
+   * 1.0000
+   */
+  score?: string;
+  static names(): { [key: string]: string } {
+    return {
+      certifyId: 'CertifyId',
+      result: 'Result',
+      score: 'Score',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      certifyId: 'string',
+      result: 'string',
+      score: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class AIGCFaceVerifyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Return code: 200 for success, others for failure.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Returned result
+   */
   resultObject?: AIGCFaceVerifyResponseBodyResultObject;
   static names(): { [key: string]: string } {
     return {

package/src/models/BankMetaVerifyRequest.ts

@@ -4,33 +4,86 @@ import * as $dara from '@darabonba/typescript';
 
 export class BankMetaVerifyRequest extends $dara.Model {
   /**
+   * @remarks
+   * Bank card number.
+   * 
+   * - When `paramType` is `normal`, enter the plain text bank card number.
+   * - When `paramType` is `md5`, enter the part of the card number except the last 6 digits in plain text + the last 6 digits encrypted with MD5 (32 lowercase).
+   * 
    * @example
    * 610*************1181
    */
   bankCard?: string;
   /**
+   * @remarks
+   * ID number.
+   * 
+   * - When `ProductType` is `BANK_CARD_3_META`, this field is required.
+   * - When `paramType` is `normal`, enter the plain text ID number.
+   * - When `paramType` is `md5`, enter the first 6 digits of the ID number in plain text + the birth date encrypted with MD5 (32 lowercase MD5) + the last 4 digits of the ID number.
+   * 
    * @example
    * 429001********8211
    */
   identifyNum?: string;
+  /**
+   * @remarks
+   * Identity type.
+   * 
+   * @example
+   * 01
+   */
   identityType?: string;
   /**
+   * @remarks
+   * Mobile phone number.
+   * 
+   * - When `ProductType` is `BANK_CARD_4_META`, this field is required.
+   * - When `paramType` is `normal`, enter the plain text mobile phone number.
+   * - When `paramType` is `md5`, enter the mobile phone number (32 lowercase MD5).
+   * 
    * @example
    * 138******11
    */
   mobile?: string;
   /**
+   * @remarks
+   * Parameter type:
+   * 
+   * - normal: Unencrypted.
+   * - md5: MD5 encrypted.
+   * 
    * @example
    * normal
    */
   paramType?: string;
   /**
+   * @remarks
+   * Product type to call:
+   * 
+   * - BANK_CARD_2_META: Bank card number + name verification.
+   * - BANK_CARD_3_META: Bank card number + name + ID number verification.
+   * - BANK_CARD_4_META: Bank card number + name + ID number + mobile phone number verification.
+   * 
    * @example
    * BANK_CARD_2_META
    */
   productType?: string;
+  /**
+   * @remarks
+   * Name.
+   * 
+   * - When `paramType` is `normal`, enter the plain text name.
+   * - When `paramType` is `md5`, encrypt the first character of the name with MD5 (32 lowercase MD5) + the rest of the name in plain text.
+   * 
+   * @example
+   * 张*
+   */
   userName?: string;
   /**
+   * @remarks
+   * VERIFY_BANK_CARD: Bank card authentication mode. It indicates whether the provided bank card number matches the user\\"s real name, ID number, and mobile phone number.
+   * 
    * @example
    * VERIFY_BANK_CARD
    */

package/src/models/BankMetaVerifyResponseBody.ts

@@ -1,24 +1,104 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { BankMetaVerifyResponseBodyResultObject } from "./BankMetaVerifyResponseBodyResultObject";
 
 
+export class BankMetaVerifyResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * Verification result.
+   * 
+   * - 1: Consistent (billable)
+   * - 2: Inconsistent (billable)
+   * - 3: No record found (non-billable)
+   * 
+   * @example
+   * 1
+   */
+  bizCode?: string;
+  /**
+   * @remarks
+   * Verification details:
+   * 
+   * - **101**: Verification passed.
+   * - **201**: Authentication information does not match, cardholder information is incorrect.
+   * - **202**: Authentication information does not match, bank card has not enabled authentication payment.
+   * - **203**: Authentication information does not match, bank card has expired.
+   * - **204**: Authentication information does not match, bank card is a restricted card.
+   * - **205**: Authentication information does not match, this card has been confiscated.
+   * - **206**: Authentication information does not match, bank card is invalid.
+   * - **207**: Authentication information does not match, this card has no corresponding issuing bank.
+   * - **208**: Authentication information does not match, the card is uninitialized or a dormant card.
+   * - **209**: Authentication information does not match, this card is a cheating card or swallowed card.
+   * - **210**: Authentication information does not match, this card has been reported lost.
+   * - **211**: Authentication information does not match, the number of password errors exceeds the limit.
+   * - **212**: Authentication information does not match, the issuing bank does not support this transaction.
+   * - **213**: Authentication information does not match, the card status is abnormal or the card is invalid.
+   * - **214**: Authentication information does not match, no mobile phone number reserved.
+   * - **215**: Authentication information does not match, the entered password, expiration date, or CVN2 is incorrect.
+   * - **216**: Authentication information does not match, other card anomalies.
+   * - **301**: Unable to verify, the bank card does not support this service.
+   * - **302**: Unable to verify, verification failed or the bank refused to verify, please contact the issuing bank.
+   * - **303**: Unable to verify, the bank card does not currently support mobile phone number verification.
+   * - **304**: Unable to verify, the bank card number is incorrect.
+   * - **305**: Unable to verify, other reasons.
+   * - **306**: Unable to verify, the number of verifications exceeds the limit.
+   * 
+   * @example
+   * 101
+   */
+  subCode?: string;
+  static names(): { [key: string]: string } {
+    return {
+      bizCode: 'BizCode',
+      subCode: 'SubCode',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      bizCode: 'string',
+      subCode: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class BankMetaVerifyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Return code: 200 for success, others for failure.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Return message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 473469C7-A***B-A3DC0DE3C83E
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Returned result information
+   */
   resultObject?: BankMetaVerifyResponseBodyResultObject;
   static names(): { [key: string]: string } {
     return {

package/src/models/CompareFaceVerifyRequest.ts

@@ -3,68 +3,132 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CompareFaceVerifyRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Whether cropping is allowed. Default is not allowed, T/F.
+   * 
+   * - T: Indicates that cropping is required
+   * - F: Indicates that cropping is not required (default F)
+   * 
+   * @example
+   * T
+   */
   crop?: string;
   /**
+   * @remarks
+   * A unique identifier for the merchant\\"s request. The value is a 32-character alphanumeric combination, where the first few characters are a custom abbreviation defined by the merchant, followed by a period, and the latter part can be a random or incrementing sequence.
+   * 
    * @example
    * e0c34a77f5ac40a5aa5e6ed20c353888
    */
   outerOrderNo?: string;
   /**
+   * @remarks
+   * Fixed value: PV_FC.
+   * 
    * @example
    * PV_FC
    */
   productCode?: string;
   /**
+   * @remarks
+   * Authentication scenario ID.
+   * 
    * @example
    * 1000000006
    */
   sceneId?: number;
   /**
+   * @remarks
+   * The CertifyId of a previously successful real-person verification, where the photo taken during that verification is used as the face comparison photo.
+   * > Among the four ways to input facial photos (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to provide.
+   * 
    * @example
    * 0bfa7c493f850e5178b9f8613634c9xx
    */
   sourceCertifyId?: string;
   /**
+   * @remarks
+   * Base64 encoding of the photo.
+   * > Choose one of the four ways to input a face photo: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.
+   * 
    * @example
    * /9j/4AAQSkZJRgABAQAASxxxxxxx
    */
   sourceFaceContrastPicture?: string;
   /**
+   * @remarks
+   * OSS photo URL, currently only supports authorized OSS photo URLs.
+   * > Four ways to input face photos: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, and OSS. Choose one of them to input.
+   * 
    * @example
    * https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg
    */
   sourceFaceContrastPictureUrl?: string;
   /**
+   * @remarks
+   * Name of the authorized OSS bucket.
+   * > Choose one of the four ways to input face photos: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.
+   * 
    * @example
    * cn-shanghai-aliyun-cloudauth-xxxxx
    */
   sourceOssBucketName?: string;
   /**
+   * @remarks
+   * Filename of the authorized OSS space.
+   * > Choose one of the four ways to input face photos: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.
+   * 
    * @example
    * verify/xxxxx/xxxxxx.jpeg
    */
   sourceOssObjectName?: string;
   /**
+   * @remarks
+   * CertifyId from a previously successful real-person authentication, where the photo taken during the authentication is used for face comparison.
+   * 
+   * > Choose one of the four methods to provide the reference face photo: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.
+   * 
    * @example
    * 0bfa7c493f850e5178b9f8613634c9xx
    */
   targetCertifyId?: string;
   /**
+   * @remarks
+   * Base64 encoding of the reference photo.
+   * 
+   * > Choose one of the four methods to provide the reference face photo: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.
+   * 
    * @example
    * /9j/4AAQSkZJRgABAQAASxxxxxxx
    */
   targetFaceContrastPicture?: string;
   /**
+   * @remarks
+   * OSS address of the reference photo. Currently, only authorized OSS addresses are supported.
+   * 
+   * > Choose one of the four methods to provide the reference face photo: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.
+   * 
    * @example
    * https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg
    */
   targetFaceContrastPictureUrl?: string;
   /**
+   * @remarks
+   * Name of the authorized OSS bucket.
+   * 
+   * > Choose one of the four methods to provide the reference face photo: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.
+   * 
    * @example
    * cn-shanghai-aliyun-cloudauth-xxxxx
    */
   targetOssBucketName?: string;
   /**
+   * @remarks
+   * File name in the authorized OSS space.
+   * 
+   * > Choose one of the four methods to provide the reference face photo: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.
+   * 
    * @example
    * verify/xxxxx/xxxxxx.jpeg
    */

package/src/models/CompareFaceVerifyResponseBody.ts

@@ -1,24 +1,86 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { CompareFaceVerifyResponseBodyResultObject } from "./CompareFaceVerifyResponseBodyResultObject";
 
 
+export class CompareFaceVerifyResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * Unique identifier for the real-person authentication request.
+   * 
+   * @example
+   * 08573be80f944d95ac812e019e3655a8
+   */
+  certifyId?: string;
+  /**
+   * @remarks
+   * Whether the verification passed, T for pass, F for fail.
+   * 
+   * @example
+   * T
+   */
+  passed?: string;
+  /**
+   * @remarks
+   * Face comparison score.
+   * 
+   * @example
+   * 99.60875
+   */
+  verifyScore?: number;
+  static names(): { [key: string]: string } {
+    return {
+      certifyId: 'CertifyId',
+      passed: 'Passed',
+      verifyScore: 'VerifyScore',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      certifyId: 'string',
+      passed: 'string',
+      verifyScore: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class CompareFaceVerifyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Return code: 200 for success, other values indicate failure.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Error message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 130A2C10-B9EE-4D84-88E3-5384FF039795
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Face comparison result information.
+   */
   resultObject?: CompareFaceVerifyResponseBodyResultObject;
   static names(): { [key: string]: string } {
     return {

package/src/models/CompareFacesRequest.ts

@@ -4,21 +4,39 @@ import * as $dara from '@darabonba/typescript';
 
 export class CompareFacesRequest extends $dara.Model {
   /**
+   * @remarks
+   * Type of Image 1, with values:
+   * 
+   * - **FacePic**: User\\"s face photo
+   * - **IDPic**: Headshot from the user\\"s second-generation ID card chip (typically obtained and decoded by a second-generation ID card reader)
+   * 
    * @example
    * FacePic
    */
   sourceImageType?: string;
   /**
+   * @remarks
+   * Address of Image 1. Please refer to the instructions on uploading image addresses.
+   * 
    * @example
    * http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg
    */
   sourceImageValue?: string;
   /**
+   * @remarks
+   * Type of Image 2, with values:
+   * 
+   * - **FacePic**: User\\"s face photo
+   * - **IDPic**: Headshot from the user\\"s second-generation ID card chip (typically obtained and decoded by a second-generation ID card reader)
+   * 
    * @example
    * FacePic
    */
   targetImageType?: string;
   /**
+   * @remarks
+   * Address of Image 2. Please refer to the instructions on uploading image addresses.
+   * 
    * @example
    * http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg
    */

package/src/models/CompareFacesResponseBody.ts

@@ -1,26 +1,92 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { CompareFacesResponseBodyData } from "./CompareFacesResponseBodyData";
 
 
+export class CompareFacesResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * Confidence thresholds for face comparison. The returned content is a JSON Object, with the specific structure being `"key":"value"`.
+   * 
+   * - `key` represents the false acceptance rate, which is the probability of misidentifying someone else as the specified person.
+   * - `value` is the corresponding threshold.
+   * 
+   * 
+   * > Regarding the confidence thresholds (confidenceThresholds) in the example:
+   * - `"0.0001": "90.07"` indicates that the threshold is 90.07 when the false acceptance rate is 0.01%.
+   * - `"0.001": "80.01"` indicates that the threshold is 80.01 when the false acceptance rate is 0.1%.
+   * - `"0.01": "70.02"` indicates that the threshold is 70.02 when the false acceptance rate is 1%.
+   * 
+   * Confidence thresholds are dynamically provided based on different images and algorithms, so do not persist these thresholds.
+   * 
+   * @example
+   * {"0.0001":"90.07","0.001":"80.01","0.01":"70.02"}
+   */
+  confidenceThresholds?: string;
+  /**
+   * @remarks
+   * The degree of similarity between the faces in the two images. The value range is [0, 100], with higher values indicating greater similarity.
+   * 
+   * @example
+   * 98.7913
+   */
+  similarityScore?: number;
+  static names(): { [key: string]: string } {
+    return {
+      confidenceThresholds: 'ConfidenceThresholds',
+      similarityScore: 'SimilarityScore',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      confidenceThresholds: 'string',
+      similarityScore: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class CompareFacesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * HTTP status code.
+   * 
    * @example
    * 200
    */
   code?: string;
+  /**
+   * @remarks
+   * Result of the face comparison.
+   */
   data?: CompareFacesResponseBodyData;
   /**
+   * @remarks
+   * Error code.
+   * 
    * @example
    * Error.InternalError
    */
   message?: string;
   /**
+   * @remarks
+   * ID of the current request.
+   * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the response was successful.
+   * 
    * @example
    * true
    */