tccli-intl-en 3.0.1283.1__py2.py3-none-any.whl → 3.1.8.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 (49) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +6 -0
  3. tccli/services/autoscaling/v20180419/api.json +36 -14
  4. tccli/services/ckafka/ckafka_client.py +288 -8
  5. tccli/services/ckafka/v20190819/api.json +494 -76
  6. tccli/services/ckafka/v20190819/examples.json +45 -5
  7. tccli/services/clb/clb_client.py +636 -300
  8. tccli/services/clb/v20180317/api.json +2255 -1017
  9. tccli/services/clb/v20180317/examples.json +184 -124
  10. tccli/services/controlcenter/controlcenter_client.py +224 -0
  11. tccli/services/controlcenter/v20230110/api.json +528 -5
  12. tccli/services/controlcenter/v20230110/examples.json +32 -0
  13. tccli/services/cvm/v20170312/api.json +41 -41
  14. tccli/services/cvm/v20170312/examples.json +21 -21
  15. tccli/services/faceid/v20180301/api.json +31 -3
  16. tccli/services/kms/v20190118/api.json +80 -3
  17. tccli/services/kms/v20190118/examples.json +3 -3
  18. tccli/services/mdl/v20200326/api.json +165 -5
  19. tccli/services/mongodb/mongodb_client.py +1048 -96
  20. tccli/services/mongodb/v20190725/api.json +1765 -108
  21. tccli/services/mongodb/v20190725/examples.json +136 -0
  22. tccli/services/mps/mps_client.py +713 -209
  23. tccli/services/mps/v20190612/api.json +1009 -67
  24. tccli/services/mps/v20190612/examples.json +100 -52
  25. tccli/services/ocr/ocr_client.py +112 -0
  26. tccli/services/ocr/v20181119/api.json +550 -6
  27. tccli/services/ocr/v20181119/examples.json +22 -0
  28. tccli/services/smh/__init__.py +4 -0
  29. tccli/services/smh/smh_client.py +714 -0
  30. tccli/services/smh/v20210712/api.json +1287 -0
  31. tccli/services/smh/v20210712/examples.json +85 -0
  32. tccli/services/tdmq/tdmq_client.py +2406 -278
  33. tccli/services/tdmq/v20200217/api.json +11607 -3958
  34. tccli/services/tdmq/v20200217/examples.json +562 -264
  35. tccli/services/teo/v20220901/api.json +68 -4
  36. tccli/services/teo/v20220901/examples.json +28 -22
  37. tccli/services/trocket/__init__.py +4 -0
  38. tccli/services/trocket/trocket_client.py +2450 -0
  39. tccli/services/trocket/v20230308/api.json +6062 -0
  40. tccli/services/trocket/v20230308/examples.json +339 -0
  41. tccli/services/trtc/v20190722/api.json +5 -5
  42. tccli/services/vpc/v20170312/api.json +19 -16
  43. tccli/services/vpc/v20170312/examples.json +4 -4
  44. {tccli_intl_en-3.0.1283.1.dist-info → tccli_intl_en-3.1.8.1.dist-info}/METADATA +2 -2
  45. {tccli_intl_en-3.0.1283.1.dist-info → tccli_intl_en-3.1.8.1.dist-info}/RECORD +49 -41
  46. {tccli_intl_en-3.0.1283.1.dist-info → tccli_intl_en-3.1.8.1.dist-info}/LICENSE +0 -0
  47. {tccli_intl_en-3.0.1283.1.dist-info → tccli_intl_en-3.1.8.1.dist-info}/WHEEL +0 -0
  48. {tccli_intl_en-3.0.1283.1.dist-info → tccli_intl_en-3.1.8.1.dist-info}/entry_points.txt +0 -0
  49. {tccli_intl_en-3.0.1283.1.dist-info → tccli_intl_en-3.1.8.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",
@@ -280,6 +294,112 @@
280
294
  "serviceShortName": "ocr"
281
295
  },
282
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
+ },
283
403
  "AirTransport": {
284
404
  "document": "Itinerary/Receipt of e-ticket for air transportation",
285
405
  "members": [
@@ -526,6 +646,97 @@
526
646
  ],
527
647
  "usage": "out"
528
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
+ },
529
740
  "BankCardOCRRequest": {
530
741
  "document": "BankCardOCR request structure.",
531
742
  "members": [
@@ -2183,6 +2394,232 @@
2183
2394
  ],
2184
2395
  "type": "object"
2185
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
2589
+ },
2590
+ {
2591
+ "disabled": false,
2592
+ "document": "Localized name.\nNote: This field may return null, indicating that no valid values can be obtained.",
2593
+ "example": "",
2594
+ "member": "string",
2595
+ "name": "FullNameLocal",
2596
+ "output_required": false,
2597
+ "type": "string",
2598
+ "value_allowed_null": true
2599
+ },
2600
+ {
2601
+ "disabled": 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
2609
+ },
2610
+ {
2611
+ "disabled": false,
2612
+ "document": "Localized surname.\nNote: This field may return null, indicating that no valid values can be obtained.",
2613
+ "example": "",
2614
+ "member": "string",
2615
+ "name": "LastNameLocal",
2616
+ "output_required": false,
2617
+ "type": "string",
2618
+ "value_allowed_null": true
2619
+ }
2620
+ ],
2621
+ "usage": "out"
2622
+ },
2186
2623
  "GeneralMachineItem": {
2187
2624
  "document": "Items of a general machine-printed invoice",
2188
2625
  "members": [
@@ -2269,6 +2706,83 @@
2269
2706
  ],
2270
2707
  "usage": "out"
2271
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
+ },
2272
2786
  "GroupInfo": {
2273
2787
  "document": "The sequence number of an element group in the image",
2274
2788
  "members": [
@@ -2294,7 +2808,7 @@
2294
2808
  "example": "false",
2295
2809
  "member": "bool",
2296
2810
  "name": "ReturnHeadImage",
2297
- "required": true,
2811
+ "required": false,
2298
2812
  "type": "bool"
2299
2813
  },
2300
2814
  {
@@ -2309,7 +2823,7 @@
2309
2823
  {
2310
2824
  "disabled": false,
2311
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.",
2312
- "example": "",
2826
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
2313
2827
  "member": "string",
2314
2828
  "name": "ImageBase64",
2315
2829
  "required": false,
@@ -2318,7 +2832,7 @@
2318
2832
  {
2319
2833
  "disabled": false,
2320
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.",
2321
- "example": "https://xx/a.jpg",
2835
+ "example": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/***/fakeurl.jpg",
2322
2836
  "member": "string",
2323
2837
  "name": "ImageUrl",
2324
2838
  "required": false,
@@ -2442,17 +2956,27 @@
2442
2956
  },
2443
2957
  {
2444
2958
  "disabled": false,
2445
- "document": "Base64-encoded identity photo\nNote: this field may return null, indicating that no valid values can be obtained.",
2446
- "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==",
2447
2961
  "member": "string",
2448
2962
  "name": "HeadImage",
2449
2963
  "output_required": true,
2450
2964
  "type": "string",
2451
2965
  "value_allowed_null": true
2452
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
+ },
2453
2977
  {
2454
2978
  "disabled": true,
2455
- "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.",
2456
2980
  "example": "[-9102,-9103]",
2457
2981
  "member": "int64",
2458
2982
  "name": "WarningCode",
@@ -2470,6 +2994,26 @@
2470
2994
  "type": "list",
2471
2995
  "value_allowed_null": false
2472
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
+ },
2473
3017
  {
2474
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.",
2475
3019
  "member": "string",