tccli-intl-en 3.0.1248.1__py2.py3-none-any.whl → 3.1.33.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).\nENHANCE: Enhance version, enable additional output of device risk level field.\nPRO: Pro version, enable additional output of attack type fields.\nPLUS: Plus version, enable additional output of device risk level and attack type fields.\nPlease contact us to access enhance version & plus version.\t",
+          "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",
@@ -1175,7 +1202,7 @@
         {
           "disabled": false,
           "document": "The liveness algorithm package generated during this SDK-based liveness detection.",
-          "example": "{ \"MD5\": \"b2852d5..\", \"Size\": 972506, \"Url\": \"https://faceid-intl-test-1258344699...\" }",
+          "example": "无",
           "member": "FileInfo",
           "name": "LiveData",
           "output_required": true,
@@ -1185,7 +1212,7 @@
         {
           "disabled": false,
           "document": "The download URL of the video used for verification, which contains specific color reflection effects, is valid for 10 minutes.",
-          "example": "{ \"MD5\": \"24d2fde9b...\", \"Size\": 407308, \"Url\": \"https://faceid-intl-test-1258344699...\" }",
+          "example": "无",
           "member": "FileInfo",
           "name": "LiveVideo",
           "output_required": true,
@@ -1195,7 +1222,7 @@
         {
           "disabled": false,
           "document": "Records the specific action performed by the user, used for AI Face Shield analysis.",
-          "example": "{ \"MD5\": \"ef179aa94f06b989...\", \"Size\": 191015, \"Url\": \"https://faceid-intl-test-1258344699.com....\" }",
+          "example": "无",
           "member": "FileInfo",
           "name": "ActionVideo",
           "output_required": true,
@@ -1225,7 +1252,7 @@
         {
           "disabled": false,
           "document": "The download URL of the face screenshot during verification, which is valid for 10 minutes.\nNote: This field may return null, indicating that no valid value can be obtained.",
-          "example": "{ \"MD5\": \"1c4a918dc..\", \"Size\": 243050, \"Url\": \"https://faceid-intl-test-1258344699...\" }",
+          "example": "无",
           "member": "FileInfo",
           "name": "BestFrame",
           "output_required": true,
@@ -1235,7 +1262,7 @@
         {
           "disabled": false,
           "document": "The download URL of the profile photo screenshot from the identity document, which is valid for 10 minutes.",
-          "example": "{ \"MD5\": \"\", \"Size\": 0, \"Url\": \"\" }",
+          "example": "无",
           "member": "FileInfo",
           "name": "ProfileImage",
           "output_required": true,
@@ -1285,7 +1312,7 @@
         {
           "disabled": false,
           "document": "The identity document photo info edited by the user. Currently, this parameter is not applied.\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "{ \"MD5\": \"\", \"Size\": 0, \"Url\": \"\" }",
+          "example": "无",
           "member": "FileInfo",
           "name": "CardInfoInputJson",
           "output_required": true,
@@ -1301,6 +1328,16 @@
           "output_required": true,
           "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
         }
       ],
       "usage": "out"
@@ -1705,7 +1742,7 @@
         {
           "disabled": false,
           "document": "License number\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "S7033777J",
           "member": "string",
           "name": "LicenseNumber",
           "output_required": true,
@@ -1715,7 +1752,7 @@
         {
           "disabled": false,
           "document": "Personal number, which is returned when it is a passport\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "K2152143P",
           "member": "string",
           "name": "PersonalNumber",
           "output_required": true,
@@ -1725,7 +1762,7 @@
         {
           "disabled": false,
           "document": "The first line of passport machine reading code\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "EM98767821CHN9302280F3407105LKMOLPMC<<<<A926",
           "member": "string",
           "name": "PassportCodeFirst",
           "output_required": true,
@@ -1735,7 +1772,7 @@
         {
           "disabled": false,
           "document": "The first line of passport machine reading code\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "POCHNHE<<KE<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<",
           "member": "string",
           "name": "PassportCodeSecond",
           "output_required": true,
@@ -1745,7 +1782,7 @@
         {
           "disabled": false,
           "document": "Date of expiry in the format of YYYY-MM-DD\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "2026/09/11",
           "member": "string",
           "name": "ExpirationDate",
           "output_required": true,
@@ -1755,7 +1792,7 @@
         {
           "disabled": false,
           "document": "Valid date in the format of YYYY-MM-DD\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "2021/03/09",
           "member": "string",
           "name": "DueDate",
           "output_required": true,
@@ -1765,7 +1802,7 @@
         {
           "disabled": false,
           "document": "Date of issue in the format of YYYY-MM-DD\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "2021/03/09",
           "member": "string",
           "name": "IssuedDate",
           "output_required": true,
@@ -1775,7 +1812,7 @@
         {
           "disabled": false,
           "document": "Issuing authority\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "MINISTRY OF HOME AFFAIRS",
           "member": "string",
           "name": "IssuedAuthority",
           "output_required": true,
@@ -1785,7 +1822,7 @@
         {
           "disabled": false,
           "document": "Issuing country, which is returned following the ISO 3166 country coding specification\nNote: This field may return null, indicating that no valid values can be obtained.\nExample: MYS",
-          "example": "MYS",
+          "example": "SGP",
           "member": "string",
           "name": "IssuedCountry",
           "output_required": true,
@@ -1795,7 +1832,7 @@
         {
           "disabled": false,
           "document": "Full Name\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "LCY KAI LIM",
           "member": "string",
           "name": "FullName",
           "output_required": true,
@@ -1805,7 +1842,7 @@
         {
           "disabled": false,
           "document": "First name\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "LCY",
           "member": "string",
           "name": "FirstName",
           "output_required": true,
@@ -1815,7 +1852,7 @@
         {
           "disabled": false,
           "document": "Last name\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "LIM",
           "member": "string",
           "name": "LastName",
           "output_required": true,
@@ -1835,7 +1872,7 @@
         {
           "disabled": false,
           "document": "Age. 0 indicates that no valid information is obtained.\nExample: 0",
-          "example": "无",
+          "example": "0",
           "member": "string",
           "name": "Age",
           "output_required": true,
@@ -1855,7 +1892,7 @@
         {
           "disabled": false,
           "document": "Birth place\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "SINGAPORE",
           "member": "string",
           "name": "BirthPlace",
           "output_required": true,
@@ -1875,7 +1912,7 @@
         {
           "disabled": false,
           "document": "Registration number\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "1140",
           "member": "string",
           "name": "RegistrationNumber",
           "output_required": true,
@@ -1891,6 +1928,36 @@
           "output_required": false,
           "type": "object",
           "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "Localized name.",
+          "example": "刘洋",
+          "member": "string",
+          "name": "FullNameLocal",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Localization.",
+          "example": "洋",
+          "member": "string",
+          "name": "FirstNameLocal",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "Localized surname.",
+          "example": "刘",
+          "member": "string",
+          "name": "LastNameLocal",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
         }
       ],
       "usage": "out"
@@ -2145,6 +2212,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 Enhance and Plus 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 +2246,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 +2265,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 +2274,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 +2288,15 @@
           "name": "ActionList",
           "required": false,
           "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "BASIC: Basic version (Default).\nENHANCE: Enhance version, enable additional output of device risk level field.\nPRO: Pro version, enable additional output of attack type fields.\nPLUS: Plus version, enable additional output of device risk level and attack type fields.\nPlease contact us to access enhance version & plus version.\t",
+          "example": "BASIC",
+          "member": "string",
+          "name": "SdkVersion",
+          "required": false,
+          "type": "string"
         }
       ],
       "type": "object"
@@ -2300,7 +2396,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 +2411,7 @@
         {
           "disabled": false,
           "document": "The result code of the verification result.",
-          "example": "无",
+          "example": "0",
           "member": "string",
           "name": "Result",
           "output_required": true,
@@ -2325,7 +2421,7 @@
         {
           "disabled": false,
           "document": "The verification result description.",
-          "example": "无",
+          "example": "success",
           "member": "string",
           "name": "Description",
           "output_required": true,
@@ -2365,13 +2461,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 Enhance and Plus 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",
@@ -3976,7 +4082,7 @@
         {
           "disabled": false,
           "document": "Telex code correspondint to the Chinese name\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "中文姓名对应电码",
           "member": "string",
           "name": "RegistrationNumber",
           "output_required": false,
@@ -4006,7 +4112,7 @@
         {
           "disabled": false,
           "document": "Permanent resident ID card: 0-non-permanent; 1-permanent; -1-unknown\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "1",
           "member": "string",
           "name": "Permanent",
           "output_required": false,
@@ -4026,7 +4132,7 @@
         {
           "disabled": false,
           "document": "Lisence symbol, which is the symbol below Birthday. Example: \"***AZ\"\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "***AZ",
           "member": "string",
           "name": "Symbol",
           "output_required": false,
@@ -4036,7 +4142,7 @@
         {
           "disabled": false,
           "document": "The first date of issue\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "无   ",
           "member": "string",
           "name": "IssuedDate",
           "output_required": false,
@@ -4046,12 +4152,22 @@
         {
           "disabled": false,
           "document": "The current date of issue\nNote: This field may return null, indicating that no valid values can be obtained.",
-          "example": "无",
+          "example": "16-06-06",
           "member": "string",
           "name": "CurrentIssueDate",
           "output_required": false,
           "type": "string",
           "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "Hong kong identity card version.\nNote: This field may return null, indicating that no valid values can be obtained.",
+          "example": "HKID-2003",
+          "member": "string",
+          "name": "HKIDVersion",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": true
         }
       ],
       "usage": "out"
@@ -5569,7 +5685,7 @@
       "members": [
         {
           "disabled": false,
-          "document": "When starting verification, whether to skip the starting verification page. If true, enter the verification process directly. The default is false. This configuration will not take effect if the downgrade policy is triggered.",
+          "document": "When starting verification, whether to skip the starting verification page. If true, enter the verification process directly. This configuration will not take effect if the downgrade policy is triggered. The default is false.\nExample: false",
           "example": "false",
           "member": "bool",
           "name": "AutoSkipStartPage",
@@ -5578,7 +5694,7 @@
         },
         {
           "disabled": false,
-          "document": "When the verification passed, whether to skip the result page and automatically jump to RedirectURL. The default value is false.\nExample value: false",
+          "document": "When the verification passed, whether to skip the result page and automatically jump to RedirectURL. The default value is false.\nExample: false",
           "example": "false",
           "member": "bool",
           "name": "AutoSkip",
@@ -5587,7 +5703,7 @@
         },
         {
           "disabled": false,
-          "document": "Detection mode, parameter values are as follows:\n1: OCR+liveness detection & face comparison;\n2: Liveness detection & face comparison;\n3: Liveness detection;\n4: OCR;\nThe default value is 2.\nExample value: 3",
+          "document": "Detection mode, parameter values are as follows:\n1: OCR+liveness detection & face comparison;\n2: Liveness detection & face comparison;\n3: Liveness detection;\n4: OCR;\nThe default value is 2.\nExample: 3",
           "example": "1",
           "member": "int64",
           "name": "CheckMode",
@@ -5596,7 +5712,7 @@
         },
         {
           "disabled": false,
-          "document": "The type of lisence used for verification. The following types are supported.\n1.HKIDCard: Hong Kong (China) ID card\n2.MLIDCard: Malaysia ID card\n3.IndonesialDCard: Indonesia ID card\n4.PhilippinesVoteID: Philippines Vote lD card\n5.PhilippinesDrivingLicense: Philippines driving license\n6.PhilippinesTinID: Philippines TinID card\n7.PhilippinesSSSID: Philippines SSSID card\n8.PhilippinesUMID: Philippines UMID card\n9.InternationallDPassport: ID cards of Hong Kong (China), Macao (China) and Taiwan (China), and international passport.\n10.ThailandIDCard: Thailand ID card\n11.SingaporelDCard: Singapore ID card\n12.MainlandIDCard: Mainland (China) ID card\nExample: HKIDCard",
+          "document": "Card Type for verification. The following types are supported:\n1.HKIDCard: Hong Kong (China) ID card\n2.MLIDCard: Malaysia ID card\n3.IndonesialDCard: Indonesia ID card\n4.PhilippinesVoteID: Philippines Vote lD card\n5.PhilippinesDrivingLicense: Philippines driving license\n6.PhilippinesTinID: Philippines TinID card\n7.PhilippinesSSSID: Philippines SSSID card\n8.PhilippinesUMID: Philippines UMID card\n9.InternationallDPassport: ID cards of Hong Kong (China), Macao (China) and Taiwan (China), and international passport.\n10.ThailandIDCard: Thailand ID card\n11.SingaporelDCard: Singapore ID card\n12.MainlandIDCard: Mainland (China) ID card\nExample: HKIDCard",
           "example": "HKIDCard",
           "member": "string",
           "name": "IDCardType",
@@ -5605,7 +5721,7 @@
         },
         {
           "disabled": false,
-          "document": "Whether to turn off document alarms, the default is false (the alarm detection function is turned on). When enabled, the identity authentication process will be intercepted based on the alarm status of the certificate. If you need to use the document authentication function, please contact us.",
+          "document": "Whether to turn off document alarms, the default is false (the alarm detection function is turned on). When enabled, the identity authentication process will be intercepted based on the alarm status of the certificate. If you need to use the document authentication function, please contact us.\nExample: false",
           "example": "false",
           "member": "bool",
           "name": "DisableCheckOcrWarnings",
@@ -5614,7 +5730,7 @@
         },
         {
           "disabled": false,
-          "document": "Liveness security level: 1:Silent mode;2:Action mode;3:Lighting mode;4:Action+Lighting mode;5:Action+Lighting(High security) mode; default value is 3",
+          "document": "Liveness security level, the default value is 3. The currently supported security level are as follows:\n1:Silent mode;\n2:Action mode;\n3:Lighting mode;\n4:Action+Lighting mode;\n5:Action+Lighting(High security) mode.\nExample: 4",
           "example": "3",
           "member": "int64",
           "name": "SecurityLevel",
@@ -5623,7 +5739,7 @@
         },
         {
           "disabled": false,
-          "document": "Whether to skip the agreement page, the default is false. When SkipPrivacyPolicy is false, the agreement page will be displayed and the privacy agreement needs to be checked; when SkipPrivacyPolicy is true, the agreement page will be skipped and the liveness process will be entered directly without checking the privacy agreement page.",
+          "document": "Whether to skip the agreement page. When SkipPrivacyPolicy is false, the agreement page will be displayed and the privacy agreement needs to be checked; when SkipPrivacyPolicy is true, the agreement page will be skipped and the liveness process will be entered directly without checking the privacy agreement page. The default is false.\nExample: false",
           "example": "false",
           "member": "bool",
           "name": "SkipPrivacyPolicy",
@@ -5632,7 +5748,7 @@
         },
         {
           "disabled": false,
-          "document": "The default value is false. If it is false, the original ID image will be displayed. If it is true, the cut ID image will be displayed.",
+          "document": "whether to display the cropped ID card image. When set to false, the original ID card image is displayed. When set to true, the cropped version is displayed. The default value is false. \nExample: false",
           "example": "false",
           "member": "bool",
           "name": "IdCardCutReturn",
@@ -5641,7 +5757,7 @@
         },
         {
           "disabled": false,
-          "document": "Front-end theme color, in the format of RGB hexadecimal color code. The default value is \"#2d72f1\". If the format is incorrect, the default value color will be used. ",
+          "document": "Front-end theme color, in the format of RGB hexadecimal color code. If the format is incorrect, the default value color will be used. The default value is \"#2d72f1\".\nExample: #2d72f1",
           "example": "#2d72f1",
           "member": "string",
           "name": "ThemeColor",
@@ -5650,7 +5766,7 @@
         },
         {
           "disabled": false,
-          "document": "International language, the default value is en (English). Currently supported: th: Thai; en: English; zh-cn: Simplified Chinese; zh-tc: Tradionnal Chinese; id: Bahasa Indonesia.",
+          "document": "International language, the default value is en (English). The currently supported language are as follows: \nth: Thai; \nen: English; \nzh-cn: Simplified Chinese; \nzh-tc: Tradionnal Chinese; \nid: Bahasa Indonesia.",
           "example": "en",
           "member": "string",
           "name": "Language",
@@ -5659,7 +5775,7 @@
         },
         {
           "disabled": false,
-          "document": "Automatic downgrade mode, with the following parameter values: 1: Downgrade to silent live mode; 2: Disable downgrade mode. The default value is 1.",
+          "document": "Automatic downgrade mode, the following parameter are supported: \n1: Downgrade to silent live mode; \n2: Disable downgrade mode. \nThe default value is 1.",
           "example": "1",
           "member": "int64",
           "name": "AutoDowngrade",
@@ -5668,7 +5784,7 @@
         },
         {
           "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, 4, or 5; otherwise, the interface reports an error.",
+          "document": "This interface is used to control th action sequences.\nThe supported action types are as follows:\n\"blink\";\n\"mouth\";\n\"nod\";\n\"shake\".\nYou can choose 1-2 actions out of the four. Single action example: \"blink\". Multiple action example: \"blink,mouth\". The different action types passed in this parameter take effect only when the SecurityLevel is 2, 4, or 5; otherwise, the interface reports an error.\nThe default value is blink.",
           "example": "blink",
           "member": "string",
           "name": "ActionList",
@@ -5677,12 +5793,39 @@
         },
         {
           "disabled": false,
-          "document": "Control liveness retry number.The value range is 1-99.",
+          "document": "Control liveness retry number.The value range is 1-99.\nThe default value is 99.",
           "example": "3",
           "member": "int64",
           "name": "LivenessRetryLimit",
           "required": false,
           "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "Specifies the liveness detection timeout period in seconds. value range: (0,600].\nThe default value is 45.",
+          "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. The supported alarm types are as follows:\n-9101: Incomplete Border Alert;\n-9102: Copy Document Alert;\n-9103: Remediated Document Alert;\n-9104: PS-altered Document Alert;\n-9107: Glare Alert;\n-9108: Blurriness Alert;\n-9109: Alert Not Activated.",
+          "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"