tencentcloud-sdk-nodejs-intl-en 3.0.1452 → 3.0.1453

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.
@@ -16,6 +16,34 @@
16
16
  */
17
17
  const AbstractModel = require("../../common/abstract_model");
18
18
 
19
+ /**
20
+ * GetOcrVerificationResult request structure.
21
+ * @class
22
+ */
23
+ class GetOcrVerificationResultRequest extends AbstractModel {
24
+ constructor(){
25
+ super();
26
+
27
+ /**
28
+ * Token that identifies an SDK verification process. It is valid for 10 minutes. After the process completes, use this token to obtain the verification result information.
29
+ * @type {string || null}
30
+ */
31
+ this.SdkToken = null;
32
+
33
+ }
34
+
35
+ /**
36
+ * @private
37
+ */
38
+ deserialize(params) {
39
+ if (!params) {
40
+ return;
41
+ }
42
+ this.SdkToken = 'SdkToken' in params ? params.SdkToken : null;
43
+
44
+ }
45
+ }
46
+
19
47
  /**
20
48
  * RecognizeMexicoVTID response structure.
21
49
  * @class
@@ -1424,7 +1452,7 @@ class RecognizePhilippinesVoteIDOCRRequest extends AbstractModel {
1424
1452
  super();
1425
1453
 
1426
1454
  /**
1427
- * Whether to return the identity photo.
1455
+ * Whether to return the portrait photo.
1428
1456
  * @type {boolean || null}
1429
1457
  */
1430
1458
  this.ReturnHeadImage = null;
@@ -1734,7 +1762,7 @@ class RecognizeDetectCardCoordsRequest extends AbstractModel {
1734
1762
  }
1735
1763
 
1736
1764
  /**
1737
- * General card certificate information.
1765
+ * General card certificate information
1738
1766
  * @class
1739
1767
  */
1740
1768
  class GeneralCard extends AbstractModel {
@@ -1742,263 +1770,223 @@ class GeneralCard extends AbstractModel {
1742
1770
  super();
1743
1771
 
1744
1772
  /**
1745
- * ID number.
1746
- Note: This field may return null, indicating that no valid values can be obtained.
1773
+ * <p>ID number</p>
1747
1774
  * @type {string || null}
1748
1775
  */
1749
1776
  this.LicenseNumber = null;
1750
1777
 
1751
1778
  /**
1752
- * Personal number.
1753
- Note: This field may return null, indicating that no valid values can be obtained.
1779
+ * <p>Personal number, returned when the identity document type is passport</p>
1754
1780
  * @type {string || null}
1755
1781
  */
1756
1782
  this.PersonalNumber = null;
1757
1783
 
1758
1784
  /**
1759
- * Full name on the document.
1760
- Note: This field may return null, indicating that no valid values can be obtained.
1785
+ * <p>Name</p>
1761
1786
  * @type {string || null}
1762
1787
  */
1763
1788
  this.FullName = null;
1764
1789
 
1765
1790
  /**
1766
- * Full name in local language.
1767
- Note: This field may return null, indicating that no valid values can be obtained.
1791
+ * <p>Localized name</p>
1768
1792
  * @type {string || null}
1769
1793
  */
1770
1794
  this.FullNameLocal = null;
1771
1795
 
1772
1796
  /**
1773
- * First name or given name.
1774
- Note: This field may return null, indicating that no valid values can be obtained.
1797
+ * <p>Name</p>
1775
1798
  * @type {string || null}
1776
1799
  */
1777
1800
  this.FirstName = null;
1778
1801
 
1779
1802
  /**
1780
- * First name in local language.
1781
- Note: This field may return null, indicating that no valid values can be obtained.
1803
+ * <p>Localized name</p>
1782
1804
  * @type {string || null}
1783
1805
  */
1784
1806
  this.FirstNameLocal = null;
1785
1807
 
1786
1808
  /**
1787
- * Middle name.
1788
- Note: This field may return null, indicating that no valid values can be obtained.
1809
+ * <p>Middle name</p>
1789
1810
  * @type {string || null}
1790
1811
  */
1791
1812
  this.MiddleName = null;
1792
1813
 
1793
1814
  /**
1794
- * Middle name in local language.
1795
- Note: This field may return null, indicating that no valid values can be obtained.
1815
+ * <p>Localized middle name</p>
1796
1816
  * @type {string || null}
1797
1817
  */
1798
1818
  this.MiddleNameLocal = null;
1799
1819
 
1800
1820
  /**
1801
- * Last name or surname.
1802
- Note: This field may return null, indicating that no valid values can be obtained.
1821
+ * <p>Last name</p>
1803
1822
  * @type {string || null}
1804
1823
  */
1805
1824
  this.LastName = null;
1806
1825
 
1807
1826
  /**
1808
- * Last name in local language.
1809
- Note: This field may return null, indicating that no valid values can be obtained.
1827
+ * <p>Localized last name</p>
1810
1828
  * @type {string || null}
1811
1829
  */
1812
1830
  this.LastNameLocal = null;
1813
1831
 
1814
1832
  /**
1815
- * Gender on the document.
1816
- - M: man.
1817
- - F: woman.
1818
- - X: other gender identity.
1819
- Note: This field may return null, indicating that no valid values can be obtained.
1833
+ * <p>Gender on the document</p><ul><li>M: man</li><li>F: woman</li><li>X: other gender identity</li></ul>
1820
1834
  * @type {string || null}
1821
1835
  */
1822
1836
  this.Sex = null;
1823
1837
 
1824
1838
  /**
1825
- * Date of birth.
1826
- Note: This field may return null, indicating that no valid values can be obtained.
1839
+ * <p>Date of birth</p>
1827
1840
  * @type {string || null}
1828
1841
  */
1829
1842
  this.Birthday = null;
1830
1843
 
1831
1844
  /**
1832
- * Birth place.
1833
- Note: This field may return null, indicating that no valid values can be obtained.
1845
+ * <p>Birth place</p>
1834
1846
  * @type {string || null}
1835
1847
  */
1836
1848
  this.BirthPlace = null;
1837
1849
 
1838
1850
  /**
1839
- * Issue date.
1840
- Note: This field may return null, indicating that no valid values can be obtained.
1851
+ * <p>Issue date, in YYYY-MM-DD format</p>
1841
1852
  * @type {string || null}
1842
1853
  */
1843
1854
  this.IssuedDate = null;
1844
1855
 
1845
1856
  /**
1846
- * Issuing authority.
1847
- Note: This field may return null, indicating that no valid values can be obtained.
1857
+ * <p>Issuing authority</p>
1848
1858
  * @type {string || null}
1849
1859
  */
1850
1860
  this.IssuedAuthority = null;
1851
1861
 
1852
1862
  /**
1853
- * Place of issue.
1854
- Note: This field may return null, indicating that no valid values can be obtained.
1863
+ * <p>Place where the specified file is issued</p>
1855
1864
  * @type {string || null}
1856
1865
  */
1857
1866
  this.IssuedPlace = null;
1858
1867
 
1859
1868
  /**
1860
- * Issuing country.
1861
- Note: This field may return null, indicating that no valid values can be obtained.
1869
+ * <p>Issuing country</p>
1862
1870
  * @type {string || null}
1863
1871
  */
1864
1872
  this.IssuedCountry = null;
1865
1873
 
1866
1874
  /**
1867
- * Country code of issue, ISO Alpha-3 format.
1868
- Note: This field may return null, indicating that no valid values can be obtained.
1875
+ * <p>Country code of the country that issued the file, ISO ALPHA-3 country/region code</p>
1869
1876
  * @type {string || null}
1870
1877
  */
1871
1878
  this.IssuedCountryCode = null;
1872
1879
 
1873
1880
  /**
1874
- * Expiry date.
1875
- Note: This field may return null, indicating that no valid values can be obtained.
1881
+ * <p>Expiration date, in YYYY-MM-DD format</p>
1876
1882
  * @type {string || null}
1877
1883
  */
1878
1884
  this.ExpirationDate = null;
1879
1885
 
1880
1886
  /**
1881
- * First line of the Machine Readable Zone (MRZ).
1882
- Note: This field may return null, indicating that no valid values can be obtained.
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>
1883
1888
  * @type {string || null}
1884
1889
  */
1885
1890
  this.MRZLine1 = null;
1886
1891
 
1887
1892
  /**
1888
- * Second line of the Machine Readable Zone (MRZ).
1889
- Note: This field may return null, indicating that no valid values can be obtained.
1893
+ * <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>
1890
1894
  * @type {string || null}
1891
1895
  */
1892
1896
  this.MRZLine2 = null;
1893
1897
 
1894
1898
  /**
1895
- * Document nationality, following ISO 3166 country coding specification.
1896
- Note: This field may return null, indicating that no valid values can be obtained.
1899
+ * <p>Document nationality, returned following the ISO 3166 country coding specification</p>
1897
1900
  * @type {string || null}
1898
1901
  */
1899
1902
  this.Nationality = null;
1900
1903
 
1901
1904
  /**
1902
- * Address information on the document.
1903
- Note: This field may return null, indicating that no valid values can be obtained.
1905
+ * <p>Address information on the document</p>
1904
1906
  * @type {AddressInfo || null}
1905
1907
  */
1906
1908
  this.Address = null;
1907
1909
 
1908
1910
  /**
1909
- * Religion (if displayed on the document).
1910
- Note: This field may return null, indicating that no valid values can be obtained.
1911
+ * <p>Religious belief</p>
1911
1912
  * @type {string || null}
1912
1913
  */
1913
1914
  this.Religion = null;
1914
1915
 
1915
1916
  /**
1916
- * Type of document.
1917
- Note: This field may return null, indicating that no valid values can be obtained.
1917
+ * <p>Document type</p>
1918
1918
  * @type {string || null}
1919
1919
  */
1920
1920
  this.Type = null;
1921
1921
 
1922
1922
  /**
1923
- * Blood type.
1924
- Note: This field may return null, indicating that no valid values can be obtained.
1923
+ * <p>Blood type</p>
1925
1924
  * @type {string || null}
1926
1925
  */
1927
1926
  this.BloodType = null;
1928
1927
 
1929
1928
  /**
1930
- * Height.
1931
- Note: This field may return null, indicating that no valid values can be obtained.
1929
+ * <p>Height</p>
1932
1930
  * @type {string || null}
1933
1931
  */
1934
1932
  this.Height = null;
1935
1933
 
1936
1934
  /**
1937
- * Weight.
1938
- Note: This field may return null, indicating that no valid values can be obtained.
1935
+ * <p>Weight</p>
1939
1936
  * @type {string || null}
1940
1937
  */
1941
1938
  this.Weight = null;
1942
1939
 
1943
1940
  /**
1944
- * Vehicle class authorized on the driver license (e.g., A, B, C).
1945
- Note: This field may return null, indicating that no valid values can be obtained.
1941
+ * <p>Driver's license vehicle type (for example, A/B/C)</p>
1946
1942
  * @type {string || null}
1947
1943
  */
1948
1944
  this.VehicleClass = null;
1949
1945
 
1950
1946
  /**
1951
- * Restrictions on the driver license.
1952
- Note: This field may return null, indicating that no valid values can be obtained.
1947
+ * <p>Driver's license restriction condition</p>
1953
1948
  * @type {string || null}
1954
1949
  */
1955
1950
  this.Restrictions = null;
1956
1951
 
1957
1952
  /**
1958
- * Endorsements or additional records on the driver license.
1959
- Note: This field may return null, indicating that no valid values can be obtained.
1953
+ * <p>Driver's license extra records</p>
1960
1954
  * @type {string || null}
1961
1955
  */
1962
1956
  this.Endorsement = null;
1963
1957
 
1964
1958
  /**
1965
- * Supplementary fields (varies by document type).
1966
- Note: This field may return null, indicating that no valid values can be obtained.
1959
+ * <p>Additional field</p>
1967
1960
  * @type {string || null}
1968
1961
  */
1969
1962
  this.Others = null;
1970
1963
 
1971
1964
  /**
1972
- * First line of the passport MRZ (Machine Readable Zone).
1973
- Note: This field may return null, indicating that no valid values can be obtained.
1965
+ * <p>MRZ line 1 of the passport</p>
1974
1966
  * @type {string || null}
1975
1967
  */
1976
1968
  this.PassportCodeFirst = null;
1977
1969
 
1978
1970
  /**
1979
- * Second line of the passport MRZ (Machine Readable Zone).
1980
- Note: This field may return null, indicating that no valid values can be obtained.
1971
+ * <p>MRZ line 2 of the passport</p>
1981
1972
  * @type {string || null}
1982
1973
  */
1983
1974
  this.PassportCodeSecond = null;
1984
1975
 
1985
1976
  /**
1986
- * Expiry date.
1987
- Note: This field may return null, indicating that no valid values can be obtained.
1977
+ * <p>Validity date, in YYYY-MM-DD format</p>
1988
1978
  * @type {string || null}
1989
1979
  */
1990
1980
  this.DueDate = null;
1991
1981
 
1992
1982
  /**
1993
- * Age. 0 means no valid info.
1994
- Note: This field may return null, indicating that no valid values can be obtained.
1983
+ * <p>Age. 0 means no valid info is obtained</p>
1995
1984
  * @type {string || null}
1996
1985
  */
1997
1986
  this.Age = null;
1998
1987
 
1999
1988
  /**
2000
- * Registration number.
2001
- Note: This field may return null, indicating that no valid values can be obtained.
1989
+ * <p>Registration number</p>
2002
1990
  * @type {string || null}
2003
1991
  */
2004
1992
  this.RegistrationNumber = null;
@@ -2181,7 +2169,7 @@ class RecognizePhilippinesTinIDOCRResponse extends AbstractModel {
2181
2169
  super();
2182
2170
 
2183
2171
  /**
2184
- * The Base64-encoded identity photo.
2172
+ * Base64 encoded result of portrait photo.
2185
2173
  * @type {TextDetectionResult || null}
2186
2174
  */
2187
2175
  this.HeadPortrait = null;
@@ -2193,7 +2181,7 @@ class RecognizePhilippinesTinIDOCRResponse extends AbstractModel {
2193
2181
  this.LicenseNumber = null;
2194
2182
 
2195
2183
  /**
2196
- * The full name.
2184
+ * Full name of the taxpayer.
2197
2185
  * @type {TextDetectionResult || null}
2198
2186
  */
2199
2187
  this.FullName = null;
@@ -2216,6 +2204,30 @@ class RecognizePhilippinesTinIDOCRResponse extends AbstractModel {
2216
2204
  */
2217
2205
  this.IssueDate = null;
2218
2206
 
2207
+ /**
2208
+ * Given name of the taxpayer.
2209
+ * @type {TextDetectionResult || null}
2210
+ */
2211
+ this.GivenName = null;
2212
+
2213
+ /**
2214
+ * Last name of the taxpayer.
2215
+ * @type {TextDetectionResult || null}
2216
+ */
2217
+ this.LastName = null;
2218
+
2219
+ /**
2220
+ * Middle name of the taxpayer.
2221
+ * @type {TextDetectionResult || null}
2222
+ */
2223
+ this.MiddleName = null;
2224
+
2225
+ /**
2226
+ * Revenue district office where the taxpayer is registered.
2227
+ * @type {TextDetectionResult || null}
2228
+ */
2229
+ this.RDO = null;
2230
+
2219
2231
  /**
2220
2232
  * 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.
2221
2233
  * @type {string || null}
@@ -2267,6 +2279,30 @@ class RecognizePhilippinesTinIDOCRResponse extends AbstractModel {
2267
2279
  obj.deserialize(params.IssueDate)
2268
2280
  this.IssueDate = obj;
2269
2281
  }
2282
+
2283
+ if (params.GivenName) {
2284
+ let obj = new TextDetectionResult();
2285
+ obj.deserialize(params.GivenName)
2286
+ this.GivenName = obj;
2287
+ }
2288
+
2289
+ if (params.LastName) {
2290
+ let obj = new TextDetectionResult();
2291
+ obj.deserialize(params.LastName)
2292
+ this.LastName = obj;
2293
+ }
2294
+
2295
+ if (params.MiddleName) {
2296
+ let obj = new TextDetectionResult();
2297
+ obj.deserialize(params.MiddleName)
2298
+ this.MiddleName = obj;
2299
+ }
2300
+
2301
+ if (params.RDO) {
2302
+ let obj = new TextDetectionResult();
2303
+ obj.deserialize(params.RDO)
2304
+ this.RDO = obj;
2305
+ }
2270
2306
  this.RequestId = 'RequestId' in params ? params.RequestId : null;
2271
2307
 
2272
2308
  }
@@ -2615,6 +2651,48 @@ class PortraitImageInfo extends AbstractModel {
2615
2651
  }
2616
2652
  }
2617
2653
 
2654
+ /**
2655
+ * ApplyOcrToken response structure.
2656
+ * @class
2657
+ */
2658
+ class ApplyOcrTokenResponse extends AbstractModel {
2659
+ constructor(){
2660
+ super();
2661
+
2662
+ /**
2663
+ * Token that identifies an SDK verification process. It is valid for 10 minutes. After the process completes, use this token to obtain the verification result information.
2664
+ * @type {string || null}
2665
+ */
2666
+ this.SdkToken = null;
2667
+
2668
+ /**
2669
+ * Encryption configuration generated on the server side.
2670
+ * @type {string || null}
2671
+ */
2672
+ this.EncryptedConfig = null;
2673
+
2674
+ /**
2675
+ * 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.
2676
+ * @type {string || null}
2677
+ */
2678
+ this.RequestId = null;
2679
+
2680
+ }
2681
+
2682
+ /**
2683
+ * @private
2684
+ */
2685
+ deserialize(params) {
2686
+ if (!params) {
2687
+ return;
2688
+ }
2689
+ this.SdkToken = 'SdkToken' in params ? params.SdkToken : null;
2690
+ this.EncryptedConfig = 'EncryptedConfig' in params ? params.EncryptedConfig : null;
2691
+ this.RequestId = 'RequestId' in params ? params.RequestId : null;
2692
+
2693
+ }
2694
+ }
2695
+
2618
2696
  /**
2619
2697
  * GeneralBasicOCR response structure.
2620
2698
  * @class
@@ -2786,7 +2864,7 @@ class RecognizePhilippinesSssIDOCRRequest extends AbstractModel {
2786
2864
  super();
2787
2865
 
2788
2866
  /**
2789
- * Whether to return the identity photo.
2867
+ * Whether to return the portrait photo.
2790
2868
  * @type {boolean || null}
2791
2869
  */
2792
2870
  this.ReturnHeadImage = null;
@@ -3268,7 +3346,7 @@ class RecognizeThaiIDCardOCRResponse extends AbstractModel {
3268
3346
  this.Address = null;
3269
3347
 
3270
3348
  /**
3271
- * Laser ID on the back of the card.
3349
+ * Laser ID on the back of the card
3272
3350
  * @type {string || null}
3273
3351
  */
3274
3352
  this.LaserID = null;
@@ -3287,14 +3365,14 @@ class RecognizeThaiIDCardOCRResponse extends AbstractModel {
3287
3365
  -9103 Alarm for photographed certificate
3288
3366
  -9104 Alarm for tamper certificate
3289
3367
  -9107 Alarm for reflective certificate
3290
- -9108 Alarm for blurry certificate
3368
+ -9108 Alarm for blurry certificate
3291
3369
  -9109 This capability is not enabled. Please contact customer support to activate the alert service
3292
3370
  * @type {Array.<number> || null}
3293
3371
  */
3294
3372
  this.WarnCardInfos = null;
3295
3373
 
3296
3374
  /**
3297
- * This field is deprecated and will always return "1". Usage is not recommended.
3375
+ * <p>This field is deprecated and will always return "1". It is not recommended for use.</p>
3298
3376
  * @type {string || null}
3299
3377
  */
3300
3378
  this.AdvancedInfo = null;
@@ -3312,6 +3390,18 @@ true: complete; false: incomplete
3312
3390
  */
3313
3391
  this.IsComplete = null;
3314
3392
 
3393
+ /**
3394
+ * First name in Thai
3395
+ * @type {string || null}
3396
+ */
3397
+ this.ThaiFirstName = null;
3398
+
3399
+ /**
3400
+ * Last name in Thai
3401
+ * @type {string || null}
3402
+ */
3403
+ this.ThaiLastName = null;
3404
+
3315
3405
  /**
3316
3406
  * 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.
3317
3407
  * @type {string || null}
@@ -3346,6 +3436,8 @@ true: complete; false: incomplete
3346
3436
  this.AdvancedInfo = 'AdvancedInfo' in params ? params.AdvancedInfo : null;
3347
3437
  this.CardCount = 'CardCount' in params ? params.CardCount : null;
3348
3438
  this.IsComplete = 'IsComplete' in params ? params.IsComplete : null;
3439
+ this.ThaiFirstName = 'ThaiFirstName' in params ? params.ThaiFirstName : null;
3440
+ this.ThaiLastName = 'ThaiLastName' in params ? params.ThaiLastName : null;
3349
3441
  this.RequestId = 'RequestId' in params ? params.RequestId : null;
3350
3442
 
3351
3443
  }
@@ -3432,7 +3524,7 @@ class RecognizePhilippinesSssIDOCRResponse extends AbstractModel {
3432
3524
  super();
3433
3525
 
3434
3526
  /**
3435
- * The Base64-encoded identity photo.
3527
+ * Base64 encoded result of portrait photo.
3436
3528
  * @type {TextDetectionResult || null}
3437
3529
  */
3438
3530
  this.HeadPortrait = null;
@@ -3455,6 +3547,24 @@ class RecognizePhilippinesSssIDOCRResponse extends AbstractModel {
3455
3547
  */
3456
3548
  this.Birthday = null;
3457
3549
 
3550
+ /**
3551
+ * First name (given name) of the cardholder.
3552
+ * @type {TextDetectionResult || null}
3553
+ */
3554
+ this.GivenName = null;
3555
+
3556
+ /**
3557
+ * Family name (surname) of the cardholder.
3558
+ * @type {TextDetectionResult || null}
3559
+ */
3560
+ this.Surname = null;
3561
+
3562
+ /**
3563
+ * Middle name of the cardholder.
3564
+ * @type {TextDetectionResult || null}
3565
+ */
3566
+ this.MiddleName = null;
3567
+
3458
3568
  /**
3459
3569
  * 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.
3460
3570
  * @type {string || null}
@@ -3494,11 +3604,134 @@ class RecognizePhilippinesSssIDOCRResponse extends AbstractModel {
3494
3604
  obj.deserialize(params.Birthday)
3495
3605
  this.Birthday = obj;
3496
3606
  }
3607
+
3608
+ if (params.GivenName) {
3609
+ let obj = new TextDetectionResult();
3610
+ obj.deserialize(params.GivenName)
3611
+ this.GivenName = obj;
3612
+ }
3613
+
3614
+ if (params.Surname) {
3615
+ let obj = new TextDetectionResult();
3616
+ obj.deserialize(params.Surname)
3617
+ this.Surname = obj;
3618
+ }
3619
+
3620
+ if (params.MiddleName) {
3621
+ let obj = new TextDetectionResult();
3622
+ obj.deserialize(params.MiddleName)
3623
+ this.MiddleName = obj;
3624
+ }
3497
3625
  this.RequestId = 'RequestId' in params ? params.RequestId : null;
3498
3626
 
3499
3627
  }
3500
3628
  }
3501
3629
 
3630
+ /**
3631
+ * ApplyOcrToken request structure.
3632
+ * @class
3633
+ */
3634
+ class ApplyOcrTokenRequest extends AbstractModel {
3635
+ constructor(){
3636
+ super();
3637
+
3638
+ /**
3639
+ * Country code. ISO 3166-1 Alpha-3 country/region code standard.
3640
+ * @type {string || null}
3641
+ */
3642
+ this.Nationality = null;
3643
+
3644
+ /**
3645
+ * Supported countries/regions and document types:
3646
+
3647
+ Mainland China: ID_CARD, PERMIT
3648
+ Hong Kong: ID_CARD
3649
+ Macao: ID_CARD
3650
+ Hong Kong/Macao/Taiwan: MAINLAND_PERMIT, HMT_RESIDENT_PERMIT
3651
+ Thailand: ID_CARD, THA_PINK_CARD
3652
+ Indonesia: ID_CARD
3653
+ Malaysia: ID_CARD
3654
+ Singapore: ID_CARD
3655
+ Philippines: PHL_UMID, PHL_VOTE_ID, PHL_TIN_ID, PHL_SSS_ID, DRIVING_LICENSE
3656
+ Any country/region: PASSPORT
3657
+ * @type {string || null}
3658
+ */
3659
+ this.CardType = null;
3660
+
3661
+ /**
3662
+ * SDK-generated device-related encryption configuration information.
3663
+ * @type {string || null}
3664
+ */
3665
+ this.EncryptedConfig = null;
3666
+
3667
+ /**
3668
+ * <p>Whether to extract the portrait image from the document. false by default</p><p>Default value: false</p>
3669
+ * @type {boolean || null}
3670
+ */
3671
+ this.ReturnHeadImage = null;
3672
+
3673
+ /**
3674
+ * <p>Maximum number of token retries</p><p>Value range: [1, 5]</p><p>Default value: 3</p>
3675
+ * @type {number || null}
3676
+ */
3677
+ this.RetryLimit = null;
3678
+
3679
+ /**
3680
+ * <p>SDK capture mode</p><p>Enumeration values:</p><ul><li>OCR_DETECT_MANUAL: Photo recognition mode. The system performs recognition after you tap to take a photo.</li><li>OCR_DETECT_AUTO_MANUAL: Automatic recognition mode. The system recognizes automatically, and you can switch to photo recognition after a recognition timeout.</li><li>OCR_DETECT_AUTO: Pure automatic recognition mode. The system recognizes automatically, and you cannot switch to photo recognition after a recognition timeout.</li><li>OCR_DETECT_AUTO_MULTI: Pure automatic recognition mode (multiple images). The system turns on the flash and automatically collects multiple document photos.</li></ul><p>Default value: OCR_DETECT_AUTO_MANUAL</p>
3681
+ * @type {string || null}
3682
+ */
3683
+ this.OcrModeType = null;
3684
+
3685
+ /**
3686
+ * <p>Whether to allow uploading gallery images for recognition.</p><p>Default value: true</p>
3687
+ * @type {boolean || null}
3688
+ */
3689
+ this.AllowUploadPhoto = null;
3690
+
3691
+ /**
3692
+ * <p>Whether to enable ID card photo cropping (remove extra edges outside the document and automatically correct the shooting angle). It is false by default and only applicable to Mainland ID cards.</p><p>Default value: false</p>
3693
+ * @type {boolean || null}
3694
+ */
3695
+ this.CropIdCard = null;
3696
+
3697
+ /**
3698
+ * <p>SDK-supported recognition version mode</p><p>Enumeration values:</p><ul><li>BASIC: Basic version</li><li>ENHANCED: Enhanced version</li></ul><p>Default value: BASIC</p>
3699
+ * @type {string || null}
3700
+ */
3701
+ this.SdkVersion = null;
3702
+
3703
+ /**
3704
+ * OCR automatic capture mode timeout (ms).
3705
+ Value range: [5000, 180000].
3706
+ Default value: 20000.
3707
+ If the value is below 5000, it is set to 5000; if above 180000, it is set to 180000.
3708
+ * @type {number || null}
3709
+ */
3710
+ this.OcrAutoDetectTimeout = null;
3711
+
3712
+ }
3713
+
3714
+ /**
3715
+ * @private
3716
+ */
3717
+ deserialize(params) {
3718
+ if (!params) {
3719
+ return;
3720
+ }
3721
+ this.Nationality = 'Nationality' in params ? params.Nationality : null;
3722
+ this.CardType = 'CardType' in params ? params.CardType : null;
3723
+ this.EncryptedConfig = 'EncryptedConfig' in params ? params.EncryptedConfig : null;
3724
+ this.ReturnHeadImage = 'ReturnHeadImage' in params ? params.ReturnHeadImage : null;
3725
+ this.RetryLimit = 'RetryLimit' in params ? params.RetryLimit : null;
3726
+ this.OcrModeType = 'OcrModeType' in params ? params.OcrModeType : null;
3727
+ this.AllowUploadPhoto = 'AllowUploadPhoto' in params ? params.AllowUploadPhoto : null;
3728
+ this.CropIdCard = 'CropIdCard' in params ? params.CropIdCard : null;
3729
+ this.SdkVersion = 'SdkVersion' in params ? params.SdkVersion : null;
3730
+ this.OcrAutoDetectTimeout = 'OcrAutoDetectTimeout' in params ? params.OcrAutoDetectTimeout : null;
3731
+
3732
+ }
3733
+ }
3734
+
3502
3735
  /**
3503
3736
  * RecognizePhilippinesUMIDOCR response structure.
3504
3737
  * @class
@@ -3633,7 +3866,7 @@ class RecognizeThaiIDCardOCRRequest extends AbstractModel {
3633
3866
 
3634
3867
  /**
3635
3868
  * 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.
3636
- Either `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, `ImageUrl` is used.
3869
+ Either ImageUrl or ImageBase64 of the image must be provided. If both are provided, ImageUrl is used.
3637
3870
  * @type {string || null}
3638
3871
  */
3639
3872
  this.ImageBase64 = null;
@@ -3658,8 +3891,8 @@ We recommend that you store the image in Tencent Cloud for higher download speed
3658
3891
  this.BackImageUrl = null;
3659
3892
 
3660
3893
  /**
3661
- * 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.
3662
- 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.
3894
+ * 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.
3895
+ 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.
3663
3896
  * @type {boolean || null}
3664
3897
  */
3665
3898
  this.CropPortrait = null;
@@ -5313,7 +5546,7 @@ class RecognizePhilippinesVoteIDOCRResponse extends AbstractModel {
5313
5546
  super();
5314
5547
 
5315
5548
  /**
5316
- * The Base64-encoded identity photo.
5549
+ * Base64 encoded result of portrait photo.
5317
5550
  * @type {TextDetectionResult || null}
5318
5551
  */
5319
5552
  this.HeadPortrait = null;
@@ -5337,7 +5570,7 @@ class RecognizePhilippinesVoteIDOCRResponse extends AbstractModel {
5337
5570
  this.FirstName = null;
5338
5571
 
5339
5572
  /**
5340
- *
5573
+ * The middle name.
5341
5574
  * @type {TextDetectionResult || null}
5342
5575
  */
5343
5576
  this.MiddleName = null;
@@ -6375,6 +6608,132 @@ class PODAuditAIResponse extends AbstractModel {
6375
6608
  }
6376
6609
  }
6377
6610
 
6611
+ /**
6612
+ * GetOcrVerificationResult response structure.
6613
+ * @class
6614
+ */
6615
+ class GetOcrVerificationResultResponse extends AbstractModel {
6616
+ constructor(){
6617
+ super();
6618
+
6619
+ /**
6620
+ * <p>Indicates the completion status of an SDK verification process.</p><p>Enumeration values: </p><ul><li>PROCESSING: PROCESSING.</li><li>COMPLETE: Completed.</li></ul>
6621
+ * @type {string || null}
6622
+ */
6623
+ this.Status = null;
6624
+
6625
+ /**
6626
+ * Front image of the card.
6627
+ * @type {string || null}
6628
+ */
6629
+ this.CardImage = null;
6630
+
6631
+ /**
6632
+ * Back image of the card.
6633
+ * @type {string || null}
6634
+ */
6635
+ this.CardImageBack = null;
6636
+
6637
+ /**
6638
+ * Portrait image on the front of the card.
6639
+ * @type {string || null}
6640
+ */
6641
+ this.HeadImage = null;
6642
+
6643
+ /**
6644
+ * Result code of this verification.
6645
+ * @type {string || null}
6646
+ */
6647
+ this.ResultCode = null;
6648
+
6649
+ /**
6650
+ * Indicates the risk level of the device from which the current request is sent. There are four levels:
6651
+ 1 - Safe.
6652
+ 2 - Low risk.
6653
+ 3 - Medium risk.
6654
+ 4 - High risk.
6655
+ Empty - The risk level is not obtained.
6656
+ Returned only in the enhanced version. Empty by default.
6657
+ * @type {string || null}
6658
+ */
6659
+ this.DeviceInfoLevel = null;
6660
+
6661
+ /**
6662
+ * Card recognition result. The latest result is taken as the valid one.
6663
+ * @type {GeneralCard || null}
6664
+ */
6665
+ this.CardInfo = null;
6666
+
6667
+ /**
6668
+ * Recognition result on the back of the card.
6669
+ * @type {GeneralCard || null}
6670
+ */
6671
+ this.BackCardInfo = null;
6672
+
6673
+ /**
6674
+ * Authenticity check. Valid values:
6675
+ 0: Unable to determine (caused by blur, incompleteness, glare, or low brightness).
6676
+ 1: Fake.
6677
+ 2: Genuine.
6678
+ Only effective for Hong Kong, China ID card recognition. This field is gradually being phased out.
6679
+ * @type {number || null}
6680
+ */
6681
+ this.FakeDetectResult = null;
6682
+
6683
+ /**
6684
+ * Card Warning Information
6685
+
6686
+ -9101 Alarm for covered certificate
6687
+ -9102 Alarm for photocopied certificate
6688
+ -9103 Alarm for photographed certificate
6689
+ -9104 Alarm for tamper certificate
6690
+ -9107 Alarm for reflective certificate
6691
+ -9108 Alarm for blurry certificate
6692
+ -9109 This capability is not enabled. Please contact customer support to activate the alert service.
6693
+ * @type {Array.<number> || null}
6694
+ */
6695
+ this.WarnCardInfos = null;
6696
+
6697
+ /**
6698
+ * 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.
6699
+ * @type {string || null}
6700
+ */
6701
+ this.RequestId = null;
6702
+
6703
+ }
6704
+
6705
+ /**
6706
+ * @private
6707
+ */
6708
+ deserialize(params) {
6709
+ if (!params) {
6710
+ return;
6711
+ }
6712
+ this.Status = 'Status' in params ? params.Status : null;
6713
+ this.CardImage = 'CardImage' in params ? params.CardImage : null;
6714
+ this.CardImageBack = 'CardImageBack' in params ? params.CardImageBack : null;
6715
+ this.HeadImage = 'HeadImage' in params ? params.HeadImage : null;
6716
+ this.ResultCode = 'ResultCode' in params ? params.ResultCode : null;
6717
+ this.DeviceInfoLevel = 'DeviceInfoLevel' in params ? params.DeviceInfoLevel : null;
6718
+
6719
+ if (params.CardInfo) {
6720
+ let obj = new GeneralCard();
6721
+ obj.deserialize(params.CardInfo)
6722
+ this.CardInfo = obj;
6723
+ }
6724
+
6725
+ if (params.BackCardInfo) {
6726
+ let obj = new GeneralCard();
6727
+ obj.deserialize(params.BackCardInfo)
6728
+ this.BackCardInfo = obj;
6729
+ }
6730
+ this.FakeDetectResult = 'FakeDetectResult' in params ? params.FakeDetectResult : null;
6731
+ this.WarnCardInfos = 'WarnCardInfos' in params ? params.WarnCardInfos : null;
6732
+ this.RequestId = 'RequestId' in params ? params.RequestId : null;
6733
+
6734
+ }
6735
+ }
6736
+
6378
6737
  /**
6379
6738
  *
6380
6739
  * @class
@@ -7389,7 +7748,7 @@ class RecognizePhilippinesDrivingLicenseOCRResponse extends AbstractModel {
7389
7748
  super();
7390
7749
 
7391
7750
  /**
7392
- * The Base64-encoded identity photo.
7751
+ * Base64 encoded result of portrait photo.
7393
7752
  * @type {TextDetectionResult || null}
7394
7753
  */
7395
7754
  this.HeadPortrait = null;
@@ -7425,7 +7784,7 @@ class RecognizePhilippinesDrivingLicenseOCRResponse extends AbstractModel {
7425
7784
  this.Nationality = null;
7426
7785
 
7427
7786
  /**
7428
- * Gender
7787
+ * Gender.
7429
7788
  * @type {TextDetectionResult || null}
7430
7789
  */
7431
7790
  this.Sex = null;
@@ -7460,6 +7819,48 @@ class RecognizePhilippinesDrivingLicenseOCRResponse extends AbstractModel {
7460
7819
  */
7461
7820
  this.Birthday = null;
7462
7821
 
7822
+ /**
7823
+ * Blood type of the license holder.
7824
+ * @type {TextDetectionResult || null}
7825
+ */
7826
+ this.BloodType = null;
7827
+
7828
+ /**
7829
+ * Height of the license holder, in metres as printed on the card (e.g. 1.69).
7830
+ * @type {TextDetectionResult || null}
7831
+ */
7832
+ this.Height = null;
7833
+
7834
+ /**
7835
+ * Weight of the license holder, in kilograms (e.g. 65).
7836
+ * @type {TextDetectionResult || null}
7837
+ */
7838
+ this.Weight = null;
7839
+
7840
+ /**
7841
+ * Eye color of the license holder (e.g. BLACK).
7842
+ * @type {TextDetectionResult || null}
7843
+ */
7844
+ this.EyeColor = null;
7845
+
7846
+ /**
7847
+ * Driver's license codes indicating the vehicle categories the license holder is authorized to operate (e.g. A, A1, B, B1, B2, C, D, BE, CE).
7848
+ * @type {TextDetectionResult || null}
7849
+ */
7850
+ this.DLCodes = null;
7851
+
7852
+ /**
7853
+ * Restrictions that limit the license holder's driving privileges, such as transmission type (AT / MT) or vehicle-class limits.
7854
+ * @type {TextDetectionResult || null}
7855
+ */
7856
+ this.Restrictions = null;
7857
+
7858
+ /**
7859
+ * Driving conditions of the license holder (e.g. A = must wear glasses, D = daytime driving only).
7860
+ * @type {TextDetectionResult || null}
7861
+ */
7862
+ this.Conditions = null;
7863
+
7463
7864
  /**
7464
7865
  * 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.
7465
7866
  * @type {string || null}
@@ -7547,13 +7948,55 @@ class RecognizePhilippinesDrivingLicenseOCRResponse extends AbstractModel {
7547
7948
  obj.deserialize(params.Birthday)
7548
7949
  this.Birthday = obj;
7549
7950
  }
7951
+
7952
+ if (params.BloodType) {
7953
+ let obj = new TextDetectionResult();
7954
+ obj.deserialize(params.BloodType)
7955
+ this.BloodType = obj;
7956
+ }
7957
+
7958
+ if (params.Height) {
7959
+ let obj = new TextDetectionResult();
7960
+ obj.deserialize(params.Height)
7961
+ this.Height = obj;
7962
+ }
7963
+
7964
+ if (params.Weight) {
7965
+ let obj = new TextDetectionResult();
7966
+ obj.deserialize(params.Weight)
7967
+ this.Weight = obj;
7968
+ }
7969
+
7970
+ if (params.EyeColor) {
7971
+ let obj = new TextDetectionResult();
7972
+ obj.deserialize(params.EyeColor)
7973
+ this.EyeColor = obj;
7974
+ }
7975
+
7976
+ if (params.DLCodes) {
7977
+ let obj = new TextDetectionResult();
7978
+ obj.deserialize(params.DLCodes)
7979
+ this.DLCodes = obj;
7980
+ }
7981
+
7982
+ if (params.Restrictions) {
7983
+ let obj = new TextDetectionResult();
7984
+ obj.deserialize(params.Restrictions)
7985
+ this.Restrictions = obj;
7986
+ }
7987
+
7988
+ if (params.Conditions) {
7989
+ let obj = new TextDetectionResult();
7990
+ obj.deserialize(params.Conditions)
7991
+ this.Conditions = obj;
7992
+ }
7550
7993
  this.RequestId = 'RequestId' in params ? params.RequestId : null;
7551
7994
 
7552
7995
  }
7553
7996
  }
7554
7997
 
7555
7998
  /**
7556
- * Overseas document recognition address information.
7999
+ * Overseas document recognition address information
7557
8000
  * @class
7558
8001
  */
7559
8002
  class AddressInfo extends AbstractModel {
@@ -7561,85 +8004,73 @@ class AddressInfo extends AbstractModel {
7561
8004
  super();
7562
8005
 
7563
8006
  /**
7564
- * Country.
7565
- Note: This field may return null, indicating that no valid values can be obtained.
8007
+ * <p>Country</p>
7566
8008
  * @type {string || null}
7567
8009
  */
7568
8010
  this.Country = null;
7569
8011
 
7570
8012
  /**
7571
- * Postal code.
7572
- Note: This field may return null, indicating that no valid values can be obtained.
8013
+ * <p>Postal code</p>
7573
8014
  * @type {string || null}
7574
8015
  */
7575
8016
  this.PostalCode = null;
7576
8017
 
7577
8018
  /**
7578
- * Sub-region or state/province.
7579
- Note: This field may return null, indicating that no valid values can be obtained.
8019
+ * <p>Sub-region</p>
7580
8020
  * @type {string || null}
7581
8021
  */
7582
8022
  this.Subdivision = null;
7583
8023
 
7584
8024
  /**
7585
- * District or county.
7586
- Note: This field may return null, indicating that no valid values can be obtained.
8025
+ * <p>District</p>
7587
8026
  * @type {string || null}
7588
8027
  */
7589
8028
  this.District = null;
7590
8029
 
7591
8030
  /**
7592
- * City name.
7593
- Note: This field may return null, indicating that no valid values can be obtained.
8031
+ * <p>City</p>
7594
8032
  * @type {string || null}
7595
8033
  */
7596
8034
  this.City = null;
7597
8035
 
7598
8036
  /**
7599
- * Subdistrict or township.
7600
- Note: This field may return null, indicating that no valid values can be obtained.
8037
+ * <p>Sub-district office</p>
7601
8038
  * @type {string || null}
7602
8039
  */
7603
8040
  this.Subdistrict = null;
7604
8041
 
7605
8042
  /**
7606
- * Formatted complete address.
7607
- Note: This field may return null, indicating that no valid values can be obtained.
8043
+ * <p>Complete address</p>
7608
8044
  * @type {string || null}
7609
8045
  */
7610
8046
  this.FormattedAddress = null;
7611
8047
 
7612
8048
  /**
7613
- * First line of the address bar.
7614
- Note: This field may return null, indicating that no valid values can be obtained.
8049
+ * <p>First line of the address bar</p>
7615
8050
  * @type {string || null}
7616
8051
  */
7617
8052
  this.LineOne = null;
7618
8053
 
7619
8054
  /**
7620
- * Second line of the address bar.
7621
- Note: This field may return null, indicating that no valid values can be obtained.
8055
+ * <p>Second line of the address bar</p>
7622
8056
  * @type {string || null}
7623
8057
  */
7624
8058
  this.LineTwo = null;
7625
8059
 
7626
8060
  /**
7627
- * Specifies the third line of the address bar.
7628
- Note: This field may return null, indicating that no valid values can be obtained.
8061
+ * <p>Third line of the address bar</p>
7629
8062
  * @type {string || null}
7630
8063
  */
7631
8064
  this.LineThree = null;
7632
8065
 
7633
8066
  /**
7634
- * Specifies the fourth line of the address bar.
7635
- Note: This field may return null, indicating that no valid values can be obtained.
8067
+ * <p>Fourth line of the address bar</p>
7636
8068
  * @type {string || null}
7637
8069
  */
7638
8070
  this.LineFour = null;
7639
8071
 
7640
8072
  /**
7641
- * Specifies the fifth line of the address bar.
7642
- Note: This field may return null, indicating that no valid values can be obtained.
8073
+ * <p>Fifth line of the address bar</p>
7643
8074
  * @type {string || null}
7644
8075
  */
7645
8076
  this.LineFive = null;
@@ -7670,6 +8101,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
7670
8101
  }
7671
8102
 
7672
8103
  module.exports = {
8104
+ GetOcrVerificationResultRequest: GetOcrVerificationResultRequest,
7673
8105
  RecognizeMexicoVTIDResponse: RecognizeMexicoVTIDResponse,
7674
8106
  HKIDCardOCRRequest: HKIDCardOCRRequest,
7675
8107
  ExtractDocMultiRequest: ExtractDocMultiRequest,
@@ -7703,6 +8135,7 @@ module.exports = {
7703
8135
  GeneralAccurateOCRResponse: GeneralAccurateOCRResponse,
7704
8136
  HmtResidentPermitOCRRequest: HmtResidentPermitOCRRequest,
7705
8137
  PortraitImageInfo: PortraitImageInfo,
8138
+ ApplyOcrTokenResponse: ApplyOcrTokenResponse,
7706
8139
  GeneralBasicOCRResponse: GeneralBasicOCRResponse,
7707
8140
  PermitOCRRequest: PermitOCRRequest,
7708
8141
  RecognizePhilippinesUMIDOCRRequest: RecognizePhilippinesUMIDOCRRequest,
@@ -7714,6 +8147,7 @@ module.exports = {
7714
8147
  RecognizeThaiIDCardOCRResponse: RecognizeThaiIDCardOCRResponse,
7715
8148
  ExtractDocMultiResponse: ExtractDocMultiResponse,
7716
8149
  RecognizePhilippinesSssIDOCRResponse: RecognizePhilippinesSssIDOCRResponse,
8150
+ ApplyOcrTokenRequest: ApplyOcrTokenRequest,
7717
8151
  RecognizePhilippinesUMIDOCRResponse: RecognizePhilippinesUMIDOCRResponse,
7718
8152
  RecognizeThaiIDCardOCRRequest: RecognizeThaiIDCardOCRRequest,
7719
8153
  PassportRecognizeInfos: PassportRecognizeInfos,
@@ -7748,6 +8182,7 @@ module.exports = {
7748
8182
  ImageCoordinates: ImageCoordinates,
7749
8183
  RecognizeMexicoVTIDRequest: RecognizeMexicoVTIDRequest,
7750
8184
  PODAuditAIResponse: PODAuditAIResponse,
8185
+ GetOcrVerificationResultResponse: GetOcrVerificationResultResponse,
7751
8186
  MainlandTravelPermitBackInfos: MainlandTravelPermitBackInfos,
7752
8187
  DetectedWordCoordPoint: DetectedWordCoordPoint,
7753
8188
  RecognizeBrazilDriverLicenseOCRResponse: RecognizeBrazilDriverLicenseOCRResponse,