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

tccli/services/faceid/v20180301/api.json

@@ -22,7 +22,7 @@
       "status": "online"
     },
     "ApplyWebVerificationBizTokenIntl": {
-      "document": "This API is used to apply for a BizToken before calling the web-based verification service each time. This token is required for initiating a verification process and getting the result after the verification is completed.",
+      "document": "This API is used to obtain a BizToken before each call to the Web verification service. Save the BizToken to initiate the verification process and retrieve the result upon completion. The BizToken is valid for 10 minutes.",
       "input": "ApplyWebVerificationBizTokenIntlRequest",
       "name": "Applies for a BizToken for the web-based verification service",
       "output": "ApplyWebVerificationBizTokenIntlResponse",
@@ -78,7 +78,7 @@
       "status": "online"
     },
     "GetFaceIdResultIntl": {
-      "document": "This API is used to get the verification result with the corresponding SDK token after the identity verification process is completed. The SDK token is valid for two hours (2*3,600s) after generation and can be called multiple times.",
+      "document": "This API is used to get the verification result with the corresponding SDK token after the identity verification process is completed. The SDK token is valid for 72 hours (72*3600s) after generation and can be called multiple times.",
       "input": "GetFaceIdResultIntlRequest",
       "name": "Gets the verification result of liveness detection and face comparison",
       "output": "GetFaceIdResultIntlResponse",
@@ -407,7 +407,7 @@
         },
         {
           "disabled": false,
-          "document": "The identity document type. Valid values: \n1. HK (default): Identity card of Hong Kong (China)\n2. ML: Malaysian identity card\n3. IndonesiaIDCard: Indonesian identity card\n4. PhilippinesVoteID: Philippine voters ID card\n5. PhilippinesDrivingLicense: Philippine driver's license\n6. PhilippinesTinID: Philippine TIN ID card\n7. PhilippinesSSSID: Philippine SSS ID card\n8. PhilippinesUMID: Philippine UMID card\n9. MLIDPassport: Passport issued in Hong Kong/Macao/Taiwan (China) or other countries/regions\n10..MacaoIDCard: Macao ID Card\n11.ThailandIDCard: Thailand ID Card\n12.MainlandIDCard: Mainland ID Card\n13.SingaporeIDCard: Singapore ID Card\n14.JapanIDCard: Japan ID Card\n15.MLDrivingLicense: Malaysian Driving License\n16.IndonesiaDrivingLicense: Indonesia Driving License\n17.ThailandDrivingLicense: Thailand Driving License\n18.SingaporeDrivingLicense: Singapore Driving License\n19.JapanDrivingLicense: Japan Driving License\n20.TaiWanIDCard:Taiwan ID Card\n21.HMTPermit: exit/entry permit (card) for traveling to and from Hong Kong, Macao, or Taiwan",
+          "document": "Specifies the identity document type used for authentication. valid values:.  \n\nHK (default): hong kong (china) identity card.\n2. ML: malaysian identity card.\nIndonesian identity card.\n4. PhilippinesVoteID: specifies the voter card in the philippines.\n5. PhilippinesDrivingLicense: specifies the driving license in philippines.\n6. PhilippinesTinID: specifies the philippines tin id.\n7. PhilippinesSSSID: specifies the SSSID in the philippines.\n8. philippines UMID: specifies the philippines UMID.\n9. MLIDPassport: specifies the passport for hong kong (china), macao (china), and taiwan (china) as well as overseas passports.\nThailandIDCard: specifies the thai identity card.\nMainland id card.\n12. SingaporeIDCard: specifies the Singapore id card.\n13. HMTPermit: specifies the hong kong, macau and taiwan travel permit.",
           "example": "HK",
           "member": "string",
           "name": "IdCardType",
@@ -417,7 +417,7 @@
         {
           "disabled": false,
           "document": "The Base64-encoded value of the photo to compare, which is required only when `CheckMode` is set to `2`.",
-          "example": "无",
+          "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
           "member": "string",
           "name": "CompareImage",
           "required": false,
@@ -450,6 +450,15 @@
           "required": false,
           "type": "bool"
         },
+        {
+          "disabled": false,
+          "document": "Customize which alarm codes to block. If left blank, all alarm codes will be blocked by default.\nOptional alarm codes are: -9101 (occlusion or incomplete border), -9102 (photocopying), -9103 (screen capture by camera), -9104 (image editing/PS modification), -9107 (glare/reflection), -9108 (blurriness), -9901 (other alarms).",
+          "example": "[-9101]",
+          "member": "int64",
+          "name": "SelectedWarningCodes",
+          "required": false,
+          "type": "list"
+        },
         {
           "disabled": false,
           "document": "A passthrough field, which is returned together with the verification result and can contain up to 1,024 bits.",
@@ -459,6 +468,15 @@
           "required": false,
           "type": "string"
         },
+        {
+          "disabled": false,
+          "document": "BASIC: Basic Version (default).",
+          "example": "ENHANCED",
+          "member": "string",
+          "name": "SdkVersion",
+          "required": false,
+          "type": "string"
+        },
         {
           "disabled": false,
           "document": "This interface is used to control th action sequences.\nAction types are as follows:\n\"blink\"\n\"mouth\"\n\"nod\"\n\"shake\"\nYou can choose 1-2 actions out of the four.\nSingle action example: \"blink\"\nMultiple action example: \"blink,mouth\"\nThe default value is blink. The different action types passed in this parameter take effect only when the SecurityLevel is 2 or 4; otherwise, the interface reports an error.",
@@ -467,6 +485,15 @@
           "name": "ActionList",
           "required": false,
           "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Whether expired identity documents are permitted to proceed to the liveness detection process. This parameter only takes effect when the document type is Hong Kong Identity Card (HKID).\ntrue (default value): Expired HKID is allowed to enter the liveness process.\nfalse : Expired HKID is rejected and cannot enter the liveness process.",
+          "example": "true",
+          "member": "bool",
+          "name": "AllowExpiredDocument",
+          "required": false,
+          "type": "bool"
         }
       ],
       "type": "object"
@@ -476,7 +503,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "The token used to identify an SDK-based verification process. It is valid for 7,200s and can be used to get the verification result after the process is completed.",
+          "document": "A token that identifies an SDK verification process. the validity time is 10 minutes. after the process is complete, the token can be used to retrieve the verification result.",
           "example": "A561B769-C347-4724-A69A-6C3B3483E107",
           "member": "string",
           "name": "SdkToken",
@@ -535,7 +562,7 @@
         {
           "disabled": false,
           "document": "The parameter control the page configuration.\nExample: {\"AutoSkip\": true,\"CheckMode\": 1,\"IdCardType\": \"HKIDCard\"}",
-          "example": "{\"AutoSkip\": true,\"CheckMode\": 1,\"IdCardType\": \"HKIDCard\"}",
+          "example": "无",
           "member": "WebVerificationConfigIntl",
           "name": "Config",
           "required": false,
@@ -559,7 +586,7 @@
         },
         {
           "disabled": false,
-          "document": "The token for the web-based verification, which is generated using the ApplyWebVerificationBizTokenIntl API.\nExample: 81EEF678-28EE-4759-A82E-6CBBBE6BC442",
+          "document": "A token that identifies a Web verification process, with a validity time of 10 minutes. after the process is complete, the token can be used to obtain the verification result.",
           "example": "81EEF678-28EE-4759-A82E-6CBBBE6BC442",
           "member": "string",
           "name": "BizToken",
@@ -2145,6 +2172,26 @@
           "type": "string",
           "value_allowed_null": true
         },
+        {
+          "disabled": false,
+          "document": "Describe the risk level of the device where the current request is located, with a total of 4 levels. The details are as follows:\n1 - Secure\n2 - Low Risk\n3 - Medium Risk\n4 - High Risk\nEmpty - Risk level not obtained.\nOnly returned for the ENHANCED version, with the default value being empty.",
+          "example": "1",
+          "member": "string",
+          "name": "DeviceInfoLevel",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Describes the detailed reason for the current liveness detection failure. Output only when SdkVersion is PLUS. Details are as follows:\n01 - User kept eyes closed throughout the process.\n02 - User failed to complete the specified action.\n03 - Suspected photo replay attack.\n04 - Suspected synthetic image.\n05 - Suspected synthetic video.\n06 - Suspected synthetic action.\n07 - Suspected fraud template.\n08 - Suspected watermark existence.\n09 - Light verification failed.\n10 - Face verification failed.\n11 - Poor face quality.\n12 - Unqualified collection quality.\n13 - Suspected adversarial sample attack.",
+          "example": "[\"04\"]",
+          "member": "string",
+          "name": "LivenessInfoTag",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": true
+        },
         {
           "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.",
           "member": "string",
@@ -2159,7 +2206,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "The detection mode. Valid values:\n`liveness`: Liveness detection only.\n`compare`: Selfie verification.\nDefault value: `liveness`.",
+          "document": "The detection mode. Valid values:\n`liveness`: Liveness detection only.\n`compare`: Selfie Verification(liveness detection and face comparison).\nDefault value: `liveness`.",
           "example": "liveness",
           "member": "string",
           "name": "CheckMode",
@@ -2178,7 +2225,7 @@
         {
           "disabled": false,
           "document": "The photo (in Base64) to compare. This parameter is required when the value of `CheckMode` is `compare`.",
-          "example": "无",
+          "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
           "member": "string",
           "name": "Image",
           "required": false,
@@ -2187,7 +2234,7 @@
         {
           "disabled": false,
           "document": "The pass-through parameter, which can be omitted if there are no special requirements.",
-          "example": "无",
+          "example": "extra",
           "member": "string",
           "name": "Extra",
           "required": false,
@@ -2201,6 +2248,15 @@
           "name": "ActionList",
           "required": false,
           "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "BASIC: Basic Version (Default).",
+          "example": "BASIC",
+          "member": "string",
+          "name": "SdkVersion",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"
@@ -2300,7 +2356,7 @@
         {
           "disabled": false,
           "document": "The token used to identify an SDK-based verification process. ",
-          "example": "无",
+          "example": "41734715-B5D9-4DD8-A0C6-804BE5B45AD1",
           "member": "string",
           "name": "SdkToken",
           "required": true,
@@ -2315,7 +2371,7 @@
         {
           "disabled": false,
           "document": "The result code of the verification result.",
-          "example": "无",
+          "example": "0",
           "member": "string",
           "name": "Result",
           "output_required": true,
@@ -2325,7 +2381,7 @@
         {
           "disabled": false,
           "document": "The verification result description.",
-          "example": "无",
+          "example": "success",
           "member": "string",
           "name": "Description",
           "output_required": true,
@@ -2365,13 +2421,23 @@
         {
           "disabled": false,
           "document": "Data passed through in the process of getting the token.",
-          "example": "无",
+          "example": "\"extra\"",
           "member": "string",
           "name": "Extra",
           "output_required": true,
           "type": "string",
           "value_allowed_null": false
         },
+        {
+          "disabled": false,
+          "document": "Describe the risk level of the device where the current request is located, with a total of 4 levels. The details are as follows:\n1 - Secure\n2 - Low Risk\n3 - Medium Risk\n4 - High Risk\nEmpty - Risk level not obtained.\nOnly returned for the ENHANCED version, with the default value being empty.",
+          "example": "1",
+          "member": "string",
+          "name": "DeviceInfoLevel",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
         {
           "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.",
           "member": "string",
@@ -5683,6 +5749,33 @@
           "name": "LivenessRetryLimit",
           "required": false,
           "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "Specifies the liveness detection timeout period in seconds. value range: (0,600].",
+          "example": "45",
+          "member": "uint64",
+          "name": "LivenessTimeout",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "Selects OCR alarms requiring attention. When an OCR Alarm occurs, the identity verification process will be interrupted. Default value is empty, indicating all alarms are monitored. This feature requires the parameter DisableCheckOcrWarnings=false. If the Alarm is disabled, this parameter will not be effective.",
+          "example": "-9104,-9105",
+          "member": "string",
+          "name": "SelectedWarningCodes",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "Whether expired identity documents are permitted to proceed to the liveness detection process. This parameter only takes effect when the document type is Hong Kong Identity Card (HKID).\ntrue (default value): Expired HKID is allowed to enter the liveness process.\nfalse : Expired HKID is rejected and cannot enter the liveness process.",
+          "example": "true",
+          "member": "bool",
+          "name": "AllowExpiredDocument",
+          "required": false,
+          "type": "bool"
         }
       ],
       "usage": "in"

tccli/services/faceid/v20180301/examples.json

@@ -12,7 +12,7 @@
       {
         "document": " ",
         "input": "POST / HTTP/1.1\nHost: faceid.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ApplyLivenessToken\n<Common request parameters>\n\n{\n    \"SecureLevel\": \"1\"\n}",
-        "output": "{\n    \"Response\": {\n        \"SdkToken\": \"A561B769-C347-4724-A69A-6C3B3483E107\",\n        \"RequestId\": \"d73c0c05-f7ff-419c-84cb-0756303b1925\"\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"SdkToken\": \"A561B769-C347-4724-A69A-6C3B3483E107\",\n        \"RequestId\": \"d73c0c05-f7ff-419c-84cb-0756303b1934\"\n    }\n}",
         "title": "Applying for a token"
       }
     ],
@@ -56,7 +56,7 @@
       {
         "document": "Liveness detection failed, the specified action was not detected.",
         "input": "POST / HTTP/1.1\nHost: faceid.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CompareFaceLiveness\n<Common request parameters>\n\n{\n    \"ImageBase64\": \"iVBORw0KGg...s97n//2Q==\",\n    \"VideoBase64\": \"AAAAGGZ0eX...AAwAAAAEecg=\",\n    \"LivenessType\": \"ACTION\",\n    \"ValidateData\": \"4,2\"\n}",
-        "output": "{\n    \"Response\": {\n        \"Result\": \"FailedOperation.ActionFirstAction\",\n        \"Description\": \"The first motion is not detected.\",\n        \"Sim\": 0,\n        \"BestFrameBase64\": \"/9j/4AAQSk...W/M7/M/9k=\",\n        \"RequestId\": \"df5afd82-6469-4a4a-bd62-debf8c2ef94f\"\n    }\n}",
+        "output": "{\n    \"Response\": {\n        \"Result\": \"FailedOperation.ActionFirstAction\",\n        \"Description\": \"The first motion is not detected.\",\n        \"Sim\": 0,\n        \"BestFrameBase64\": \"/9j/4AAQSk...W/M7/M/9k=\",\n        \"RequestId\": \"df5afd82-6469-4a4a-bd62-debf8c2ef94e\"\n    }\n}",
         "title": "Liveness detection failed, the specified action was not detected."
       }
     ],
@@ -122,7 +122,7 @@
     ],
     "GetFaceIdTokenIntl": [
       {
-        "document": "\t\nThis example shows you how to apply for an SDK-based verification token.",
+        "document": "This example shows you how to apply for an SDK-based verification token.",
         "input": "POST / HTTP/1.1\nHost: faceid.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: GetFaceIdTokenIntl\n<Common request parameters>\n\n{\n    \"CheckMode\": \"liveness\",\n    \"SecureLevel\": \"4\",\n    \"Extra\": \"idxxxx\"\n}",
         "output": "{\n    \"Response\": {\n        \"RequestId\": \"c27f8a53-1766-4d62-84fc-c400843e9e21\",\n        \"SdkToken\": \"91BF5AD0-C5C9-41CC-9562-DB35BBA2712D\"\n    }\n}",
         "title": "Applying for a token"