@alicloud/cloudauth20190307 3.13.4 → 3.14.1

package/src/models/Id3metaVerifyProadvanceRequest.ts

@@ -0,0 +1,144 @@
+// This file is auto-generated, don't edit it
+import { Readable } from 'stream';
+import * as $dara from '@darabonba/typescript';
+
+
+export class Id3MetaVerifyPROAdvanceRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to allow cropping the face image. By default, cropping is not allowed.
+   * - **T**: Cropping is allowed.
+   * - **F**: Cropping is not allowed.
+   * > If the requested image is not collected by the standard liveness detection SDK, we recommend that you allow face image cropping.
+   * After this feature is enabled, the requested image is cropped and corrected before the request is processed.
+   * 
+   * @example
+   * T
+   */
+  crop?: string;
+  /**
+   * @remarks
+   * Specifies whether to allow fallback to non-public security sources. Valid values:
+   * 
+   * - **N** (default): Disabled.
+   * - **Y**: Enabled.
+   * 
+   * @example
+   * Y
+   */
+  enableFallback?: string;
+  /**
+   * @remarks
+   * The input stream of the face photo.
+   * 
+   * @example
+   * For integration details, refer to the configuration of the Advance file upload API
+   */
+  faceFileObject?: Readable;
+  /**
+   * @remarks
+   * The Base64-encoded string of the photo. If you use this method to pass the face photo, check the photo size and do not pass an excessively large photo.
+   * 
+   * @example
+   * /9j/4AAQSkZJRgABAQAASxxxxxxx
+   */
+  facePicture?: string;
+  /**
+   * @remarks
+   * The URL of the face photo. The URL must be a publicly accessible HTTP or HTTPS link.
+   * 
+   * @example
+   * https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg
+   */
+  faceUrl?: string;
+  /**
+   * @remarks
+   * The ID card number.
+   * 
+   * - If **paramType** is set to normal, enter the plaintext ID card number.
+   * 
+   * - If **paramType** is set to sm2, enter the ciphertext ID card number.
+   * 
+   * 
+   * > Due to authoritative source limitations, only the ID card numbers of the second-generation resident identity cards are supported.
+   * 
+   * @example
+   * Plaintext: 429001********8211
+   * 
+   * Ciphertext: MHsCIEPDt1ycBNSVgA2yKsMnvWGheiI+STWqJLmYWlZnklhnAiEAwq1bk5YVepHwqfMsd9ErlK71OrdXx8E+wfqbzyFCwoMEIM1QdrFeekvQh6fwK7sVXAsNePiNm7Eulqm/zahRosbKBBKgtyhm3SopJ3tO/wALKXQQW+g=
+   */
+  identifyNum?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable liveness detection. Valid values:
+   * 
+   * - **N** (default): Liveness detection is disabled.
+   * - **Y**: Liveness detection is enabled.
+   * 
+   * @example
+   * Y
+   */
+  livenessCheck?: string;
+  /**
+   * @remarks
+   * The encryption method. Valid values:
+   * 
+   * - **normal**: Plaintext without encryption.
+   * 
+   * - **sm2**: SM2 encryption.
+   * 
+   * @example
+   * normal
+   */
+  paramType?: string;
+  /**
+   * @remarks
+   * The name.
+   * 
+   * - If **paramType** is set to normal, enter the plaintext name.
+   * 
+   * - If **paramType** is set to sm2, enter the ciphertext name.
+   * 
+   * @example
+   * Plaintext: Zhang San
+   * 
+   * Ciphertext: MG8CIQCxI0wNYbc0c2BRL+7+tSethTXfQC391ZFnszRRcvRZ9AIgekQYhgDtxaDuoRD4bde/5fnFdlUp4YoxlEnIFLLm2mQEILkctuy6Rw6lfAUxBtkpPoPVCJAeD5al/RX8JFUvTACEBAYAgLJjBe0=
+   */
+  userName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      crop: 'Crop',
+      enableFallback: 'EnableFallback',
+      faceFileObject: 'FaceFile',
+      facePicture: 'FacePicture',
+      faceUrl: 'FaceUrl',
+      identifyNum: 'IdentifyNum',
+      livenessCheck: 'LivenessCheck',
+      paramType: 'ParamType',
+      userName: 'UserName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      crop: 'string',
+      enableFallback: 'string',
+      faceFileObject: 'Readable',
+      facePicture: 'string',
+      faceUrl: 'string',
+      identifyNum: 'string',
+      livenessCheck: 'string',
+      paramType: 'string',
+      userName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/Id3metaVerifyProrequest.ts

@@ -0,0 +1,143 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class Id3MetaVerifyPRORequest extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to allow cropping the face image. By default, cropping is not allowed.
+   * - **T**: Cropping is allowed.
+   * - **F**: Cropping is not allowed.
+   * > If the requested image is not collected by the standard liveness detection SDK, we recommend that you allow face image cropping.
+   * After this feature is enabled, the requested image is cropped and corrected before the request is processed.
+   * 
+   * @example
+   * T
+   */
+  crop?: string;
+  /**
+   * @remarks
+   * Specifies whether to allow fallback to non-public security sources. Valid values:
+   * 
+   * - **N** (default): Disabled.
+   * - **Y**: Enabled.
+   * 
+   * @example
+   * Y
+   */
+  enableFallback?: string;
+  /**
+   * @remarks
+   * The input stream of the face photo.
+   * 
+   * @example
+   * For integration details, refer to the configuration of the Advance file upload API
+   */
+  faceFile?: string;
+  /**
+   * @remarks
+   * The Base64-encoded string of the photo. If you use this method to pass the face photo, check the photo size and do not pass an excessively large photo.
+   * 
+   * @example
+   * /9j/4AAQSkZJRgABAQAASxxxxxxx
+   */
+  facePicture?: string;
+  /**
+   * @remarks
+   * The URL of the face photo. The URL must be a publicly accessible HTTP or HTTPS link.
+   * 
+   * @example
+   * https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg
+   */
+  faceUrl?: string;
+  /**
+   * @remarks
+   * The ID card number.
+   * 
+   * - If **paramType** is set to normal, enter the plaintext ID card number.
+   * 
+   * - If **paramType** is set to sm2, enter the ciphertext ID card number.
+   * 
+   * 
+   * > Due to authoritative source limitations, only the ID card numbers of the second-generation resident identity cards are supported.
+   * 
+   * @example
+   * Plaintext: 429001********8211
+   * 
+   * Ciphertext: MHsCIEPDt1ycBNSVgA2yKsMnvWGheiI+STWqJLmYWlZnklhnAiEAwq1bk5YVepHwqfMsd9ErlK71OrdXx8E+wfqbzyFCwoMEIM1QdrFeekvQh6fwK7sVXAsNePiNm7Eulqm/zahRosbKBBKgtyhm3SopJ3tO/wALKXQQW+g=
+   */
+  identifyNum?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable liveness detection. Valid values:
+   * 
+   * - **N** (default): Liveness detection is disabled.
+   * - **Y**: Liveness detection is enabled.
+   * 
+   * @example
+   * Y
+   */
+  livenessCheck?: string;
+  /**
+   * @remarks
+   * The encryption method. Valid values:
+   * 
+   * - **normal**: Plaintext without encryption.
+   * 
+   * - **sm2**: SM2 encryption.
+   * 
+   * @example
+   * normal
+   */
+  paramType?: string;
+  /**
+   * @remarks
+   * The name.
+   * 
+   * - If **paramType** is set to normal, enter the plaintext name.
+   * 
+   * - If **paramType** is set to sm2, enter the ciphertext name.
+   * 
+   * @example
+   * Plaintext: Zhang San
+   * 
+   * Ciphertext: MG8CIQCxI0wNYbc0c2BRL+7+tSethTXfQC391ZFnszRRcvRZ9AIgekQYhgDtxaDuoRD4bde/5fnFdlUp4YoxlEnIFLLm2mQEILkctuy6Rw6lfAUxBtkpPoPVCJAeD5al/RX8JFUvTACEBAYAgLJjBe0=
+   */
+  userName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      crop: 'Crop',
+      enableFallback: 'EnableFallback',
+      faceFile: 'FaceFile',
+      facePicture: 'FacePicture',
+      faceUrl: 'FaceUrl',
+      identifyNum: 'IdentifyNum',
+      livenessCheck: 'LivenessCheck',
+      paramType: 'ParamType',
+      userName: 'UserName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      crop: 'string',
+      enableFallback: 'string',
+      faceFile: 'string',
+      facePicture: 'string',
+      faceUrl: 'string',
+      identifyNum: 'string',
+      livenessCheck: 'string',
+      paramType: 'string',
+      userName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/Id3metaVerifyProresponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { Id3MetaVerifyPROResponseBody } from "./Id3metaVerifyProresponseBody";
+
+
+export class Id3MetaVerifyPROResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: Id3MetaVerifyPROResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: Id3MetaVerifyPROResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/Id3metaVerifyProresponseBody.ts

@@ -0,0 +1,160 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class Id3MetaVerifyPROResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * The verification result from the authoritative source. Valid values:
+   * 
+   * - **1**: Consistent (billed).
+   * - **2**: Inconsistent (billed).
+   * - **3**: No record found (not billed).
+   * 
+   * @example
+   * 1
+   */
+  bizCode?: string;
+  /**
+   * @remarks
+   * - **verifyScore**: The face comparison score. Valid values: 0 to 1000. A higher score indicates a higher probability that the faces belong to the same person. A score of 700.0 or higher confirms that the faces belong to the same person.
+   * 
+   * - **faceAttack**: Returned when liveness detection is enabled. This value does not affect the verification result.
+   * 
+   * - **invokeChannel**: The identifier of the actual invocation channel. Valid values:
+   * 1: Authoritative source. 0: Comprehensive source.
+   * 
+   * @example
+   * {
+   *  "verifyScore": 810.28,
+   * "faceAttack":"N",
+   * "invokeChannel": 1
+   * }
+   */
+  faceDetail?: string;
+  /**
+   * @remarks
+   * Indicates whether the whitelist is hit. Valid value: **Y**.
+   * 
+   * @example
+   * Y
+   */
+  hitWhitelist?: string;
+  /**
+   * @remarks
+   * The verification details from the authoritative source. 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 owner.
+   * 
+   * - **203**: Authentication failed. No photo is found in the database.
+   * 
+   * - **204**: Authentication failed. The faces do not belong to the same person.
+   * 
+   * - **205**: Authentication failed. Image modeling for the image to be compared failed.
+   * 
+   * - **206**: Authentication failed. The image format is incorrect.
+   * 
+   * - **207**: Authentication failed. The uploaded image is too small. Upload another image.
+   * 
+   * - **208**: Authentication failed. The quality of the uploaded face photo is poor. Upload another photo.
+   * 
+   * - **301**: No record found. The ID card number does not exist in the database.
+   * 
+   * - **302**: No record found. Verification cannot be performed.
+   * 
+   * @example
+   * 101
+   */
+  subCode?: string;
+  static names(): { [key: string]: string } {
+    return {
+      bizCode: 'BizCode',
+      faceDetail: 'FaceDetail',
+      hitWhitelist: 'HitWhitelist',
+      subCode: 'SubCode',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      bizCode: 'string',
+      faceDetail: 'string',
+      hitWhitelist: 'string',
+      subCode: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class Id3MetaVerifyPROResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The return code. A value of **200** indicates that the API call is successful.
+   * 
+   * @example
+   * 200
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The message returned for the API call.
+   * >Notice: This parameter only indicates whether an exception occurs during the API call.
+   * 
+   * @example
+   * success
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 2FA2C773-47DB-4156-B1EE-5B047321A939
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The returned result.
+   */
+  resultObject?: Id3MetaVerifyPROResponseBodyResultObject;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'Code',
+      message: 'Message',
+      requestId: 'RequestId',
+      resultObject: 'ResultObject',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      message: 'string',
+      requestId: 'string',
+      resultObject: Id3MetaVerifyPROResponseBodyResultObject,
+    };
+  }
+
+  validate() {
+    if(this.resultObject && typeof (this.resultObject as any).validate === 'function') {
+      (this.resultObject as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+