tccli-intl-en 3.0.1241.1__py2.py3-none-any.whl → 3.1.16.1__py2.py3-none-any.whl

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.
Files changed (239) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/argument.py +1 -1
  3. tccli/services/__init__.py +29 -1
  4. tccli/services/advisor/advisor_client.py +10 -4
  5. tccli/services/ai3d/__init__.py +4 -0
  6. tccli/services/ai3d/ai3d_client.py +266 -0
  7. tccli/services/ai3d/v20250513/api.json +264 -0
  8. tccli/services/ai3d/v20250513/examples.json +20 -0
  9. tccli/services/aiart/aiart_client.py +5 -2
  10. tccli/services/ams/ams_client.py +20 -8
  11. tccli/services/antiddos/antiddos_client.py +350 -140
  12. tccli/services/apigateway/apigateway_client.py +465 -186
  13. tccli/services/apm/apm_client.py +835 -68
  14. tccli/services/apm/v20210622/api.json +3936 -1145
  15. tccli/services/apm/v20210622/examples.json +133 -23
  16. tccli/services/asr/asr_client.py +10 -4
  17. tccli/services/autoscaling/autoscaling_client.py +290 -116
  18. tccli/services/autoscaling/v20180419/api.json +78 -28
  19. tccli/services/batch/batch_client.py +140 -56
  20. tccli/services/bi/bi_client.py +1244 -6
  21. tccli/services/bi/v20220105/api.json +5340 -107
  22. tccli/services/bi/v20220105/examples.json +196 -1
  23. tccli/services/billing/billing_client.py +210 -84
  24. tccli/services/cam/cam_client.py +405 -162
  25. tccli/services/captcha/captcha_client.py +5 -2
  26. tccli/services/car/car_client.py +165 -66
  27. tccli/services/cbs/cbs_client.py +190 -76
  28. tccli/services/ccc/ccc_client.py +794 -160
  29. tccli/services/ccc/v20200210/api.json +1748 -217
  30. tccli/services/ccc/v20200210/examples.json +64 -0
  31. tccli/services/cdb/cdb_client.py +665 -266
  32. tccli/services/cdb/v20170320/api.json +334 -134
  33. tccli/services/cdb/v20170320/examples.json +3 -3
  34. tccli/services/cdc/cdc_client.py +100 -40
  35. tccli/services/cdc/v20201214/api.json +2 -2
  36. tccli/services/cdc/v20201214/examples.json +4 -4
  37. tccli/services/cdn/cdn_client.py +220 -88
  38. tccli/services/cdwdoris/cdwdoris_client.py +385 -154
  39. tccli/services/cdwpg/cdwpg_client.py +120 -48
  40. tccli/services/cdz/__init__.py +4 -0
  41. tccli/services/cdz/cdz_client.py +210 -0
  42. tccli/services/cdz/v20221123/api.json +233 -0
  43. tccli/services/cdz/v20221123/examples.json +12 -0
  44. tccli/services/cfg/cfg_client.py +80 -32
  45. tccli/services/cfs/cfs_client.py +195 -78
  46. tccli/services/cfw/cfw_client.py +330 -132
  47. tccli/services/chdfs/chdfs_client.py +145 -58
  48. tccli/services/ciam/ciam_client.py +80 -32
  49. tccli/services/ckafka/ckafka_client.py +1033 -255
  50. tccli/services/ckafka/v20190819/api.json +3378 -1681
  51. tccli/services/ckafka/v20190819/examples.json +254 -160
  52. tccli/services/clb/clb_client.py +1054 -469
  53. tccli/services/clb/v20180317/api.json +2273 -1020
  54. tccli/services/clb/v20180317/examples.json +184 -124
  55. tccli/services/cloudaudit/cloudaudit_client.py +90 -36
  56. tccli/services/cls/cls_client.py +434 -173
  57. tccli/services/cmq/cmq_client.py +14 -803
  58. tccli/services/cmq/v20190304/api.json +173 -1367
  59. tccli/services/cmq/v20190304/examples.json +0 -120
  60. tccli/services/config/config_client.py +30 -12
  61. tccli/services/controlcenter/controlcenter_client.py +229 -2
  62. tccli/services/controlcenter/v20230110/api.json +528 -5
  63. tccli/services/controlcenter/v20230110/examples.json +32 -0
  64. tccli/services/csip/csip_client.py +170 -68
  65. tccli/services/ctsdb/ctsdb_client.py +10 -4
  66. tccli/services/cvm/cvm_client.py +706 -189
  67. tccli/services/cvm/v20170312/api.json +851 -382
  68. tccli/services/cvm/v20170312/examples.json +173 -127
  69. tccli/services/cwp/cwp_client.py +2325 -930
  70. tccli/services/cynosdb/cynosdb_client.py +1887 -577
  71. tccli/services/cynosdb/v20190107/api.json +11763 -7697
  72. tccli/services/cynosdb/v20190107/examples.json +132 -4
  73. tccli/services/dataintegration/dataintegration_client.py +5 -2
  74. tccli/services/dayu/dayu_client.py +515 -206
  75. tccli/services/dbbrain/dbbrain_client.py +210 -84
  76. tccli/services/dc/dc_client.py +90 -36
  77. tccli/services/dcdb/dcdb_client.py +310 -124
  78. tccli/services/dlc/dlc_client.py +859 -214
  79. tccli/services/dlc/v20210125/api.json +637 -13
  80. tccli/services/dlc/v20210125/examples.json +48 -0
  81. tccli/services/dms/dms_client.py +10 -4
  82. tccli/services/dnspod/dnspod_client.py +302 -76
  83. tccli/services/dnspod/v20210323/api.json +153 -0
  84. tccli/services/dnspod/v20210323/examples.json +16 -0
  85. tccli/services/domain/domain_client.py +120 -48
  86. tccli/services/dts/dts_client.py +415 -166
  87. tccli/services/eb/eb_client.py +130 -52
  88. tccli/services/ecdn/ecdn_client.py +75 -30
  89. tccli/services/ecm/ecm_client.py +620 -248
  90. tccli/services/eiam/eiam_client.py +200 -80
  91. tccli/services/emr/emr_client.py +2815 -146
  92. tccli/services/emr/v20190103/api.json +14527 -4841
  93. tccli/services/emr/v20190103/examples.json +404 -36
  94. tccli/services/es/es_client.py +105 -42
  95. tccli/services/facefusion/facefusion_client.py +15 -6
  96. tccli/services/faceid/faceid_client.py +95 -38
  97. tccli/services/faceid/v20180301/api.json +107 -14
  98. tccli/services/faceid/v20180301/examples.json +3 -3
  99. tccli/services/gaap/gaap_client.py +440 -176
  100. tccli/services/gme/gme_client.py +50 -20
  101. tccli/services/gpm/gpm_client.py +90 -36
  102. tccli/services/gse/gse_client.py +110 -44
  103. tccli/services/gwlb/gwlb_client.py +90 -36
  104. tccli/services/hunyuan/__init__.py +4 -0
  105. tccli/services/hunyuan/hunyuan_client.py +266 -0
  106. tccli/services/hunyuan/v20230901/api.json +270 -0
  107. tccli/services/hunyuan/v20230901/examples.json +20 -0
  108. tccli/services/iai/iai_client.py +145 -58
  109. tccli/services/iap/iap_client.py +30 -12
  110. tccli/services/ims/ims_client.py +5 -2
  111. tccli/services/intlpartnersmgt/intlpartnersmgt_client.py +210 -84
  112. tccli/services/intlpartnersmgt/v20220928/api.json +11 -11
  113. tccli/services/iotcloud/iotcloud_client.py +100 -40
  114. tccli/services/ip/ip_client.py +30 -12
  115. tccli/services/kms/kms_client.py +340 -136
  116. tccli/services/kms/v20190118/api.json +80 -3
  117. tccli/services/kms/v20190118/examples.json +3 -3
  118. tccli/services/lcic/lcic_client.py +265 -106
  119. tccli/services/lighthouse/lighthouse_client.py +370 -148
  120. tccli/services/lighthouse/v20200324/api.json +14 -14
  121. tccli/services/lighthouse/v20200324/examples.json +5 -5
  122. tccli/services/live/live_client.py +600 -240
  123. tccli/services/lke/lke_client.py +450 -180
  124. tccli/services/lke/v20231130/api.json +182 -39
  125. tccli/services/lkeap/__init__.py +4 -0
  126. tccli/services/lkeap/lkeap_client.py +602 -0
  127. tccli/services/lkeap/v20240522/api.json +953 -0
  128. tccli/services/lkeap/v20240522/examples.json +92 -0
  129. tccli/services/mariadb/mariadb_client.py +250 -100
  130. tccli/services/mdc/mdc_client.py +90 -36
  131. tccli/services/mdl/mdl_client.py +357 -90
  132. tccli/services/mdl/v20200326/api.json +791 -24
  133. tccli/services/mdl/v20200326/examples.json +40 -16
  134. tccli/services/mdp/mdp_client.py +734 -124
  135. tccli/services/mdp/v20200527/api.json +748 -23
  136. tccli/services/mdp/v20200527/examples.json +143 -79
  137. tccli/services/message/__init__.py +4 -0
  138. tccli/services/message/message_client.py +210 -0
  139. tccli/services/message/v20181225/api.json +72 -0
  140. tccli/services/message/v20181225/examples.json +13 -0
  141. tccli/services/mongodb/mongodb_client.py +1404 -141
  142. tccli/services/mongodb/v20190725/api.json +2919 -677
  143. tccli/services/mongodb/v20190725/examples.json +190 -22
  144. tccli/services/monitor/monitor_client.py +1008 -296
  145. tccli/services/monitor/v20180724/api.json +660 -11
  146. tccli/services/monitor/v20180724/examples.json +152 -4
  147. tccli/services/mps/mps_client.py +1489 -429
  148. tccli/services/mps/v20190612/api.json +4750 -1077
  149. tccli/services/mps/v20190612/examples.json +182 -70
  150. tccli/services/msp/msp_client.py +35 -14
  151. tccli/services/ocr/ocr_client.py +417 -82
  152. tccli/services/ocr/v20181119/api.json +1486 -103
  153. tccli/services/ocr/v20181119/examples.json +42 -4
  154. tccli/services/omics/omics_client.py +100 -40
  155. tccli/services/organization/organization_client.py +580 -232
  156. tccli/services/postgres/postgres_client.py +455 -182
  157. tccli/services/privatedns/privatedns_client.py +155 -62
  158. tccli/services/pts/pts_client.py +240 -96
  159. tccli/services/quota/__init__.py +4 -0
  160. tccli/services/quota/quota_client.py +434 -0
  161. tccli/services/quota/v20241204/api.json +548 -0
  162. tccli/services/quota/v20241204/examples.json +51 -0
  163. tccli/services/rce/rce_client.py +5 -2
  164. tccli/services/redis/redis_client.py +545 -218
  165. tccli/services/redis/v20180412/api.json +225 -113
  166. tccli/services/redis/v20180412/examples.json +19 -19
  167. tccli/services/region/region_client.py +15 -6
  168. tccli/services/rum/rum_client.py +300 -120
  169. tccli/services/scf/scf_client.py +210 -84
  170. tccli/services/ses/ses_client.py +145 -58
  171. tccli/services/smh/__init__.py +4 -0
  172. tccli/services/smh/smh_client.py +714 -0
  173. tccli/services/smh/v20210712/api.json +1287 -0
  174. tccli/services/smh/v20210712/examples.json +85 -0
  175. tccli/services/sms/sms_client.py +90 -36
  176. tccli/services/sqlserver/sqlserver_client.py +3855 -470
  177. tccli/services/sqlserver/v20180328/api.json +9725 -3356
  178. tccli/services/sqlserver/v20180328/examples.json +470 -10
  179. tccli/services/ssl/ssl_client.py +190 -76
  180. tccli/services/ssm/ssm_client.py +120 -48
  181. tccli/services/sts/sts_client.py +25 -10
  182. tccli/services/tag/tag_client.py +150 -60
  183. tccli/services/tat/tat_client.py +95 -38
  184. tccli/services/tbaas/tbaas_client.py +20 -8
  185. tccli/services/tcaplusdb/tcaplusdb_client.py +260 -104
  186. tccli/services/tcaplusdb/v20190823/api.json +836 -760
  187. tccli/services/tcaplusdb/v20190823/examples.json +3 -3
  188. tccli/services/tchd/tchd_client.py +5 -2
  189. tccli/services/tcmpp/tcmpp_client.py +520 -208
  190. tccli/services/tcr/tcr_client.py +380 -152
  191. tccli/services/tcsas/tcsas_client.py +295 -118
  192. tccli/services/tcsas/v20250106/api.json +155 -79
  193. tccli/services/tcsas/v20250106/examples.json +3 -3
  194. tccli/services/tcss/tcss_client.py +1650 -660
  195. tccli/services/tdid/tdid_client.py +240 -96
  196. tccli/services/tdmq/tdmq_client.py +2876 -466
  197. tccli/services/tdmq/v20200217/api.json +11607 -3958
  198. tccli/services/tdmq/v20200217/examples.json +562 -264
  199. tccli/services/tem/tem_client.py +280 -112
  200. tccli/services/teo/teo_client.py +1590 -540
  201. tccli/services/teo/v20220901/api.json +703 -71
  202. tccli/services/teo/v20220901/examples.json +88 -22
  203. tccli/services/tione/__init__.py +4 -0
  204. tccli/services/tione/tione_client.py +210 -0
  205. tccli/services/tione/v20211111/api.json +3074 -0
  206. tccli/services/tione/v20211111/examples.json +12 -0
  207. tccli/services/tiw/tiw_client.py +255 -102
  208. tccli/services/tke/tke_client.py +690 -276
  209. tccli/services/tms/tms_client.py +5 -2
  210. tccli/services/tmt/tmt_client.py +5 -2
  211. tccli/services/trabbit/trabbit_client.py +145 -58
  212. tccli/services/trocket/__init__.py +4 -0
  213. tccli/services/trocket/trocket_client.py +2450 -0
  214. tccli/services/trocket/v20230308/api.json +6062 -0
  215. tccli/services/trocket/v20230308/examples.json +339 -0
  216. tccli/services/trro/trro_client.py +95 -38
  217. tccli/services/trtc/trtc_client.py +255 -102
  218. tccli/services/trtc/v20190722/api.json +135 -31
  219. tccli/services/trtc/v20190722/examples.json +7 -7
  220. tccli/services/tts/tts_client.py +5 -2
  221. tccli/services/vclm/vclm_client.py +10 -4
  222. tccli/services/vm/vm_client.py +20 -8
  223. tccli/services/vod/vod_client.py +895 -358
  224. tccli/services/vpc/v20170312/api.json +1032 -134
  225. tccli/services/vpc/v20170312/examples.json +119 -23
  226. tccli/services/vpc/vpc_client.py +2159 -644
  227. tccli/services/waf/v20180125/api.json +1372 -194
  228. tccli/services/waf/v20180125/examples.json +89 -1
  229. tccli/services/waf/waf_client.py +1149 -245
  230. tccli/services/wedata/v20250806/api.json +13644 -0
  231. tccli/services/wedata/v20250806/examples.json +621 -0
  232. tccli/services/wedata/wedata_client.py +6067 -1263
  233. tccli/services/yunjing/yunjing_client.py +355 -142
  234. {tccli_intl_en-3.0.1241.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/METADATA +4 -7
  235. {tccli_intl_en-3.0.1241.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/RECORD +239 -201
  236. {tccli_intl_en-3.0.1241.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/WHEEL +1 -1
  237. {tccli_intl_en-3.0.1241.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/entry_points.txt +0 -1
  238. {tccli_intl_en-3.0.1241.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/LICENSE +0 -0
  239. {tccli_intl_en-3.0.1241.1.dist-info → tccli_intl_en-3.1.16.1.dist-info}/top_level.txt +0 -0
@@ -1,5 +1,12 @@
1
1
  {
2
2
  "actions": {
3
+ "ApplyCardVerificationExternal": {
4
+ "document": "This API is used for general recognition of overseas cards.\n\nThe following list details the countries or regions, document types supported by the overseas document recognition API and whether the back side of the document is required:\n\n<table>\n<thead>\n<tr>\n<td style=\"width:200px\">Nationality</td>\n<td style=\"width:200px\">CardType</td>\n<td style=\"width:200px\">Whether the Back Side is Required</td>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Argentina</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Argentina</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Argentina</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Australia</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Australia</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Australia</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Australia</td>\n<td>Residence Permit</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Bangladesh</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Bangladesh</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Bangladesh</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Cambodia</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Cambodia</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Cambodia</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Canada</td>\n<td>Driver's License</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Canada</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Canada</td>\n<td>Passport</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Canada</td>\n<td>Residence Permit</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Chile</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Chile</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Chile</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Germany</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Germany</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Germany</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Germany</td>\n<td>Residence Permit</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Mexico</td>\n<td>Driver's License</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Mexico</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Mexico</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Myanmar</td>\n<td>Driver's License</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Myanmar</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Myanmar</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>New Zealand</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>New Zealand</td>\n<td>National ID Card</td>\n<td>No</td>\n</tr>\n<tr>\n<td>New Zealand</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>New Zealand</td>\n<td>Residence Permit</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Nigeria</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Nigeria</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Nigeria</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Nigeria</td>\n<td>Residence Permit</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Pakistan</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Pakistan</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Pakistan</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Russia</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Russia</td>\n<td>National ID Card</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Russia</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Singapore</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Singapore</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Singapore</td>\n<td>Passport</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Singapore</td>\n<td>Residence Permit</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Indonesia</td>\n<td>National ID Card</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Indonesia</td>\n<td>Driver's License</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Hong Kong, China</td>\n<td>Identity Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Thailand</td>\n<td>National ID Card</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Thailand</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Malaysia</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Malaysia</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Singapore</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Singapore</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Philippines</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Philippines</td>\n<td>Driver's License</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Japan</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Japan</td>\n<td>Driver's License</td>\n<td>No</td>\n</tr>\n<tr>\n<td>Macau, China</td>\n<td>Identity Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Taiwan, China</td>\n<td>Identity Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Bangladesh</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Nigeria</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Nigeria</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Pakistan</td>\n<td>National ID Card</td>\n<td>Yes</td>\n</tr>\n<tr>\n<td>Pakistan</td>\n<td>Driver's License</td>\n<td>Yes</td>\n</tr>\n</tbody>\n</table>",
5
+ "input": "ApplyCardVerificationExternalRequest",
6
+ "name": "Initiate overseas document recognition",
7
+ "output": "ApplyCardVerificationExternalResponse",
8
+ "status": "online"
9
+ },
3
10
  "BankCardOCR": {
4
11
  "document": "This API is used to detect and recognize key fields such as the card number, bank information, and expiration date on mainstream bank cards in Mainland China.\n\nThis API is not fully available for the time being. For more information, please contact your [Tencent Cloud sales rep](https://intl.cloud.tencent.com/contact-sales).",
5
12
  "input": "BankCardOCRRequest",
@@ -28,6 +35,13 @@
28
35
  "output": "GeneralBasicOCRResponse",
29
36
  "status": "online"
30
37
  },
38
+ "GetCardVerificationExternalResult": {
39
+ "document": "This API is used to obtain document recognition results.",
40
+ "input": "GetCardVerificationExternalResultRequest",
41
+ "name": "Retrieve the card recognition result",
42
+ "output": "GetCardVerificationExternalResultResponse",
43
+ "status": "online"
44
+ },
31
45
  "HKIDCardOCR": {
32
46
  "document": "This API is used to recognize key fields on the photo side of a Hong Kong (China) identity card, including name in Chinese, name in English, telecode for name, date of birth, gender, document symbol, date of the first issue, date of the last receipt, identity card number, and permanent residency attribute. \n\nThis API is not fully available for the time being. For more information, please contact your [Tencent Cloud sales rep](https://intl.cloud.tencent.com/contact-sales).",
33
47
  "input": "HKIDCardOCRRequest",
@@ -84,6 +98,13 @@
84
98
  "output": "PermitOCRResponse",
85
99
  "status": "online"
86
100
  },
101
+ "RecognizeBrazilCommonOCR": {
102
+ "document": "This API is used to identify Brazil common documents.\n\nThis API is used to set the default request rate limit to 5 requests/second.",
103
+ "input": "RecognizeBrazilCommonOCRRequest",
104
+ "name": "Recognizes a brazil common document",
105
+ "output": "RecognizeBrazilCommonOCRResponse",
106
+ "status": "online"
107
+ },
87
108
  "RecognizeBrazilDriverLicenseOCR": {
88
109
  "document": "This interface supports identification of the front and back of Brazilian driver's license. The identification fields include name, driver's license category, number, validity period, etc.",
89
110
  "input": "RecognizeBrazilDriverLicenseOCRRequest",
@@ -112,6 +133,13 @@
112
133
  "output": "RecognizeBrazilRNMOCRResponse",
113
134
  "status": "online"
114
135
  },
136
+ "RecognizeDetectCardCoords": {
137
+ "document": "This API is used to recognize the coordinates of four corners of cards.",
138
+ "input": "RecognizeDetectCardCoordsRequest",
139
+ "name": "Four-Corner coordinate detection and recognition",
140
+ "output": "RecognizeDetectCardCoordsResponse",
141
+ "status": "online"
142
+ },
115
143
  "RecognizeGeneralInvoice": {
116
144
  "document": "This API is used to recognize various types of invoices or tickets in an image or PDF file. You can also specify a type. 14 types of standard expense reimbursement invoices are supported, including value-added tax (VAT) invoice (special, general, roll, blockchain, and toll), fully digitalized electronic invoice (special and general), non-tax revenue invoice (general receipt and general payment voucher), quota invoice, general machine-printed invoice, car sales invoice (motor vehicle sales invoice and used car invoice), train ticket, taxi receipt, itinerary/receipt of e-ticket for air transportation, bus ticket, ship ticket, toll receipt, and medical invoice (inpatient and outpatient). This API can also be used for intelligent recognition of other types of invoices. To try now, click [here](https://intl.cloud.tencent.com/product/ocr?from_cn_redirect=1).\n\nA maximum of 5 requests can be initiated per second for this API.\n\n\nThe invoice/ticket subtype (SubType), subtype description (TypeDescription), and parent type (Type) can be returned, as described below:\n<table style=\"width:715px\">\n <thead>\n <tr>\n <th style=\"width:200px\">SubType</th>\n <th style=\"width:200px\">TypeDescription</th>\n <th >Type</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td> VatSpecialInvoice</td>\n <td> Special VAT invoice </td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatCommonInvoice</td>\n <td> General VAT invoice </td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatElectronicCommonInvoice </td>\n <td> Electronic general VAT invoice </td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatElectronicSpecialInvoice </td>\n <td> Electronic special VAT invoice </td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatElectronicInvoiceBlockchain</td>\n <td> Blockchain electronic invoice </td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatElectronicInvoiceToll</td>\n <td> Electronic general VAT invoice (toll)</td>\n <td> 3 </td>\n </tr>\n <tr>\n <td> VatElectronicSpecialInvoiceFull</td>\n <td> Electronic invoice (special)</td>\n <td> 16 </td>\n </tr>\n <tr>\n <td> VatElectronicInvoiceFull</td>\n <td> Electronic invoice (general) </td>\n <td> 16 </td>\n </tr>\n <tr>\n <td> MotorVehicleSaleInvoice </td>\n <td> Motor vehicle sales invoice </td>\n <td> 12 </td>\n </tr>\n <tr>\n <td> UsedCarPurchaseInvoice </td>\n <td> Used car invoice </td>\n <td> 12 </td>\n </tr>\n <tr>\n <td> VatInvoiceRoll </td>\n <td> General VAT invoice (roll) </td>\n <td> 11 </td>\n </tr>\n <tr>\n <td> TaxiTicket </td>\n <td> Taxi receipt </td>\n <td> 0 </td>\n </tr>\n <tr>\n <td> QuotaInvoice </td>\n <td> Quota invoice </td>\n <td> 1 </td>\n </tr>\n <tr>\n <td> TrainTicket </td>\n <td> Train ticket </td>\n <td> 2 </td>\n </tr>\n <tr>\n <td> AirTransport </td>\n <td> Itinerary/Receipt of e-ticket for air transportation </td>\n <td> 5 </td>\n </tr>\n <tr>\n <td> MachinePrintedInvoice </td>\n <td> General machine-printed invoice </td>\n <td> 8 </td>\n </tr>\n <tr>\n <td> BusInvoice </td>\n <td> Bus ticket </td>\n <td> 9 </td>\n </tr>\n <tr>\n <td> ShippingInvoice </td>\n <td> Ship ticket </td>\n <td> 10 </td>\n </tr>\n <tr>\n <td> NonTaxIncomeGeneralBill </td>\n <td> General receipt for non-tax revenue </td>\n <td> 15 </td>\n </tr>\n <tr>\n <td> NonTaxIncomeElectronicBill </td>\n <td> General payment voucher for non-tax revenue (electronic) </td>\n <td> 15 </td>\n </tr>\n <tr>\n <td> TollInvoice </td>\n <td> Toll receipt </td>\n <td> 13 </td>\n </tr>\n <tr>\n <td> OtherInvoice </td>\n <td> Other </td>\n <td> -1 </td>\n </tr>\n </tbody>\n </table>",
117
145
  "input": "RecognizeGeneralInvoiceRequest",
@@ -148,7 +176,7 @@
148
176
  "status": "online"
149
177
  },
150
178
  "RecognizeMainlandIDCardOCR": {
151
- "document": "This interface supports the identification of all fields on the front and back of the second-generation ID card for mainland Chinese residents.Including name, gender, ethnicity, date of birth, address, citizen ID number, issuing authority, and validity period, the identification accuracy reaches more than 99%.In addition, this interface also supports a variety of value-added capabilities to meet the needs of different scenarios. Such as the cropping function of ID card photos and portrait photos, and also has 5 alarm functions.\nAs shown in the table below. <table style=\"width:650px\"> <thead> <tr> <th width=\"150\">Value-added ability</th> <th width=\"500\">Ability items</th> </tr> </thead> <tbody> <tr> <td rowspan=\"9\">Alarm function</td> </tr> <tr> <td>ID card copy warning</td> </tr> <tr> <td>ID card copy warning</td> </tr> <tr> <td>Alarm for occlusion in the ID card frame</td> </tr> <tr> <td>ID card reflective warning</td> </tr> <tr> <td>Blurry picture warning</td> </tr> </tbody> </table> Default interface request frequency limit: 20 times/second",
179
+ "document": "This interface supports the identification of all fields on the front and back of the second-generation ID card for mainland Chinese residents.Including name, gender, ethnicity, date of birth, address, citizen ID number, issuing authority, and validity period, the identification accuracy reaches more than 99%.In addition, this interface also supports a variety of value-added capabilities to meet the needs of different scenarios. Such as the cropping function of ID card photos and portrait photos, and also has 5 alarm functions.\nAs shown in the table below. <table style=\"width:650px\"> <thead> <tr> <th width=\"150\">Value-added ability</th> <th width=\"500\">Ability items</th> </tr> </thead> <tbody> <tr> <td rowspan=\"9\">Alarm function</td> </tr> <tr> <td>ID card photocopy warning</td> </tr> <tr> <td>ID card on-screen display warning</td> </tr> <tr> <td>Alarm for occlusion in the ID card frame</td> </tr> <tr> <td>ID card reflective warning</td> </tr> <tr> <td>Blurry picture warning</td> </tr> </tbody> </table> Default interface request frequency limit: 20 times/second",
152
180
  "input": "RecognizeMainlandIDCardOCRRequest",
153
181
  "name": "Mainland ID Card OCR",
154
182
  "output": "RecognizeMainlandIDCardOCRResponse",
@@ -266,6 +294,112 @@
266
294
  "serviceShortName": "ocr"
267
295
  },
268
296
  "objects": {
297
+ "AddressInfo": {
298
+ "document": "Overseas document recognition address information.",
299
+ "members": [
300
+ {
301
+ "disabled": false,
302
+ "document": "Country.\nNote: This field may return null, indicating that no valid values can be obtained.",
303
+ "example": "无",
304
+ "member": "string",
305
+ "name": "Country",
306
+ "output_required": false,
307
+ "type": "string",
308
+ "value_allowed_null": true
309
+ },
310
+ {
311
+ "disabled": false,
312
+ "document": "Postal code.\nNote: This field may return null, indicating that no valid values can be obtained.",
313
+ "example": "无",
314
+ "member": "string",
315
+ "name": "PostalCode",
316
+ "output_required": false,
317
+ "type": "string",
318
+ "value_allowed_null": true
319
+ },
320
+ {
321
+ "disabled": false,
322
+ "document": "Specifies the sub-region.\nNote: This field may return null, indicating that no valid values can be obtained.",
323
+ "example": "无",
324
+ "member": "string",
325
+ "name": "Subdivision",
326
+ "output_required": false,
327
+ "type": "string",
328
+ "value_allowed_null": true
329
+ },
330
+ {
331
+ "disabled": false,
332
+ "document": "Specifies the city.\nNote: This field may return null, indicating that no valid values can be obtained.",
333
+ "example": "无",
334
+ "member": "string",
335
+ "name": "City",
336
+ "output_required": false,
337
+ "type": "string",
338
+ "value_allowed_null": true
339
+ },
340
+ {
341
+ "disabled": false,
342
+ "document": "Complete address.\nNote: This field may return null, indicating that no valid values can be obtained.",
343
+ "example": "无",
344
+ "member": "string",
345
+ "name": "FormattedAddress",
346
+ "output_required": false,
347
+ "type": "string",
348
+ "value_allowed_null": true
349
+ },
350
+ {
351
+ "disabled": false,
352
+ "document": "First line of the address bar.\nNote: This field may return null, indicating that no valid values can be obtained.",
353
+ "example": "无",
354
+ "member": "string",
355
+ "name": "LineOne",
356
+ "output_required": false,
357
+ "type": "string",
358
+ "value_allowed_null": true
359
+ },
360
+ {
361
+ "disabled": false,
362
+ "document": "Second line of the address bar.\nNote: This field may return null, indicating that no valid values can be obtained.",
363
+ "example": "无",
364
+ "member": "string",
365
+ "name": "LineTwo",
366
+ "output_required": false,
367
+ "type": "string",
368
+ "value_allowed_null": true
369
+ },
370
+ {
371
+ "disabled": false,
372
+ "document": "Specifies the third line of the address bar.\nNote: This field may return null, indicating that no valid values can be obtained.",
373
+ "example": "无",
374
+ "member": "string",
375
+ "name": "LineThree",
376
+ "output_required": false,
377
+ "type": "string",
378
+ "value_allowed_null": true
379
+ },
380
+ {
381
+ "disabled": false,
382
+ "document": "Specifies the fourth line of the address bar.\nNote: This field may return null, indicating that no valid values can be obtained.",
383
+ "example": "无",
384
+ "member": "string",
385
+ "name": "LineFour",
386
+ "output_required": false,
387
+ "type": "string",
388
+ "value_allowed_null": true
389
+ },
390
+ {
391
+ "disabled": false,
392
+ "document": "Specifies the fifth line in the address bar.\nNote: This field may return null, indicating that no valid values can be obtained.",
393
+ "example": "无",
394
+ "member": "string",
395
+ "name": "LineFive",
396
+ "output_required": false,
397
+ "type": "string",
398
+ "value_allowed_null": true
399
+ }
400
+ ],
401
+ "usage": "out"
402
+ },
269
403
  "AirTransport": {
270
404
  "document": "Itinerary/Receipt of e-ticket for air transportation",
271
405
  "members": [
@@ -512,6 +646,97 @@
512
646
  ],
513
647
  "usage": "out"
514
648
  },
649
+ "ApplyCardVerificationExternalRequest": {
650
+ "document": "ApplyCardVerificationExternal request structure.",
651
+ "members": [
652
+ {
653
+ "disabled": false,
654
+ "document": "Specifies the country of the document.\nARG:Argentina\nAUS:Australia\nKHM:Cambodia\nCAN:Canada\nSGP:Singapore\nCHL:Chile\nDEU:Germany\nMEX:Mexico\nMMR:Myanmar\nNZL:New Zealand\nBGD:Bangladesh\nNGA:Nigeria\nPAK:Pakistan\nRUS:Russia\nIDN:Indonesia\nHKG:Hong Kong, China\nTHA:Thailand\nMYS:Malaysia\nJPN:Japan\nPHL:Philippines\nMAC:Macao, China\nCHN:ChinaPermit\nTWN:Taiwan, China\nBGD:Bangladesh\nNGA:Nigeria \nPAK:Pakistan\n\nAUTO: supports cards and documents from 200+ countries",
655
+ "example": "ARG",
656
+ "member": "string",
657
+ "name": "Nationality",
658
+ "required": true,
659
+ "type": "string"
660
+ },
661
+ {
662
+ "disabled": false,
663
+ "document": "Document type.\nID_CARD\nPASSPORT\nDRIVING_LICENSE\nRESIDENCE_PERMIT (Supported in certain countries/regions, including Australia, Canada, Germany, New Zealand, Nigeria, Singapore).",
664
+ "example": "ID_CARD",
665
+ "member": "string",
666
+ "name": "CardType",
667
+ "required": true,
668
+ "type": "string"
669
+ },
670
+ {
671
+ "disabled": false,
672
+ "document": "The Base64 value of the document Front. supported image formats: PNG, JPG/JPEG. \nSupported image size: the downloaded image after Base64 encoding must be no more than 2M. image download time must be no more than 5 seconds. \nSupported image resolution: between 256 \\* 256 and 4096 \\* 4096. For some documents, either ImageUrlBack or ImageBase64Back must be provided. If both are provided, only ImageUrlFront will be used.",
673
+ "example": "/9j/4AAQSkZJRgABAQAASABIAAD",
674
+ "member": "string",
675
+ "name": "ImageBase64Front",
676
+ "required": false,
677
+ "type": "string"
678
+ },
679
+ {
680
+ "disabled": false,
681
+ "document": "The Base64 value of the reverse side of the document. Supported image formats: PNG, JPG/JPEG. \nSupported image size: the downloaded image after Base64 encoding must be no more than 2M. image download time must be no more than 5 seconds. \nSupported 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.",
682
+ "example": "/9j/4AAQSkZJRgABAQAASABIAAD",
683
+ "member": "string",
684
+ "name": "ImageBase64Back",
685
+ "required": false,
686
+ "type": "string"
687
+ },
688
+ {
689
+ "disabled": false,
690
+ "document": "Url of the document Front. supported image formats: PNG, JPG/JPEG. \nSupported image size: the downloaded image after Base64 encoding must be no more than 2M. image download time must be no more than 5 seconds. \nSupported image resolution: between 256 \\* 256 and 4096 \\* 4096. For some documents, either ImageUrlBack or ImageBase64Back must be provided. If both are provided, only ImageUrlFront will be used.",
691
+ "example": "https://test/demo.jpeg",
692
+ "member": "string",
693
+ "name": "ImageUrlFront",
694
+ "required": false,
695
+ "type": "string"
696
+ },
697
+ {
698
+ "disabled": false,
699
+ "document": "Specifies the Url of the document Back. supported image formats: PNG, JPG/JPEG\nSupported image size: no more than 2M after Base64 encoding. image download time should not exceed 5 seconds. \nSupported image resolution: between 256 \\* 256 and 4096 \\* 4096. For some documents, either ImageUrlBack or ImageBase64Back must be provided. If both are provided, only use ImageUrlBack.\n",
700
+ "example": "https://test/demo.jpeg",
701
+ "member": "string",
702
+ "name": "ImageUrlBack",
703
+ "required": false,
704
+ "type": "string"
705
+ },
706
+ {
707
+ "disabled": false,
708
+ "document": "Whether to extract the ID portrait. Default value: false.",
709
+ "example": "false",
710
+ "member": "bool",
711
+ "name": "ReturnHeadImage",
712
+ "required": false,
713
+ "type": "bool"
714
+ }
715
+ ],
716
+ "type": "object"
717
+ },
718
+ "ApplyCardVerificationExternalResponse": {
719
+ "document": "ApplyCardVerificationExternal response structure.",
720
+ "members": [
721
+ {
722
+ "disabled": false,
723
+ "document": "Process token, which is used to obtain the result.",
724
+ "example": "88ed374d-cfa7-4391-bcde-66b49f2f192b",
725
+ "member": "string",
726
+ "name": "CardVerificationToken",
727
+ "output_required": false,
728
+ "type": "string",
729
+ "value_allowed_null": false
730
+ },
731
+ {
732
+ "document": "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.",
733
+ "member": "string",
734
+ "name": "RequestId",
735
+ "type": "string"
736
+ }
737
+ ],
738
+ "type": "object"
739
+ },
515
740
  "BankCardOCRRequest": {
516
741
  "document": "BankCardOCR request structure.",
517
742
  "members": [
@@ -692,116 +917,786 @@
692
917
  ],
693
918
  "type": "object"
694
919
  },
695
- "BusInvoice": {
696
- "document": "Bus ticket",
920
+ "BrazilCardInfo": {
921
+ "document": "Type of document in brazil.",
697
922
  "members": [
698
923
  {
699
924
  "disabled": false,
700
- "document": "Invoice title",
925
+ "document": "RNE document.\nNote: This field may return null, indicating that no valid values can be obtained.",
701
926
  "example": "无",
702
- "member": "string",
703
- "name": "Title",
704
- "required": false,
705
- "type": "string",
706
- "value_allowed_null": false
927
+ "member": "BrazilRNEInfo",
928
+ "name": "RNE",
929
+ "output_required": false,
930
+ "type": "object",
931
+ "value_allowed_null": true
707
932
  },
708
933
  {
709
934
  "disabled": false,
710
- "document": "Whether there is a QR code (0: No, 1: Yes)",
935
+ "document": "Specifies the document.\nNote: This field may return null, indicating that no valid values can be obtained.",
711
936
  "example": "无",
712
- "member": "int64",
713
- "name": "QRCodeMark",
714
- "required": false,
715
- "type": "int",
716
- "value_allowed_null": false
937
+ "member": "BrazilRNMInfo",
938
+ "name": "RNM",
939
+ "output_required": false,
940
+ "type": "object",
941
+ "value_allowed_null": true
717
942
  },
718
943
  {
719
944
  "disabled": false,
720
- "document": "Invoice number",
945
+ "document": "Driver license document.\nNote: This field may return null, indicating that no valid values can be obtained.",
721
946
  "example": "无",
722
- "member": "string",
723
- "name": "Number",
724
- "required": false,
725
- "type": "string",
726
- "value_allowed_null": false
947
+ "member": "BrazilDriverLicenseInfo",
948
+ "name": "DriverLicense",
949
+ "output_required": false,
950
+ "type": "object",
951
+ "value_allowed_null": true
727
952
  },
728
953
  {
729
954
  "disabled": false,
730
- "document": "Invoice code",
955
+ "document": "ID card document.\nNote: This field may return null, indicating that no valid values can be obtained.",
731
956
  "example": "无",
957
+ "member": "BrazilIDCardInfo",
958
+ "name": "IDCard",
959
+ "output_required": false,
960
+ "type": "object",
961
+ "value_allowed_null": true
962
+ }
963
+ ],
964
+ "usage": "out"
965
+ },
966
+ "BrazilDriverLicenseInfo": {
967
+ "document": "Driver'S license type in brazil.",
968
+ "members": [
969
+ {
970
+ "disabled": false,
971
+ "document": "Name.",
972
+ "example": "ZHANG SAN",
732
973
  "member": "string",
733
- "name": "Code",
734
- "required": false,
974
+ "name": "NOME",
975
+ "output_required": false,
735
976
  "type": "string",
736
977
  "value_allowed_null": false
737
978
  },
738
979
  {
739
980
  "disabled": false,
740
- "document": "Date of issue",
741
- "example": "",
981
+ "document": "Specifies the driver's license type.",
982
+ "example": "B",
742
983
  "member": "string",
743
- "name": "Date",
744
- "required": false,
984
+ "name": "CatHab",
985
+ "output_required": false,
745
986
  "type": "string",
746
987
  "value_allowed_null": false
747
988
  },
748
989
  {
749
990
  "disabled": false,
750
- "document": "Departure time",
751
- "example": "",
991
+ "document": "Driver’s license id.",
992
+ "example": "23*****110",
752
993
  "member": "string",
753
- "name": "TimeGetOn",
754
- "required": false,
994
+ "name": "CNHNumber",
995
+ "output_required": false,
755
996
  "type": "string",
756
997
  "value_allowed_null": false
757
998
  },
758
999
  {
759
1000
  "disabled": false,
760
- "document": "Departure date",
761
- "example": "",
1001
+ "document": "Expiration date.",
1002
+ "example": " 07/08/2024",
762
1003
  "member": "string",
763
- "name": "DateGetOn",
764
- "required": false,
1004
+ "name": "VALIDADE",
1005
+ "output_required": false,
765
1006
  "type": "string",
766
1007
  "value_allowed_null": false
767
1008
  },
768
1009
  {
769
1010
  "disabled": false,
770
- "document": "Departure station",
771
- "example": "",
1011
+ "document": "Indicates the qualification.",
1012
+ "example": " 23/05/2013",
772
1013
  "member": "string",
773
- "name": "StationGetOn",
774
- "required": false,
1014
+ "name": "QUALIFICATION",
1015
+ "output_required": false,
775
1016
  "type": "string",
776
1017
  "value_allowed_null": false
777
1018
  },
778
1019
  {
779
1020
  "disabled": false,
780
- "document": "Destination",
781
- "example": "",
1021
+ "document": "Identity card number.",
1022
+ "example": " F048**** DIREX EX",
782
1023
  "member": "string",
783
- "name": "StationGetOff",
784
- "required": false,
1024
+ "name": "IDENTIDADE",
1025
+ "output_required": false,
785
1026
  "type": "string",
786
1027
  "value_allowed_null": false
787
1028
  },
788
1029
  {
789
1030
  "disabled": false,
790
- "document": "Fare",
791
- "example": "",
1031
+ "document": "Tax number of the person.",
1032
+ "example": " 238.***.758-75",
792
1033
  "member": "string",
793
- "name": "Total",
794
- "required": false,
1034
+ "name": "CPF",
1035
+ "output_required": false,
795
1036
  "type": "string",
796
1037
  "value_allowed_null": false
797
1038
  },
798
1039
  {
799
1040
  "disabled": false,
800
- "document": "Name",
801
- "example": "",
1041
+ "document": "Date of birth.",
1042
+ "example": " 28/03/1992",
802
1043
  "member": "string",
803
- "name": "UserName",
804
- "required": false,
1044
+ "name": "NASCIMENTO",
1045
+ "output_required": false,
1046
+ "type": "string",
1047
+ "value_allowed_null": false
1048
+ },
1049
+ {
1050
+ "disabled": false,
1051
+ "document": "Membership status.",
1052
+ "example": " JINJI PAN/WEIHONG CHEN",
1053
+ "member": "string",
1054
+ "name": "MEMBERSHIP",
1055
+ "output_required": false,
1056
+ "type": "string",
1057
+ "value_allowed_null": false
1058
+ },
1059
+ {
1060
+ "disabled": false,
1061
+ "document": "Registration number.",
1062
+ "example": "073****3357",
1063
+ "member": "string",
1064
+ "name": "REGISTRO",
1065
+ "output_required": false,
1066
+ "type": "string",
1067
+ "value_allowed_null": false
1068
+ },
1069
+ {
1070
+ "disabled": false,
1071
+ "document": "Remarks.",
1072
+ "example": "A",
1073
+ "member": "string",
1074
+ "name": "OBSERVATIONS",
1075
+ "output_required": false,
1076
+ "type": "string",
1077
+ "value_allowed_null": false
1078
+ },
1079
+ {
1080
+ "disabled": false,
1081
+ "document": "Issue date.",
1082
+ "example": "15/02/2022",
1083
+ "member": "string",
1084
+ "name": "IssueDate",
1085
+ "output_required": false,
1086
+ "type": "string",
1087
+ "value_allowed_null": false
1088
+ },
1089
+ {
1090
+ "disabled": false,
1091
+ "document": "Issuing location.",
1092
+ "example": " SAO PAULO, SP",
1093
+ "member": "string",
1094
+ "name": "LOCAL",
1095
+ "output_required": false,
1096
+ "type": "string",
1097
+ "value_allowed_null": false
1098
+ },
1099
+ {
1100
+ "disabled": false,
1101
+ "document": "Record number.",
1102
+ "example": " 51******489/SP8******10",
1103
+ "member": "string",
1104
+ "name": "BackNumber",
1105
+ "output_required": false,
1106
+ "type": "string",
1107
+ "value_allowed_null": false
1108
+ },
1109
+ {
1110
+ "disabled": false,
1111
+ "document": "Specifies the avatar in base64 format.",
1112
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
1113
+ "member": "string",
1114
+ "name": "PortraitImage",
1115
+ "output_required": false,
1116
+ "type": "string",
1117
+ "value_allowed_null": false
1118
+ }
1119
+ ],
1120
+ "usage": "out"
1121
+ },
1122
+ "BrazilIDCardInfo": {
1123
+ "document": "Specifies the identity card type in brazil.",
1124
+ "members": [
1125
+ {
1126
+ "disabled": false,
1127
+ "document": "Name.",
1128
+ "example": "JESSINY LIN YAO",
1129
+ "member": "string",
1130
+ "name": "Nome",
1131
+ "output_required": false,
1132
+ "type": "string",
1133
+ "value_allowed_null": false
1134
+ },
1135
+ {
1136
+ "disabled": false,
1137
+ "document": "Parent information.",
1138
+ "example": "WENZHEN YAO / LIHUA LIN",
1139
+ "member": "string",
1140
+ "name": "MemberShip",
1141
+ "output_required": false,
1142
+ "type": "string",
1143
+ "value_allowed_null": false
1144
+ },
1145
+ {
1146
+ "disabled": false,
1147
+ "document": "Date of birth.",
1148
+ "example": "27/09/2002",
1149
+ "member": "string",
1150
+ "name": "DataNascimento",
1151
+ "output_required": false,
1152
+ "type": "string",
1153
+ "value_allowed_null": false
1154
+ },
1155
+ {
1156
+ "disabled": false,
1157
+ "document": "Issuing organization.",
1158
+ "example": "SSP-SP",
1159
+ "member": "string",
1160
+ "name": "IssuingAgency",
1161
+ "output_required": false,
1162
+ "type": "string",
1163
+ "value_allowed_null": false
1164
+ },
1165
+ {
1166
+ "disabled": false,
1167
+ "document": "Specifies the blood type.",
1168
+ "example": "A",
1169
+ "member": "string",
1170
+ "name": "Fatorrh",
1171
+ "output_required": false,
1172
+ "type": "string",
1173
+ "value_allowed_null": false
1174
+ },
1175
+ {
1176
+ "disabled": false,
1177
+ "document": "Birthplace.",
1178
+ "example": "CORUMBÁ - MS",
1179
+ "member": "string",
1180
+ "name": "NaturalIDade",
1181
+ "output_required": false,
1182
+ "type": "string",
1183
+ "value_allowed_null": false
1184
+ },
1185
+ {
1186
+ "disabled": false,
1187
+ "document": "Remarks.",
1188
+ "example": "Observations",
1189
+ "member": "string",
1190
+ "name": "Observations",
1191
+ "output_required": false,
1192
+ "type": "string",
1193
+ "value_allowed_null": false
1194
+ },
1195
+ {
1196
+ "disabled": false,
1197
+ "document": "CPF Type",
1198
+ "example": "CPF",
1199
+ "member": "string",
1200
+ "name": "CPF",
1201
+ "output_required": false,
1202
+ "type": "string",
1203
+ "value_allowed_null": false
1204
+ },
1205
+ {
1206
+ "disabled": false,
1207
+ "document": "DNI Type",
1208
+ "example": "DNI",
1209
+ "member": "string",
1210
+ "name": "DNI",
1211
+ "output_required": false,
1212
+ "type": "string",
1213
+ "value_allowed_null": false
1214
+ },
1215
+ {
1216
+ "disabled": false,
1217
+ "document": "Common registration.",
1218
+ "example": "38.488.402-7 2 VIA",
1219
+ "member": "string",
1220
+ "name": "RegistroGeral",
1221
+ "output_required": false,
1222
+ "type": "string",
1223
+ "value_allowed_null": false
1224
+ },
1225
+ {
1226
+ "disabled": false,
1227
+ "document": "Issue date. valid values: dd/mm/yyyy.",
1228
+ "example": "22/09/2017",
1229
+ "member": "string",
1230
+ "name": "DispatchDate",
1231
+ "output_required": false,
1232
+ "type": "string",
1233
+ "value_allowed_null": false
1234
+ },
1235
+ {
1236
+ "disabled": false,
1237
+ "document": "Address.",
1238
+ "example": "CORUMBA-MS XXX CN:LV. A163/FLS.184V/N",
1239
+ "member": "string",
1240
+ "name": "Registro",
1241
+ "output_required": false,
1242
+ "type": "string",
1243
+ "value_allowed_null": false
1244
+ },
1245
+ {
1246
+ "disabled": false,
1247
+ "document": "Specifies the avatar in Base64 format of the id card.",
1248
+ "example": "/9j/4AAQSkZJ....AQAAAAB",
1249
+ "member": "string",
1250
+ "name": "PortraitImage",
1251
+ "output_required": false,
1252
+ "type": "string",
1253
+ "value_allowed_null": false
1254
+ },
1255
+ {
1256
+ "disabled": false,
1257
+ "document": "Original identity information.",
1258
+ "example": "XXX-XX xxx DE XXXXXX XX:XX.A91/XX.300/N°11111",
1259
+ "member": "string",
1260
+ "name": "DocOrigem",
1261
+ "output_required": false,
1262
+ "type": "string",
1263
+ "value_allowed_null": false
1264
+ }
1265
+ ],
1266
+ "usage": "out"
1267
+ },
1268
+ "BrazilRNEInfo": {
1269
+ "document": "BrazilRNEInfo",
1270
+ "members": [
1271
+ {
1272
+ "disabled": false,
1273
+ "document": "RNE",
1274
+ "example": "G111111-A",
1275
+ "member": "string",
1276
+ "name": "RNE",
1277
+ "output_required": false,
1278
+ "type": "string",
1279
+ "value_allowed_null": false
1280
+ },
1281
+ {
1282
+ "disabled": false,
1283
+ "document": "CLASSIFICAÇÃO(CLASSIFICATION)",
1284
+ "example": "PERMANENTE",
1285
+ "member": "string",
1286
+ "name": "CLASSIFICATION",
1287
+ "output_required": false,
1288
+ "type": "string",
1289
+ "value_allowed_null": false
1290
+ },
1291
+ {
1292
+ "disabled": false,
1293
+ "document": "VALIDADE",
1294
+ "example": "INDETERMINADA",
1295
+ "member": "string",
1296
+ "name": "VALIDADE",
1297
+ "output_required": false,
1298
+ "type": "string",
1299
+ "value_allowed_null": false
1300
+ },
1301
+ {
1302
+ "disabled": false,
1303
+ "document": "NOME",
1304
+ "example": "HUA LI",
1305
+ "member": "string",
1306
+ "name": "NOME",
1307
+ "output_required": false,
1308
+ "type": "string",
1309
+ "value_allowed_null": false
1310
+ },
1311
+ {
1312
+ "disabled": false,
1313
+ "document": "FILIAÇÃO(MEMBERSHIP)",
1314
+ "example": "DA LI",
1315
+ "member": "string",
1316
+ "name": "Membership",
1317
+ "output_required": false,
1318
+ "type": "string",
1319
+ "value_allowed_null": false
1320
+ },
1321
+ {
1322
+ "disabled": false,
1323
+ "document": "NACIONALIDADE",
1324
+ "example": "CHINESA",
1325
+ "member": "string",
1326
+ "name": "NACIONALIDADE",
1327
+ "output_required": false,
1328
+ "type": "string",
1329
+ "value_allowed_null": false
1330
+ },
1331
+ {
1332
+ "disabled": false,
1333
+ "document": "NATURALIDADE(PAÍS)",
1334
+ "example": "REP.POPULAR DA CHINA",
1335
+ "member": "string",
1336
+ "name": "NATURALIDADE",
1337
+ "output_required": false,
1338
+ "type": "string",
1339
+ "value_allowed_null": false
1340
+ },
1341
+ {
1342
+ "disabled": false,
1343
+ "document": "ORGÃO EXPEDIDOR(IssuingAgency)",
1344
+ "example": "CGPI",
1345
+ "member": "string",
1346
+ "name": "IssuingAgency",
1347
+ "output_required": false,
1348
+ "type": "string",
1349
+ "value_allowed_null": false
1350
+ },
1351
+ {
1352
+ "disabled": false,
1353
+ "document": "DATA DE NASCIMENTO(DateOfBirth)",
1354
+ "example": "01/08/1900",
1355
+ "member": "string",
1356
+ "name": "DateOfBirth",
1357
+ "output_required": false,
1358
+ "type": "string",
1359
+ "value_allowed_null": false
1360
+ },
1361
+ {
1362
+ "disabled": false,
1363
+ "document": "SEXO",
1364
+ "example": "F",
1365
+ "member": "string",
1366
+ "name": "Sex",
1367
+ "output_required": false,
1368
+ "type": "string",
1369
+ "value_allowed_null": false
1370
+ },
1371
+ {
1372
+ "disabled": false,
1373
+ "document": "DATA DE ENTRADA(EntryDate)",
1374
+ "example": "01/08/2000",
1375
+ "member": "string",
1376
+ "name": "EntryDate",
1377
+ "output_required": false,
1378
+ "type": "string",
1379
+ "value_allowed_null": false
1380
+ },
1381
+ {
1382
+ "disabled": false,
1383
+ "document": "VIA",
1384
+ "example": "1",
1385
+ "member": "string",
1386
+ "name": "VIA",
1387
+ "output_required": false,
1388
+ "type": "string",
1389
+ "value_allowed_null": false
1390
+ },
1391
+ {
1392
+ "disabled": false,
1393
+ "document": "DATA DE EXPEDIÇÃO(DispatchDate)",
1394
+ "example": "01/08/2001",
1395
+ "member": "string",
1396
+ "name": "DispatchDate",
1397
+ "output_required": false,
1398
+ "type": "string",
1399
+ "value_allowed_null": false
1400
+ },
1401
+ {
1402
+ "disabled": false,
1403
+ "document": "MRZ",
1404
+ "example": "V1246N 2CHN12 34",
1405
+ "member": "string",
1406
+ "name": "MRZ",
1407
+ "output_required": false,
1408
+ "type": "string",
1409
+ "value_allowed_null": false
1410
+ },
1411
+ {
1412
+ "disabled": false,
1413
+ "document": "PortraitImage",
1414
+ "example": "/9j/4AAQSkZJ....AQAAAAB",
1415
+ "member": "string",
1416
+ "name": "PortraitImage",
1417
+ "output_required": false,
1418
+ "type": "string",
1419
+ "value_allowed_null": false
1420
+ }
1421
+ ],
1422
+ "usage": "out"
1423
+ },
1424
+ "BrazilRNMInfo": {
1425
+ "document": "Document type for brazil RNM.",
1426
+ "members": [
1427
+ {
1428
+ "disabled": false,
1429
+ "document": "SOBRENOME Type",
1430
+ "example": "LI",
1431
+ "member": "string",
1432
+ "name": "SOBRENOME",
1433
+ "output_required": false,
1434
+ "type": "string",
1435
+ "value_allowed_null": false
1436
+ },
1437
+ {
1438
+ "disabled": false,
1439
+ "document": "NOME Type",
1440
+ "example": "HUA",
1441
+ "member": "string",
1442
+ "name": "NOME",
1443
+ "output_required": false,
1444
+ "type": "string",
1445
+ "value_allowed_null": false
1446
+ },
1447
+ {
1448
+ "disabled": false,
1449
+ "document": "DATA DE NASCIMENTO",
1450
+ "example": "01/08/1900",
1451
+ "member": "string",
1452
+ "name": "DATADENASCIMENTO",
1453
+ "output_required": false,
1454
+ "type": "string",
1455
+ "value_allowed_null": false
1456
+ },
1457
+ {
1458
+ "disabled": false,
1459
+ "document": "SEXO F",
1460
+ "example": "F",
1461
+ "member": "string",
1462
+ "name": "SEXO",
1463
+ "output_required": false,
1464
+ "type": "string",
1465
+ "value_allowed_null": false
1466
+ },
1467
+ {
1468
+ "disabled": false,
1469
+ "document": "FILIAÇÃO(MEMBERSHIP)",
1470
+ "example": "DA LI",
1471
+ "member": "string",
1472
+ "name": "MEMBERSHIP",
1473
+ "output_required": false,
1474
+ "type": "string",
1475
+ "value_allowed_null": false
1476
+ },
1477
+ {
1478
+ "disabled": false,
1479
+ "document": "NACIONALIDADE Type",
1480
+ "example": "CHINESA",
1481
+ "member": "string",
1482
+ "name": "NACIONALIDADE",
1483
+ "output_required": false,
1484
+ "type": "string",
1485
+ "value_allowed_null": false
1486
+ },
1487
+ {
1488
+ "disabled": false,
1489
+ "document": "VALIDADE Type",
1490
+ "example": "01/08/2000",
1491
+ "member": "string",
1492
+ "name": "VALIDADE",
1493
+ "output_required": false,
1494
+ "type": "string",
1495
+ "value_allowed_null": false
1496
+ },
1497
+ {
1498
+ "disabled": false,
1499
+ "document": "RNM Type",
1500
+ "example": "XAAA56-Y",
1501
+ "member": "string",
1502
+ "name": "RNM",
1503
+ "output_required": false,
1504
+ "type": "string",
1505
+ "value_allowed_null": false
1506
+ },
1507
+ {
1508
+ "disabled": false,
1509
+ "document": "CPF Type",
1510
+ "example": "000.000.000-00",
1511
+ "member": "string",
1512
+ "name": "CPF",
1513
+ "output_required": false,
1514
+ "type": "string",
1515
+ "value_allowed_null": false
1516
+ },
1517
+ {
1518
+ "disabled": false,
1519
+ "document": "CLASSIFICAÇÃO(CLASSIFICATION)",
1520
+ "example": "RESIDENTE",
1521
+ "member": "string",
1522
+ "name": "CLASSIFICATION",
1523
+ "output_required": false,
1524
+ "type": "string",
1525
+ "value_allowed_null": false
1526
+ },
1527
+ {
1528
+ "disabled": false,
1529
+ "document": "PRAZO DE RESIDENCIA",
1530
+ "example": "01/08/1950",
1531
+ "member": "string",
1532
+ "name": "PRAZODERESIDENCIA",
1533
+ "output_required": false,
1534
+ "type": "string",
1535
+ "value_allowed_null": false
1536
+ },
1537
+ {
1538
+ "disabled": false,
1539
+ "document": "EMISSÃO(ISSUANCE)",
1540
+ "example": "01/08/1999 CGPI/DIREX/PF",
1541
+ "member": "string",
1542
+ "name": "ISSUANCE",
1543
+ "output_required": false,
1544
+ "type": "string",
1545
+ "value_allowed_null": false
1546
+ },
1547
+ {
1548
+ "disabled": false,
1549
+ "document": "AMPARO LEGAL(LegalHelp)",
1550
+ "example": "AMPARO LEGAL",
1551
+ "member": "string",
1552
+ "name": "AMPAROLEGAL",
1553
+ "output_required": false,
1554
+ "type": "string",
1555
+ "value_allowed_null": false
1556
+ },
1557
+ {
1558
+ "disabled": false,
1559
+ "document": "MRZCode",
1560
+ "example": "NOMENOME NOME NOME",
1561
+ "member": "string",
1562
+ "name": "MRZ",
1563
+ "output_required": false,
1564
+ "type": "string",
1565
+ "value_allowed_null": false
1566
+ },
1567
+ {
1568
+ "disabled": false,
1569
+ "document": "Portrait Image",
1570
+ "example": "PortraitImage",
1571
+ "member": "string",
1572
+ "name": "PortraitImage",
1573
+ "output_required": false,
1574
+ "type": "string",
1575
+ "value_allowed_null": false
1576
+ },
1577
+ {
1578
+ "disabled": false,
1579
+ "document": "PortraitImage(Back)",
1580
+ "example": "PortraitImageBack",
1581
+ "member": "string",
1582
+ "name": "PortraitImageBack",
1583
+ "output_required": false,
1584
+ "type": "string",
1585
+ "value_allowed_null": false
1586
+ }
1587
+ ],
1588
+ "usage": "out"
1589
+ },
1590
+ "BusInvoice": {
1591
+ "document": "Bus ticket",
1592
+ "members": [
1593
+ {
1594
+ "disabled": false,
1595
+ "document": "Invoice title",
1596
+ "example": "无",
1597
+ "member": "string",
1598
+ "name": "Title",
1599
+ "required": false,
1600
+ "type": "string",
1601
+ "value_allowed_null": false
1602
+ },
1603
+ {
1604
+ "disabled": false,
1605
+ "document": "Whether there is a QR code (0: No, 1: Yes)",
1606
+ "example": "无",
1607
+ "member": "int64",
1608
+ "name": "QRCodeMark",
1609
+ "required": false,
1610
+ "type": "int",
1611
+ "value_allowed_null": false
1612
+ },
1613
+ {
1614
+ "disabled": false,
1615
+ "document": "Invoice number",
1616
+ "example": "无",
1617
+ "member": "string",
1618
+ "name": "Number",
1619
+ "required": false,
1620
+ "type": "string",
1621
+ "value_allowed_null": false
1622
+ },
1623
+ {
1624
+ "disabled": false,
1625
+ "document": "Invoice code",
1626
+ "example": "无",
1627
+ "member": "string",
1628
+ "name": "Code",
1629
+ "required": false,
1630
+ "type": "string",
1631
+ "value_allowed_null": false
1632
+ },
1633
+ {
1634
+ "disabled": false,
1635
+ "document": "Date of issue",
1636
+ "example": "无",
1637
+ "member": "string",
1638
+ "name": "Date",
1639
+ "required": false,
1640
+ "type": "string",
1641
+ "value_allowed_null": false
1642
+ },
1643
+ {
1644
+ "disabled": false,
1645
+ "document": "Departure time",
1646
+ "example": "无",
1647
+ "member": "string",
1648
+ "name": "TimeGetOn",
1649
+ "required": false,
1650
+ "type": "string",
1651
+ "value_allowed_null": false
1652
+ },
1653
+ {
1654
+ "disabled": false,
1655
+ "document": "Departure date",
1656
+ "example": "无",
1657
+ "member": "string",
1658
+ "name": "DateGetOn",
1659
+ "required": false,
1660
+ "type": "string",
1661
+ "value_allowed_null": false
1662
+ },
1663
+ {
1664
+ "disabled": false,
1665
+ "document": "Departure station",
1666
+ "example": "无",
1667
+ "member": "string",
1668
+ "name": "StationGetOn",
1669
+ "required": false,
1670
+ "type": "string",
1671
+ "value_allowed_null": false
1672
+ },
1673
+ {
1674
+ "disabled": false,
1675
+ "document": "Destination",
1676
+ "example": "无",
1677
+ "member": "string",
1678
+ "name": "StationGetOff",
1679
+ "required": false,
1680
+ "type": "string",
1681
+ "value_allowed_null": false
1682
+ },
1683
+ {
1684
+ "disabled": false,
1685
+ "document": "Fare",
1686
+ "example": "无",
1687
+ "member": "string",
1688
+ "name": "Total",
1689
+ "required": false,
1690
+ "type": "string",
1691
+ "value_allowed_null": false
1692
+ },
1693
+ {
1694
+ "disabled": false,
1695
+ "document": "Name",
1696
+ "example": "无",
1697
+ "member": "string",
1698
+ "name": "UserName",
1699
+ "required": false,
805
1700
  "type": "string",
806
1701
  "value_allowed_null": false
807
1702
  },
@@ -949,6 +1844,32 @@
949
1844
  ],
950
1845
  "usage": "out"
951
1846
  },
1847
+ "CoordsItem": {
1848
+ "document": "Detected coordinate recognition information.",
1849
+ "members": [
1850
+ {
1851
+ "disabled": false,
1852
+ "document": "Coordinates of four points in the image.",
1853
+ "example": "无",
1854
+ "member": "Polygon",
1855
+ "name": "Polygon",
1856
+ "output_required": false,
1857
+ "type": "object",
1858
+ "value_allowed_null": false
1859
+ },
1860
+ {
1861
+ "disabled": false,
1862
+ "document": "Coordinates of two points in the image.",
1863
+ "example": "无",
1864
+ "member": "ItemCoord",
1865
+ "name": "Coords",
1866
+ "output_required": false,
1867
+ "type": "object",
1868
+ "value_allowed_null": false
1869
+ }
1870
+ ],
1871
+ "usage": "out"
1872
+ },
952
1873
  "DetectedWordCoordPoint": {
953
1874
  "document": "Coordinates of a word’s four corners in a clockwise order on the input image, starting from the upper-left corner",
954
1875
  "members": [
@@ -1050,7 +1971,7 @@
1050
1971
  },
1051
1972
  {
1052
1973
  "disabled": false,
1053
- "document": "Configuration ID support: \n-- General\n-- InvoiceEng\n-- WayBillEng\n-- CustomsDeclaration\n-- WeightNote\n-- MedicalMeter\n-- BillOfLading\n-- EntrustmentBook\n-- Statement\n-- BookingConfirmation\n-- AirWayBill\n-- Table\n-- SteelLabel\n-- CarInsurance\n-- MultiRealEstateCertificate\n-- MultiRealEstateMaterial\n-- HongKongUtilityBill",
1974
+ "document": "Configuration ID support: \n-- General\n-- InvoiceEng\n-- WayBillEng\n-- CustomsDeclaration\n-- WeightNote\n-- MedicalMeter\n-- BillOfLading\n-- EntrustmentBook\n-- Statement\n-- BookingConfirmation\n-- AirWayBill\n-- Table\n-- SteelLabel\n-- CarInsurance\n-- MultiRealEstateCertificate\n-- MultiRealEstateMaterial\n-- HongKongUtilityBill\n-- OverseasCheques\n-- RegistrationCertificate\n-- GridPhoto\n-- SignaturePage",
1054
1975
  "example": "General",
1055
1976
  "member": "string",
1056
1977
  "name": "ConfigId",
@@ -1078,7 +1999,7 @@
1078
1999
  {
1079
2000
  "disabled": false,
1080
2001
  "document": "Single attribute configuration of a template.",
1081
- "example": "{\"Scene\": \"only_hw\"}",
2002
+ "example": "",
1082
2003
  "member": "ConfigAdvanced",
1083
2004
  "name": "ConfigAdvanced",
1084
2005
  "required": false,
@@ -1102,7 +2023,7 @@
1102
2023
  {
1103
2024
  "disabled": false,
1104
2025
  "document": "Image rotation angle (angle system). the text's horizontal direction is 0. clockwise is positive; counterclockwise is negative.",
1105
- "example": "0",
2026
+ "example": "0.0",
1106
2027
  "member": "float",
1107
2028
  "name": "Angle",
1108
2029
  "output_required": true,
@@ -1430,48 +2351,274 @@
1430
2351
  "members": [
1431
2352
  {
1432
2353
  "disabled": false,
1433
- "document": "Information of recognized text, including the text line content, confidence, text line coordinates, and text line coordinates after rotation correction. For more information, please click the link on the left.",
1434
- "example": "无",
1435
- "member": "TextDetection",
1436
- "name": "TextDetections",
1437
- "type": "list",
1438
- "value_allowed_null": false
2354
+ "document": "Information of recognized text, including the text line content, confidence, text line coordinates, and text line coordinates after rotation correction. For more information, please click the link on the left.",
2355
+ "example": "无",
2356
+ "member": "TextDetection",
2357
+ "name": "TextDetections",
2358
+ "type": "list",
2359
+ "value_allowed_null": false
2360
+ },
2361
+ {
2362
+ "disabled": false,
2363
+ "document": "Detected language. For more information on the supported languages, please see the description of the `LanguageType` input parameter.",
2364
+ "example": "zh",
2365
+ "member": "string",
2366
+ "name": "Language",
2367
+ "type": "string",
2368
+ "value_allowed_null": false
2369
+ },
2370
+ {
2371
+ "disabled": false,
2372
+ "document": "Image rotation angle in degrees. 0°: The horizontal direction of the text on the image; a positive value: rotate clockwise; a negative value: rotate counterclockwise.",
2373
+ "example": "6.5",
2374
+ "member": "float",
2375
+ "name": "Angel",
2376
+ "type": "float",
2377
+ "value_allowed_null": false
2378
+ },
2379
+ {
2380
+ "disabled": false,
2381
+ "document": "Total number of PDF pages to be returned if the image is a PDF. Default value: 0.",
2382
+ "example": "0",
2383
+ "member": "int64",
2384
+ "name": "PdfPageSize",
2385
+ "type": "int",
2386
+ "value_allowed_null": false
2387
+ },
2388
+ {
2389
+ "document": "The unique request ID, which is returned for each request. RequestId is required for locating a problem.",
2390
+ "member": "string",
2391
+ "name": "RequestId",
2392
+ "type": "string"
2393
+ }
2394
+ ],
2395
+ "type": "object"
2396
+ },
2397
+ "GeneralCard": {
2398
+ "document": "General card certificate information.",
2399
+ "members": [
2400
+ {
2401
+ "disabled": false,
2402
+ "document": "ID number.\nNote: This field may return null, indicating that no valid values can be obtained.",
2403
+ "example": "",
2404
+ "member": "string",
2405
+ "name": "LicenseNumber",
2406
+ "output_required": true,
2407
+ "type": "string",
2408
+ "value_allowed_null": true
2409
+ },
2410
+ {
2411
+ "disabled": false,
2412
+ "document": "Personal number. returned when the identity document type is passport.\nNote: This field may return null, indicating that no valid values can be obtained.",
2413
+ "example": "",
2414
+ "member": "string",
2415
+ "name": "PersonalNumber",
2416
+ "output_required": true,
2417
+ "type": "string",
2418
+ "value_allowed_null": true
2419
+ },
2420
+ {
2421
+ "disabled": false,
2422
+ "document": "Passport mrz line 1.\nNote: This field may return null, indicating that no valid values can be obtained.",
2423
+ "example": "",
2424
+ "member": "string",
2425
+ "name": "PassportCodeFirst",
2426
+ "output_required": true,
2427
+ "type": "string",
2428
+ "value_allowed_null": true
2429
+ },
2430
+ {
2431
+ "disabled": false,
2432
+ "document": "Passport mrz line 2.\nNote: This field may return null, indicating that no valid values can be obtained.",
2433
+ "example": "",
2434
+ "member": "string",
2435
+ "name": "PassportCodeSecond",
2436
+ "output_required": true,
2437
+ "type": "string",
2438
+ "value_allowed_null": true
2439
+ },
2440
+ {
2441
+ "disabled": false,
2442
+ "document": "Expiration date, in YYYY-MM-DD format.\nNote: This field may return null, indicating that no valid values can be obtained.",
2443
+ "example": "",
2444
+ "member": "string",
2445
+ "name": "ExpirationDate",
2446
+ "output_required": true,
2447
+ "type": "string",
2448
+ "value_allowed_null": true
2449
+ },
2450
+ {
2451
+ "disabled": false,
2452
+ "document": "Expiration date in YYYY-MM-DD format.\nNote: This field may return null, indicating that no valid values can be obtained.",
2453
+ "example": "",
2454
+ "member": "string",
2455
+ "name": "DueDate",
2456
+ "output_required": true,
2457
+ "type": "string",
2458
+ "value_allowed_null": true
2459
+ },
2460
+ {
2461
+ "disabled": false,
2462
+ "document": "Issue date, in YYYY-MM-DD format.\nNote: This field may return null, indicating that no valid values can be obtained.",
2463
+ "example": "",
2464
+ "member": "string",
2465
+ "name": "IssuedDate",
2466
+ "output_required": true,
2467
+ "type": "string",
2468
+ "value_allowed_null": true
2469
+ },
2470
+ {
2471
+ "disabled": false,
2472
+ "document": "Issuing authority.\nNote: This field may return null, indicating that no valid values can be obtained.",
2473
+ "example": "",
2474
+ "member": "string",
2475
+ "name": "IssuedAuthority",
2476
+ "output_required": true,
2477
+ "type": "string",
2478
+ "value_allowed_null": true
2479
+ },
2480
+ {
2481
+ "disabled": false,
2482
+ "document": "Issuing country, following the ISO 3166 country coding specification.\nNote: This field may return null, indicating that no valid values can be obtained.",
2483
+ "example": "",
2484
+ "member": "string",
2485
+ "name": "IssuedCountry",
2486
+ "output_required": true,
2487
+ "type": "string",
2488
+ "value_allowed_null": true
2489
+ },
2490
+ {
2491
+ "disabled": false,
2492
+ "document": "Specifies the name.\nNote: This field may return null, indicating that no valid values can be obtained.",
2493
+ "example": "",
2494
+ "member": "string",
2495
+ "name": "FullName",
2496
+ "output_required": true,
2497
+ "type": "string",
2498
+ "value_allowed_null": true
2499
+ },
2500
+ {
2501
+ "disabled": false,
2502
+ "document": "Name.\nNote: This field may return null, indicating that no valid values can be obtained.",
2503
+ "example": "",
2504
+ "member": "string",
2505
+ "name": "FirstName",
2506
+ "output_required": true,
2507
+ "type": "string",
2508
+ "value_allowed_null": true
2509
+ },
2510
+ {
2511
+ "disabled": false,
2512
+ "document": "Name.\nNote: This field may return null, indicating that no valid values can be obtained.",
2513
+ "example": "",
2514
+ "member": "string",
2515
+ "name": "LastName",
2516
+ "output_required": true,
2517
+ "type": "string",
2518
+ "value_allowed_null": true
2519
+ },
2520
+ {
2521
+ "disabled": false,
2522
+ "document": "Gender on the document.\n-M: man.\n-F: woman.\n-X: other gender identity.\nNote: This field may return null, indicating that no valid values can be obtained.",
2523
+ "example": "",
2524
+ "member": "string",
2525
+ "name": "Sex",
2526
+ "output_required": true,
2527
+ "type": "string",
2528
+ "value_allowed_null": true
2529
+ },
2530
+ {
2531
+ "disabled": false,
2532
+ "document": "Age. 0 means no valid info.\nNote: This field may return null, indicating that no valid values can be obtained.",
2533
+ "example": "",
2534
+ "member": "string",
2535
+ "name": "Age",
2536
+ "output_required": true,
2537
+ "type": "string",
2538
+ "value_allowed_null": true
2539
+ },
2540
+ {
2541
+ "disabled": false,
2542
+ "document": "Date of birth.\nNote: This field may return null, indicating that no valid values can be obtained.",
2543
+ "example": "",
2544
+ "member": "string",
2545
+ "name": "Birthday",
2546
+ "output_required": true,
2547
+ "type": "string",
2548
+ "value_allowed_null": true
2549
+ },
2550
+ {
2551
+ "disabled": false,
2552
+ "document": "Birth place.\nNote: This field may return null, indicating that no valid values can be obtained.",
2553
+ "example": "",
2554
+ "member": "string",
2555
+ "name": "BirthPlace",
2556
+ "output_required": true,
2557
+ "type": "string",
2558
+ "value_allowed_null": true
2559
+ },
2560
+ {
2561
+ "disabled": false,
2562
+ "document": "Document nationality, following ISO 3166 country coding specification.\nNote: This field may return null, indicating that no valid values can be obtained.",
2563
+ "example": "",
2564
+ "member": "string",
2565
+ "name": "Nationality",
2566
+ "output_required": true,
2567
+ "type": "string",
2568
+ "value_allowed_null": true
2569
+ },
2570
+ {
2571
+ "disabled": false,
2572
+ "document": "Registration number.\nNote: This field may return null, indicating that no valid values can be obtained.",
2573
+ "example": "",
2574
+ "member": "string",
2575
+ "name": "RegistrationNumber",
2576
+ "output_required": true,
2577
+ "type": "string",
2578
+ "value_allowed_null": true
2579
+ },
2580
+ {
2581
+ "disabled": false,
2582
+ "document": "Specifies the address information of the document.\nNote: This field may return null, indicating that no valid values can be obtained.",
2583
+ "example": "",
2584
+ "member": "AddressInfo",
2585
+ "name": "Address",
2586
+ "output_required": false,
2587
+ "type": "object",
2588
+ "value_allowed_null": true
1439
2589
  },
1440
2590
  {
1441
2591
  "disabled": false,
1442
- "document": "Detected language. For more information on the supported languages, please see the description of the `LanguageType` input parameter.",
1443
- "example": "zh",
2592
+ "document": "Localized name.\nNote: This field may return null, indicating that no valid values can be obtained.",
2593
+ "example": "",
1444
2594
  "member": "string",
1445
- "name": "Language",
2595
+ "name": "FullNameLocal",
2596
+ "output_required": false,
1446
2597
  "type": "string",
1447
- "value_allowed_null": false
2598
+ "value_allowed_null": true
1448
2599
  },
1449
2600
  {
1450
2601
  "disabled": false,
1451
- "document": "Image rotation angle in degrees. 0°: The horizontal direction of the text on the image; a positive value: rotate clockwise; a negative value: rotate counterclockwise.",
1452
- "example": "6.5",
1453
- "member": "float",
1454
- "name": "Angel",
1455
- "type": "float",
1456
- "value_allowed_null": false
2602
+ "document": "Localization name.\nNote: This field may return null, indicating that no valid values can be obtained.",
2603
+ "example": "",
2604
+ "member": "string",
2605
+ "name": "FirstNameLocal",
2606
+ "output_required": false,
2607
+ "type": "string",
2608
+ "value_allowed_null": true
1457
2609
  },
1458
2610
  {
1459
2611
  "disabled": false,
1460
- "document": "Total number of PDF pages to be returned if the image is a PDF. Default value: 0.",
1461
- "example": "0",
1462
- "member": "int64",
1463
- "name": "PdfPageSize",
1464
- "type": "int",
1465
- "value_allowed_null": false
1466
- },
1467
- {
1468
- "document": "The unique request ID, which is returned for each request. RequestId is required for locating a problem.",
2612
+ "document": "Localized surname.\nNote: This field may return null, indicating that no valid values can be obtained.",
2613
+ "example": "",
1469
2614
  "member": "string",
1470
- "name": "RequestId",
1471
- "type": "string"
2615
+ "name": "LastNameLocal",
2616
+ "output_required": false,
2617
+ "type": "string",
2618
+ "value_allowed_null": true
1472
2619
  }
1473
2620
  ],
1474
- "type": "object"
2621
+ "usage": "out"
1475
2622
  },
1476
2623
  "GeneralMachineItem": {
1477
2624
  "document": "Items of a general machine-printed invoice",
@@ -1559,6 +2706,83 @@
1559
2706
  ],
1560
2707
  "usage": "out"
1561
2708
  },
2709
+ "GetCardVerificationExternalResultRequest": {
2710
+ "document": "GetCardVerificationExternalResult request structure.",
2711
+ "members": [
2712
+ {
2713
+ "disabled": false,
2714
+ "document": "Initiates the recognition interface and returns a unique token.",
2715
+ "example": "9943345f-a690-4220-a749-9c68518f2e17",
2716
+ "member": "string",
2717
+ "name": "CardVerificationToken",
2718
+ "required": true,
2719
+ "type": "string"
2720
+ }
2721
+ ],
2722
+ "type": "object"
2723
+ },
2724
+ "GetCardVerificationExternalResultResponse": {
2725
+ "document": "GetCardVerificationExternalResult response structure.",
2726
+ "members": [
2727
+ {
2728
+ "disabled": false,
2729
+ "document": "Indicates the status. valid values: \nPASSED\nPROCESSING\nWARNING",
2730
+ "example": "PASSED",
2731
+ "member": "string",
2732
+ "name": "Status",
2733
+ "output_required": false,
2734
+ "type": "string",
2735
+ "value_allowed_null": false
2736
+ },
2737
+ {
2738
+ "disabled": false,
2739
+ "document": "Indicates the anti-counterfeiting information.\n-ScreenshotSuspected: The image is a screenshot.\n-RetakeSuspected: The image is taken from another screen.\n-PaperCopy: The image is a black and white, or color photocopy.\n-FakeSuspected: The image of the card, or the information on the card has been edited or altered.\n-OtherWarning: Document's authenticity is not verified for various reasons.\nNote: This field may return null, indicating that no valid values can be obtained.",
2740
+ "example": "[\"OtherWarning\"]",
2741
+ "member": "string",
2742
+ "name": "WarnInfo",
2743
+ "output_required": false,
2744
+ "type": "list",
2745
+ "value_allowed_null": true
2746
+ },
2747
+ {
2748
+ "disabled": false,
2749
+ "document": "Country Code.\nNote: This field may return null, indicating that no valid values can be obtained.",
2750
+ "example": "PHL",
2751
+ "member": "string",
2752
+ "name": "Nationality",
2753
+ "output_required": false,
2754
+ "type": "string",
2755
+ "value_allowed_null": true
2756
+ },
2757
+ {
2758
+ "disabled": false,
2759
+ "document": "Recognition result of the text in the id photo.\t\nNote: This field may return null, indicating that no valid values can be obtained.",
2760
+ "example": "无",
2761
+ "member": "GeneralCard",
2762
+ "name": "CardInfo",
2763
+ "output_required": false,
2764
+ "type": "object",
2765
+ "value_allowed_null": true
2766
+ },
2767
+ {
2768
+ "disabled": false,
2769
+ "document": "Specifies the token in the request parameters.",
2770
+ "example": "9943345f-a690-4220-a749-9c68518f2e17",
2771
+ "member": "string",
2772
+ "name": "CardVerificationToken",
2773
+ "output_required": false,
2774
+ "type": "string",
2775
+ "value_allowed_null": false
2776
+ },
2777
+ {
2778
+ "document": "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.",
2779
+ "member": "string",
2780
+ "name": "RequestId",
2781
+ "type": "string"
2782
+ }
2783
+ ],
2784
+ "type": "object"
2785
+ },
1562
2786
  "GroupInfo": {
1563
2787
  "document": "The sequence number of an element group in the image",
1564
2788
  "members": [
@@ -1584,7 +2808,7 @@
1584
2808
  "example": "false",
1585
2809
  "member": "bool",
1586
2810
  "name": "ReturnHeadImage",
1587
- "required": true,
2811
+ "required": false,
1588
2812
  "type": "bool"
1589
2813
  },
1590
2814
  {
@@ -1599,7 +2823,7 @@
1599
2823
  {
1600
2824
  "disabled": false,
1601
2825
  "document": "Base64 string of the image\nSupported image formats: PNG, JPG, JPEG. GIF is not supported yet.\nSupported image size: The downloaded image cannot exceed 7 MB after being Base64-encoded, and it cannot take longer than 3 seconds to download the image.",
1602
- "example": "",
2826
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
1603
2827
  "member": "string",
1604
2828
  "name": "ImageBase64",
1605
2829
  "required": false,
@@ -1608,7 +2832,7 @@
1608
2832
  {
1609
2833
  "disabled": false,
1610
2834
  "document": "URL address of image. (This field is not supported outside Chinese mainland)\nSupported image formats: PNG, JPG, JPEG. GIF is currently not supported.\nSupported image size: the downloaded image cannot exceed 3 MB after being Base64-encoded. The download time of the image cannot exceed 3 seconds.\nWe recommend you store the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.\nThe download speed and stability of non-Tencent Cloud URLs may be low.",
1611
- "example": "https://xx/a.jpg",
2835
+ "example": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/fakeurl.jpg",
1612
2836
  "member": "string",
1613
2837
  "name": "ImageUrl",
1614
2838
  "required": false,
@@ -1732,17 +2956,27 @@
1732
2956
  },
1733
2957
  {
1734
2958
  "disabled": false,
1735
- "document": "Base64-encoded identity photo\nNote: this field may return null, indicating that no valid values can be obtained.",
1736
- "example": "xx",
2959
+ "document": "Base64-encoded large primary portrait photo from the left side of the new-generation Hong Kong Identity Card.\nNote: this field may return null, indicating that no valid values can be obtained.",
2960
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
1737
2961
  "member": "string",
1738
2962
  "name": "HeadImage",
1739
2963
  "output_required": true,
1740
2964
  "type": "string",
1741
2965
  "value_allowed_null": true
1742
2966
  },
2967
+ {
2968
+ "disabled": false,
2969
+ "document": "Base64-encoded small secondary portrait photo from the right side of the new-generation Hong Kong Identity Card.\nNote: this field may return null, indicating that no valid values can be obtained.",
2970
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
2971
+ "member": "string",
2972
+ "name": "SmallHeadImage",
2973
+ "output_required": false,
2974
+ "type": "string",
2975
+ "value_allowed_null": true
2976
+ },
1743
2977
  {
1744
2978
  "disabled": true,
1745
- "document": "Multiple alarm codes. If the ID card is spoofed, photocopied, or photoshopped, the corresponding alarm code will be returned.\n-9102: Alarm for photocopied document\n-9103: Alarm for spoofed document",
2979
+ "document": "This field is deprecated and will always return an empty array. Usage is not recommended.",
1746
2980
  "example": "[-9102,-9103]",
1747
2981
  "member": "int64",
1748
2982
  "name": "WarningCode",
@@ -1760,6 +2994,26 @@
1760
2994
  "type": "list",
1761
2995
  "value_allowed_null": false
1762
2996
  },
2997
+ {
2998
+ "disabled": false,
2999
+ "document": "Text information incorporated within the laser-perforated see-through window on the new-generation Hong Kong Identity Card.",
3000
+ "example": "C000000",
3001
+ "member": "string",
3002
+ "name": "WindowEmbeddedText",
3003
+ "output_required": false,
3004
+ "type": "string",
3005
+ "value_allowed_null": false
3006
+ },
3007
+ {
3008
+ "disabled": false,
3009
+ "document": "Versions of the Hong Kong Identity Card: HKID-2018, HKID-2003.",
3010
+ "example": "HKID-2018",
3011
+ "member": "string",
3012
+ "name": "HKIDVersion",
3013
+ "output_required": false,
3014
+ "type": "string",
3015
+ "value_allowed_null": true
3016
+ },
1763
3017
  {
1764
3018
  "document": "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.",
1765
3019
  "member": "string",
@@ -2151,7 +3405,7 @@
2151
3405
  {
2152
3406
  "disabled": false,
2153
3407
  "document": "X-coordinate of top-left point.",
2154
- "example": "",
3408
+ "example": "537",
2155
3409
  "member": "int64",
2156
3410
  "name": "X",
2157
3411
  "required": true,
@@ -2161,7 +3415,7 @@
2161
3415
  {
2162
3416
  "disabled": false,
2163
3417
  "document": "Y-coordinate of top-left point.",
2164
- "example": "",
3418
+ "example": "335",
2165
3419
  "member": "int64",
2166
3420
  "name": "Y",
2167
3421
  "required": true,
@@ -2171,7 +3425,7 @@
2171
3425
  {
2172
3426
  "disabled": false,
2173
3427
  "document": "Width",
2174
- "example": "",
3428
+ "example": "169",
2175
3429
  "member": "int64",
2176
3430
  "name": "Width",
2177
3431
  "required": true,
@@ -2181,7 +3435,7 @@
2181
3435
  {
2182
3436
  "disabled": false,
2183
3437
  "document": "Height",
2184
- "example": "",
3438
+ "example": "63",
2185
3439
  "member": "int64",
2186
3440
  "name": "Height",
2187
3441
  "required": true,
@@ -4669,6 +5923,89 @@
4669
5923
  ],
4670
5924
  "usage": "out"
4671
5925
  },
5926
+ "RecognizeBrazilCommonOCRRequest": {
5927
+ "document": "RecognizeBrazilCommonOCR request structure.",
5928
+ "members": [
5929
+ {
5930
+ "disabled": false,
5931
+ "document": "The Base64 value of the image. supported image formats: PNG, JPG, JPEG. GIF format is not currently supported. supported image size: no more than 7M after encoding. image download time: no more than 3 seconds.",
5932
+ "example": "11",
5933
+ "member": "string",
5934
+ "name": "ImageBase64",
5935
+ "required": false,
5936
+ "type": "string"
5937
+ },
5938
+ {
5939
+ "disabled": false,
5940
+ "document": "The Url of the image. supported image formats: PNG, JPG, JPEG. GIF format is not currently supported. supported image size: no more than 7M after Base64 encoding. image download time is no more than 3 seconds. urls stored in tencent cloud guarantee higher download speed and stability. it is advisable to store images in tencent cloud. urls not stored in tencent cloud may possibly be impacted in speed and stability.",
5941
+ "example": "http://zzxxxx.x.xxx",
5942
+ "member": "string",
5943
+ "name": "ImageUrl",
5944
+ "required": false,
5945
+ "type": "string"
5946
+ },
5947
+ {
5948
+ "disabled": false,
5949
+ "document": "The Base64 value of the back side of the card. supported image formats: PNG, JPG, JPEG. GIF format is not currently supported. supported image size: no more than 7M after encoding. image download time: not more than 3 seconds. either ImageUrl or ImageBase64 must be provided. if both are provided, only use ImageUrl.",
5950
+ "example": "11",
5951
+ "member": "string",
5952
+ "name": "BackImageBase64",
5953
+ "required": false,
5954
+ "type": "string"
5955
+ },
5956
+ {
5957
+ "disabled": false,
5958
+ "document": "The Url address of the back side of the card. supported image formats: PNG, JPG, JPEG. GIF format is not currently supported. supported image size: no more than 7M after Base64 encoding. image download time is no more than 3 seconds. urls stored in tencent cloud guarantee higher download speed and stability. it is recommended to store images in tencent cloud. speed and stability of non-tencent cloud storage urls may be impacted.",
5959
+ "example": "11",
5960
+ "member": "string",
5961
+ "name": "BackImageUrl",
5962
+ "required": false,
5963
+ "type": "string"
5964
+ },
5965
+ {
5966
+ "disabled": false,
5967
+ "document": "Specifies whether to return the portrait photo.",
5968
+ "example": "true",
5969
+ "member": "bool",
5970
+ "name": "ReturnHeadImage",
5971
+ "required": false,
5972
+ "type": "bool"
5973
+ }
5974
+ ],
5975
+ "type": "object"
5976
+ },
5977
+ "RecognizeBrazilCommonOCRResponse": {
5978
+ "document": "RecognizeBrazilCommonOCR response structure.",
5979
+ "members": [
5980
+ {
5981
+ "disabled": false,
5982
+ "document": "Specifies the type of document in brazil. valid values: 1. RNE 2. RNM 3. IDCard 4. DrivingLicense.",
5983
+ "example": "1",
5984
+ "member": "uint64",
5985
+ "name": "Type",
5986
+ "output_required": false,
5987
+ "type": "int",
5988
+ "value_allowed_null": false
5989
+ },
5990
+ {
5991
+ "disabled": false,
5992
+ "document": "Identifies the content of a brazil document.",
5993
+ "example": "无",
5994
+ "member": "BrazilCardInfo",
5995
+ "name": "Result",
5996
+ "output_required": false,
5997
+ "type": "object",
5998
+ "value_allowed_null": false
5999
+ },
6000
+ {
6001
+ "document": "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.",
6002
+ "member": "string",
6003
+ "name": "RequestId",
6004
+ "type": "string"
6005
+ }
6006
+ ],
6007
+ "type": "object"
6008
+ },
4672
6009
  "RecognizeBrazilDriverLicenseOCRRequest": {
4673
6010
  "document": "RecognizeBrazilDriverLicenseOCR request structure.",
4674
6011
  "members": [
@@ -5531,6 +6868,52 @@
5531
6868
  ],
5532
6869
  "type": "object"
5533
6870
  },
6871
+ "RecognizeDetectCardCoordsRequest": {
6872
+ "document": "RecognizeDetectCardCoords request structure.",
6873
+ "members": [
6874
+ {
6875
+ "disabled": false,
6876
+ "document": "The Url of the image. supported image formats: PNG, JPG, JPEG. GIF format is not currently supported. supported image size: the downloaded image should be no more than 7M after Base64 encoding. image download time should be no more than 3 seconds. images stored in tencent cloud's urls guarantee higher download speed and stability. it is recommended to store images in tencent cloud. the speed and stability of non-tencent cloud storage urls may be impacted.",
6877
+ "example": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/url.jpg",
6878
+ "member": "string",
6879
+ "name": "ImageUrl",
6880
+ "required": false,
6881
+ "type": "string"
6882
+ },
6883
+ {
6884
+ "disabled": false,
6885
+ "document": "The Base64 value of the image. supported image formats: PNG, JPG, JPEG. GIF format is not currently supported. supported image size: no more than 7M after the downloaded image is encoded in Base64. image download time is not more than 3 seconds. either ImageUrl or ImageBase64 must be provided. if both are provided, only use ImageUrl.",
6886
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
6887
+ "member": "string",
6888
+ "name": "ImageBase64",
6889
+ "required": false,
6890
+ "type": "string"
6891
+ }
6892
+ ],
6893
+ "type": "object"
6894
+ },
6895
+ "RecognizeDetectCardCoordsResponse": {
6896
+ "document": "RecognizeDetectCardCoords response structure.",
6897
+ "members": [
6898
+ {
6899
+ "disabled": false,
6900
+ "document": "Detected coordinate information.",
6901
+ "example": "无",
6902
+ "member": "CoordsItem",
6903
+ "name": "ItemList",
6904
+ "output_required": true,
6905
+ "type": "list",
6906
+ "value_allowed_null": false
6907
+ },
6908
+ {
6909
+ "document": "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.",
6910
+ "member": "string",
6911
+ "name": "RequestId",
6912
+ "type": "string"
6913
+ }
6914
+ ],
6915
+ "type": "object"
6916
+ },
5534
6917
  "RecognizeGeneralInvoiceRequest": {
5535
6918
  "document": "RecognizeGeneralInvoice request structure.",
5536
6919
  "members": [
@@ -6386,7 +7769,7 @@
6386
7769
  {
6387
7770
  "disabled": false,
6388
7771
  "document": "The Base64 value of the image. The image is required to be no larger than 7M after Base64 encoding, and the resolution is recommended to be 500*800 or above. PNG, JPG, JPEG, and BMP formats are supported. It is recommended that the card part occupies at least 2/3 of the picture. One of ImageUrl and ImageBase64 of the image must be provided. If both are provided, only ImageUrl will be used.",
6389
- "example": "",
7772
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
6390
7773
  "member": "string",
6391
7774
  "name": "ImageBase64",
6392
7775
  "required": false,
@@ -6395,7 +7778,7 @@
6395
7778
  {
6396
7779
  "disabled": false,
6397
7780
  "document": "The URL address of the image. The image is required to be no larger than 7M after Base64 encoding, and the resolution is recommended to be 500*800 or above. PNG, JPG, JPEG, and BMP formats are supported. It is recommended that the card part occupies at least 2/3 of the picture. It is recommended that images be stored in Tencent Cloud to ensure higher download speed and stability.",
6398
- "example": "https://xx/a.jpg",
7781
+ "example": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/fakeurl.jpg",
6399
7782
  "member": "string",
6400
7783
  "name": "ImageUrl",
6401
7784
  "required": false,
@@ -6487,7 +7870,7 @@
6487
7870
  {
6488
7871
  "disabled": false,
6489
7872
  "document": "ID number (portrait side)",
6490
- "example": "440524198701010014",
7873
+ "example": "440********010014",
6491
7874
  "member": "string",
6492
7875
  "name": "IdNum",
6493
7876
  "output_required": true,
@@ -6497,7 +7880,7 @@
6497
7880
  {
6498
7881
  "disabled": false,
6499
7882
  "document": "Card authority(national emblem side)",
6500
- "example": "",
7883
+ "example": "深圳市公安局宝安分局",
6501
7884
  "member": "string",
6502
7885
  "name": "Authority",
6503
7886
  "output_required": true,
@@ -6507,7 +7890,7 @@
6507
7890
  {
6508
7891
  "disabled": false,
6509
7892
  "document": "Card valid date (national emblem side)",
6510
- "example": "",
7893
+ "example": "2016.02.20-2036.02.20",
6511
7894
  "member": "string",
6512
7895
  "name": "ValidDate",
6513
7896
  "output_required": true,
@@ -6517,7 +7900,7 @@
6517
7900
  {
6518
7901
  "disabled": false,
6519
7902
  "document": "Card Warning Information\n\n-9101 Alarm for covered certificate,\n-9102 Alarm for photocopied certificate,\n-9103 Alarm for photographed certificate,\n-9104 Alarm for PS certificate,\n-9107 Alarm for reflective certificate,\n-9108 Alarm for blurry image,\n-9109 This capability is not enabled.",
6520
- "example": "",
7903
+ "example": "[-9109]",
6521
7904
  "member": "int64",
6522
7905
  "name": "WarnCardInfos",
6523
7906
  "output_required": true,
@@ -6527,7 +7910,7 @@
6527
7910
  {
6528
7911
  "disabled": false,
6529
7912
  "document": "Portrait image base64",
6530
- "example": "",
7913
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
6531
7914
  "member": "string",
6532
7915
  "name": "PortraitImage",
6533
7916
  "output_required": true,
@@ -6537,7 +7920,7 @@
6537
7920
  {
6538
7921
  "disabled": false,
6539
7922
  "document": "ID card photo cropping results base64",
6540
- "example": "",
7923
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
6541
7924
  "member": "string",
6542
7925
  "name": "IdCardImage",
6543
7926
  "output_required": true,
@@ -10115,7 +11498,7 @@
10115
11498
  "example": "* 2 1 0 0 0 5 8 9 8 1 2 4 *",
10116
11499
  "member": "string",
10117
11500
  "name": "AutoContent",
10118
- "required": false,
11501
+ "output_required": true,
10119
11502
  "type": "string",
10120
11503
  "value_allowed_null": false
10121
11504
  },
@@ -10125,7 +11508,7 @@
10125
11508
  "example": "无",
10126
11509
  "member": "Polygon",
10127
11510
  "name": "Coord",
10128
- "required": false,
11511
+ "output_required": true,
10129
11512
  "type": "object",
10130
11513
  "value_allowed_null": true
10131
11514
  }