tencentcloud-sdk-nodejs-intl-en 3.0.1384 → 3.0.1386

package/tencentcloud/ocr/v20181119/models.js

@@ -1030,48 +1030,60 @@ class GetCardVerificationExternalResultResponse extends  AbstractModel {
         super();
 
         /**
-         * Indicates the status. valid values: 
-PASSED
+         * Verification status. Valid values: 
 PROCESSING
-WARNING
+ABNORMAL
+COMPLETED
          * @type {string || null}
          */
         this.Status = null;
 
         /**
-         * Indicates the anti-counterfeiting information.
--ScreenshotSuspected: The image is a screenshot.
--RetakeSuspected: The image is taken from another screen.
--PaperCopy: The image is a black and white, or color photocopy.
--FakeSuspected: The image of the card, or the information on the card has been edited or altered.
--OtherWarning: Document's authenticity is not verified for various reasons.
+         * Anti-counterfeiting information. 
+- ScreenshotSuspected: The image is a screenshot.
+- RetakeSuspected: The image is taken from another screen.
+- PaperCopy: The image is a black and white, or color photocopy.
+- FakeSuspected: The image of the card, or the information on the card has been edited or altered.
+- PoorImageQuality: The image is bad quality.
+- InformationVerificationFailed: Information verification failed based on OCR recognition results
+- TooManyCards: Multiple cards present in the frame.
+- IncompleteCard: Captured document is incomplete.
+- OtherWarning: Document's authenticity is not verified for various reasons.
+
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {Array.<string> || null}
          */
         this.WarnInfo = null;
 
         /**
-         * Country Code.
+         * Country or region of the document.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
         this.Nationality = null;
 
         /**
-         * Recognition result of the text in the id photo.	
+         * Front-side document recognition results. 
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {GeneralCard || null}
          */
         this.CardInfo = null;
 
         /**
-         * Specifies the token in the request parameters.
+         * Back-side document recognition results.
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {GeneralCard || null}
+         */
+        this.BackCardInfo = null;
+
+        /**
+         * The token passed in the input parameters.
          * @type {string || null}
          */
         this.CardVerificationToken = null;
 
         /**
-         * If the ReturnHeadImage is false or not passed when initiating the card and certificate recognition, the HeadImageBase64 will return an empty string. If the ReturnHeadImage is true when initiating the card and certificate recognition and the HeadImageBase64 returns an empty string, it indicates that the face image recognition has failed. Please check the image.
+         * Base64-encoded head image from the document. If ReturnHeadImage was set to false or not provided in the request, this field returns an empty string. If ReturnHeadImage was set to true and this field returns an empty string, indicating a failure to extract the head image extraction failed. Please check the input document photo.
          * @type {string || null}
          */
         this.HeadImageBase64 = null;
@@ -1100,6 +1112,12 @@ Note: This field may return null, indicating that no valid values can be obtaine
             obj.deserialize(params.CardInfo)
             this.CardInfo = obj;
         }
+
+        if (params.BackCardInfo) {
+            let obj = new GeneralCard();
+            obj.deserialize(params.BackCardInfo)
+            this.BackCardInfo = obj;
+        }
         this.CardVerificationToken = 'CardVerificationToken' in params ? params.CardVerificationToken : null;
         this.HeadImageBase64 = 'HeadImageBase64' in params ? params.HeadImageBase64 : null;
         this.RequestId = 'RequestId' in params ? params.RequestId : null;
@@ -2391,42 +2409,94 @@ Note: This field may return null, indicating that no valid values can be obtaine
         this.LicenseNumber = null;
 
         /**
-         * Personal number. returned when the identity document type is passport.
+         * Personal number. 
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
         this.PersonalNumber = null;
 
         /**
-         * Passport mrz line 1.
+         * Full name on the document.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
-        this.PassportCodeFirst = null;
+        this.FullName = null;
 
         /**
-         * Passport mrz line 2.
+         * Full name in local language.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
-        this.PassportCodeSecond = null;
+        this.FullNameLocal = null;
 
         /**
-         * Expiration date, in YYYY-MM-DD format.
+         * First name or given name.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
-        this.ExpirationDate = null;
+        this.FirstName = null;
 
         /**
-         * Expiration date in YYYY-MM-DD format.
+         * First name in local language.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
-        this.DueDate = null;
+        this.FirstNameLocal = null;
+
+        /**
+         * Middle name.
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {string || null}
+         */
+        this.MiddleName = null;
 
         /**
-         * Issue date, in YYYY-MM-DD format.
+         * Middle name in local language.
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {string || null}
+         */
+        this.MiddleNameLocal = null;
+
+        /**
+         * Last name or surname.
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {string || null}
+         */
+        this.LastName = null;
+
+        /**
+         * Last name in local language.
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {string || null}
+         */
+        this.LastNameLocal = null;
+
+        /**
+         * Gender on the document.
+- M: man.
+- F: woman.
+- X: other gender identity.
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {string || null}
+         */
+        this.Sex = null;
+
+        /**
+         * Date of birth.
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {string || null}
+         */
+        this.Birthday = null;
+
+        /**
+         * Birth place.
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {string || null}
+         */
+        this.BirthPlace = null;
+
+        /**
+         * Issue date.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
@@ -2440,105 +2510,158 @@ Note: This field may return null, indicating that no valid values can be obtaine
         this.IssuedAuthority = null;
 
         /**
-         * Issuing country, following the ISO 3166 country coding specification.
+         * Place of issue.
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {string || null}
+         */
+        this.IssuedPlace = null;
+
+        /**
+         * Issuing country.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
         this.IssuedCountry = null;
 
         /**
-         * Specifies the name.
+         * Country code of issue, ISO Alpha-3 format.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
-        this.FullName = null;
+        this.IssuedCountryCode = null;
 
         /**
-         * Name.
+         * Expiry date.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
-        this.FirstName = null;
+        this.ExpirationDate = null;
 
         /**
-         * Name.
+         * First line of the Machine Readable Zone (MRZ).
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
-        this.LastName = null;
+        this.MRZLine1 = null;
 
         /**
-         * Gender on the document.
-- M: man.
-- F: woman.
-- X: other gender identity.
+         * Second line of the Machine Readable Zone (MRZ).
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
-        this.Sex = null;
+        this.MRZLine2 = null;
 
         /**
-         * Age. 0 means no valid info.
+         * Document nationality, following ISO 3166 country coding specification.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
-        this.Age = null;
+        this.Nationality = null;
 
         /**
-         * Date of birth.
+         * Address information on the document.
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {AddressInfo || null}
+         */
+        this.Address = null;
+
+        /**
+         * Religion (if displayed on the document).
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
-        this.Birthday = null;
+        this.Religion = null;
 
         /**
-         * Birth place.
+         * Type of document.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
-        this.BirthPlace = null;
+        this.Type = null;
 
         /**
-         * Document nationality, following ISO 3166 country coding specification.
+         * Blood type.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
-        this.Nationality = null;
+        this.BloodType = null;
 
         /**
-         * Registration number.
+         * Height.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
-        this.RegistrationNumber = null;
+        this.Height = null;
 
         /**
-         * Specifies the address information of the document.
+         * Weight.
 Note: This field may return null, indicating that no valid values can be obtained.
-         * @type {AddressInfo || null}
+         * @type {string || null}
          */
-        this.Address = null;
+        this.Weight = null;
 
         /**
-         * Localized name.
+         * Vehicle class authorized on the driver license (e.g., A, B, C).
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
-        this.FullNameLocal = null;
+        this.VehicleClass = null;
 
         /**
-         * Localization name.
+         * Restrictions on the driver license.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
-        this.FirstNameLocal = null;
+        this.Restrictions = null;
 
         /**
-         * Localized surname.
+         * Endorsements or additional records on the driver license.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
-        this.LastNameLocal = null;
+        this.Endorsement = null;
+
+        /**
+         * Supplementary fields (varies by document type).
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {string || null}
+         */
+        this.Others = null;
+
+        /**
+         * First line of the passport MRZ (Machine Readable Zone).
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {string || null}
+         */
+        this.PassportCodeFirst = null;
+
+        /**
+         * Second line of the passport MRZ (Machine Readable Zone).
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {string || null}
+         */
+        this.PassportCodeSecond = null;
+
+        /**
+         * Expiry date.
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {string || null}
+         */
+        this.DueDate = null;
+
+        /**
+         * Age. 0 means no valid info.
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {string || null}
+         */
+        this.Age = null;
+
+        /**
+         * Registration number.
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {string || null}
+         */
+        this.RegistrationNumber = null;
 
     }
 
@@ -2551,31 +2674,46 @@ Note: This field may return null, indicating that no valid values can be obtaine
         }
         this.LicenseNumber = 'LicenseNumber' in params ? params.LicenseNumber : null;
         this.PersonalNumber = 'PersonalNumber' in params ? params.PersonalNumber : null;
-        this.PassportCodeFirst = 'PassportCodeFirst' in params ? params.PassportCodeFirst : null;
-        this.PassportCodeSecond = 'PassportCodeSecond' in params ? params.PassportCodeSecond : null;
-        this.ExpirationDate = 'ExpirationDate' in params ? params.ExpirationDate : null;
-        this.DueDate = 'DueDate' in params ? params.DueDate : null;
-        this.IssuedDate = 'IssuedDate' in params ? params.IssuedDate : null;
-        this.IssuedAuthority = 'IssuedAuthority' in params ? params.IssuedAuthority : null;
-        this.IssuedCountry = 'IssuedCountry' in params ? params.IssuedCountry : null;
         this.FullName = 'FullName' in params ? params.FullName : null;
+        this.FullNameLocal = 'FullNameLocal' in params ? params.FullNameLocal : null;
         this.FirstName = 'FirstName' in params ? params.FirstName : null;
+        this.FirstNameLocal = 'FirstNameLocal' in params ? params.FirstNameLocal : null;
+        this.MiddleName = 'MiddleName' in params ? params.MiddleName : null;
+        this.MiddleNameLocal = 'MiddleNameLocal' in params ? params.MiddleNameLocal : null;
         this.LastName = 'LastName' in params ? params.LastName : null;
+        this.LastNameLocal = 'LastNameLocal' in params ? params.LastNameLocal : null;
         this.Sex = 'Sex' in params ? params.Sex : null;
-        this.Age = 'Age' in params ? params.Age : null;
         this.Birthday = 'Birthday' in params ? params.Birthday : null;
         this.BirthPlace = 'BirthPlace' in params ? params.BirthPlace : null;
+        this.IssuedDate = 'IssuedDate' in params ? params.IssuedDate : null;
+        this.IssuedAuthority = 'IssuedAuthority' in params ? params.IssuedAuthority : null;
+        this.IssuedPlace = 'IssuedPlace' in params ? params.IssuedPlace : null;
+        this.IssuedCountry = 'IssuedCountry' in params ? params.IssuedCountry : null;
+        this.IssuedCountryCode = 'IssuedCountryCode' in params ? params.IssuedCountryCode : null;
+        this.ExpirationDate = 'ExpirationDate' in params ? params.ExpirationDate : null;
+        this.MRZLine1 = 'MRZLine1' in params ? params.MRZLine1 : null;
+        this.MRZLine2 = 'MRZLine2' in params ? params.MRZLine2 : null;
         this.Nationality = 'Nationality' in params ? params.Nationality : null;
-        this.RegistrationNumber = 'RegistrationNumber' in params ? params.RegistrationNumber : null;
 
         if (params.Address) {
             let obj = new AddressInfo();
             obj.deserialize(params.Address)
             this.Address = obj;
         }
-        this.FullNameLocal = 'FullNameLocal' in params ? params.FullNameLocal : null;
-        this.FirstNameLocal = 'FirstNameLocal' in params ? params.FirstNameLocal : null;
-        this.LastNameLocal = 'LastNameLocal' in params ? params.LastNameLocal : null;
+        this.Religion = 'Religion' in params ? params.Religion : null;
+        this.Type = 'Type' in params ? params.Type : null;
+        this.BloodType = 'BloodType' in params ? params.BloodType : null;
+        this.Height = 'Height' in params ? params.Height : null;
+        this.Weight = 'Weight' in params ? params.Weight : null;
+        this.VehicleClass = 'VehicleClass' in params ? params.VehicleClass : null;
+        this.Restrictions = 'Restrictions' in params ? params.Restrictions : null;
+        this.Endorsement = 'Endorsement' in params ? params.Endorsement : null;
+        this.Others = 'Others' in params ? params.Others : null;
+        this.PassportCodeFirst = 'PassportCodeFirst' in params ? params.PassportCodeFirst : null;
+        this.PassportCodeSecond = 'PassportCodeSecond' in params ? params.PassportCodeSecond : null;
+        this.DueDate = 'DueDate' in params ? params.DueDate : null;
+        this.Age = 'Age' in params ? params.Age : null;
+        this.RegistrationNumber = 'RegistrationNumber' in params ? params.RegistrationNumber : null;
 
     }
 }
@@ -6585,84 +6723,62 @@ class ApplyCardVerificationExternalRequest extends  AbstractModel {
         super();
 
         /**
-         * Specifies the country of the document.
-ARG:Argentina
-AUS:Australia
-KHM:Cambodia
-CAN:Canada
-SGP:Singapore
-CHL:Chile
-DEU:Germany
-MEX:Mexico
-MMR:Myanmar
-NZL:New Zealand
-BGD:Bangladesh
-NGA:Nigeria
-PAK:Pakistan
-RUS:Russia
-IDN:Indonesia
-HKG:Hong Kong, China
-THA:Thailand
-MYS:Malaysia
-JPN:Japan
-PHL:Philippines
-MAC:Macao, China
-CHN:ChinaPermit
-TWN:Taiwan, China
-BGD:Bangladesh
-NGA:Nigeria 
-PAK:Pakistan
-
-AUTO: supports cards and documents from 200+ countries
+         * Country/Region of the document. For the full list of supported countries/regions, refer to the API description.
          * @type {string || null}
          */
         this.Nationality = null;
 
         /**
-         * Document type.
-ID_CARD
-PASSPORT
-DRIVING_LICENSE
-RESIDENCE_PERMIT (Supported in certain countries/regions, including Australia, Canada, Germany, New Zealand, Nigeria, Singapore).
+         * Document type. Supported values: ID_CARD, PASSPORT, DRIVING_LICENSE, RESIDENCE_PERMIT (only supported in certain countries/regions, including Australia, Canada, Germany, New Zealand, Nigeria, Singapore).
          * @type {string || null}
          */
         this.CardType = null;
 
         /**
-         * The Base64 value of the document Front. supported image formats: PNG, JPG/JPEG. 
-Supported image size: the downloaded image after Base64 encoding must be no more than 2M. image download time must be no more than 5 seconds. 
-Supported image resolution: between 256 \* 256 and 4096 \* 4096. For some documents, either ImageUrlBack or ImageBase64Back must be provided. If both are provided, only ImageUrlFront will be used.
+         * Base64-encoded image of the document front.
+Supported image formats: PNG, JPG/JPEG (GIF not supported).
+Supported image size: The downloaded image after Base64 encoding must not exceed 2 MB. Image download time must not exceed 5 seconds.
+Supported image resolution: Between 256*256 and 4096*4096 pixels.
+Note: You must provide either ImageUrlFront or ImageBase64Front. If both are provided, only ImageUrlFront is used.
          * @type {string || null}
          */
         this.ImageBase64Front = null;
 
         /**
          * The Base64 value of the reverse side of the document. Supported image formats: PNG, JPG/JPEG. 
-Supported image size: the downloaded image after Base64 encoding must be no more than 2M. image download time must be no more than 5 seconds. 
+Supported image size: the downloaded image after Base64 encoding must be no more than 2M. Image download time must be no more than 5 seconds. 
 Supported image resolution: between 256 \* 256 and 4096 \* 4096. For some documents, either ImageUrlBack or ImageBase64Back must be provided. If both are provided, only ImageUrlBack is used.
          * @type {string || null}
          */
         this.ImageBase64Back = null;
 
         /**
-         * Url of the document Front. supported image formats: PNG, JPG/JPEG. 
-Supported image size: the downloaded image after Base64 encoding must be no more than 2M. image download time must be no more than 5 seconds. 
-Supported image resolution: between 256 \* 256 and 4096 \* 4096. For some documents, either ImageUrlBack or ImageBase64Back must be provided. If both are provided, only ImageUrlFront will be used.
+         * URL of the document front image.
+Supported image formats: PNG, JPG/JPEG (GIF not supported).
+Supported image size: The downloaded image after Base64 encoding must not exceed 2 MB. Image download time must not exceed 5 seconds.
+Supported image resolution: Between 256*256 and 4096*4096 pixels.
+Note: You must provide either ImageUrlFront or ImageBase64Front. If both are provided, only ImageUrlFront is used.
          * @type {string || null}
          */
         this.ImageUrlFront = null;
 
         /**
-         * Specifies the Url of the document Back. supported image formats: PNG, JPG/JPEG
-Supported image size: no more than 2M after Base64 encoding. image download time should not exceed 5 seconds. 
-Supported image resolution: between 256 \* 256 and 4096 \* 4096. For some documents, either ImageUrlBack or ImageBase64Back must be provided. If both are provided, only use ImageUrlBack.
-
+         * URL of the document back image.
+Supported image formats: PNG, JPG/JPEG (GIF not supported).
+Supported image size: The downloaded image after Base64 encoding must not exceed 2 MB. Image download time must not exceed 5 seconds.
+Supported image resolution: Between 256*256 and 4096*4096 pixels.
+Note: For some documents, you must provide either ImageUrlBack or ImageBase64Back. If both are provided, only ImageUrlBack is used.
          * @type {string || null}
          */
         this.ImageUrlBack = null;
 
         /**
-         * Whether to extract the ID portrait. Default value: false.
+         * Whether to crop and return the face image from the document. Default: false.
+If set to true, the image constraints are:
+- Size after Base64 encoding must not exceed 5 MB.
+- Maximum pixel width/height: 4000 for JPG, 2000 for other formats.
+- Minimum pixel width/height: 64.
+- Supported formats: PNG, JPG, JPEG, BMP (GIF not supported).
          * @type {boolean || null}
          */
         this.ReturnHeadImage = null;
@@ -10403,7 +10519,7 @@ class ApplyCardVerificationExternalResponse extends  AbstractModel {
         super();
 
         /**
-         * Process token, which is used to obtain the result.
+         * Unique token for the verification process, used to retrieve the result.
          * @type {string || null}
          */
         this.CardVerificationToken = null;
@@ -12803,21 +12919,35 @@ Note: This field may return null, indicating that no valid values can be obtaine
         this.PostalCode = null;
 
         /**
-         * Specifies the sub-region.
+         * Sub-region or state/province.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
         this.Subdivision = null;
 
         /**
-         * Specifies the city.
+         * District or county.
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {string || null}
+         */
+        this.District = null;
+
+        /**
+         * City name.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
         this.City = null;
 
         /**
-         * Complete address.
+         * Subdistrict or township.
+Note: This field may return null, indicating that no valid values can be obtained.
+         * @type {string || null}
+         */
+        this.Subdistrict = null;
+
+        /**
+         * Formatted complete address.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
@@ -12852,7 +12982,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
         this.LineFour = null;
 
         /**
-         * Specifies the fifth line in the address bar.
+         * Specifies the fifth line of the address bar.
 Note: This field may return null, indicating that no valid values can be obtained.
          * @type {string || null}
          */
@@ -12870,7 +13000,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
         this.Country = 'Country' in params ? params.Country : null;
         this.PostalCode = 'PostalCode' in params ? params.PostalCode : null;
         this.Subdivision = 'Subdivision' in params ? params.Subdivision : null;
+        this.District = 'District' in params ? params.District : null;
         this.City = 'City' in params ? params.City : null;
+        this.Subdistrict = 'Subdistrict' in params ? params.Subdistrict : null;
         this.FormattedAddress = 'FormattedAddress' in params ? params.FormattedAddress : null;
         this.LineOne = 'LineOne' in params ? params.LineOne : null;
         this.LineTwo = 'LineTwo' in params ? params.LineTwo : null;

package/tencentcloud/ocr/v20181119/ocr_client.js

@@ -365,9 +365,9 @@ This interface supports regional scope: countries with machine-readable passport
     }
 
     /**
-     * This API is used for general recognition of overseas cards.
+     * This API provides general OCR recognition for overseas identity documents.
 
-The following list details the countries or regions, document types supported by the overseas document recognition API and whether the back side of the document is required:
+The following table lists the supported countries or regions, document types, and whether the back side is required:
 
 <table>
 <thead>

package/tencentcloud/rum/v20210622/models.js

@@ -10912,7 +10912,7 @@ class CreateReleaseFileResponse extends  AbstractModel {
         this.Msg = null;
 
         /**
-         * The unique request ID, which is returned for each request. RequestId is required for locating a problem.
+         * The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
          * @type {string || null}
          */
         this.RequestId = null;