tencentcloud-sdk-nodejs-intl-en 3.0.1094 → 3.0.1095

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-intl-en",
3
- "version": "3.0.1094",
3
+ "version": "3.0.1095",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -1,2 +1,2 @@
1
- const sdkVersion = "3.0.1094";
1
+ const sdkVersion = "3.0.1095";
2
2
  module.exports = sdkVersion
@@ -165,7 +165,7 @@ The image and the data generated with the SDK must be stored in COS, and the reg
165
165
  }
166
166
 
167
167
  /**
168
- * This API is used to generate an appropriate light sequence based on the information collected by the liveness comparison (reflection-based) SDK and pass the light sequence into the SDK to start the identity verification process.
168
+ * This API is used to generate an appropriate light sequence based on the information collected by the liveness comparison (reflection-based) SDK and pass the light sequence into the SDK to start the eKYC process.
169
169
  The data generated with the SDK must be stored in COS, and the region of the COS bucket must be same as that of requests made with this API. We recommend that you pass resources with upload link APIs.
170
170
  * @param {GenerateReflectSequenceRequest} req
171
171
  * @param {function(string, GenerateReflectSequenceResponse):void} cb
@@ -233,7 +233,7 @@ The data generated with the SDK must be stored in COS, and the region of the COS
233
233
  }
234
234
 
235
235
  /**
236
- * This API is used to apply for an SDK token before calling the liveness detection and face comparison SDK each time. The SDK token is used throughout the identity verification process and to get the verification result after the verification is completed. A token is valid for one identity verification process only.
236
+ * This API is used to apply for an SDK token before calling the selfie verification SDK each time. The SDK token is used throughout the eKYC process and to get the verification result after the verification is completed. A token is valid for one eKYC process only.
237
237
  * @param {GetFaceIdTokenIntlRequest} req
238
238
  * @param {function(string, GetFaceIdTokenIntlResponse):void} cb
239
239
  * @public
@@ -278,7 +278,7 @@ The data will be stored in a COS bucket in the region specified by the parameter
278
278
  }
279
279
 
280
280
  /**
281
- * This API is used to apply for a token before calling the Identity Verification SDK service each time. This token is required for initiating the verification process and getting the result after the verification is completed.
281
+ * This API is used to apply for a token before calling the eKYC SDK service each time. This token is required for initiating the verification process and getting the result after the verification is completed.
282
282
  * @param {ApplySdkVerificationTokenRequest} req
283
283
  * @param {function(string, ApplySdkVerificationTokenResponse):void} cb
284
284
  * @public
@@ -789,7 +789,7 @@ class GetFaceIdTokenIntlRequest extends AbstractModel {
789
789
  /**
790
790
  * The detection mode. Valid values:
791
791
  `liveness`: Liveness detection only.
792
- `compare`: Liveness detection and face comparison.
792
+ `compare`: Selfie verification.
793
793
  Default value: `liveness`.
794
794
  * @type {string || null}
795
795
  */
@@ -1317,7 +1317,7 @@ class GetWebVerificationResultIntlResponse extends AbstractModel {
1317
1317
 
1318
1318
  /**
1319
1319
  * The final result of this verification. `0` indicates that the person is the same as that in the photo.
1320
- For other error codes, see <a href="https://www.tencentcloud.com/document/product/1061/55390?lang=en&pg=#8a960e1e-39c0-42cb-b181-b3164d77f81e">Liveness Detection and Face Comparison (Mobile HTML5) Error Codes</a>
1320
+ For other error codes, see <a href="https://www.tencentcloud.com/document/product/1061/55390?lang=en&pg=#8a960e1e-39c0-42cb-b181-b3164d77f81e">Selfie Verification (Mobile HTML5) Error Codes</a>
1321
1321
  Note: This field may return null, indicating that no valid values can be obtained.
1322
1322
  * @type {number || null}
1323
1323
  */
@@ -1795,7 +1795,7 @@ class GetFaceIdResultIntlRequest extends AbstractModel {
1795
1795
  super();
1796
1796
 
1797
1797
  /**
1798
- * The ID of the SDK-based liveness detection and face comparison process, which is generated when the `GetFaceIdTokenIntl` API is called.
1798
+ * The ID of the SDK-based selfie verification process, which is generated when the `GetFaceIdTokenIntl` API is called.
1799
1799
  * @type {string || null}
1800
1800
  */
1801
1801
  this.SdkToken = null;
@@ -2081,7 +2081,7 @@ class GetFaceIdResultIntlResponse extends AbstractModel {
2081
2081
  * The return code of the verification result.
2082
2082
  0: Succeeded.
2083
2083
  1001: System error.
2084
- 1004: Liveness detection and face comparison failed.
2084
+ 1004: Selfie verification comparison failed.
2085
2085
  2004: The image passed in is too large or too small.
2086
2086
  2012: Several faces were detected.
2087
2087
  2013: No face was detected, or the face detected was incomplete.
@@ -2112,7 +2112,7 @@ class GetFaceIdResultIntlResponse extends AbstractModel {
2112
2112
  this.Video = null;
2113
2113
 
2114
2114
  /**
2115
- * The similarity, with a value range of 0-100. A greater value indicates higher similarity. This parameter is returned only in the `compare` (liveness detection and face comparison) mode.
2115
+ * The similarity, with a value range of 0-100. A greater value indicates higher similarity. This parameter is returned only in the `compare` (selfie verification) mode.
2116
2116
  Note: This field may return `null`, indicating that no valid values can be obtained.
2117
2117
  * @type {number || null}
2118
2118
  */
@@ -4115,29 +4115,31 @@ class CompareFaceLivenessResponse extends AbstractModel {
4115
4115
  super();
4116
4116
 
4117
4117
  /**
4118
- * Service error code. When the return value is "Success", it indicates that the liveness detection and face comparison succeeded. It is determined that they are the same person. When the return value is "FailedOperation.CompareLowSimilarity", it indicates that the liveness detection succeeded, and the face comparison similarity is lower than 70 points. It is determined that they are not the same person. For other error cases, please refer to Liveness Face Comparison (Pure API) Error Code (https://www.tencentcloud.com/document/product/1061/55390).
4119
- Example Value: "Success".
4118
+ * Business Error Codes.
4119
+ -When the return value is "Success", it indicates that liveness detection and face comparison passed. Determined to be the same person.
4120
+ -When the return value is "FailedOperation.CompareLowSimilarity", it indicates that liveness detection passed, but face comparison similarity is below 70. Determined not to be the same person.
4121
+ -For other error cases, please refer to [Liveness Face Comparison (API only) Error Codes](https://www.tencentcloud.com/zh/document/product/1061/55390?lang=zh&pg=#97df7537-87fe-4266-87e9-02c816d41ee2)
4120
4122
  * @type {string || null}
4121
4123
  */
4122
4124
  this.Result = null;
4123
4125
 
4124
4126
  /**
4125
- * Description of business results.
4126
- Example value: "Success"
4127
+ * The service result description
4127
4128
  * @type {string || null}
4128
4129
  */
4129
4130
  this.Description = null;
4130
4131
 
4131
4132
  /**
4132
- * This value is valid when the "Result" parameter is "Success" or "FailedOperation.CompareLowSimilarity."
4133
- This value indicates the similarity of face comparison. Value range: [0.00, 100.00]. The false pass rate for threshold 70 is 1 in 1,000, and the false pass rate for threshold 80 is 1 in 10,000.
4134
- Example value: 80.00
4133
+ * This value indicates the similarity of face comparison. Value range: 0.00-100.00.
4134
+ - The false acceptance rate for a threshold of 70 is 0.1%, and for a threshold of 80, it is 0.01%.
4135
+ - This value is valid when the Result parameter is "Success" or "FailedOperation.CompareLowSimilarity".
4135
4136
  * @type {number || null}
4136
4137
  */
4137
4138
  this.Sim = null;
4138
4139
 
4139
4140
  /**
4140
- * The optimal screenshot of the video after verification is the value encoded by BASE64, jpg format.
4141
+ * The best screenshot photo from the video after verification, encoded in BASE64, in jpg format.
4142
+ The optimal screenshot of the video after verification is the value encoded by BASE64, jpg format.
4141
4143
  Note: This field may return "null", indicating that no valid value can be obtained.
4142
4144
  Example values: "/9j/4AAQSk... (total length:142036)s97n//2Q=="
4143
4145
  * @type {string || null}
@@ -4624,43 +4626,37 @@ class CompareFaceLivenessRequest extends AbstractModel {
4624
4626
  super();
4625
4627
 
4626
4628
  /**
4627
- * Base64 value of photos used for face comparison.
4628
- The size of image data encoded by Base64 shall not exceed 3M, only jpg and png are supported.
4629
- Please use standard Base64 encoding (use = for padding). Refer to RFC4648 for encoding specifications.
4630
- Example values: "/9j/4AAQSk... (total length:61944)KiiK//2Q=="
4629
+ * Base64 string of the image for face comparison.
4630
+ - The size of the Base64-encoded image data can be up to 3 MB. JPG and PNG formats are supported.
4631
+ - Please use the standard Base64 encoding method (with = padding). Refer to RFC4648 for the encoding specification.
4631
4632
  * @type {string || null}
4632
4633
  */
4633
4634
  this.ImageBase64 = null;
4634
4635
 
4635
4636
  /**
4636
- * Base64 value of videos used for face comparison.
4637
- The size of videos data encoded by Base64 shall not exceed 8M, only mp4,avi,flv are supported.
4638
- Please use standard Base64 encoding (use = for padding). Refer to RFC4648 for encoding specifications.
4639
- Example values: "/9j/4AAQSk... (total length:61944)KiiK//2Q=="
4637
+ * Base64 string of the video for liveness detection.
4638
+ - The size of the Base64-encoded video data can be up to 8 MB. MP4, AVI, and FLV formats are supported.
4639
+ -Use standard Base64 encoding (with = padding), following RFC4648.
4640
4640
  * @type {string || null}
4641
4641
  */
4642
4642
  this.VideoBase64 = null;
4643
4643
 
4644
4644
  /**
4645
- * The liveness detection type. Valid values: `ACTION`, and `SILENT`.
4646
- `ACTION`: Motion mode; `SILENT`: silent mode. Select one of them.
4647
- Example value: "SILENT"
4645
+ * Liveness detection type.
4646
+ -Values:
4647
+ ACTION is action mode.
4648
+ SILENT is silent mode.
4649
+ -Choose one of the two modes to pass in.
4648
4650
  * @type {string || null}
4649
4651
  */
4650
4652
  this.LivenessType = null;
4651
4653
 
4652
4654
  /**
4653
- * When the "LivenessType" parameter is "ACTION", it must be specified.
4654
- It is used to control the action sequence. Action types:
4655
- 1 (open mouth)
4656
- 2 (blink)
4657
- 3 (nod)
4658
- 4 (shake head).
4659
- Select one or two from the four actions.
4660
- Example of passing single action parameter: "1".
4661
- Example of passing multiple action parameters: "4,2".
4662
- When the "LivenessType" parameter value is "SILENT", it shall be unspecified.
4663
- Example value: ""
4655
+ * Control the action sequence. Action types include: 1 (open mouth), 2 (blink), 3 (nod), 4 (shake head). Supports one or two actions.
4656
+ -Required when the LivenessType parameter is set to ACTION.
4657
+ -Single action example: "1".
4658
+ -Multiple actions parameter passing example: "4,2".
4659
+ -When the LivenessType parameter is set to SILENT, leave it blank.
4664
4660
  * @type {string || null}
4665
4661
  */
4666
4662
  this.ValidateData = null;
@@ -5155,7 +5151,7 @@ class GenerateReflectSequenceResponse extends AbstractModel {
5155
5151
  super();
5156
5152
 
5157
5153
  /**
5158
- * The resource URL of the light sequence, which needs to be downloaded and passed through to the SDK to start the identity verification process.
5154
+ * The resource URL of the light sequence, which needs to be downloaded and passed through to the SDK to start the eKYC process.
5159
5155
  * @type {string || null}
5160
5156
  */
5161
5157
  this.ReflectSequenceUrl = null;