tencentcloud-sdk-nodejs-intl-en 3.0.698 → 3.0.699

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tencentcloud-sdk-nodejs-intl-en",
-  "version": "3.0.698",
+  "version": "3.0.699",
   "description": "腾讯云 API NODEJS SDK",
   "main": "index.js",
   "scripts": {

package/tencentcloud/common/sdk_version.js

@@ -1,2 +1,2 @@
-const sdkVersion = "3.0.698";
+const sdkVersion = "3.0.699";
 module.exports = sdkVersion

package/tencentcloud/faceid/v20180301/models.js

@@ -682,19 +682,19 @@ class ApplySdkVerificationTokenRequest extends  AbstractModel {
         this.NeedVerifyIdCard = null;
 
         /**
-         * The card type. Valid values: `HK` (identity card of Hong Kong (China)) (default), `ML` (Malaysian identity card), `PhilippinesVoteID` (Philippine voters ID card), `IndonesiaIDCard` (Indonesian identity card), `SingaporeIDCard` (Singapore identity card), and `PhilippinesDrivingLicense` (Philippine driver's license).
+         * The identity document type. Valid values: `HK` (identity card of Hong Kong (China)) (default), `ML` (Malaysian identity card), `IndonesiaIDCard` (Indonesian identity card), `PhilippinesVoteID` (Philippine voters ID card), `PhilippinesDrivingLicense` (Philippine driver's license), `PhilippinesTinID` (Philippine TIN ID card), `PhilippinesSSSID` (Philippine SSS ID card), and `MLIDPassport` (passport issued in Hong Kong/Macao/Taiwan (China) or other countries/regions).
          * @type {string || null}
          */
         this.IdCardType = null;
 
         /**
-         * Disable the modification of the OCR result by the user. Default value: `false` (modification allowed).
+         * Whether to forbid the modification of the OCR result by users. Default value: `false` (modification allowed).
          * @type {boolean || null}
          */
         this.DisableChangeOcrResult = null;
 
         /**
-         * Disable the OCR warnings. Default value: `false` (not disable), where OCR warnings are enabled and the OCR result will not be returned based on the warnings. If the value of `NeedVerifyIdCard` is `true`, the value of this field will also be `true`.
+         * Whether to disable the OCR warnings. Default value: `false` (not disable), where OCR warnings are enabled and the OCR result will not be returned if there is a warning. If `NeedVerifyIdCard` is set to `true`, this parameter must also be set to `true`.
          * @type {boolean || null}
          */
         this.DisableCheckOcrWarnings = null;
@@ -894,7 +894,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
 }
 
 /**
- * The result of a single authentication or OCR process during the identity verification.
+ * The OCR result of a user's identity document during the eKYC verification process.
  * @class
  */
 class CardVerifyResult extends  AbstractModel {
@@ -908,68 +908,84 @@ class CardVerifyResult extends  AbstractModel {
         this.IsPass = null;
 
         /**
-         * The video for ID card authentication. This field is returned only if the video-based ID card authentication is enabled. The URL is valid for 10 minutes.
-Note: This field may return null, indicating that no valid values can be obtained.
+         * The download URL of the video used for identity document verification, which is valid for 10 minutes. This parameter is returned only if video-based identity document verification is enabled.
+Note: This field may return null, indicating that no valid value can be obtained.
          * @type {FileInfo || null}
          */
         this.CardVideo = null;
 
         /**
-         * The identity document image. The URL is valid for 10 minutes.
-Note: This field may return null, indicating that no valid values can be obtained.
+         * The download URL of the identity document image, which is valid for 10 minutes.
+Note: This field may return null, indicating that no valid value can be obtained.
          * @type {FileInfo || null}
          */
         this.CardImage = null;
 
         /**
-         * The OCR result (in JSON) of the identity document image. If authentication or OCR fails, this parameter is left empty. The URL is valid for 10 minutes.
+         * The OCR result (in JSON) of the identity document image. If verification or OCR fails, this parameter is left empty. The URL is valid for 10 minutes.
+(1) Hong Kong (China) identity card
 When the value of `IdCardType` is `HK`:
-- CnName (string): Chinese name.
-- EnName (string): English name.
-- TelexCode (string): The code corresponding to the Chinese name.
+- CnName (string): Name in Chinese.
+- EnName (string): Name in English.
+- TelexCode (string): The code corresponding to the name in Chinese.
 - Sex (string): Gender. Valid values: `M` (male) and `F` (female).
 - Birthday (string): Date of birth.
 - Permanent (int): Whether it is a permanent residence identity card. Valid values: `0` (non-permanent), `1` (permanent), and `-1` (unknown).
-- IdNum (string): ID number.
+- IdNum (string): Identity card number.
 - Symbol (string): The ID symbol below the date of birth, such as "***AZ".
-- FirstIssueDate (string): The date of first issuance.
+- FirstIssueDate (string): Month and year of first registration.
 - CurrentIssueDate (string): The date of latest issuance.
 
+(2) Malaysian identity card
 When the value of `IdCardType` is `ML`:
-- Sex (string): `LELAKI` (male) and `PEREMPUAN` (female).
+- Sex (string): Gender. Valid values: `LELAKI` (male) and `PEREMPUAN` (female).
 - Birthday (string): Date of birth.
-- ID (string): ID number.
+- ID (string): Identity card number.
 - Name (string): Name.
 - Address (string): Address.
 - Type (string): Identity document type.
 
+(3) Philippine identity document
 When the value of `IdCardType` is `PhilippinesVoteID`:
 - Birthday (string): Date of birth.
 - Address (string): Address.
-- LastName (string): Family name.
+- LastName (string): Last name.
 - FirstName (string): First name.
-- VIN (string): VIN number.
-- CivilStatus (string): Marital status.
+- VIN (string): Voter's identification number (VIN).
+- CivilStatus (string): Civil status.
 - Citizenship (string): Citizenship.
-- PrecinctNo (string): Region.
+- PrecinctNo (string): Precinct.
 
 When the value of `IdCardType` is `PhilippinesDrivingLicense`:
 - Sex (string): Gender.
 - Birthday (string): Date of birth.
 - Name (string): Name.
 - Address (string): Address.
-- LastName (string): Family name.
+- LastName (string): Last name.
 - FirstName (string): First name.
 - MiddleName (string): Middle name.
 - Nationality (string): Nationality.
 - LicenseNo (string): License number.
-- ExpiresDate (string): Validity period.
+- ExpiresDate (string): Expiration date.
 - AgencyCode (string): Agency code.
 
+When the value of `IdCardType` is `PhilippinesTinID`:
+- LicenseNumber (string): Tax identification number (TIN).
+- FullName (string): Full name.
+- Address (string): Address.
+- Birthday (string): Date of birth.
+- IssueDate (string): Issue date.
+
+When the value of `IdCardType` is `PhilippinesSSSID`:
+- LicenseNumber (string): Common reference number (CRN).
+- FullName (string): Full name.
+- Birthday (string): Date of birth.
+
+(4) Indonesian identity card
 When the value of `IdCardType` is `IndonesiaIDCard`:
-- NIK (string): Identity document No.
-- Nama (string): Name.
-- TempatTglLahir (string): Place/Date of birth.
+- NIK (string): Single Identity Number.
+- Nama (string): Full name.
+- TempatTglLahir (string): Place and date of birth.
 - JenisKelamin (string): Gender.
 - GolDarah (string): Blood type.
 - Alamat (string): Address.
@@ -978,12 +994,22 @@ When the value of `IdCardType` is `IndonesiaIDCard`:
 - Kecamatan (string): Region.
 - Agama (string): Religion.
 - StatusPerkawinan (string): Marital status.
-- Perkerjaan (string): Profession.
+- Perkerjaan (string): Occupation.
 - KewargaNegaraan (string): Nationality.
-- BerlakuHingga (string): Expiry date of the identity document.
-- IssuedDate (string): Date of issuance.
-
-Note: This field may return null, indicating that no valid values can be obtained.
+- BerlakuHingga (string): Expiry date.
+- IssuedDate (string): Issue date.
+
+(5) A passport issued in Hong Kong/Macao/Taiwan (China) or other countries/regions
+When the value of `IdCardType` is `MLIDPassport`:
+- FullName (string): Full name.
+- Surname (string): Surname.
+- GivenName (string): Given name.
+- Birthday (string): Date of birth.
+- Sex (string): Gender. Valid values: `F` (female) and `M` (male).
+- DateOfExpiration (string): Expiration date.
+- IssuingCountry (string): Issuing country.
+- NationalityCode (string): Country/region code.
+Note: This field may return null, indicating that no valid value can be obtained.
          * @type {FileInfo || null}
          */
         this.CardInfoOcrJson = null;
@@ -1632,13 +1658,22 @@ class CompareResult extends  AbstractModel {
         super();
 
         /**
-         * The final comparison result.
+         * The final verification result code.
+0: Success.
+1001: Failed to call the liveness detection engine.
+1004: Face detection failed.
+2004: The uploaded face image is too large or too small.
+2012: The face is not fully exposed.
+2013: No face is detected.
+2014: The resolution of the uploaded image is too low . Please upload a new one.
+2015: Face comparison failed.
+2016: The similarity did not reach the passing standard.
          * @type {string || null}
          */
         this.ErrorCode = null;
 
         /**
-         * The description of the final comparison result.
+         * The description of the final verification result.
          * @type {string || null}
          */
         this.ErrorMsg = null;
@@ -1650,13 +1685,16 @@ class CompareResult extends  AbstractModel {
         this.LiveData = null;
 
         /**
-         * The video for this liveness detection process. The URL is valid for 10 minutes.
+         * The download URL of the video used for verification, which is valid for 10 minutes.
          * @type {FileInfo || null}
          */
         this.LiveVideo = null;
 
         /**
-         * The code of the liveness detection result.
+         * The liveness detection result code.
+0: Success.
+1001: Failed to call the liveness detection engine.
+1004: Face detection failed.
          * @type {string || null}
          */
         this.LiveErrorCode = null;
@@ -1668,21 +1706,28 @@ class CompareResult extends  AbstractModel {
         this.LiveErrorMsg = null;
 
         /**
-         * The best face screenshot in this liveness detection. The URL is valid for 10 minutes.
-Note: This field may return null, indicating that no valid values can be obtained.
+         * The download URL of the face screenshot during verification, which is valid for 10 minutes.
+Note: This field may return null, indicating that no valid value can be obtained.
          * @type {FileInfo || null}
          */
         this.BestFrame = null;
 
         /**
-         * The profile photo screenshot from the identity document. The URL is valid for 10 minutes.
+         * The download URL of the profile photo screenshot from the identity document, which is valid for 10 minutes.
          * @type {FileInfo || null}
          */
         this.ProfileImage = null;
 
         /**
-         * The code of the face comparison result.
-Note: This field may return null, indicating that no valid values can be obtained.
+         * The face comparison result code.
+0: Success.
+2004: The uploaded face image is too large or too small.
+2012: The face is not fully exposed.
+2013: No face is detected.
+2014: The resolution of the uploaded image is too low . Please upload a new one.
+2015: Face comparison failed.
+2016: The similarity did not reach the passing standard.
+Note: This field may return null, indicating that no valid value can be obtained.
          * @type {string || null}
          */
         this.CompareErrorCode = null;
@@ -1695,8 +1740,8 @@ Note: This field may return null, indicating that no valid values can be obtaine
         this.CompareErrorMsg = null;
 
         /**
-         * Similarity
-Note: This field may return null, indicating that no valid values can be obtained.
+         * The similarity score of face comparison.
+Note: This field may return null, indicating that no valid value can be obtained.
          * @type {number || null}
          */
         this.Sim = null;

package/tencentcloud/ocr/v20181119/models.js

@@ -1790,6 +1790,130 @@ class Coord extends  AbstractModel {
     }
 }
 
+/**
+ * RecognizePhilippinesUMIDOCR response structure.
+ * @class
+ */
+class RecognizePhilippinesUMIDOCRResponse extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * The surname.
+         * @type {TextDetectionResult || null}
+         */
+        this.Surname = null;
+
+        /**
+         * The middle name.
+         * @type {TextDetectionResult || null}
+         */
+        this.MiddleName = null;
+
+        /**
+         * The given name.
+         * @type {TextDetectionResult || null}
+         */
+        this.GivenName = null;
+
+        /**
+         * The address.
+         * @type {TextDetectionResult || null}
+         */
+        this.Address = null;
+
+        /**
+         * The date of birth.
+         * @type {TextDetectionResult || null}
+         */
+        this.Birthday = null;
+
+        /**
+         * The common reference number (CRN).
+         * @type {TextDetectionResult || null}
+         */
+        this.CRN = null;
+
+        /**
+         * The gender.
+         * @type {TextDetectionResult || null}
+         */
+        this.Sex = null;
+
+        /**
+         * The Base64-encoded identity photo.
+         * @type {TextDetectionResult || null}
+         */
+        this.HeadPortrait = null;
+
+        /**
+         * The unique request ID, which is returned for each request. RequestId is required for locating a problem.
+         * @type {string || null}
+         */
+        this.RequestId = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+
+        if (params.Surname) {
+            let obj = new TextDetectionResult();
+            obj.deserialize(params.Surname)
+            this.Surname = obj;
+        }
+
+        if (params.MiddleName) {
+            let obj = new TextDetectionResult();
+            obj.deserialize(params.MiddleName)
+            this.MiddleName = obj;
+        }
+
+        if (params.GivenName) {
+            let obj = new TextDetectionResult();
+            obj.deserialize(params.GivenName)
+            this.GivenName = obj;
+        }
+
+        if (params.Address) {
+            let obj = new TextDetectionResult();
+            obj.deserialize(params.Address)
+            this.Address = obj;
+        }
+
+        if (params.Birthday) {
+            let obj = new TextDetectionResult();
+            obj.deserialize(params.Birthday)
+            this.Birthday = obj;
+        }
+
+        if (params.CRN) {
+            let obj = new TextDetectionResult();
+            obj.deserialize(params.CRN)
+            this.CRN = obj;
+        }
+
+        if (params.Sex) {
+            let obj = new TextDetectionResult();
+            obj.deserialize(params.Sex)
+            this.Sex = obj;
+        }
+
+        if (params.HeadPortrait) {
+            let obj = new TextDetectionResult();
+            obj.deserialize(params.HeadPortrait)
+            this.HeadPortrait = obj;
+        }
+        this.RequestId = 'RequestId' in params ? params.RequestId : null;
+
+    }
+}
+
 /**
  * RecognizeKoreanIDCardOCR request structure.
  * @class
@@ -2793,6 +2917,55 @@ class ItemCoord extends  AbstractModel {
     }
 }
 
+/**
+ * RecognizePhilippinesUMIDOCR request structure.
+ * @class
+ */
+class RecognizePhilippinesUMIDOCRRequest extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * The Base64-encoded value of the image.
+Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported.
+Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s.
+Either `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageUrl` is used.
+         * @type {string || null}
+         */
+        this.ImageBase64 = null;
+
+        /**
+         * The URL of the image.
+Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported.
+Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s.
+We recommend that you store the image in Tencent Cloud for higher download speed and stability.
+The download speed and stability of non-Tencent Cloud URLs may be low.
+         * @type {string || null}
+         */
+        this.ImageUrl = null;
+
+        /**
+         * Whether to return the identity photo.
+         * @type {boolean || null}
+         */
+        this.ReturnHeadImage = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.ImageBase64 = 'ImageBase64' in params ? params.ImageBase64 : null;
+        this.ImageUrl = 'ImageUrl' in params ? params.ImageUrl : null;
+        this.ReturnHeadImage = 'ReturnHeadImage' in params ? params.ReturnHeadImage : null;
+
+    }
+}
+
 /**
  * OCR result.
  * @class
@@ -3120,6 +3293,7 @@ module.exports = {
     DetectedWordCoordPoint: DetectedWordCoordPoint,
     Value: Value,
     Coord: Coord,
+    RecognizePhilippinesUMIDOCRResponse: RecognizePhilippinesUMIDOCRResponse,
     RecognizeKoreanIDCardOCRRequest: RecognizeKoreanIDCardOCRRequest,
     RecognizeKoreanIDCardOCRResponse: RecognizeKoreanIDCardOCRResponse,
     RecognizePhilippinesSssIDOCRResponse: RecognizePhilippinesSssIDOCRResponse,
@@ -3134,6 +3308,7 @@ module.exports = {
     LineInfo: LineInfo,
     BankCardOCRResponse: BankCardOCRResponse,
     ItemCoord: ItemCoord,
+    RecognizePhilippinesUMIDOCRRequest: RecognizePhilippinesUMIDOCRRequest,
     TextDetection: TextDetection,
     RecognizePhilippinesTinIDOCRResponse: RecognizePhilippinesTinIDOCRResponse,
     GeneralBasicOCRRequest: GeneralBasicOCRRequest,

package/tencentcloud/ocr/v20181119/ocr_client.js

@@ -43,6 +43,7 @@ const TableOCRResponse = models.TableOCRResponse;
 const DetectedWordCoordPoint = models.DetectedWordCoordPoint;
 const Value = models.Value;
 const Coord = models.Coord;
+const RecognizePhilippinesUMIDOCRResponse = models.RecognizePhilippinesUMIDOCRResponse;
 const RecognizeKoreanIDCardOCRRequest = models.RecognizeKoreanIDCardOCRRequest;
 const RecognizeKoreanIDCardOCRResponse = models.RecognizeKoreanIDCardOCRResponse;
 const RecognizePhilippinesSssIDOCRResponse = models.RecognizePhilippinesSssIDOCRResponse;
@@ -57,6 +58,7 @@ const TableOCRRequest = models.TableOCRRequest;
 const LineInfo = models.LineInfo;
 const BankCardOCRResponse = models.BankCardOCRResponse;
 const ItemCoord = models.ItemCoord;
+const RecognizePhilippinesUMIDOCRRequest = models.RecognizePhilippinesUMIDOCRRequest;
 const TextDetection = models.TextDetection;
 const RecognizePhilippinesTinIDOCRResponse = models.RecognizePhilippinesTinIDOCRResponse;
 const GeneralBasicOCRRequest = models.GeneralBasicOCRRequest;
@@ -107,6 +109,17 @@ A maximum of 10 requests can be initiated per second for this API.
         this.request("SmartStructuralOCRV2", req, resp, cb);
     }
 
+    /**
+     * This API is used to recognize a Philippine Unified Multi-Purpose ID (UMID) card.
+     * @param {RecognizePhilippinesUMIDOCRRequest} req
+     * @param {function(string, RecognizePhilippinesUMIDOCRResponse):void} cb
+     * @public
+     */
+    RecognizePhilippinesUMIDOCR(req, cb) {
+        let resp = new RecognizePhilippinesUMIDOCRResponse();
+        this.request("RecognizePhilippinesUMIDOCR", req, resp, cb);
+    }
+
     /**
      * This API is used to detect and recognize key fields such as the card number, bank information, and expiration date on mainstream bank cards in Mainland China.