tccli-intl-en 3.0.1237.1__py2.py3-none-any.whl → 3.0.1282.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 (214) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +17 -1
  3. tccli/services/advisor/advisor_client.py +8 -2
  4. tccli/services/aiart/aiart_client.py +4 -1
  5. tccli/services/ams/ams_client.py +16 -4
  6. tccli/services/antiddos/antiddos_client.py +280 -70
  7. tccli/services/apigateway/apigateway_client.py +372 -93
  8. tccli/services/apm/apm_client.py +52 -13
  9. tccli/services/asr/asr_client.py +8 -2
  10. tccli/services/autoscaling/autoscaling_client.py +232 -58
  11. tccli/services/autoscaling/v20180419/api.json +1 -1
  12. tccli/services/batch/batch_client.py +112 -28
  13. tccli/services/bi/bi_client.py +1242 -4
  14. tccli/services/bi/v20220105/api.json +5340 -107
  15. tccli/services/bi/v20220105/examples.json +196 -1
  16. tccli/services/billing/billing_client.py +168 -42
  17. tccli/services/cam/cam_client.py +324 -81
  18. tccli/services/captcha/captcha_client.py +4 -1
  19. tccli/services/car/car_client.py +132 -33
  20. tccli/services/cbs/cbs_client.py +152 -38
  21. tccli/services/ccc/ccc_client.py +732 -98
  22. tccli/services/ccc/v20200210/api.json +1727 -196
  23. tccli/services/ccc/v20200210/examples.json +64 -0
  24. tccli/services/cdb/cdb_client.py +532 -133
  25. tccli/services/cdc/cdc_client.py +80 -20
  26. tccli/services/cdc/v20201214/api.json +2 -2
  27. tccli/services/cdc/v20201214/examples.json +4 -4
  28. tccli/services/cdn/cdn_client.py +176 -44
  29. tccli/services/cdwdoris/cdwdoris_client.py +308 -77
  30. tccli/services/cdwpg/cdwpg_client.py +96 -24
  31. tccli/services/cdz/__init__.py +4 -0
  32. tccli/services/cdz/cdz_client.py +210 -0
  33. tccli/services/cdz/v20221123/api.json +233 -0
  34. tccli/services/cdz/v20221123/examples.json +12 -0
  35. tccli/services/cfg/cfg_client.py +64 -16
  36. tccli/services/cfs/cfs_client.py +156 -39
  37. tccli/services/cfw/cfw_client.py +264 -66
  38. tccli/services/chdfs/chdfs_client.py +116 -29
  39. tccli/services/ciam/ciam_client.py +64 -16
  40. tccli/services/ckafka/ckafka_client.py +575 -77
  41. tccli/services/ckafka/v20190819/api.json +2749 -1470
  42. tccli/services/ckafka/v20190819/examples.json +209 -155
  43. tccli/services/clb/clb_client.py +332 -83
  44. tccli/services/clb/v20180317/api.json +29 -14
  45. tccli/services/cloudaudit/cloudaudit_client.py +72 -18
  46. tccli/services/cls/cls_client.py +348 -87
  47. tccli/services/cmq/cmq_client.py +12 -801
  48. tccli/services/cmq/v20190304/api.json +173 -1367
  49. tccli/services/cmq/v20190304/examples.json +0 -120
  50. tccli/services/config/config_client.py +24 -6
  51. tccli/services/controlcenter/controlcenter_client.py +4 -1
  52. tccli/services/csip/csip_client.py +136 -34
  53. tccli/services/ctsdb/ctsdb_client.py +8 -2
  54. tccli/services/cvm/cvm_client.py +627 -110
  55. tccli/services/cvm/v20170312/api.json +750 -340
  56. tccli/services/cvm/v20170312/examples.json +105 -59
  57. tccli/services/cwp/cwp_client.py +1860 -465
  58. tccli/services/cynosdb/cynosdb_client.py +1749 -439
  59. tccli/services/cynosdb/v20190107/api.json +11763 -7697
  60. tccli/services/cynosdb/v20190107/examples.json +132 -4
  61. tccli/services/dataintegration/dataintegration_client.py +4 -1
  62. tccli/services/dayu/dayu_client.py +412 -103
  63. tccli/services/dbbrain/dbbrain_client.py +168 -42
  64. tccli/services/dc/dc_client.py +72 -18
  65. tccli/services/dcdb/dcdb_client.py +248 -62
  66. tccli/services/dlc/dlc_client.py +756 -111
  67. tccli/services/dlc/v20210125/api.json +637 -13
  68. tccli/services/dlc/v20210125/examples.json +48 -0
  69. tccli/services/dms/dms_client.py +8 -2
  70. tccli/services/dnspod/dnspod_client.py +353 -74
  71. tccli/services/dnspod/v20210323/api.json +196 -0
  72. tccli/services/dnspod/v20210323/examples.json +24 -0
  73. tccli/services/domain/domain_client.py +96 -24
  74. tccli/services/dts/dts_client.py +332 -83
  75. tccli/services/eb/eb_client.py +104 -26
  76. tccli/services/ecdn/ecdn_client.py +60 -15
  77. tccli/services/ecm/ecm_client.py +496 -124
  78. tccli/services/eiam/eiam_client.py +160 -40
  79. tccli/services/emr/emr_client.py +2784 -115
  80. tccli/services/emr/v20190103/api.json +14647 -4756
  81. tccli/services/emr/v20190103/examples.json +408 -40
  82. tccli/services/es/es_client.py +84 -21
  83. tccli/services/facefusion/facefusion_client.py +12 -3
  84. tccli/services/faceid/faceid_client.py +76 -19
  85. tccli/services/faceid/v20180301/api.json +79 -14
  86. tccli/services/faceid/v20180301/examples.json +3 -3
  87. tccli/services/gaap/gaap_client.py +352 -88
  88. tccli/services/gme/gme_client.py +40 -10
  89. tccli/services/gpm/gpm_client.py +72 -18
  90. tccli/services/gse/gse_client.py +88 -22
  91. tccli/services/gwlb/gwlb_client.py +72 -18
  92. tccli/services/iai/iai_client.py +116 -29
  93. tccli/services/iap/iap_client.py +24 -6
  94. tccli/services/ims/ims_client.py +4 -1
  95. tccli/services/intlpartnersmgt/intlpartnersmgt_client.py +168 -42
  96. tccli/services/intlpartnersmgt/v20220928/api.json +11 -11
  97. tccli/services/iotcloud/iotcloud_client.py +80 -20
  98. tccli/services/ip/ip_client.py +24 -6
  99. tccli/services/kms/kms_client.py +272 -68
  100. tccli/services/lcic/lcic_client.py +212 -53
  101. tccli/services/lighthouse/lighthouse_client.py +296 -74
  102. tccli/services/lighthouse/v20200324/api.json +14 -14
  103. tccli/services/lighthouse/v20200324/examples.json +5 -5
  104. tccli/services/live/live_client.py +480 -120
  105. tccli/services/lke/lke_client.py +360 -90
  106. tccli/services/lke/v20231130/api.json +182 -39
  107. tccli/services/lkeap/__init__.py +4 -0
  108. tccli/services/lkeap/lkeap_client.py +546 -0
  109. tccli/services/lkeap/v20240522/api.json +855 -0
  110. tccli/services/lkeap/v20240522/examples.json +72 -0
  111. tccli/services/mariadb/mariadb_client.py +200 -50
  112. tccli/services/mdc/mdc_client.py +72 -18
  113. tccli/services/mdl/mdl_client.py +132 -33
  114. tccli/services/mdl/v20200326/api.json +186 -12
  115. tccli/services/mdl/v20200326/examples.json +16 -16
  116. tccli/services/mdp/mdp_client.py +680 -70
  117. tccli/services/mdp/v20200527/api.json +748 -23
  118. tccli/services/mdp/v20200527/examples.json +143 -79
  119. tccli/services/message/__init__.py +4 -0
  120. tccli/services/message/message_client.py +210 -0
  121. tccli/services/message/v20181225/api.json +72 -0
  122. tccli/services/message/v20181225/examples.json +13 -0
  123. tccli/services/mongodb/mongodb_client.py +340 -29
  124. tccli/services/mongodb/v20190725/api.json +811 -226
  125. tccli/services/mongodb/v20190725/examples.json +54 -22
  126. tccli/services/monitor/monitor_client.py +864 -152
  127. tccli/services/monitor/v20180724/api.json +657 -8
  128. tccli/services/monitor/v20180724/examples.json +152 -4
  129. tccli/services/mps/mps_client.py +592 -92
  130. tccli/services/mps/v20190612/api.json +2931 -399
  131. tccli/services/mps/v20190612/examples.json +64 -14
  132. tccli/services/msp/msp_client.py +28 -7
  133. tccli/services/ocr/ocr_client.py +212 -45
  134. tccli/services/ocr/v20181119/api.json +872 -112
  135. tccli/services/ocr/v20181119/examples.json +12 -4
  136. tccli/services/omics/omics_client.py +80 -20
  137. tccli/services/organization/organization_client.py +464 -116
  138. tccli/services/postgres/postgres_client.py +364 -91
  139. tccli/services/postgres/v20170312/api.json +134 -109
  140. tccli/services/postgres/v20170312/examples.json +14 -14
  141. tccli/services/privatedns/privatedns_client.py +124 -31
  142. tccli/services/pts/pts_client.py +192 -48
  143. tccli/services/quota/__init__.py +4 -0
  144. tccli/services/quota/quota_client.py +434 -0
  145. tccli/services/quota/v20241204/api.json +548 -0
  146. tccli/services/quota/v20241204/examples.json +51 -0
  147. tccli/services/rce/rce_client.py +4 -1
  148. tccli/services/redis/redis_client.py +592 -106
  149. tccli/services/redis/v20180412/api.json +636 -240
  150. tccli/services/redis/v20180412/examples.json +98 -56
  151. tccli/services/region/region_client.py +12 -3
  152. tccli/services/rum/rum_client.py +240 -60
  153. tccli/services/scf/scf_client.py +168 -42
  154. tccli/services/ses/ses_client.py +116 -29
  155. tccli/services/sms/sms_client.py +72 -18
  156. tccli/services/sqlserver/sqlserver_client.py +3772 -387
  157. tccli/services/sqlserver/v20180328/api.json +9760 -3380
  158. tccli/services/sqlserver/v20180328/examples.json +478 -18
  159. tccli/services/ssl/ssl_client.py +152 -38
  160. tccli/services/ssm/ssm_client.py +96 -24
  161. tccli/services/sts/sts_client.py +20 -5
  162. tccli/services/tag/tag_client.py +120 -30
  163. tccli/services/tat/tat_client.py +76 -19
  164. tccli/services/tbaas/tbaas_client.py +16 -4
  165. tccli/services/tcaplusdb/tcaplusdb_client.py +208 -52
  166. tccli/services/tcaplusdb/v20190823/api.json +836 -760
  167. tccli/services/tcaplusdb/v20190823/examples.json +3 -3
  168. tccli/services/tchd/tchd_client.py +4 -1
  169. tccli/services/tcmpp/tcmpp_client.py +416 -104
  170. tccli/services/tcr/tcr_client.py +304 -76
  171. tccli/services/tcsas/tcsas_client.py +236 -59
  172. tccli/services/tcsas/v20250106/api.json +155 -79
  173. tccli/services/tcsas/v20250106/examples.json +3 -3
  174. tccli/services/tcss/tcss_client.py +1320 -330
  175. tccli/services/tdid/tdid_client.py +192 -48
  176. tccli/services/tdmq/tdmq_client.py +376 -94
  177. tccli/services/tem/tem_client.py +224 -56
  178. tccli/services/teo/teo_client.py +1127 -245
  179. tccli/services/teo/v20220901/api.json +382 -58
  180. tccli/services/teo/v20220901/examples.json +24 -0
  181. tccli/services/tione/__init__.py +4 -0
  182. tccli/services/tione/tione_client.py +210 -0
  183. tccli/services/tione/v20211111/api.json +3074 -0
  184. tccli/services/tione/v20211111/examples.json +12 -0
  185. tccli/services/tiw/tiw_client.py +204 -51
  186. tccli/services/tke/tke_client.py +552 -138
  187. tccli/services/tms/tms_client.py +4 -1
  188. tccli/services/tmt/tmt_client.py +4 -1
  189. tccli/services/trabbit/trabbit_client.py +116 -29
  190. tccli/services/trro/trro_client.py +76 -19
  191. tccli/services/trtc/trtc_client.py +420 -55
  192. tccli/services/trtc/v20190722/api.json +685 -23
  193. tccli/services/trtc/v20190722/examples.json +39 -7
  194. tccli/services/tts/tts_client.py +4 -1
  195. tccli/services/vclm/vclm_client.py +8 -2
  196. tccli/services/vm/vm_client.py +16 -4
  197. tccli/services/vod/v20180717/examples.json +1 -1
  198. tccli/services/vod/vod_client.py +716 -179
  199. tccli/services/vpc/v20170312/api.json +970 -75
  200. tccli/services/vpc/v20170312/examples.json +106 -10
  201. tccli/services/vpc/vpc_client.py +1876 -361
  202. tccli/services/waf/v20180125/api.json +1372 -194
  203. tccli/services/waf/v20180125/examples.json +89 -1
  204. tccli/services/waf/waf_client.py +1051 -147
  205. tccli/services/wedata/v20250806/api.json +13644 -0
  206. tccli/services/wedata/v20250806/examples.json +621 -0
  207. tccli/services/wedata/wedata_client.py +5830 -1026
  208. tccli/services/yunjing/yunjing_client.py +284 -71
  209. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/METADATA +4 -7
  210. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/RECORD +214 -192
  211. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/WHEEL +1 -1
  212. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/entry_points.txt +0 -1
  213. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/LICENSE +0 -0
  214. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/top_level.txt +0 -0
@@ -84,6 +84,13 @@
84
84
  "output": "PermitOCRResponse",
85
85
  "status": "online"
86
86
  },
87
+ "RecognizeBrazilCommonOCR": {
88
+ "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.",
89
+ "input": "RecognizeBrazilCommonOCRRequest",
90
+ "name": "Recognizes a brazil common document",
91
+ "output": "RecognizeBrazilCommonOCRResponse",
92
+ "status": "online"
93
+ },
87
94
  "RecognizeBrazilDriverLicenseOCR": {
88
95
  "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
96
  "input": "RecognizeBrazilDriverLicenseOCRRequest",
@@ -148,7 +155,7 @@
148
155
  "status": "online"
149
156
  },
150
157
  "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",
158
+ "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
159
  "input": "RecognizeMainlandIDCardOCRRequest",
153
160
  "name": "Mainland ID Card OCR",
154
161
  "output": "RecognizeMainlandIDCardOCRResponse",
@@ -526,171 +533,841 @@
526
533
  },
527
534
  {
528
535
  "disabled": false,
529
- "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 7 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.",
530
- "example": "https://xx/a.jpg",
536
+ "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 7 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.",
537
+ "example": "https://xx/a.jpg",
538
+ "member": "string",
539
+ "name": "ImageUrl",
540
+ "required": false,
541
+ "type": "string"
542
+ },
543
+ {
544
+ "disabled": false,
545
+ "document": "Whether to return the bank card image data after preprocessing (precise cropping and alignment). Default value: `false`",
546
+ "example": "false",
547
+ "member": "bool",
548
+ "name": "RetBorderCutImage",
549
+ "required": false,
550
+ "type": "bool"
551
+ },
552
+ {
553
+ "disabled": false,
554
+ "document": "Whether to return the card number image data after slicing. Default value: `false`",
555
+ "example": "false",
556
+ "member": "bool",
557
+ "name": "RetCardNoImage",
558
+ "required": false,
559
+ "type": "bool"
560
+ },
561
+ {
562
+ "disabled": false,
563
+ "document": "Whether to enable photocopy check. If the input image is a bank card photocopy, an alarm will be returned. Default value: `false`",
564
+ "example": "false",
565
+ "member": "bool",
566
+ "name": "EnableCopyCheck",
567
+ "required": false,
568
+ "type": "bool"
569
+ },
570
+ {
571
+ "disabled": false,
572
+ "document": "Whether to enable photograph check. If the input image is a bank card photograph, an alarm will be returned. Default value: `false`",
573
+ "example": "false",
574
+ "member": "bool",
575
+ "name": "EnableReshootCheck",
576
+ "required": false,
577
+ "type": "bool"
578
+ },
579
+ {
580
+ "disabled": false,
581
+ "document": "Whether to enable obscured border check. If the input image is a bank card with obscured border, an alarm will be returned. Default value: `false`",
582
+ "example": "false",
583
+ "member": "bool",
584
+ "name": "EnableBorderCheck",
585
+ "required": false,
586
+ "type": "bool"
587
+ },
588
+ {
589
+ "disabled": false,
590
+ "document": "Whether to return the image quality value, which measures how clear an image is. Default value: `false`",
591
+ "example": "false",
592
+ "member": "bool",
593
+ "name": "EnableQualityValue",
594
+ "required": false,
595
+ "type": "bool"
596
+ }
597
+ ],
598
+ "type": "object"
599
+ },
600
+ "BankCardOCRResponse": {
601
+ "document": "BankCardOCR response structure.",
602
+ "members": [
603
+ {
604
+ "disabled": false,
605
+ "document": "Card number",
606
+ "example": "6225768888888888",
607
+ "member": "string",
608
+ "name": "CardNo",
609
+ "required": true,
610
+ "type": "string",
611
+ "value_allowed_null": false
612
+ },
613
+ {
614
+ "disabled": false,
615
+ "document": "Bank information",
616
+ "example": "招商银行(03080000)",
617
+ "member": "string",
618
+ "name": "BankInfo",
619
+ "required": true,
620
+ "type": "string",
621
+ "value_allowed_null": false
622
+ },
623
+ {
624
+ "disabled": false,
625
+ "document": "Expiration date. Format: 07/2023",
626
+ "example": "07/2023",
627
+ "member": "string",
628
+ "name": "ValidDate",
629
+ "required": true,
630
+ "type": "string",
631
+ "value_allowed_null": false
632
+ },
633
+ {
634
+ "disabled": false,
635
+ "document": "Card type",
636
+ "example": "贷记卡",
637
+ "member": "string",
638
+ "name": "CardType",
639
+ "required": true,
640
+ "type": "string",
641
+ "value_allowed_null": false
642
+ },
643
+ {
644
+ "disabled": false,
645
+ "document": "Card name",
646
+ "example": "招商银行信用卡",
647
+ "member": "string",
648
+ "name": "CardName",
649
+ "required": true,
650
+ "type": "string",
651
+ "value_allowed_null": false
652
+ },
653
+ {
654
+ "disabled": false,
655
+ "document": "Sliced image data\nNote: this field may return `null`, indicating that no valid values can be obtained.",
656
+ "example": "无",
657
+ "member": "string",
658
+ "name": "BorderCutImage",
659
+ "required": true,
660
+ "type": "string",
661
+ "value_allowed_null": true
662
+ },
663
+ {
664
+ "disabled": false,
665
+ "document": "Card number image data\nNote: this field may return `null`, indicating that no valid values can be obtained.",
666
+ "example": "无",
667
+ "member": "string",
668
+ "name": "CardNoImage",
669
+ "required": true,
670
+ "type": "string",
671
+ "value_allowed_null": true
672
+ },
673
+ {
674
+ "disabled": false,
675
+ "document": "Warning code:\n-9110: the bank card date is invalid. \n-9111: the bank card border is incomplete. \n-9112: the bank card image is reflective.\n-9113: the bank card image is a photocopy.\n-9114: the bank card image is a photograph.\nMultiple warning codes may be returned at a time.\nNote: this field may return `null`, indicating that no valid values can be obtained.",
676
+ "example": "[-9110]",
677
+ "member": "int64",
678
+ "name": "WarningCode",
679
+ "required": true,
680
+ "type": "list",
681
+ "value_allowed_null": true
682
+ },
683
+ {
684
+ "disabled": false,
685
+ "document": "Image quality value, which is returned when `EnableQualityValue` is set to `true`. The smaller the value, the less clear the image is. Value range: 0−100 (a threshold greater than or equal to 50 is recommended.)\nNote: This field may return `null`, indicating that no valid values can be obtained.",
686
+ "example": "90",
687
+ "member": "int64",
688
+ "name": "QualityValue",
689
+ "required": true,
690
+ "type": "int",
691
+ "value_allowed_null": true
692
+ },
693
+ {
694
+ "document": "The unique request ID, which is returned for each request. RequestId is required for locating a problem.",
695
+ "member": "string",
696
+ "name": "RequestId",
697
+ "type": "string"
698
+ }
699
+ ],
700
+ "type": "object"
701
+ },
702
+ "BrazilCardInfo": {
703
+ "document": "Type of document in brazil.",
704
+ "members": [
705
+ {
706
+ "disabled": false,
707
+ "document": "RNE document.\nNote: This field may return null, indicating that no valid values can be obtained.",
708
+ "example": "无",
709
+ "member": "BrazilRNEInfo",
710
+ "name": "RNE",
711
+ "output_required": false,
712
+ "type": "object",
713
+ "value_allowed_null": true
714
+ },
715
+ {
716
+ "disabled": false,
717
+ "document": "Specifies the document.\nNote: This field may return null, indicating that no valid values can be obtained.",
718
+ "example": "无",
719
+ "member": "BrazilRNMInfo",
720
+ "name": "RNM",
721
+ "output_required": false,
722
+ "type": "object",
723
+ "value_allowed_null": true
724
+ },
725
+ {
726
+ "disabled": false,
727
+ "document": "Driver license document.\nNote: This field may return null, indicating that no valid values can be obtained.",
728
+ "example": "无",
729
+ "member": "BrazilDriverLicenseInfo",
730
+ "name": "DriverLicense",
731
+ "output_required": false,
732
+ "type": "object",
733
+ "value_allowed_null": true
734
+ },
735
+ {
736
+ "disabled": false,
737
+ "document": "ID card document.\nNote: This field may return null, indicating that no valid values can be obtained.",
738
+ "example": "无",
739
+ "member": "BrazilIDCardInfo",
740
+ "name": "IDCard",
741
+ "output_required": false,
742
+ "type": "object",
743
+ "value_allowed_null": true
744
+ }
745
+ ],
746
+ "usage": "out"
747
+ },
748
+ "BrazilDriverLicenseInfo": {
749
+ "document": "Driver'S license type in brazil.",
750
+ "members": [
751
+ {
752
+ "disabled": false,
753
+ "document": "Name.",
754
+ "example": "ZHANG SAN",
755
+ "member": "string",
756
+ "name": "NOME",
757
+ "output_required": false,
758
+ "type": "string",
759
+ "value_allowed_null": false
760
+ },
761
+ {
762
+ "disabled": false,
763
+ "document": "Specifies the driver's license type.",
764
+ "example": "B",
765
+ "member": "string",
766
+ "name": "CatHab",
767
+ "output_required": false,
768
+ "type": "string",
769
+ "value_allowed_null": false
770
+ },
771
+ {
772
+ "disabled": false,
773
+ "document": "Driver’s license id.",
774
+ "example": "23*****110",
775
+ "member": "string",
776
+ "name": "CNHNumber",
777
+ "output_required": false,
778
+ "type": "string",
779
+ "value_allowed_null": false
780
+ },
781
+ {
782
+ "disabled": false,
783
+ "document": "Expiration date.",
784
+ "example": " 07/08/2024",
785
+ "member": "string",
786
+ "name": "VALIDADE",
787
+ "output_required": false,
788
+ "type": "string",
789
+ "value_allowed_null": false
790
+ },
791
+ {
792
+ "disabled": false,
793
+ "document": "Indicates the qualification.",
794
+ "example": " 23/05/2013",
795
+ "member": "string",
796
+ "name": "QUALIFICATION",
797
+ "output_required": false,
798
+ "type": "string",
799
+ "value_allowed_null": false
800
+ },
801
+ {
802
+ "disabled": false,
803
+ "document": "Identity card number.",
804
+ "example": " F048**** DIREX EX",
805
+ "member": "string",
806
+ "name": "IDENTIDADE",
807
+ "output_required": false,
808
+ "type": "string",
809
+ "value_allowed_null": false
810
+ },
811
+ {
812
+ "disabled": false,
813
+ "document": "Tax number of the person.",
814
+ "example": " 238.***.758-75",
815
+ "member": "string",
816
+ "name": "CPF",
817
+ "output_required": false,
818
+ "type": "string",
819
+ "value_allowed_null": false
820
+ },
821
+ {
822
+ "disabled": false,
823
+ "document": "Date of birth.",
824
+ "example": " 28/03/1992",
825
+ "member": "string",
826
+ "name": "NASCIMENTO",
827
+ "output_required": false,
828
+ "type": "string",
829
+ "value_allowed_null": false
830
+ },
831
+ {
832
+ "disabled": false,
833
+ "document": "Membership status.",
834
+ "example": " JINJI PAN/WEIHONG CHEN",
835
+ "member": "string",
836
+ "name": "MEMBERSHIP",
837
+ "output_required": false,
838
+ "type": "string",
839
+ "value_allowed_null": false
840
+ },
841
+ {
842
+ "disabled": false,
843
+ "document": "Registration number.",
844
+ "example": "073****3357",
845
+ "member": "string",
846
+ "name": "REGISTRO",
847
+ "output_required": false,
848
+ "type": "string",
849
+ "value_allowed_null": false
850
+ },
851
+ {
852
+ "disabled": false,
853
+ "document": "Remarks.",
854
+ "example": "A",
855
+ "member": "string",
856
+ "name": "OBSERVATIONS",
857
+ "output_required": false,
858
+ "type": "string",
859
+ "value_allowed_null": false
860
+ },
861
+ {
862
+ "disabled": false,
863
+ "document": "Issue date.",
864
+ "example": "15/02/2022",
865
+ "member": "string",
866
+ "name": "IssueDate",
867
+ "output_required": false,
868
+ "type": "string",
869
+ "value_allowed_null": false
870
+ },
871
+ {
872
+ "disabled": false,
873
+ "document": "Issuing location.",
874
+ "example": " SAO PAULO, SP",
875
+ "member": "string",
876
+ "name": "LOCAL",
877
+ "output_required": false,
878
+ "type": "string",
879
+ "value_allowed_null": false
880
+ },
881
+ {
882
+ "disabled": false,
883
+ "document": "Record number.",
884
+ "example": " 51******489/SP8******10",
885
+ "member": "string",
886
+ "name": "BackNumber",
887
+ "output_required": false,
888
+ "type": "string",
889
+ "value_allowed_null": false
890
+ },
891
+ {
892
+ "disabled": false,
893
+ "document": "Specifies the avatar in base64 format.",
894
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
895
+ "member": "string",
896
+ "name": "PortraitImage",
897
+ "output_required": false,
898
+ "type": "string",
899
+ "value_allowed_null": false
900
+ }
901
+ ],
902
+ "usage": "out"
903
+ },
904
+ "BrazilIDCardInfo": {
905
+ "document": "Specifies the identity card type in brazil.",
906
+ "members": [
907
+ {
908
+ "disabled": false,
909
+ "document": "Name.",
910
+ "example": "JESSINY LIN YAO",
911
+ "member": "string",
912
+ "name": "Nome",
913
+ "output_required": false,
914
+ "type": "string",
915
+ "value_allowed_null": false
916
+ },
917
+ {
918
+ "disabled": false,
919
+ "document": "Parent information.",
920
+ "example": "WENZHEN YAO / LIHUA LIN",
921
+ "member": "string",
922
+ "name": "MemberShip",
923
+ "output_required": false,
924
+ "type": "string",
925
+ "value_allowed_null": false
926
+ },
927
+ {
928
+ "disabled": false,
929
+ "document": "Date of birth.",
930
+ "example": "27/09/2002",
931
+ "member": "string",
932
+ "name": "DataNascimento",
933
+ "output_required": false,
934
+ "type": "string",
935
+ "value_allowed_null": false
936
+ },
937
+ {
938
+ "disabled": false,
939
+ "document": "Issuing organization.",
940
+ "example": "SSP-SP",
941
+ "member": "string",
942
+ "name": "IssuingAgency",
943
+ "output_required": false,
944
+ "type": "string",
945
+ "value_allowed_null": false
946
+ },
947
+ {
948
+ "disabled": false,
949
+ "document": "Specifies the blood type.",
950
+ "example": "A",
951
+ "member": "string",
952
+ "name": "Fatorrh",
953
+ "output_required": false,
954
+ "type": "string",
955
+ "value_allowed_null": false
956
+ },
957
+ {
958
+ "disabled": false,
959
+ "document": "Birthplace.",
960
+ "example": "CORUMBÁ - MS",
961
+ "member": "string",
962
+ "name": "NaturalIDade",
963
+ "output_required": false,
964
+ "type": "string",
965
+ "value_allowed_null": false
966
+ },
967
+ {
968
+ "disabled": false,
969
+ "document": "Remarks.",
970
+ "example": "Observations",
971
+ "member": "string",
972
+ "name": "Observations",
973
+ "output_required": false,
974
+ "type": "string",
975
+ "value_allowed_null": false
976
+ },
977
+ {
978
+ "disabled": false,
979
+ "document": "CPF Type",
980
+ "example": "CPF",
981
+ "member": "string",
982
+ "name": "CPF",
983
+ "output_required": false,
984
+ "type": "string",
985
+ "value_allowed_null": false
986
+ },
987
+ {
988
+ "disabled": false,
989
+ "document": "DNI Type",
990
+ "example": "DNI",
991
+ "member": "string",
992
+ "name": "DNI",
993
+ "output_required": false,
994
+ "type": "string",
995
+ "value_allowed_null": false
996
+ },
997
+ {
998
+ "disabled": false,
999
+ "document": "Common registration.",
1000
+ "example": "38.488.402-7 2 VIA",
1001
+ "member": "string",
1002
+ "name": "RegistroGeral",
1003
+ "output_required": false,
1004
+ "type": "string",
1005
+ "value_allowed_null": false
1006
+ },
1007
+ {
1008
+ "disabled": false,
1009
+ "document": "Issue date. valid values: dd/mm/yyyy.",
1010
+ "example": "22/09/2017",
1011
+ "member": "string",
1012
+ "name": "DispatchDate",
1013
+ "output_required": false,
1014
+ "type": "string",
1015
+ "value_allowed_null": false
1016
+ },
1017
+ {
1018
+ "disabled": false,
1019
+ "document": "Address.",
1020
+ "example": "CORUMBA-MS XXX CN:LV. A163/FLS.184V/N",
1021
+ "member": "string",
1022
+ "name": "Registro",
1023
+ "output_required": false,
1024
+ "type": "string",
1025
+ "value_allowed_null": false
1026
+ },
1027
+ {
1028
+ "disabled": false,
1029
+ "document": "Specifies the avatar in Base64 format of the id card.",
1030
+ "example": "/9j/4AAQSkZJ....AQAAAAB",
1031
+ "member": "string",
1032
+ "name": "PortraitImage",
1033
+ "output_required": false,
1034
+ "type": "string",
1035
+ "value_allowed_null": false
1036
+ },
1037
+ {
1038
+ "disabled": false,
1039
+ "document": "Original identity information.",
1040
+ "example": "XXX-XX xxx DE XXXXXX XX:XX.A91/XX.300/N°11111",
1041
+ "member": "string",
1042
+ "name": "DocOrigem",
1043
+ "output_required": false,
1044
+ "type": "string",
1045
+ "value_allowed_null": false
1046
+ }
1047
+ ],
1048
+ "usage": "out"
1049
+ },
1050
+ "BrazilRNEInfo": {
1051
+ "document": "BrazilRNEInfo",
1052
+ "members": [
1053
+ {
1054
+ "disabled": false,
1055
+ "document": "RNE",
1056
+ "example": "G111111-A",
1057
+ "member": "string",
1058
+ "name": "RNE",
1059
+ "output_required": false,
1060
+ "type": "string",
1061
+ "value_allowed_null": false
1062
+ },
1063
+ {
1064
+ "disabled": false,
1065
+ "document": "CLASSIFICAÇÃO(CLASSIFICATION)",
1066
+ "example": "PERMANENTE",
1067
+ "member": "string",
1068
+ "name": "CLASSIFICATION",
1069
+ "output_required": false,
1070
+ "type": "string",
1071
+ "value_allowed_null": false
1072
+ },
1073
+ {
1074
+ "disabled": false,
1075
+ "document": "VALIDADE",
1076
+ "example": "INDETERMINADA",
1077
+ "member": "string",
1078
+ "name": "VALIDADE",
1079
+ "output_required": false,
1080
+ "type": "string",
1081
+ "value_allowed_null": false
1082
+ },
1083
+ {
1084
+ "disabled": false,
1085
+ "document": "NOME",
1086
+ "example": "HUA LI",
1087
+ "member": "string",
1088
+ "name": "NOME",
1089
+ "output_required": false,
1090
+ "type": "string",
1091
+ "value_allowed_null": false
1092
+ },
1093
+ {
1094
+ "disabled": false,
1095
+ "document": "FILIAÇÃO(MEMBERSHIP)",
1096
+ "example": "DA LI",
1097
+ "member": "string",
1098
+ "name": "Membership",
1099
+ "output_required": false,
1100
+ "type": "string",
1101
+ "value_allowed_null": false
1102
+ },
1103
+ {
1104
+ "disabled": false,
1105
+ "document": "NACIONALIDADE",
1106
+ "example": "CHINESA",
1107
+ "member": "string",
1108
+ "name": "NACIONALIDADE",
1109
+ "output_required": false,
1110
+ "type": "string",
1111
+ "value_allowed_null": false
1112
+ },
1113
+ {
1114
+ "disabled": false,
1115
+ "document": "NATURALIDADE(PAÍS)",
1116
+ "example": "REP.POPULAR DA CHINA",
1117
+ "member": "string",
1118
+ "name": "NATURALIDADE",
1119
+ "output_required": false,
1120
+ "type": "string",
1121
+ "value_allowed_null": false
1122
+ },
1123
+ {
1124
+ "disabled": false,
1125
+ "document": "ORGÃO EXPEDIDOR(IssuingAgency)",
1126
+ "example": "CGPI",
1127
+ "member": "string",
1128
+ "name": "IssuingAgency",
1129
+ "output_required": false,
1130
+ "type": "string",
1131
+ "value_allowed_null": false
1132
+ },
1133
+ {
1134
+ "disabled": false,
1135
+ "document": "DATA DE NASCIMENTO(DateOfBirth)",
1136
+ "example": "01/08/1900",
1137
+ "member": "string",
1138
+ "name": "DateOfBirth",
1139
+ "output_required": false,
1140
+ "type": "string",
1141
+ "value_allowed_null": false
1142
+ },
1143
+ {
1144
+ "disabled": false,
1145
+ "document": "SEXO",
1146
+ "example": "F",
1147
+ "member": "string",
1148
+ "name": "Sex",
1149
+ "output_required": false,
1150
+ "type": "string",
1151
+ "value_allowed_null": false
1152
+ },
1153
+ {
1154
+ "disabled": false,
1155
+ "document": "DATA DE ENTRADA(EntryDate)",
1156
+ "example": "01/08/2000",
1157
+ "member": "string",
1158
+ "name": "EntryDate",
1159
+ "output_required": false,
1160
+ "type": "string",
1161
+ "value_allowed_null": false
1162
+ },
1163
+ {
1164
+ "disabled": false,
1165
+ "document": "VIA",
1166
+ "example": "1",
1167
+ "member": "string",
1168
+ "name": "VIA",
1169
+ "output_required": false,
1170
+ "type": "string",
1171
+ "value_allowed_null": false
1172
+ },
1173
+ {
1174
+ "disabled": false,
1175
+ "document": "DATA DE EXPEDIÇÃO(DispatchDate)",
1176
+ "example": "01/08/2001",
1177
+ "member": "string",
1178
+ "name": "DispatchDate",
1179
+ "output_required": false,
1180
+ "type": "string",
1181
+ "value_allowed_null": false
1182
+ },
1183
+ {
1184
+ "disabled": false,
1185
+ "document": "MRZ",
1186
+ "example": "V1246N 2CHN12 34",
1187
+ "member": "string",
1188
+ "name": "MRZ",
1189
+ "output_required": false,
1190
+ "type": "string",
1191
+ "value_allowed_null": false
1192
+ },
1193
+ {
1194
+ "disabled": false,
1195
+ "document": "PortraitImage",
1196
+ "example": "/9j/4AAQSkZJ....AQAAAAB",
1197
+ "member": "string",
1198
+ "name": "PortraitImage",
1199
+ "output_required": false,
1200
+ "type": "string",
1201
+ "value_allowed_null": false
1202
+ }
1203
+ ],
1204
+ "usage": "out"
1205
+ },
1206
+ "BrazilRNMInfo": {
1207
+ "document": "Document type for brazil RNM.",
1208
+ "members": [
1209
+ {
1210
+ "disabled": false,
1211
+ "document": "SOBRENOME Type",
1212
+ "example": "LI",
531
1213
  "member": "string",
532
- "name": "ImageUrl",
533
- "required": false,
534
- "type": "string"
1214
+ "name": "SOBRENOME",
1215
+ "output_required": false,
1216
+ "type": "string",
1217
+ "value_allowed_null": false
535
1218
  },
536
1219
  {
537
1220
  "disabled": false,
538
- "document": "Whether to return the bank card image data after preprocessing (precise cropping and alignment). Default value: `false`",
539
- "example": "false",
540
- "member": "bool",
541
- "name": "RetBorderCutImage",
542
- "required": false,
543
- "type": "bool"
1221
+ "document": "NOME Type",
1222
+ "example": "HUA",
1223
+ "member": "string",
1224
+ "name": "NOME",
1225
+ "output_required": false,
1226
+ "type": "string",
1227
+ "value_allowed_null": false
544
1228
  },
545
1229
  {
546
1230
  "disabled": false,
547
- "document": "Whether to return the card number image data after slicing. Default value: `false`",
548
- "example": "false",
549
- "member": "bool",
550
- "name": "RetCardNoImage",
551
- "required": false,
552
- "type": "bool"
1231
+ "document": "DATA DE NASCIMENTO",
1232
+ "example": "01/08/1900",
1233
+ "member": "string",
1234
+ "name": "DATADENASCIMENTO",
1235
+ "output_required": false,
1236
+ "type": "string",
1237
+ "value_allowed_null": false
553
1238
  },
554
1239
  {
555
1240
  "disabled": false,
556
- "document": "Whether to enable photocopy check. If the input image is a bank card photocopy, an alarm will be returned. Default value: `false`",
557
- "example": "false",
558
- "member": "bool",
559
- "name": "EnableCopyCheck",
560
- "required": false,
561
- "type": "bool"
1241
+ "document": "SEXO F",
1242
+ "example": "F",
1243
+ "member": "string",
1244
+ "name": "SEXO",
1245
+ "output_required": false,
1246
+ "type": "string",
1247
+ "value_allowed_null": false
562
1248
  },
563
1249
  {
564
1250
  "disabled": false,
565
- "document": "Whether to enable photograph check. If the input image is a bank card photograph, an alarm will be returned. Default value: `false`",
566
- "example": "false",
567
- "member": "bool",
568
- "name": "EnableReshootCheck",
569
- "required": false,
570
- "type": "bool"
1251
+ "document": "FILIAÇÃO(MEMBERSHIP)",
1252
+ "example": "DA LI",
1253
+ "member": "string",
1254
+ "name": "MEMBERSHIP",
1255
+ "output_required": false,
1256
+ "type": "string",
1257
+ "value_allowed_null": false
571
1258
  },
572
1259
  {
573
1260
  "disabled": false,
574
- "document": "Whether to enable obscured border check. If the input image is a bank card with obscured border, an alarm will be returned. Default value: `false`",
575
- "example": "false",
576
- "member": "bool",
577
- "name": "EnableBorderCheck",
578
- "required": false,
579
- "type": "bool"
1261
+ "document": "NACIONALIDADE Type",
1262
+ "example": "CHINESA",
1263
+ "member": "string",
1264
+ "name": "NACIONALIDADE",
1265
+ "output_required": false,
1266
+ "type": "string",
1267
+ "value_allowed_null": false
580
1268
  },
581
1269
  {
582
1270
  "disabled": false,
583
- "document": "Whether to return the image quality value, which measures how clear an image is. Default value: `false`",
584
- "example": "false",
585
- "member": "bool",
586
- "name": "EnableQualityValue",
587
- "required": false,
588
- "type": "bool"
589
- }
590
- ],
591
- "type": "object"
592
- },
593
- "BankCardOCRResponse": {
594
- "document": "BankCardOCR response structure.",
595
- "members": [
596
- {
597
- "disabled": false,
598
- "document": "Card number",
599
- "example": "6225768888888888",
1271
+ "document": "VALIDADE Type",
1272
+ "example": "01/08/2000",
600
1273
  "member": "string",
601
- "name": "CardNo",
602
- "required": true,
1274
+ "name": "VALIDADE",
1275
+ "output_required": false,
603
1276
  "type": "string",
604
1277
  "value_allowed_null": false
605
1278
  },
606
1279
  {
607
1280
  "disabled": false,
608
- "document": "Bank information",
609
- "example": "招商银行(03080000)",
1281
+ "document": "RNM Type",
1282
+ "example": "XAAA56-Y",
610
1283
  "member": "string",
611
- "name": "BankInfo",
612
- "required": true,
1284
+ "name": "RNM",
1285
+ "output_required": false,
613
1286
  "type": "string",
614
1287
  "value_allowed_null": false
615
1288
  },
616
1289
  {
617
1290
  "disabled": false,
618
- "document": "Expiration date. Format: 07/2023",
619
- "example": "07/2023",
1291
+ "document": "CPF Type",
1292
+ "example": "000.000.000-00",
620
1293
  "member": "string",
621
- "name": "ValidDate",
622
- "required": true,
1294
+ "name": "CPF",
1295
+ "output_required": false,
623
1296
  "type": "string",
624
1297
  "value_allowed_null": false
625
1298
  },
626
1299
  {
627
1300
  "disabled": false,
628
- "document": "Card type",
629
- "example": "贷记卡",
1301
+ "document": "CLASSIFICAÇÃO(CLASSIFICATION)",
1302
+ "example": "RESIDENTE",
630
1303
  "member": "string",
631
- "name": "CardType",
632
- "required": true,
1304
+ "name": "CLASSIFICATION",
1305
+ "output_required": false,
633
1306
  "type": "string",
634
1307
  "value_allowed_null": false
635
1308
  },
636
1309
  {
637
1310
  "disabled": false,
638
- "document": "Card name",
639
- "example": "招商银行信用卡",
1311
+ "document": "PRAZO DE RESIDENCIA",
1312
+ "example": "01/08/1950",
640
1313
  "member": "string",
641
- "name": "CardName",
642
- "required": true,
1314
+ "name": "PRAZODERESIDENCIA",
1315
+ "output_required": false,
643
1316
  "type": "string",
644
1317
  "value_allowed_null": false
645
1318
  },
646
1319
  {
647
1320
  "disabled": false,
648
- "document": "Sliced image data\nNote: this field may return `null`, indicating that no valid values can be obtained.",
649
- "example": "",
1321
+ "document": "EMISSÃO(ISSUANCE)",
1322
+ "example": "01/08/1999 CGPI/DIREX/PF",
650
1323
  "member": "string",
651
- "name": "BorderCutImage",
652
- "required": true,
1324
+ "name": "ISSUANCE",
1325
+ "output_required": false,
653
1326
  "type": "string",
654
- "value_allowed_null": true
1327
+ "value_allowed_null": false
655
1328
  },
656
1329
  {
657
1330
  "disabled": false,
658
- "document": "Card number image data\nNote: this field may return `null`, indicating that no valid values can be obtained.",
659
- "example": "",
1331
+ "document": "AMPARO LEGAL(LegalHelp)",
1332
+ "example": "AMPARO LEGAL",
660
1333
  "member": "string",
661
- "name": "CardNoImage",
662
- "required": true,
1334
+ "name": "AMPAROLEGAL",
1335
+ "output_required": false,
663
1336
  "type": "string",
664
- "value_allowed_null": true
1337
+ "value_allowed_null": false
665
1338
  },
666
1339
  {
667
1340
  "disabled": false,
668
- "document": "Warning code:\n-9110: the bank card date is invalid. \n-9111: the bank card border is incomplete. \n-9112: the bank card image is reflective.\n-9113: the bank card image is a photocopy.\n-9114: the bank card image is a photograph.\nMultiple warning codes may be returned at a time.\nNote: this field may return `null`, indicating that no valid values can be obtained.",
669
- "example": "[-9110]",
670
- "member": "int64",
671
- "name": "WarningCode",
672
- "required": true,
673
- "type": "list",
674
- "value_allowed_null": true
1341
+ "document": "MRZCode",
1342
+ "example": "NOMENOME NOME NOME",
1343
+ "member": "string",
1344
+ "name": "MRZ",
1345
+ "output_required": false,
1346
+ "type": "string",
1347
+ "value_allowed_null": false
675
1348
  },
676
1349
  {
677
1350
  "disabled": false,
678
- "document": "Image quality value, which is returned when `EnableQualityValue` is set to `true`. The smaller the value, the less clear the image is. Value range: 0−100 (a threshold greater than or equal to 50 is recommended.)\nNote: This field may return `null`, indicating that no valid values can be obtained.",
679
- "example": "90",
680
- "member": "int64",
681
- "name": "QualityValue",
682
- "required": true,
683
- "type": "int",
684
- "value_allowed_null": true
1351
+ "document": "Portrait Image",
1352
+ "example": "PortraitImage",
1353
+ "member": "string",
1354
+ "name": "PortraitImage",
1355
+ "output_required": false,
1356
+ "type": "string",
1357
+ "value_allowed_null": false
685
1358
  },
686
1359
  {
687
- "document": "The unique request ID, which is returned for each request. RequestId is required for locating a problem.",
1360
+ "disabled": false,
1361
+ "document": "PortraitImage(Back)",
1362
+ "example": "PortraitImageBack",
688
1363
  "member": "string",
689
- "name": "RequestId",
690
- "type": "string"
1364
+ "name": "PortraitImageBack",
1365
+ "output_required": false,
1366
+ "type": "string",
1367
+ "value_allowed_null": false
691
1368
  }
692
1369
  ],
693
- "type": "object"
1370
+ "usage": "out"
694
1371
  },
695
1372
  "BusInvoice": {
696
1373
  "document": "Bus ticket",
@@ -1050,7 +1727,7 @@
1050
1727
  },
1051
1728
  {
1052
1729
  "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",
1730
+ "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
1731
  "example": "General",
1055
1732
  "member": "string",
1056
1733
  "name": "ConfigId",
@@ -1078,7 +1755,7 @@
1078
1755
  {
1079
1756
  "disabled": false,
1080
1757
  "document": "Single attribute configuration of a template.",
1081
- "example": "{\"Scene\": \"only_hw\"}",
1758
+ "example": "",
1082
1759
  "member": "ConfigAdvanced",
1083
1760
  "name": "ConfigAdvanced",
1084
1761
  "required": false,
@@ -1102,7 +1779,7 @@
1102
1779
  {
1103
1780
  "disabled": false,
1104
1781
  "document": "Image rotation angle (angle system). the text's horizontal direction is 0. clockwise is positive; counterclockwise is negative.",
1105
- "example": "0",
1782
+ "example": "0.0",
1106
1783
  "member": "float",
1107
1784
  "name": "Angle",
1108
1785
  "output_required": true,
@@ -4669,6 +5346,89 @@
4669
5346
  ],
4670
5347
  "usage": "out"
4671
5348
  },
5349
+ "RecognizeBrazilCommonOCRRequest": {
5350
+ "document": "RecognizeBrazilCommonOCR request structure.",
5351
+ "members": [
5352
+ {
5353
+ "disabled": false,
5354
+ "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.",
5355
+ "example": "11",
5356
+ "member": "string",
5357
+ "name": "ImageBase64",
5358
+ "required": false,
5359
+ "type": "string"
5360
+ },
5361
+ {
5362
+ "disabled": false,
5363
+ "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.",
5364
+ "example": "http://zzxxxx.x.xxx",
5365
+ "member": "string",
5366
+ "name": "ImageUrl",
5367
+ "required": false,
5368
+ "type": "string"
5369
+ },
5370
+ {
5371
+ "disabled": false,
5372
+ "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.",
5373
+ "example": "11",
5374
+ "member": "string",
5375
+ "name": "BackImageBase64",
5376
+ "required": false,
5377
+ "type": "string"
5378
+ },
5379
+ {
5380
+ "disabled": false,
5381
+ "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.",
5382
+ "example": "11",
5383
+ "member": "string",
5384
+ "name": "BackImageUrl",
5385
+ "required": false,
5386
+ "type": "string"
5387
+ },
5388
+ {
5389
+ "disabled": false,
5390
+ "document": "Specifies whether to return the portrait photo.",
5391
+ "example": "true",
5392
+ "member": "bool",
5393
+ "name": "ReturnHeadImage",
5394
+ "required": false,
5395
+ "type": "bool"
5396
+ }
5397
+ ],
5398
+ "type": "object"
5399
+ },
5400
+ "RecognizeBrazilCommonOCRResponse": {
5401
+ "document": "RecognizeBrazilCommonOCR response structure.",
5402
+ "members": [
5403
+ {
5404
+ "disabled": false,
5405
+ "document": "Specifies the type of document in brazil. valid values: 1. RNE 2. RNM 3. IDCard 4. DrivingLicense.",
5406
+ "example": "1",
5407
+ "member": "uint64",
5408
+ "name": "Type",
5409
+ "output_required": false,
5410
+ "type": "int",
5411
+ "value_allowed_null": false
5412
+ },
5413
+ {
5414
+ "disabled": false,
5415
+ "document": "Identifies the content of a brazil document.",
5416
+ "example": "无",
5417
+ "member": "BrazilCardInfo",
5418
+ "name": "Result",
5419
+ "output_required": false,
5420
+ "type": "object",
5421
+ "value_allowed_null": false
5422
+ },
5423
+ {
5424
+ "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.",
5425
+ "member": "string",
5426
+ "name": "RequestId",
5427
+ "type": "string"
5428
+ }
5429
+ ],
5430
+ "type": "object"
5431
+ },
4672
5432
  "RecognizeBrazilDriverLicenseOCRRequest": {
4673
5433
  "document": "RecognizeBrazilDriverLicenseOCR request structure.",
4674
5434
  "members": [
@@ -6386,7 +7146,7 @@
6386
7146
  {
6387
7147
  "disabled": false,
6388
7148
  "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": "",
7149
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
6390
7150
  "member": "string",
6391
7151
  "name": "ImageBase64",
6392
7152
  "required": false,
@@ -6395,7 +7155,7 @@
6395
7155
  {
6396
7156
  "disabled": false,
6397
7157
  "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",
7158
+ "example": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/fakeurl.jpg",
6399
7159
  "member": "string",
6400
7160
  "name": "ImageUrl",
6401
7161
  "required": false,
@@ -6487,7 +7247,7 @@
6487
7247
  {
6488
7248
  "disabled": false,
6489
7249
  "document": "ID number (portrait side)",
6490
- "example": "440524198701010014",
7250
+ "example": "440********010014",
6491
7251
  "member": "string",
6492
7252
  "name": "IdNum",
6493
7253
  "output_required": true,
@@ -6497,7 +7257,7 @@
6497
7257
  {
6498
7258
  "disabled": false,
6499
7259
  "document": "Card authority(national emblem side)",
6500
- "example": "",
7260
+ "example": "深圳市公安局宝安分局",
6501
7261
  "member": "string",
6502
7262
  "name": "Authority",
6503
7263
  "output_required": true,
@@ -6507,7 +7267,7 @@
6507
7267
  {
6508
7268
  "disabled": false,
6509
7269
  "document": "Card valid date (national emblem side)",
6510
- "example": "",
7270
+ "example": "2016.02.20-2036.02.20",
6511
7271
  "member": "string",
6512
7272
  "name": "ValidDate",
6513
7273
  "output_required": true,
@@ -6517,7 +7277,7 @@
6517
7277
  {
6518
7278
  "disabled": false,
6519
7279
  "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": "",
7280
+ "example": "[-9109]",
6521
7281
  "member": "int64",
6522
7282
  "name": "WarnCardInfos",
6523
7283
  "output_required": true,
@@ -6527,7 +7287,7 @@
6527
7287
  {
6528
7288
  "disabled": false,
6529
7289
  "document": "Portrait image base64",
6530
- "example": "",
7290
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
6531
7291
  "member": "string",
6532
7292
  "name": "PortraitImage",
6533
7293
  "output_required": true,
@@ -6537,7 +7297,7 @@
6537
7297
  {
6538
7298
  "disabled": false,
6539
7299
  "document": "ID card photo cropping results base64",
6540
- "example": "",
7300
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
6541
7301
  "member": "string",
6542
7302
  "name": "IdCardImage",
6543
7303
  "output_required": true,
@@ -10115,7 +10875,7 @@
10115
10875
  "example": "* 2 1 0 0 0 5 8 9 8 1 2 4 *",
10116
10876
  "member": "string",
10117
10877
  "name": "AutoContent",
10118
- "required": false,
10878
+ "output_required": true,
10119
10879
  "type": "string",
10120
10880
  "value_allowed_null": false
10121
10881
  },
@@ -10125,7 +10885,7 @@
10125
10885
  "example": "无",
10126
10886
  "member": "Polygon",
10127
10887
  "name": "Coord",
10128
- "required": false,
10888
+ "output_required": true,
10129
10889
  "type": "object",
10130
10890
  "value_allowed_null": true
10131
10891
  }