tencentcloud-sdk-nodejs-intl-en 3.0.1471 → 3.0.1472

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -703,6 +703,190 @@ ItemNames=["Name","Gender"]
703
703
  }
704
704
  }
705
705
 
706
+ /**
707
+ * RecognizeThaiIDCardOCR response structure.
708
+ * @class
709
+ */
710
+ class RecognizeThaiIDCardOCRResponse extends AbstractModel {
711
+ constructor(){
712
+ super();
713
+
714
+ /**
715
+ * ID card number
716
+ * @type {string || null}
717
+ */
718
+ this.ID = null;
719
+
720
+ /**
721
+ * Name in Thai
722
+ * @type {string || null}
723
+ */
724
+ this.ThaiName = null;
725
+
726
+ /**
727
+ * First name in English
728
+ * @type {string || null}
729
+ */
730
+ this.EnFirstName = null;
731
+
732
+ /**
733
+ * Last name in English
734
+ * @type {string || null}
735
+ */
736
+ this.EnLastName = null;
737
+
738
+ /**
739
+ * Date of issue in Thai
740
+ * @type {string || null}
741
+ */
742
+ this.IssueDate = null;
743
+
744
+ /**
745
+ * Expiration date in Thai
746
+ * @type {string || null}
747
+ */
748
+ this.ExpirationDate = null;
749
+
750
+ /**
751
+ * Date of issue in English
752
+ * @type {string || null}
753
+ */
754
+ this.EnIssueDate = null;
755
+
756
+ /**
757
+ * Expiration date in English
758
+ * @type {string || null}
759
+ */
760
+ this.EnExpirationDate = null;
761
+
762
+ /**
763
+ * Date of birth in Thai
764
+ * @type {string || null}
765
+ */
766
+ this.Birthday = null;
767
+
768
+ /**
769
+ * Date of birth in English
770
+ * @type {string || null}
771
+ */
772
+ this.EnBirthday = null;
773
+
774
+ /**
775
+ * Religion
776
+ * @type {string || null}
777
+ */
778
+ this.Religion = null;
779
+
780
+ /**
781
+ * Serial number
782
+ * @type {string || null}
783
+ */
784
+ this.SerialNumber = null;
785
+
786
+ /**
787
+ * Address
788
+ * @type {string || null}
789
+ */
790
+ this.Address = null;
791
+
792
+ /**
793
+ * Laser ID on the back of the card
794
+ * @type {string || null}
795
+ */
796
+ this.LaserID = null;
797
+
798
+ /**
799
+ * Identity photo
800
+ * @type {string || null}
801
+ */
802
+ this.PortraitImage = null;
803
+
804
+ /**
805
+ * Card Warning Information
806
+
807
+ -9101 Alarm for covered certificate
808
+ -9102 Alarm for photocopied certificate
809
+ -9103 Alarm for photographed certificate
810
+ -9104 Alarm for tamper certificate
811
+ -9107 Alarm for reflective certificate
812
+ -9108 Alarm for blurry certificate
813
+ -9109 This capability is not enabled. Please contact customer support to activate the alert service
814
+ * @type {Array.<number> || null}
815
+ */
816
+ this.WarnCardInfos = null;
817
+
818
+ /**
819
+ * <p>This field is deprecated and will always return "1". It is not recommended for use.</p>
820
+ * @type {string || null}
821
+ */
822
+ this.AdvancedInfo = null;
823
+
824
+ /**
825
+ * The number of cards detected in the input image provided via ImageBase64 parameter.(Currently supported only in ap-bangkok region)
826
+ * @type {number || null}
827
+ */
828
+ this.CardCount = null;
829
+
830
+ /**
831
+ * The card information field complete or not
832
+ true: complete; false: incomplete
833
+ * @type {boolean || null}
834
+ */
835
+ this.IsComplete = null;
836
+
837
+ /**
838
+ * First name in Thai
839
+ * @type {string || null}
840
+ */
841
+ this.ThaiFirstName = null;
842
+
843
+ /**
844
+ * Last name in Thai
845
+ * @type {string || null}
846
+ */
847
+ this.ThaiLastName = null;
848
+
849
+ /**
850
+ * 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.
851
+ * @type {string || null}
852
+ */
853
+ this.RequestId = null;
854
+
855
+ }
856
+
857
+ /**
858
+ * @private
859
+ */
860
+ deserialize(params) {
861
+ if (!params) {
862
+ return;
863
+ }
864
+ this.ID = 'ID' in params ? params.ID : null;
865
+ this.ThaiName = 'ThaiName' in params ? params.ThaiName : null;
866
+ this.EnFirstName = 'EnFirstName' in params ? params.EnFirstName : null;
867
+ this.EnLastName = 'EnLastName' in params ? params.EnLastName : null;
868
+ this.IssueDate = 'IssueDate' in params ? params.IssueDate : null;
869
+ this.ExpirationDate = 'ExpirationDate' in params ? params.ExpirationDate : null;
870
+ this.EnIssueDate = 'EnIssueDate' in params ? params.EnIssueDate : null;
871
+ this.EnExpirationDate = 'EnExpirationDate' in params ? params.EnExpirationDate : null;
872
+ this.Birthday = 'Birthday' in params ? params.Birthday : null;
873
+ this.EnBirthday = 'EnBirthday' in params ? params.EnBirthday : null;
874
+ this.Religion = 'Religion' in params ? params.Religion : null;
875
+ this.SerialNumber = 'SerialNumber' in params ? params.SerialNumber : null;
876
+ this.Address = 'Address' in params ? params.Address : null;
877
+ this.LaserID = 'LaserID' in params ? params.LaserID : null;
878
+ this.PortraitImage = 'PortraitImage' in params ? params.PortraitImage : null;
879
+ this.WarnCardInfos = 'WarnCardInfos' in params ? params.WarnCardInfos : null;
880
+ this.AdvancedInfo = 'AdvancedInfo' in params ? params.AdvancedInfo : null;
881
+ this.CardCount = 'CardCount' in params ? params.CardCount : null;
882
+ this.IsComplete = 'IsComplete' in params ? params.IsComplete : null;
883
+ this.ThaiFirstName = 'ThaiFirstName' in params ? params.ThaiFirstName : null;
884
+ this.ThaiLastName = 'ThaiLastName' in params ? params.ThaiLastName : null;
885
+ this.RequestId = 'RequestId' in params ? params.RequestId : null;
886
+
887
+ }
888
+ }
889
+
706
890
  /**
707
891
  * RecognizeBrazilCommonOCR response structure.
708
892
  * @class
@@ -1258,48 +1442,95 @@ class RecognizeMainlandIDCardOCRRequest extends AbstractModel {
1258
1442
  }
1259
1443
 
1260
1444
  /**
1261
- * MLIDCardOCR request structure.
1445
+ * HmtResidentPermitOCR response structure.
1262
1446
  * @class
1263
1447
  */
1264
- class MLIDCardOCRRequest extends AbstractModel {
1448
+ class HmtResidentPermitOCRResponse extends AbstractModel {
1265
1449
  constructor(){
1266
1450
  super();
1267
1451
 
1268
1452
  /**
1269
- * The Base64-encoded value of an image.
1270
- Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported.
1271
- Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s.
1453
+ * <p>Name on the document</p>
1272
1454
  * @type {string || null}
1273
1455
  */
1274
- this.ImageBase64 = null;
1456
+ this.Name = null;
1275
1457
 
1276
1458
  /**
1277
- * Base64 value of the image on the back of the card. Supported image formats: PNG, JPG, JPEG, GIF format is not supported yet. Supported image size: The downloaded image cannot exceed 7M after Base64 encoding. The image download takes no more than 3 seconds. One of ImageUrl and ImageBase64 of the image must be provided. If both are provided, only ImageUrl will be used.
1459
+ * <p>Gender</p>
1278
1460
  * @type {string || null}
1279
1461
  */
1280
- this.BackImageBase64 = null;
1462
+ this.Sex = null;
1281
1463
 
1282
1464
  /**
1283
- * The URL of an image. (This field is not available outside the Chinese mainland.)
1284
- Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported.
1285
- Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s.
1286
- We recommend that you store the image in Tencent Cloud for higher download speed and stability.
1287
- For a non-Tencent Cloud URL, the download speed and stability may be low.
1465
+ * <p>Date of birth</p>
1288
1466
  * @type {string || null}
1289
1467
  */
1290
- this.ImageUrl = null;
1468
+ this.Birth = null;
1291
1469
 
1292
1470
  /**
1293
- * The URL address of the image on the back of the card. Supported image formats: PNG, JPG, JPEG, GIF format is not supported yet. Supported image size: The downloaded image does not exceed 7M after Base64 encoding. The image download takes no more than 3 seconds. Storing images in Tencent Cloud URLs can ensure higher download speed and stability. It is recommended that images be stored in Tencent Cloud. The URL speed and stability of non-Tencent cloud storage may be affected to a certain extent.
1471
+ * <p>Address</p>
1294
1472
  * @type {string || null}
1295
1473
  */
1296
- this.BackImageUrl = null;
1474
+ this.Address = null;
1297
1475
 
1298
1476
  /**
1299
- * Whether to return an image. Default value: `false`.
1300
- * @type {boolean || null}
1477
+ * <p>Identity card number</p>
1478
+ * @type {string || null}
1301
1479
  */
1302
- this.RetImage = null;
1480
+ this.IdCardNo = null;
1481
+
1482
+ /**
1483
+ * <p>0-Front<br>1-Back</p>
1484
+ * @type {number || null}
1485
+ */
1486
+ this.CardType = null;
1487
+
1488
+ /**
1489
+ * <p>Document validity period</p>
1490
+ * @type {string || null}
1491
+ */
1492
+ this.ValidDate = null;
1493
+
1494
+ /**
1495
+ * <p>Issuing authority</p>
1496
+ * @type {string || null}
1497
+ */
1498
+ this.Authority = null;
1499
+
1500
+ /**
1501
+ * <p>Number of issuances</p>
1502
+ * @type {string || null}
1503
+ */
1504
+ this.VisaNum = null;
1505
+
1506
+ /**
1507
+ * Travel permit number
1508
+ * @type {string || null}
1509
+ */
1510
+ this.PassNo = null;
1511
+
1512
+ /**
1513
+ * Portrait image and coordinate information
1514
+ * @type {PortraitImageInfo || null}
1515
+ */
1516
+ this.PortraitImageInfo = null;
1517
+
1518
+ /**
1519
+ * Card Warning Information
1520
+
1521
+ -9102 Alarm for photocopied certificate
1522
+ -9103 Alarm for photographed certificate
1523
+ -9104 Alarm for tamper certificate
1524
+ -9109 This capability is not enabled. Please contact customer support to activate the alert service
1525
+ * @type {Array.<number> || null}
1526
+ */
1527
+ this.WarnCardInfos = null;
1528
+
1529
+ /**
1530
+ * 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.
1531
+ * @type {string || null}
1532
+ */
1533
+ this.RequestId = null;
1303
1534
 
1304
1535
  }
1305
1536
 
@@ -1310,11 +1541,24 @@ For a non-Tencent Cloud URL, the download speed and stability may be low.
1310
1541
  if (!params) {
1311
1542
  return;
1312
1543
  }
1313
- this.ImageBase64 = 'ImageBase64' in params ? params.ImageBase64 : null;
1314
- this.BackImageBase64 = 'BackImageBase64' in params ? params.BackImageBase64 : null;
1315
- this.ImageUrl = 'ImageUrl' in params ? params.ImageUrl : null;
1316
- this.BackImageUrl = 'BackImageUrl' in params ? params.BackImageUrl : null;
1317
- this.RetImage = 'RetImage' in params ? params.RetImage : null;
1544
+ this.Name = 'Name' in params ? params.Name : null;
1545
+ this.Sex = 'Sex' in params ? params.Sex : null;
1546
+ this.Birth = 'Birth' in params ? params.Birth : null;
1547
+ this.Address = 'Address' in params ? params.Address : null;
1548
+ this.IdCardNo = 'IdCardNo' in params ? params.IdCardNo : null;
1549
+ this.CardType = 'CardType' in params ? params.CardType : null;
1550
+ this.ValidDate = 'ValidDate' in params ? params.ValidDate : null;
1551
+ this.Authority = 'Authority' in params ? params.Authority : null;
1552
+ this.VisaNum = 'VisaNum' in params ? params.VisaNum : null;
1553
+ this.PassNo = 'PassNo' in params ? params.PassNo : null;
1554
+
1555
+ if (params.PortraitImageInfo) {
1556
+ let obj = new PortraitImageInfo();
1557
+ obj.deserialize(params.PortraitImageInfo)
1558
+ this.PortraitImageInfo = obj;
1559
+ }
1560
+ this.WarnCardInfos = 'WarnCardInfos' in params ? params.WarnCardInfos : null;
1561
+ this.RequestId = 'RequestId' in params ? params.RequestId : null;
1318
1562
 
1319
1563
  }
1320
1564
  }
@@ -1726,6 +1970,41 @@ The paragraph information `Parag` returned by the `GeneralBasicOcr` API contains
1726
1970
  }
1727
1971
  }
1728
1972
 
1973
+ /**
1974
+ * Skipped check items
1975
+ * @class
1976
+ */
1977
+ class SkippedCheck extends AbstractModel {
1978
+ constructor(){
1979
+ super();
1980
+
1981
+ /**
1982
+ * <p>Detection item name</p>
1983
+ * @type {string || null}
1984
+ */
1985
+ this.Check = null;
1986
+
1987
+ /**
1988
+ * <p>Skip reason: NotSupported (this card type does not support this detection item) / NotApplicable (prerequisite not met, for example, consistency check requires a back image)</p>
1989
+ * @type {string || null}
1990
+ */
1991
+ this.Reason = null;
1992
+
1993
+ }
1994
+
1995
+ /**
1996
+ * @private
1997
+ */
1998
+ deserialize(params) {
1999
+ if (!params) {
2000
+ return;
2001
+ }
2002
+ this.Check = 'Check' in params ? params.Check : null;
2003
+ this.Reason = 'Reason' in params ? params.Reason : null;
2004
+
2005
+ }
2006
+ }
2007
+
1729
2008
  /**
1730
2009
  * RecognizeDetectCardCoords request structure.
1731
2010
  * @class
@@ -1818,7 +2097,7 @@ class GeneralCard extends AbstractModel {
1818
2097
  this.MiddleNameLocal = null;
1819
2098
 
1820
2099
  /**
1821
- * <p>Last name</p>
2100
+ * <p>Surname</p>
1822
2101
  * @type {string || null}
1823
2102
  */
1824
2103
  this.LastName = null;
@@ -1830,7 +2109,7 @@ class GeneralCard extends AbstractModel {
1830
2109
  this.LastNameLocal = null;
1831
2110
 
1832
2111
  /**
1833
- * <p>Gender on the document</p><ul><li>M: man</li><li>F: woman</li><li>X: other gender identity</li></ul>
2112
+ * <p>Gender on the document</p><ul><li>M: Man</li><li>F: Woman</li><li>X: Other gender identity</li></ul>
1834
2113
  * @type {string || null}
1835
2114
  */
1836
2115
  this.Sex = null;
@@ -1860,7 +2139,7 @@ class GeneralCard extends AbstractModel {
1860
2139
  this.IssuedAuthority = null;
1861
2140
 
1862
2141
  /**
1863
- * <p>Place where the specified file is issued</p>
2142
+ * <p>Place where the file is issued.</p>
1864
2143
  * @type {string || null}
1865
2144
  */
1866
2145
  this.IssuedPlace = null;
@@ -1884,7 +2163,7 @@ class GeneralCard extends AbstractModel {
1884
2163
  this.ExpirationDate = null;
1885
2164
 
1886
2165
  /**
1887
- * <p>Content of the single-line machine-readable zone (MRZ) on the document. The number represents the order in which the line appears in the MRZ</p>
2166
+ * <p>Content of the single-line machine-readable zone (MRZ) on the document. The number represents the line count in the order of the MRZ</p>
1888
2167
  * @type {string || null}
1889
2168
  */
1890
2169
  this.MRZLine1 = null;
@@ -1902,7 +2181,7 @@ class GeneralCard extends AbstractModel {
1902
2181
  this.Nationality = null;
1903
2182
 
1904
2183
  /**
1905
- * <p>Address information on the document</p>
2184
+ * <p>Document address information</p>
1906
2185
  * @type {AddressInfo || null}
1907
2186
  */
1908
2187
  this.Address = null;
@@ -1932,7 +2211,7 @@ class GeneralCard extends AbstractModel {
1932
2211
  this.Height = null;
1933
2212
 
1934
2213
  /**
1935
- * <p>Weight</p>
2214
+ * <p>Weight.</p>
1936
2215
  * @type {string || null}
1937
2216
  */
1938
2217
  this.Weight = null;
@@ -1944,13 +2223,13 @@ class GeneralCard extends AbstractModel {
1944
2223
  this.VehicleClass = null;
1945
2224
 
1946
2225
  /**
1947
- * <p>Driver's license restriction condition</p>
2226
+ * <p>Driver's license restrictions</p>
1948
2227
  * @type {string || null}
1949
2228
  */
1950
2229
  this.Restrictions = null;
1951
2230
 
1952
2231
  /**
1953
- * <p>Driver's license extra records</p>
2232
+ * <p>Additional driver's license records</p>
1954
2233
  * @type {string || null}
1955
2234
  */
1956
2235
  this.Endorsement = null;
@@ -1974,7 +2253,7 @@ class GeneralCard extends AbstractModel {
1974
2253
  this.PassportCodeSecond = null;
1975
2254
 
1976
2255
  /**
1977
- * <p>Validity date, in YYYY-MM-DD format</p>
2256
+ * <p>Validity period, in YYYY-MM-DD format</p>
1978
2257
  * @type {string || null}
1979
2258
  */
1980
2259
  this.DueDate = null;
@@ -1991,6 +2270,12 @@ class GeneralCard extends AbstractModel {
1991
2270
  */
1992
2271
  this.RegistrationNumber = null;
1993
2272
 
2273
+ /**
2274
+ * <p>Complete enumeration of specific card types confirmed by server-side classification (for example, THA_ID_CARD). Wildcards are not returned.</p>
2275
+ * @type {string || null}
2276
+ */
2277
+ this.DetectedCardType = null;
2278
+
1994
2279
  }
1995
2280
 
1996
2281
  /**
@@ -2042,6 +2327,7 @@ class GeneralCard extends AbstractModel {
2042
2327
  this.DueDate = 'DueDate' in params ? params.DueDate : null;
2043
2328
  this.Age = 'Age' in params ? params.Age : null;
2044
2329
  this.RegistrationNumber = 'RegistrationNumber' in params ? params.RegistrationNumber : null;
2330
+ this.DetectedCardType = 'DetectedCardType' in params ? params.DetectedCardType : null;
2045
2331
 
2046
2332
  }
2047
2333
  }
@@ -2651,6 +2937,104 @@ class PortraitImageInfo extends AbstractModel {
2651
2937
  }
2652
2938
  }
2653
2939
 
2940
+ /**
2941
+ * RecognizeGeneralCardVerification response structure.
2942
+ * @class
2943
+ */
2944
+ class RecognizeGeneralCardVerificationResponse extends AbstractModel {
2945
+ constructor(){
2946
+ super();
2947
+
2948
+ /**
2949
+ * Recognition result of the front side of the card. Returned only when recognition is enabled (EnableRecognition=true) and succeeds.
2950
+ * @type {GeneralCard || null}
2951
+ */
2952
+ this.FrontCardInfo = null;
2953
+
2954
+ /**
2955
+ * Recognition result of the back side of the card. Returned only for double-sided card types when recognition is enabled. The structure is the same as that of FrontCardInfo.
2956
+ * @type {GeneralCard || null}
2957
+ */
2958
+ this.BackCardInfo = null;
2959
+
2960
+ /**
2961
+ * Base64-encoded portrait image of the card. Returned only when ReturnHeadImage=true.
2962
+ * @type {string || null}
2963
+ */
2964
+ this.HeadImageBase64 = null;
2965
+
2966
+ /**
2967
+ * Card Warning Information
2968
+
2969
+ -9102 Alarm for photocopied certificate
2970
+ -9103 Alarm for photographed certificate
2971
+ -9104 Alarm for tamper certificate
2972
+ -9105 Alarm for an incomplete card border.
2973
+ -9106 Alarm for a covered card.
2974
+ -9107 Alarm for reflective certificate
2975
+ -9108 Alarm for blurry certificate
2976
+ -8101 Alarm for document information format verification
2977
+ -8102 Alarm for document information consistency verification
2978
+ * @type {Array.<number> || null}
2979
+ */
2980
+ this.WarnCardInfos = null;
2981
+
2982
+ /**
2983
+ * Check items actually executed. Valid values: Recognition, QualityCheck, TamperCheck, CopyCheck, RecaptureCheck, FormatCheck, ConsistencyCheck.
2984
+ * @type {Array.<string> || null}
2985
+ */
2986
+ this.ExecutedChecks = null;
2987
+
2988
+ /**
2989
+ * Check items that were skipped and the reasons.
2990
+ * @type {Array.<SkippedCheck> || null}
2991
+ */
2992
+ this.SkippedChecks = null;
2993
+
2994
+ /**
2995
+ * 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.
2996
+ * @type {string || null}
2997
+ */
2998
+ this.RequestId = null;
2999
+
3000
+ }
3001
+
3002
+ /**
3003
+ * @private
3004
+ */
3005
+ deserialize(params) {
3006
+ if (!params) {
3007
+ return;
3008
+ }
3009
+
3010
+ if (params.FrontCardInfo) {
3011
+ let obj = new GeneralCard();
3012
+ obj.deserialize(params.FrontCardInfo)
3013
+ this.FrontCardInfo = obj;
3014
+ }
3015
+
3016
+ if (params.BackCardInfo) {
3017
+ let obj = new GeneralCard();
3018
+ obj.deserialize(params.BackCardInfo)
3019
+ this.BackCardInfo = obj;
3020
+ }
3021
+ this.HeadImageBase64 = 'HeadImageBase64' in params ? params.HeadImageBase64 : null;
3022
+ this.WarnCardInfos = 'WarnCardInfos' in params ? params.WarnCardInfos : null;
3023
+ this.ExecutedChecks = 'ExecutedChecks' in params ? params.ExecutedChecks : null;
3024
+
3025
+ if (params.SkippedChecks) {
3026
+ this.SkippedChecks = new Array();
3027
+ for (let z in params.SkippedChecks) {
3028
+ let obj = new SkippedCheck();
3029
+ obj.deserialize(params.SkippedChecks[z]);
3030
+ this.SkippedChecks.push(obj);
3031
+ }
3032
+ }
3033
+ this.RequestId = 'RequestId' in params ? params.RequestId : null;
3034
+
3035
+ }
3036
+ }
3037
+
2654
3038
  /**
2655
3039
  * ApplyOcrToken response structure.
2656
3040
  * @class
@@ -2766,30 +3150,42 @@ Example value: 6.5
2766
3150
  }
2767
3151
 
2768
3152
  /**
2769
- * PermitOCR request structure.
3153
+ *
2770
3154
  * @class
2771
3155
  */
2772
- class PermitOCRRequest extends AbstractModel {
3156
+ class ItemNames extends AbstractModel {
2773
3157
  constructor(){
2774
3158
  super();
2775
3159
 
2776
3160
  /**
2777
- * 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 cannot exceed 7 MB. The download time of the image cannot exceed 3 seconds. Either ImageUrl or ImageBase64 of the image must be provided. If both are provided, only ImageUrl is used.
3161
+ *
2778
3162
  * @type {string || null}
2779
3163
  */
2780
- this.ImageBase64 = null;
3164
+ this.KeyName = null;
2781
3165
 
2782
3166
  /**
2783
- * 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 cannot exceed 7 MB. The download time of the image cannot exceed 3 seconds. We recommend that you store the image in Tencent Cloud for higher download speed and stability. The download speed and stability of images stored outside Tencent Cloud may be compromised.
3167
+ *
3168
+ * @type {number || null}
3169
+ */
3170
+ this.KeyType = null;
3171
+
3172
+ /**
3173
+ *
2784
3174
  * @type {string || null}
2785
3175
  */
2786
- this.ImageUrl = null;
3176
+ this.KeyPrompt = null;
2787
3177
 
2788
3178
  /**
2789
- * Whether to return the ID photo. The default value is false.
2790
- * @type {boolean || null}
3179
+ *
3180
+ * @type {string || null}
2791
3181
  */
2792
- this.CropPortrait = null;
3182
+ this.KeyExpectedValue = null;
3183
+
3184
+ /**
3185
+ *
3186
+ * @type {string || null}
3187
+ */
3188
+ this.KeyAuditPrompt = null;
2793
3189
 
2794
3190
  }
2795
3191
 
@@ -2800,9 +3196,11 @@ class PermitOCRRequest extends AbstractModel {
2800
3196
  if (!params) {
2801
3197
  return;
2802
3198
  }
2803
- this.ImageBase64 = 'ImageBase64' in params ? params.ImageBase64 : null;
2804
- this.ImageUrl = 'ImageUrl' in params ? params.ImageUrl : null;
2805
- this.CropPortrait = 'CropPortrait' in params ? params.CropPortrait : null;
3199
+ this.KeyName = 'KeyName' in params ? params.KeyName : null;
3200
+ this.KeyType = 'KeyType' in params ? params.KeyType : null;
3201
+ this.KeyPrompt = 'KeyPrompt' in params ? params.KeyPrompt : null;
3202
+ this.KeyExpectedValue = 'KeyExpectedValue' in params ? params.KeyExpectedValue : null;
3203
+ this.KeyAuditPrompt = 'KeyAuditPrompt' in params ? params.KeyAuditPrompt : null;
2806
3204
 
2807
3205
  }
2808
3206
  }
@@ -3258,156 +3656,99 @@ class GroupInfo extends AbstractModel {
3258
3656
  }
3259
3657
 
3260
3658
  }
3261
- }
3262
-
3263
- /**
3264
- * RecognizeThaiIDCardOCR response structure.
3265
- * @class
3266
- */
3267
- class RecognizeThaiIDCardOCRResponse extends AbstractModel {
3268
- constructor(){
3269
- super();
3270
-
3271
- /**
3272
- * ID card number
3273
- * @type {string || null}
3274
- */
3275
- this.ID = null;
3276
-
3277
- /**
3278
- * Name in Thai
3279
- * @type {string || null}
3280
- */
3281
- this.ThaiName = null;
3282
-
3283
- /**
3284
- * First name in English
3285
- * @type {string || null}
3286
- */
3287
- this.EnFirstName = null;
3288
-
3289
- /**
3290
- * Last name in English
3291
- * @type {string || null}
3292
- */
3293
- this.EnLastName = null;
3294
-
3295
- /**
3296
- * Date of issue in Thai
3297
- * @type {string || null}
3298
- */
3299
- this.IssueDate = null;
3300
-
3301
- /**
3302
- * Expiration date in Thai
3303
- * @type {string || null}
3304
- */
3305
- this.ExpirationDate = null;
3306
-
3307
- /**
3308
- * Date of issue in English
3309
- * @type {string || null}
3310
- */
3311
- this.EnIssueDate = null;
3659
+ }
3312
3660
 
3313
- /**
3314
- * Expiration date in English
3315
- * @type {string || null}
3316
- */
3317
- this.EnExpirationDate = null;
3661
+ /**
3662
+ * PermitOCR request structure.
3663
+ * @class
3664
+ */
3665
+ class PermitOCRRequest extends AbstractModel {
3666
+ constructor(){
3667
+ super();
3318
3668
 
3319
3669
  /**
3320
- * Date of birth in Thai
3670
+ * 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 cannot exceed 7 MB. The download time of the image cannot exceed 3 seconds. Either ImageUrl or ImageBase64 of the image must be provided. If both are provided, only ImageUrl is used.
3321
3671
  * @type {string || null}
3322
3672
  */
3323
- this.Birthday = null;
3673
+ this.ImageBase64 = null;
3324
3674
 
3325
3675
  /**
3326
- * Date of birth in English
3676
+ * 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 cannot exceed 7 MB. The download time of the image cannot exceed 3 seconds. We recommend that you store the image in Tencent Cloud for higher download speed and stability. The download speed and stability of images stored outside Tencent Cloud may be compromised.
3327
3677
  * @type {string || null}
3328
3678
  */
3329
- this.EnBirthday = null;
3679
+ this.ImageUrl = null;
3330
3680
 
3331
3681
  /**
3332
- * Religion
3333
- * @type {string || null}
3682
+ * Whether to return the ID photo. The default value is false.
3683
+ * @type {boolean || null}
3334
3684
  */
3335
- this.Religion = null;
3685
+ this.CropPortrait = null;
3336
3686
 
3337
- /**
3338
- * Serial number
3339
- * @type {string || null}
3340
- */
3341
- this.SerialNumber = null;
3687
+ }
3342
3688
 
3343
- /**
3344
- * Address
3345
- * @type {string || null}
3346
- */
3347
- this.Address = null;
3689
+ /**
3690
+ * @private
3691
+ */
3692
+ deserialize(params) {
3693
+ if (!params) {
3694
+ return;
3695
+ }
3696
+ this.ImageBase64 = 'ImageBase64' in params ? params.ImageBase64 : null;
3697
+ this.ImageUrl = 'ImageUrl' in params ? params.ImageUrl : null;
3698
+ this.CropPortrait = 'CropPortrait' in params ? params.CropPortrait : null;
3348
3699
 
3349
- /**
3350
- * Laser ID on the back of the card
3351
- * @type {string || null}
3352
- */
3353
- this.LaserID = null;
3700
+ }
3701
+ }
3354
3702
 
3355
- /**
3356
- * Identity photo
3357
- * @type {string || null}
3358
- */
3359
- this.PortraitImage = null;
3703
+ /**
3704
+ * Verification capacity switch configuration
3705
+ * @class
3706
+ */
3707
+ class CardVerificationConfig extends AbstractModel {
3708
+ constructor(){
3709
+ super();
3360
3710
 
3361
3711
  /**
3362
- * Card Warning Information
3363
-
3364
- -9101 Alarm for covered certificate
3365
- -9102 Alarm for photocopied certificate
3366
- -9103 Alarm for photographed certificate
3367
- -9104 Alarm for tamper certificate
3368
- -9107 Alarm for reflective certificate
3369
- -9108 Alarm for blurry certificate
3370
- -9109 This capability is not enabled. Please contact customer support to activate the alert service
3371
- * @type {Array.<number> || null}
3712
+ * <p>Whether to perform card field recognition, true by default</p>
3713
+ * @type {boolean || null}
3372
3714
  */
3373
- this.WarnCardInfos = null;
3715
+ this.EnableRecognition = null;
3374
3716
 
3375
3717
  /**
3376
- * <p>This field is deprecated and will always return "1". It is not recommended for use.</p>
3377
- * @type {string || null}
3718
+ * <p>Whether to perform quality detection (blurry/reflective/incomplete border/obstruction). false by default</p>
3719
+ * @type {boolean || null}
3378
3720
  */
3379
- this.AdvancedInfo = null;
3721
+ this.EnableQualityCheck = null;
3380
3722
 
3381
3723
  /**
3382
- * The number of cards detected in the input image provided via ImageBase64 parameter.(Currently supported only in ap-bangkok region)
3383
- * @type {number || null}
3724
+ * <p>Whether to perform tampering detection (PS/synthesis/electronic). false by default</p>
3725
+ * @type {boolean || null}
3384
3726
  */
3385
- this.CardCount = null;
3727
+ this.EnableTamperCheck = null;
3386
3728
 
3387
3729
  /**
3388
- * The card information field complete or not
3389
- true: complete; false: incomplete
3730
+ * <p>Whether to perform photocopy detection. false by default</p>
3390
3731
  * @type {boolean || null}
3391
3732
  */
3392
- this.IsComplete = null;
3733
+ this.EnableCopyCheck = null;
3393
3734
 
3394
3735
  /**
3395
- * First name in Thai
3396
- * @type {string || null}
3736
+ * <p>Whether to perform rephotography detection. false by default</p>
3737
+ * @type {boolean || null}
3397
3738
  */
3398
- this.ThaiFirstName = null;
3739
+ this.EnableRecaptureCheck = null;
3399
3740
 
3400
3741
  /**
3401
- * Last name in Thai
3402
- * @type {string || null}
3742
+ * <p>Whether to perform format validation (dependent recognition). false by default</p>
3743
+ * @type {boolean || null}
3403
3744
  */
3404
- this.ThaiLastName = null;
3745
+ this.EnableFormatCheck = null;
3405
3746
 
3406
3747
  /**
3407
- * 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.
3408
- * @type {string || null}
3748
+ * <p>Whether to perform both sides consistency check (dependent on recognition), false by default</p>
3749
+ * @type {boolean || null}
3409
3750
  */
3410
- this.RequestId = null;
3751
+ this.EnableConsistencyCheck = null;
3411
3752
 
3412
3753
  }
3413
3754
 
@@ -3418,28 +3759,13 @@ true: complete; false: incomplete
3418
3759
  if (!params) {
3419
3760
  return;
3420
3761
  }
3421
- this.ID = 'ID' in params ? params.ID : null;
3422
- this.ThaiName = 'ThaiName' in params ? params.ThaiName : null;
3423
- this.EnFirstName = 'EnFirstName' in params ? params.EnFirstName : null;
3424
- this.EnLastName = 'EnLastName' in params ? params.EnLastName : null;
3425
- this.IssueDate = 'IssueDate' in params ? params.IssueDate : null;
3426
- this.ExpirationDate = 'ExpirationDate' in params ? params.ExpirationDate : null;
3427
- this.EnIssueDate = 'EnIssueDate' in params ? params.EnIssueDate : null;
3428
- this.EnExpirationDate = 'EnExpirationDate' in params ? params.EnExpirationDate : null;
3429
- this.Birthday = 'Birthday' in params ? params.Birthday : null;
3430
- this.EnBirthday = 'EnBirthday' in params ? params.EnBirthday : null;
3431
- this.Religion = 'Religion' in params ? params.Religion : null;
3432
- this.SerialNumber = 'SerialNumber' in params ? params.SerialNumber : null;
3433
- this.Address = 'Address' in params ? params.Address : null;
3434
- this.LaserID = 'LaserID' in params ? params.LaserID : null;
3435
- this.PortraitImage = 'PortraitImage' in params ? params.PortraitImage : null;
3436
- this.WarnCardInfos = 'WarnCardInfos' in params ? params.WarnCardInfos : null;
3437
- this.AdvancedInfo = 'AdvancedInfo' in params ? params.AdvancedInfo : null;
3438
- this.CardCount = 'CardCount' in params ? params.CardCount : null;
3439
- this.IsComplete = 'IsComplete' in params ? params.IsComplete : null;
3440
- this.ThaiFirstName = 'ThaiFirstName' in params ? params.ThaiFirstName : null;
3441
- this.ThaiLastName = 'ThaiLastName' in params ? params.ThaiLastName : null;
3442
- this.RequestId = 'RequestId' in params ? params.RequestId : null;
3762
+ this.EnableRecognition = 'EnableRecognition' in params ? params.EnableRecognition : null;
3763
+ this.EnableQualityCheck = 'EnableQualityCheck' in params ? params.EnableQualityCheck : null;
3764
+ this.EnableTamperCheck = 'EnableTamperCheck' in params ? params.EnableTamperCheck : null;
3765
+ this.EnableCopyCheck = 'EnableCopyCheck' in params ? params.EnableCopyCheck : null;
3766
+ this.EnableRecaptureCheck = 'EnableRecaptureCheck' in params ? params.EnableRecaptureCheck : null;
3767
+ this.EnableFormatCheck = 'EnableFormatCheck' in params ? params.EnableFormatCheck : null;
3768
+ this.EnableConsistencyCheck = 'EnableConsistencyCheck' in params ? params.EnableConsistencyCheck : null;
3443
3769
 
3444
3770
  }
3445
3771
  }
@@ -3858,45 +4184,79 @@ class RecognizePhilippinesUMIDOCRResponse extends AbstractModel {
3858
4184
  }
3859
4185
 
3860
4186
  /**
3861
- * RecognizeThaiIDCardOCR request structure.
4187
+ * ApplyCardVerificationExternal request structure.
3862
4188
  * @class
3863
4189
  */
3864
- class RecognizeThaiIDCardOCRRequest extends AbstractModel {
4190
+ class ApplyCardVerificationExternalRequest extends AbstractModel {
3865
4191
  constructor(){
3866
4192
  super();
3867
4193
 
3868
4194
  /**
3869
- * The Base64-encoded value of an image. The image cannot exceed 7 MB after being Base64-encoded. A resolution above 500 x 800 is recommended. PNG, JPG, JPEG, and BMP formats are supported. It is recommended that the card part occupy more than 2/3 area of the image.
3870
- Either ImageUrl or ImageBase64 of the image must be provided. If both are provided, ImageUrl is used.
4195
+ * Country/Region of the document. For the full list of supported countries/regions, refer to the API description.
3871
4196
  * @type {string || null}
3872
4197
  */
3873
- this.ImageBase64 = null;
4198
+ this.Nationality = null;
3874
4199
 
3875
4200
  /**
3876
- * Base64 value of the image on the back of the card. Supported image formats: PNG, JPG, JPEG. GIF format is not supported yet. Supported image size: The downloaded image does not exceed 7M after Base64 encoding. The image download takes no more than 3 seconds. One of ImageUrl and ImageBase64 of the image must be provided. If both are provided, only ImageUrl will be used.
4201
+ * 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).
3877
4202
  * @type {string || null}
3878
4203
  */
3879
- this.BackImageBase64 = null;
4204
+ this.CardType = null;
3880
4205
 
3881
4206
  /**
3882
- * The URL of the image. The image cannot exceed 7 MB after being Base64-encoded. A resolution above 500 x 800 is recommended. PNG, JPG, JPEG, and BMP formats are supported. It is recommended that the card part occupy more than 2/3 area of the image.
3883
- We recommend that you store the image in Tencent Cloud for higher download speed and stability.
4207
+ * Base64-encoded image of the document front.
4208
+ Supported image formats: PNG, JPG/JPEG (GIF not supported).
4209
+ Supported image size: The downloaded image after Base64 encoding must not exceed 2 MB. Image download time must not exceed 5 seconds.
4210
+ Supported image resolution: Between 256*256 and 4096*4096 pixels.
4211
+ Note: You must provide either ImageUrlFront or ImageBase64Front. If both are provided, only ImageUrlFront is used.
3884
4212
  * @type {string || null}
3885
4213
  */
3886
- this.ImageUrl = null;
4214
+ this.ImageBase64Front = null;
3887
4215
 
3888
4216
  /**
3889
- * The URL address of the image on the back of the card. Supported image formats: PNG, JPG, JPEG. GIF format is not supported yet. Supported image size: The downloaded image does not exceed 7M after Base64 encoding. The image download takes no more than 3 seconds. Storing images in Tencent Cloud URLs can ensure higher download speed and stability. It is recommended that images be stored in Tencent Cloud. The URL speed and stability of non-Tencent cloud storage may be affected to a certain extent.
4217
+ * The Base64 value of the reverse side of the document. Supported image formats: PNG, JPG/JPEG.
4218
+ 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.
4219
+ 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.
3890
4220
  * @type {string || null}
3891
4221
  */
3892
- this.BackImageUrl = null;
4222
+ this.ImageBase64Back = null;
3893
4223
 
3894
4224
  /**
3895
- * Whether to crop the profile photo. The default value is false, meaning not to return the Base64-encoded value of the profile photo on the Thai identity card.
3896
- When this parameter is set to true, the Base64-encoded value of the profile photo on the Thai identity card after rotation correction is returned.
4225
+ * URL of the document front image.
4226
+ Supported image formats: PNG, JPG/JPEG (GIF not supported).
4227
+ Supported image size: The downloaded image after Base64 encoding must not exceed 2 MB. Image download time must not exceed 5 seconds.
4228
+ Supported image resolution: Between 256*256 and 4096*4096 pixels.
4229
+ Note: You must provide either ImageUrlFront or ImageBase64Front. If both are provided, only ImageUrlFront is used.
4230
+ * @type {string || null}
4231
+ */
4232
+ this.ImageUrlFront = null;
4233
+
4234
+ /**
4235
+ * URL of the document back image.
4236
+ Supported image formats: PNG, JPG/JPEG (GIF not supported).
4237
+ Supported image size: The downloaded image after Base64 encoding must not exceed 2 MB. Image download time must not exceed 5 seconds.
4238
+ Supported image resolution: Between 256*256 and 4096*4096 pixels.
4239
+ Note: For some documents, you must provide either ImageUrlBack or ImageBase64Back. If both are provided, only ImageUrlBack is used.
4240
+ * @type {string || null}
4241
+ */
4242
+ this.ImageUrlBack = null;
4243
+
4244
+ /**
4245
+ * Whether to crop and return the face image from the document. Default: false.
4246
+ If set to true, the image constraints are:
4247
+ - Size after Base64 encoding must not exceed 5 MB.
4248
+ - Maximum pixel width/height: 4000 for JPG, 2000 for other formats.
4249
+ - Minimum pixel width/height: 64.
4250
+ - Supported formats: PNG, JPG, JPEG, BMP (GIF not supported).
3897
4251
  * @type {boolean || null}
3898
4252
  */
3899
- this.CropPortrait = null;
4253
+ this.ReturnHeadImage = null;
4254
+
4255
+ /**
4256
+ * Verification status callback URL. When set, this endpoint will be actively notified with the final verification result upon process completion. Leave blank to disable callbacks. Since callbacks are not fully reliable, a polling mechanism is advised to guarantee retrieval of the final status.
4257
+ * @type {string || null}
4258
+ */
4259
+ this.WebhookUrl = null;
3900
4260
 
3901
4261
  }
3902
4262
 
@@ -3907,11 +4267,14 @@ When this parameter is set to true, the Base64-encoded value of the profile phot
3907
4267
  if (!params) {
3908
4268
  return;
3909
4269
  }
3910
- this.ImageBase64 = 'ImageBase64' in params ? params.ImageBase64 : null;
3911
- this.BackImageBase64 = 'BackImageBase64' in params ? params.BackImageBase64 : null;
3912
- this.ImageUrl = 'ImageUrl' in params ? params.ImageUrl : null;
3913
- this.BackImageUrl = 'BackImageUrl' in params ? params.BackImageUrl : null;
3914
- this.CropPortrait = 'CropPortrait' in params ? params.CropPortrait : null;
4270
+ this.Nationality = 'Nationality' in params ? params.Nationality : null;
4271
+ this.CardType = 'CardType' in params ? params.CardType : null;
4272
+ this.ImageBase64Front = 'ImageBase64Front' in params ? params.ImageBase64Front : null;
4273
+ this.ImageBase64Back = 'ImageBase64Back' in params ? params.ImageBase64Back : null;
4274
+ this.ImageUrlFront = 'ImageUrlFront' in params ? params.ImageUrlFront : null;
4275
+ this.ImageUrlBack = 'ImageUrlBack' in params ? params.ImageUrlBack : null;
4276
+ this.ReturnHeadImage = 'ReturnHeadImage' in params ? params.ReturnHeadImage : null;
4277
+ this.WebhookUrl = 'WebhookUrl' in params ? params.WebhookUrl : null;
3915
4278
 
3916
4279
  }
3917
4280
  }
@@ -4270,6 +4633,81 @@ class RecognizeBrazilRNMOCRResponse extends AbstractModel {
4270
4633
  }
4271
4634
  }
4272
4635
 
4636
+ /**
4637
+ * RecognizeGeneralCardVerification request structure.
4638
+ * @class
4639
+ */
4640
+ class RecognizeGeneralCardVerificationRequest extends AbstractModel {
4641
+ constructor(){
4642
+ super();
4643
+
4644
+ /**
4645
+ * Base64 value of the front document image. Supported formats: PNG, JPG, JPEG. The Base64 encoded size shall not exceed 7 MB. One of ImageUrl, ImageBase64, BackImageUrl, BackImageBase64 must be provided. If both URL and Base64 are passed, URL will be used preferentially. Image download timeout is 3 seconds.
4646
+ * @type {string || null}
4647
+ */
4648
+ this.ImageBase64 = null;
4649
+
4650
+ /**
4651
+ * URL address of the front side image of the card. Refer to the description of ImageBase64 for image requirements.
4652
+ * @type {string || null}
4653
+ */
4654
+ this.ImageUrl = null;
4655
+
4656
+ /**
4657
+ * Base64-encoded value of the back side image of the card. Refer to the description of ImageBase64 for image requirements.
4658
+ * @type {string || null}
4659
+ */
4660
+ this.BackImageBase64 = null;
4661
+
4662
+ /**
4663
+ * URL address of the back side image of the card. Refer to the description of ImageBase64 for image requirements.
4664
+ * @type {string || null}
4665
+ */
4666
+ this.BackImageUrl = null;
4667
+
4668
+ /**
4669
+ * Specifies the target document type for this verification. Each element is a full card type enum in the format {CountryOrRegionCode}_{CardType}, such as THA_ID_CARD and PHL_UMID. For passports, use the single value PASSPORT regardless of the issuing country. Wildcards are supported: * indicates all supported card types, and {CountryCode}_* indicates all card types of a country/region, such as PHL_*. If this parameter is not specified or an empty array is passed, the server performs automatic classification across all supported card types. An unsupported card type returns InvalidParameterValueLimit, and the unsupported values are listed in the error message.
4670
+ * @type {Array.<string> || null}
4671
+ */
4672
+ this.CardTypes = null;
4673
+
4674
+ /**
4675
+ * Whether to return the Base64-encoded portrait image of the card. Default: false.
4676
+ * @type {boolean || null}
4677
+ */
4678
+ this.ReturnHeadImage = null;
4679
+
4680
+ /**
4681
+ * Card verification configuration.
4682
+ * @type {CardVerificationConfig || null}
4683
+ */
4684
+ this.VerificationConfig = null;
4685
+
4686
+ }
4687
+
4688
+ /**
4689
+ * @private
4690
+ */
4691
+ deserialize(params) {
4692
+ if (!params) {
4693
+ return;
4694
+ }
4695
+ this.ImageBase64 = 'ImageBase64' in params ? params.ImageBase64 : null;
4696
+ this.ImageUrl = 'ImageUrl' in params ? params.ImageUrl : null;
4697
+ this.BackImageBase64 = 'BackImageBase64' in params ? params.BackImageBase64 : null;
4698
+ this.BackImageUrl = 'BackImageUrl' in params ? params.BackImageUrl : null;
4699
+ this.CardTypes = 'CardTypes' in params ? params.CardTypes : null;
4700
+ this.ReturnHeadImage = 'ReturnHeadImage' in params ? params.ReturnHeadImage : null;
4701
+
4702
+ if (params.VerificationConfig) {
4703
+ let obj = new CardVerificationConfig();
4704
+ obj.deserialize(params.VerificationConfig)
4705
+ this.VerificationConfig = obj;
4706
+ }
4707
+
4708
+ }
4709
+ }
4710
+
4273
4711
  /**
4274
4712
  * GeneralBasicOCR request structure.
4275
4713
  * @class
@@ -4957,79 +5395,45 @@ class MLIDPassportOCRResponse extends AbstractModel {
4957
5395
  }
4958
5396
 
4959
5397
  /**
4960
- * ApplyCardVerificationExternal request structure.
5398
+ * RecognizeThaiIDCardOCR request structure.
4961
5399
  * @class
4962
5400
  */
4963
- class ApplyCardVerificationExternalRequest extends AbstractModel {
5401
+ class RecognizeThaiIDCardOCRRequest extends AbstractModel {
4964
5402
  constructor(){
4965
5403
  super();
4966
5404
 
4967
5405
  /**
4968
- * Country/Region of the document. For the full list of supported countries/regions, refer to the API description.
4969
- * @type {string || null}
4970
- */
4971
- this.Nationality = null;
4972
-
4973
- /**
4974
- * 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).
4975
- * @type {string || null}
4976
- */
4977
- this.CardType = null;
4978
-
4979
- /**
4980
- * Base64-encoded image of the document front.
4981
- Supported image formats: PNG, JPG/JPEG (GIF not supported).
4982
- Supported image size: The downloaded image after Base64 encoding must not exceed 2 MB. Image download time must not exceed 5 seconds.
4983
- Supported image resolution: Between 256*256 and 4096*4096 pixels.
4984
- Note: You must provide either ImageUrlFront or ImageBase64Front. If both are provided, only ImageUrlFront is used.
5406
+ * The Base64-encoded value of an image. The image cannot exceed 7 MB after being Base64-encoded. A resolution above 500 x 800 is recommended. PNG, JPG, JPEG, and BMP formats are supported. It is recommended that the card part occupy more than 2/3 area of the image.
5407
+ Either ImageUrl or ImageBase64 of the image must be provided. If both are provided, ImageUrl is used.
4985
5408
  * @type {string || null}
4986
5409
  */
4987
- this.ImageBase64Front = null;
5410
+ this.ImageBase64 = null;
4988
5411
 
4989
5412
  /**
4990
- * The Base64 value of the reverse side of the document. Supported image formats: PNG, JPG/JPEG.
4991
- 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.
4992
- 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.
5413
+ * Base64 value of the image on the back of the card. Supported image formats: PNG, JPG, JPEG. GIF format is not supported yet. Supported image size: The downloaded image does not exceed 7M after Base64 encoding. The image download takes no more than 3 seconds. One of ImageUrl and ImageBase64 of the image must be provided. If both are provided, only ImageUrl will be used.
4993
5414
  * @type {string || null}
4994
5415
  */
4995
- this.ImageBase64Back = null;
5416
+ this.BackImageBase64 = null;
4996
5417
 
4997
5418
  /**
4998
- * URL of the document front image.
4999
- Supported image formats: PNG, JPG/JPEG (GIF not supported).
5000
- Supported image size: The downloaded image after Base64 encoding must not exceed 2 MB. Image download time must not exceed 5 seconds.
5001
- Supported image resolution: Between 256*256 and 4096*4096 pixels.
5002
- Note: You must provide either ImageUrlFront or ImageBase64Front. If both are provided, only ImageUrlFront is used.
5419
+ * The URL of the image. The image cannot exceed 7 MB after being Base64-encoded. A resolution above 500 x 800 is recommended. PNG, JPG, JPEG, and BMP formats are supported. It is recommended that the card part occupy more than 2/3 area of the image.
5420
+ We recommend that you store the image in Tencent Cloud for higher download speed and stability.
5003
5421
  * @type {string || null}
5004
5422
  */
5005
- this.ImageUrlFront = null;
5423
+ this.ImageUrl = null;
5006
5424
 
5007
5425
  /**
5008
- * URL of the document back image.
5009
- Supported image formats: PNG, JPG/JPEG (GIF not supported).
5010
- Supported image size: The downloaded image after Base64 encoding must not exceed 2 MB. Image download time must not exceed 5 seconds.
5011
- Supported image resolution: Between 256*256 and 4096*4096 pixels.
5012
- Note: For some documents, you must provide either ImageUrlBack or ImageBase64Back. If both are provided, only ImageUrlBack is used.
5426
+ * The URL address of the image on the back of the card. Supported image formats: PNG, JPG, JPEG. GIF format is not supported yet. Supported image size: The downloaded image does not exceed 7M after Base64 encoding. The image download takes no more than 3 seconds. Storing images in Tencent Cloud URLs can ensure higher download speed and stability. It is recommended that images be stored in Tencent Cloud. The URL speed and stability of non-Tencent cloud storage may be affected to a certain extent.
5013
5427
  * @type {string || null}
5014
5428
  */
5015
- this.ImageUrlBack = null;
5429
+ this.BackImageUrl = null;
5016
5430
 
5017
5431
  /**
5018
- * Whether to crop and return the face image from the document. Default: false.
5019
- If set to true, the image constraints are:
5020
- - Size after Base64 encoding must not exceed 5 MB.
5021
- - Maximum pixel width/height: 4000 for JPG, 2000 for other formats.
5022
- - Minimum pixel width/height: 64.
5023
- - Supported formats: PNG, JPG, JPEG, BMP (GIF not supported).
5432
+ * Whether to crop the profile photo. The default value is false, meaning not to return the Base64-encoded value of the profile photo on the Thai identity card.
5433
+ When this parameter is set to true, the Base64-encoded value of the profile photo on the Thai identity card after rotation correction is returned.
5024
5434
  * @type {boolean || null}
5025
5435
  */
5026
- this.ReturnHeadImage = null;
5027
-
5028
- /**
5029
- * Verification status callback URL. When set, this endpoint will be actively notified with the final verification result upon process completion. Leave blank to disable callbacks. Since callbacks are not fully reliable, a polling mechanism is advised to guarantee retrieval of the final status.
5030
- * @type {string || null}
5031
- */
5032
- this.WebhookUrl = null;
5436
+ this.CropPortrait = null;
5033
5437
 
5034
5438
  }
5035
5439
 
@@ -5040,14 +5444,11 @@ If set to true, the image constraints are:
5040
5444
  if (!params) {
5041
5445
  return;
5042
5446
  }
5043
- this.Nationality = 'Nationality' in params ? params.Nationality : null;
5044
- this.CardType = 'CardType' in params ? params.CardType : null;
5045
- this.ImageBase64Front = 'ImageBase64Front' in params ? params.ImageBase64Front : null;
5046
- this.ImageBase64Back = 'ImageBase64Back' in params ? params.ImageBase64Back : null;
5047
- this.ImageUrlFront = 'ImageUrlFront' in params ? params.ImageUrlFront : null;
5048
- this.ImageUrlBack = 'ImageUrlBack' in params ? params.ImageUrlBack : null;
5049
- this.ReturnHeadImage = 'ReturnHeadImage' in params ? params.ReturnHeadImage : null;
5050
- this.WebhookUrl = 'WebhookUrl' in params ? params.WebhookUrl : null;
5447
+ this.ImageBase64 = 'ImageBase64' in params ? params.ImageBase64 : null;
5448
+ this.BackImageBase64 = 'BackImageBase64' in params ? params.BackImageBase64 : null;
5449
+ this.ImageUrl = 'ImageUrl' in params ? params.ImageUrl : null;
5450
+ this.BackImageUrl = 'BackImageUrl' in params ? params.BackImageUrl : null;
5451
+ this.CropPortrait = 'CropPortrait' in params ? params.CropPortrait : null;
5051
5452
 
5052
5453
  }
5053
5454
  }
@@ -5419,62 +5820,6 @@ class RecognizeIndonesiaIDCardOCRResponse extends AbstractModel {
5419
5820
  }
5420
5821
  }
5421
5822
 
5422
- /**
5423
- *
5424
- * @class
5425
- */
5426
- class ItemNames extends AbstractModel {
5427
- constructor(){
5428
- super();
5429
-
5430
- /**
5431
- *
5432
- * @type {string || null}
5433
- */
5434
- this.KeyName = null;
5435
-
5436
- /**
5437
- *
5438
- * @type {number || null}
5439
- */
5440
- this.KeyType = null;
5441
-
5442
- /**
5443
- *
5444
- * @type {string || null}
5445
- */
5446
- this.KeyPrompt = null;
5447
-
5448
- /**
5449
- *
5450
- * @type {string || null}
5451
- */
5452
- this.KeyExpectedValue = null;
5453
-
5454
- /**
5455
- *
5456
- * @type {string || null}
5457
- */
5458
- this.KeyAuditPrompt = null;
5459
-
5460
- }
5461
-
5462
- /**
5463
- * @private
5464
- */
5465
- deserialize(params) {
5466
- if (!params) {
5467
- return;
5468
- }
5469
- this.KeyName = 'KeyName' in params ? params.KeyName : null;
5470
- this.KeyType = 'KeyType' in params ? params.KeyType : null;
5471
- this.KeyPrompt = 'KeyPrompt' in params ? params.KeyPrompt : null;
5472
- this.KeyExpectedValue = 'KeyExpectedValue' in params ? params.KeyExpectedValue : null;
5473
- this.KeyAuditPrompt = 'KeyAuditPrompt' in params ? params.KeyAuditPrompt : null;
5474
-
5475
- }
5476
- }
5477
-
5478
5823
  /**
5479
5824
  * VinOCR response structure.
5480
5825
  * @class
@@ -6333,95 +6678,48 @@ Note: Only supported for the back side of the Mainland Travel Permit for Hong Ko
6333
6678
  }
6334
6679
 
6335
6680
  /**
6336
- * HmtResidentPermitOCR response structure.
6681
+ * MLIDCardOCR request structure.
6337
6682
  * @class
6338
6683
  */
6339
- class HmtResidentPermitOCRResponse extends AbstractModel {
6684
+ class MLIDCardOCRRequest extends AbstractModel {
6340
6685
  constructor(){
6341
6686
  super();
6342
6687
 
6343
6688
  /**
6344
- * <p>Name on the document</p>
6345
- * @type {string || null}
6346
- */
6347
- this.Name = null;
6348
-
6349
- /**
6350
- * <p>Gender</p>
6351
- * @type {string || null}
6352
- */
6353
- this.Sex = null;
6354
-
6355
- /**
6356
- * <p>Date of birth</p>
6357
- * @type {string || null}
6358
- */
6359
- this.Birth = null;
6360
-
6361
- /**
6362
- * <p>Address</p>
6363
- * @type {string || null}
6364
- */
6365
- this.Address = null;
6366
-
6367
- /**
6368
- * <p>Identity card number</p>
6369
- * @type {string || null}
6370
- */
6371
- this.IdCardNo = null;
6372
-
6373
- /**
6374
- * <p>0-Front<br>1-Back</p>
6375
- * @type {number || null}
6376
- */
6377
- this.CardType = null;
6378
-
6379
- /**
6380
- * <p>Document validity period</p>
6689
+ * The Base64-encoded value of an image.
6690
+ Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported.
6691
+ Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s.
6381
6692
  * @type {string || null}
6382
6693
  */
6383
- this.ValidDate = null;
6694
+ this.ImageBase64 = null;
6384
6695
 
6385
6696
  /**
6386
- * <p>Issuing authority</p>
6697
+ * Base64 value of the image on the back of the card. Supported image formats: PNG, JPG, JPEG, GIF format is not supported yet. Supported image size: The downloaded image cannot exceed 7M after Base64 encoding. The image download takes no more than 3 seconds. One of ImageUrl and ImageBase64 of the image must be provided. If both are provided, only ImageUrl will be used.
6387
6698
  * @type {string || null}
6388
6699
  */
6389
- this.Authority = null;
6700
+ this.BackImageBase64 = null;
6390
6701
 
6391
6702
  /**
6392
- * <p>Number of issuances</p>
6703
+ * The URL of an image. (This field is not available outside the Chinese mainland.)
6704
+ Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported.
6705
+ Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s.
6706
+ We recommend that you store the image in Tencent Cloud for higher download speed and stability.
6707
+ For a non-Tencent Cloud URL, the download speed and stability may be low.
6393
6708
  * @type {string || null}
6394
6709
  */
6395
- this.VisaNum = null;
6710
+ this.ImageUrl = null;
6396
6711
 
6397
6712
  /**
6398
- * Travel permit number
6713
+ * The URL address of the image on the back of the card. Supported image formats: PNG, JPG, JPEG, GIF format is not supported yet. Supported image size: The downloaded image does not exceed 7M after Base64 encoding. The image download takes no more than 3 seconds. Storing images in Tencent Cloud URLs can ensure higher download speed and stability. It is recommended that images be stored in Tencent Cloud. The URL speed and stability of non-Tencent cloud storage may be affected to a certain extent.
6399
6714
  * @type {string || null}
6400
6715
  */
6401
- this.PassNo = null;
6402
-
6403
- /**
6404
- * Portrait image and coordinate information
6405
- * @type {PortraitImageInfo || null}
6406
- */
6407
- this.PortraitImageInfo = null;
6408
-
6409
- /**
6410
- * Card Warning Information
6411
-
6412
- -9102 Alarm for photocopied certificate
6413
- -9103 Alarm for photographed certificate
6414
- -9104 Alarm for tamper certificate
6415
- -9109 This capability is not enabled. Please contact customer support to activate the alert service
6416
- * @type {Array.<number> || null}
6417
- */
6418
- this.WarnCardInfos = null;
6716
+ this.BackImageUrl = null;
6419
6717
 
6420
6718
  /**
6421
- * 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.
6422
- * @type {string || null}
6719
+ * Whether to return an image. Default value: `false`.
6720
+ * @type {boolean || null}
6423
6721
  */
6424
- this.RequestId = null;
6722
+ this.RetImage = null;
6425
6723
 
6426
6724
  }
6427
6725
 
@@ -6432,24 +6730,11 @@ class HmtResidentPermitOCRResponse extends AbstractModel {
6432
6730
  if (!params) {
6433
6731
  return;
6434
6732
  }
6435
- this.Name = 'Name' in params ? params.Name : null;
6436
- this.Sex = 'Sex' in params ? params.Sex : null;
6437
- this.Birth = 'Birth' in params ? params.Birth : null;
6438
- this.Address = 'Address' in params ? params.Address : null;
6439
- this.IdCardNo = 'IdCardNo' in params ? params.IdCardNo : null;
6440
- this.CardType = 'CardType' in params ? params.CardType : null;
6441
- this.ValidDate = 'ValidDate' in params ? params.ValidDate : null;
6442
- this.Authority = 'Authority' in params ? params.Authority : null;
6443
- this.VisaNum = 'VisaNum' in params ? params.VisaNum : null;
6444
- this.PassNo = 'PassNo' in params ? params.PassNo : null;
6445
-
6446
- if (params.PortraitImageInfo) {
6447
- let obj = new PortraitImageInfo();
6448
- obj.deserialize(params.PortraitImageInfo)
6449
- this.PortraitImageInfo = obj;
6450
- }
6451
- this.WarnCardInfos = 'WarnCardInfos' in params ? params.WarnCardInfos : null;
6452
- this.RequestId = 'RequestId' in params ? params.RequestId : null;
6733
+ this.ImageBase64 = 'ImageBase64' in params ? params.ImageBase64 : null;
6734
+ this.BackImageBase64 = 'BackImageBase64' in params ? params.BackImageBase64 : null;
6735
+ this.ImageUrl = 'ImageUrl' in params ? params.ImageUrl : null;
6736
+ this.BackImageUrl = 'BackImageUrl' in params ? params.BackImageUrl : null;
6737
+ this.RetImage = 'RetImage' in params ? params.RetImage : null;
6453
6738
 
6454
6739
  }
6455
6740
  }
@@ -8065,13 +8350,13 @@ class AddressInfo extends AbstractModel {
8065
8350
  this.LineThree = null;
8066
8351
 
8067
8352
  /**
8068
- * <p>Fourth line of the address bar</p>
8353
+ * <p>Line 4 of the address bar</p>
8069
8354
  * @type {string || null}
8070
8355
  */
8071
8356
  this.LineFour = null;
8072
8357
 
8073
8358
  /**
8074
- * <p>Fifth line of the address bar</p>
8359
+ * <p>Line 5 of the address bar</p>
8075
8360
  * @type {string || null}
8076
8361
  */
8077
8362
  this.LineFive = null;
@@ -8112,19 +8397,21 @@ module.exports = {
8112
8397
  MLIDPassportOCRRequest: MLIDPassportOCRRequest,
8113
8398
  ItemInfo: ItemInfo,
8114
8399
  SmartStructuralOCRV2Request: SmartStructuralOCRV2Request,
8400
+ RecognizeThaiIDCardOCRResponse: RecognizeThaiIDCardOCRResponse,
8115
8401
  RecognizeBrazilCommonOCRResponse: RecognizeBrazilCommonOCRResponse,
8116
8402
  RecognizeMacaoIDCardOCRResponse: RecognizeMacaoIDCardOCRResponse,
8117
8403
  GetCardVerificationExternalResultResponse: GetCardVerificationExternalResultResponse,
8118
8404
  PermitOCRResponse: PermitOCRResponse,
8119
8405
  RecognizeBrazilDriverLicenseOCRRequest: RecognizeBrazilDriverLicenseOCRRequest,
8120
8406
  RecognizeMainlandIDCardOCRRequest: RecognizeMainlandIDCardOCRRequest,
8121
- MLIDCardOCRRequest: MLIDCardOCRRequest,
8407
+ HmtResidentPermitOCRResponse: HmtResidentPermitOCRResponse,
8122
8408
  WordPolygon: WordPolygon,
8123
8409
  Value: Value,
8124
8410
  RecognizeDetectCardCoordsResponse: RecognizeDetectCardCoordsResponse,
8125
8411
  RecognizePhilippinesVoteIDOCRRequest: RecognizePhilippinesVoteIDOCRRequest,
8126
8412
  BrazilRNMInfo: BrazilRNMInfo,
8127
8413
  TextDetection: TextDetection,
8414
+ SkippedCheck: SkippedCheck,
8128
8415
  RecognizeDetectCardCoordsRequest: RecognizeDetectCardCoordsRequest,
8129
8416
  GeneralCard: GeneralCard,
8130
8417
  MainlandPermitOCRRequest: MainlandPermitOCRRequest,
@@ -8136,24 +8423,27 @@ module.exports = {
8136
8423
  GeneralAccurateOCRResponse: GeneralAccurateOCRResponse,
8137
8424
  HmtResidentPermitOCRRequest: HmtResidentPermitOCRRequest,
8138
8425
  PortraitImageInfo: PortraitImageInfo,
8426
+ RecognizeGeneralCardVerificationResponse: RecognizeGeneralCardVerificationResponse,
8139
8427
  ApplyOcrTokenResponse: ApplyOcrTokenResponse,
8140
8428
  GeneralBasicOCRResponse: GeneralBasicOCRResponse,
8141
- PermitOCRRequest: PermitOCRRequest,
8429
+ ItemNames: ItemNames,
8142
8430
  RecognizePhilippinesUMIDOCRRequest: RecognizePhilippinesUMIDOCRRequest,
8143
8431
  RecognizePhilippinesSssIDOCRRequest: RecognizePhilippinesSssIDOCRRequest,
8144
8432
  Key: Key,
8145
8433
  BrazilIDCardInfo: BrazilIDCardInfo,
8146
8434
  HKIDCardOCRResponse: HKIDCardOCRResponse,
8147
8435
  GroupInfo: GroupInfo,
8148
- RecognizeThaiIDCardOCRResponse: RecognizeThaiIDCardOCRResponse,
8436
+ PermitOCRRequest: PermitOCRRequest,
8437
+ CardVerificationConfig: CardVerificationConfig,
8149
8438
  ExtractDocMultiResponse: ExtractDocMultiResponse,
8150
8439
  RecognizePhilippinesSssIDOCRResponse: RecognizePhilippinesSssIDOCRResponse,
8151
8440
  ApplyOcrTokenRequest: ApplyOcrTokenRequest,
8152
8441
  RecognizePhilippinesUMIDOCRResponse: RecognizePhilippinesUMIDOCRResponse,
8153
- RecognizeThaiIDCardOCRRequest: RecognizeThaiIDCardOCRRequest,
8442
+ ApplyCardVerificationExternalRequest: ApplyCardVerificationExternalRequest,
8154
8443
  PassportRecognizeInfos: PassportRecognizeInfos,
8155
8444
  RecognizeSingaporeIDCardOCRRequest: RecognizeSingaporeIDCardOCRRequest,
8156
8445
  RecognizeBrazilRNMOCRResponse: RecognizeBrazilRNMOCRResponse,
8446
+ RecognizeGeneralCardVerificationRequest: RecognizeGeneralCardVerificationRequest,
8157
8447
  GeneralBasicOCRRequest: GeneralBasicOCRRequest,
8158
8448
  RecognizeBrazilRNMOCRRequest: RecognizeBrazilRNMOCRRequest,
8159
8449
  RecognizeBrazilIDCardOCRResponse: RecognizeBrazilIDCardOCRResponse,
@@ -8162,12 +8452,11 @@ module.exports = {
8162
8452
  RecognizeMacaoIDCardOCRRequest: RecognizeMacaoIDCardOCRRequest,
8163
8453
  CoordsItem: CoordsItem,
8164
8454
  MLIDPassportOCRResponse: MLIDPassportOCRResponse,
8165
- ApplyCardVerificationExternalRequest: ApplyCardVerificationExternalRequest,
8455
+ RecognizeThaiIDCardOCRRequest: RecognizeThaiIDCardOCRRequest,
8166
8456
  GetCardVerificationExternalResultRequest: GetCardVerificationExternalResultRequest,
8167
8457
  Coord: Coord,
8168
8458
  RecognizeBrazilRNEOCRResponse: RecognizeBrazilRNEOCRResponse,
8169
8459
  RecognizeIndonesiaIDCardOCRResponse: RecognizeIndonesiaIDCardOCRResponse,
8170
- ItemNames: ItemNames,
8171
8460
  VinOCRResponse: VinOCRResponse,
8172
8461
  ConfigAdvanced: ConfigAdvanced,
8173
8462
  RecognizePhilippinesVoteIDOCRResponse: RecognizePhilippinesVoteIDOCRResponse,
@@ -8179,7 +8468,7 @@ module.exports = {
8179
8468
  SmartStructuralOCRV2Response: SmartStructuralOCRV2Response,
8180
8469
  RecognizeMainlandIDCardOCRResponse: RecognizeMainlandIDCardOCRResponse,
8181
8470
  MainlandPermitOCRResponse: MainlandPermitOCRResponse,
8182
- HmtResidentPermitOCRResponse: HmtResidentPermitOCRResponse,
8471
+ MLIDCardOCRRequest: MLIDCardOCRRequest,
8183
8472
  ImageCoordinates: ImageCoordinates,
8184
8473
  RecognizeMexicoVTIDRequest: RecognizeMexicoVTIDRequest,
8185
8474
  PODAuditAIResponse: PODAuditAIResponse,