@alicloud/cloudauth20190307 3.13.4 → 3.14.0

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 (151) hide show
  1. package/dist/client.d.ts +88 -66
  2. package/dist/client.js +243 -90
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/AigcfaceVerifyRequest.d.ts +2 -2
  5. package/dist/models/AigcfaceVerifyResponseBody.d.ts +3 -3
  6. package/dist/models/CreateAntCloudAuthSceneRequest.d.ts +42 -10
  7. package/dist/models/CreateAntCloudAuthSceneRequest.js +8 -0
  8. package/dist/models/CreateAntCloudAuthSceneRequest.js.map +1 -1
  9. package/dist/models/CreateWhitelistSettingRequest.d.ts +4 -1
  10. package/dist/models/CreateWhitelistSettingRequest.js.map +1 -1
  11. package/dist/models/CreateWhitelistSettingResponseBody.d.ts +1 -1
  12. package/dist/models/DescribeFaceVerifyRequest.d.ts +1 -1
  13. package/dist/models/DescribeFaceVerifyResponseBody.d.ts +13 -5
  14. package/dist/models/DescribeFaceVerifyResponseBody.js +2 -0
  15. package/dist/models/DescribeFaceVerifyResponseBody.js.map +1 -1
  16. package/dist/models/DescribeInfoCheckExportRecordRequest.d.ts +14 -14
  17. package/dist/models/DescribeInfoCheckExportRecordResponseBody.d.ts +22 -22
  18. package/dist/models/DescribeListAntCloudAuthScenesRequest.d.ts +1 -1
  19. package/dist/models/DescribeListAntCloudAuthScenesResponseBody.d.ts +47 -15
  20. package/dist/models/DescribeListAntCloudAuthScenesResponseBody.js +8 -0
  21. package/dist/models/DescribeListAntCloudAuthScenesResponseBody.js.map +1 -1
  22. package/dist/models/DescribeListFaceVerifyInfosRequest.d.ts +1 -0
  23. package/dist/models/DescribeListFaceVerifyInfosRequest.js.map +1 -1
  24. package/dist/models/DescribeListFaceVerifyInfosResponseBody.d.ts +3 -2
  25. package/dist/models/DescribeListFaceVerifyInfosResponseBody.js.map +1 -1
  26. package/dist/models/DescribeMetaSearchPageListRequest.d.ts +22 -22
  27. package/dist/models/DescribeMetaSearchPageListResponseBody.d.ts +77 -77
  28. package/dist/models/DescribeMetaStatisticsListRequest.d.ts +3 -3
  29. package/dist/models/DescribeMetaStatisticsListResponseBody.d.ts +10 -10
  30. package/dist/models/DescribeMetaStatisticsPageListRequest.d.ts +19 -19
  31. package/dist/models/DescribeMetaStatisticsPageListResponseBody.d.ts +34 -34
  32. package/dist/models/DescribePageFaceVerifyDataRequest.d.ts +2 -2
  33. package/dist/models/DescribePageFaceVerifyDataResponseBody.d.ts +3 -3
  34. package/dist/models/DescribeVerifyDeviceRiskStatisticsRequest.d.ts +4 -4
  35. package/dist/models/DescribeVerifyDeviceRiskStatisticsResponseBody.d.ts +2 -2
  36. package/dist/models/DescribeVerifyFailStatisticsRequest.d.ts +9 -9
  37. package/dist/models/DescribeVerifyFailStatisticsResponseBody.d.ts +3 -3
  38. package/dist/models/DescribeVerifyPersonasDeviceModelStatisticsRequest.d.ts +2 -2
  39. package/dist/models/DescribeVerifyPersonasDeviceModelStatisticsResponseBody.d.ts +2 -2
  40. package/dist/models/DescribeVerifyPersonasOsStatisticsRequest.d.ts +2 -2
  41. package/dist/models/DescribeVerifyPersonasOsStatisticsResponseBody.d.ts +3 -3
  42. package/dist/models/DescribeVerifyPersonasProvinceStatisticsRequest.d.ts +2 -2
  43. package/dist/models/DescribeVerifyPersonasProvinceStatisticsResponseBody.d.ts +1 -1
  44. package/dist/models/DescribeVerifyPersonasSexStatisticsRequest.d.ts +2 -2
  45. package/dist/models/DescribeVerifyPersonasSexStatisticsResponseBody.d.ts +15 -15
  46. package/dist/models/DescribeVerifySearchPageListRequest.d.ts +24 -24
  47. package/dist/models/DescribeVerifySearchPageListResponseBody.d.ts +29 -29
  48. package/dist/models/DescribeVerifyStatisticsRequest.d.ts +4 -4
  49. package/dist/models/DescribeVerifyStatisticsResponseBody.d.ts +17 -17
  50. package/dist/models/DescribeWhitelistSettingRequest.d.ts +8 -5
  51. package/dist/models/DescribeWhitelistSettingRequest.js.map +1 -1
  52. package/dist/models/DescribeWhitelistSettingResponseBody.d.ts +6 -3
  53. package/dist/models/DescribeWhitelistSettingResponseBody.js.map +1 -1
  54. package/dist/models/Id3metaVerifyAdvanceRequest.d.ts +19 -16
  55. package/dist/models/Id3metaVerifyAdvanceRequest.js.map +1 -1
  56. package/dist/models/Id3metaVerifyProadvanceRequest.d.ts +115 -0
  57. package/dist/models/Id3metaVerifyProadvanceRequest.js +73 -0
  58. package/dist/models/Id3metaVerifyProadvanceRequest.js.map +1 -0
  59. package/dist/models/Id3metaVerifyProrequest.d.ts +114 -0
  60. package/dist/models/Id3metaVerifyProrequest.js +74 -0
  61. package/dist/models/Id3metaVerifyProrequest.js.map +1 -0
  62. package/dist/models/Id3metaVerifyProresponse.d.ts +19 -0
  63. package/dist/models/Id3metaVerifyProresponse.js +69 -0
  64. package/dist/models/Id3metaVerifyProresponse.js.map +1 -0
  65. package/dist/models/Id3metaVerifyProresponseBody.d.ts +121 -0
  66. package/dist/models/Id3metaVerifyProresponseBody.js +92 -0
  67. package/dist/models/Id3metaVerifyProresponseBody.js.map +1 -0
  68. package/dist/models/Id3metaVerifyRequest.d.ts +19 -16
  69. package/dist/models/Id3metaVerifyRequest.js.map +1 -1
  70. package/dist/models/Id3metaVerifyResponseBody.d.ts +33 -8
  71. package/dist/models/Id3metaVerifyResponseBody.js.map +1 -1
  72. package/dist/models/Id3metaVerifyWithOcradvanceRequest.d.ts +4 -4
  73. package/dist/models/Id3metaVerifyWithOcrrequest.d.ts +4 -4
  74. package/dist/models/Id3metaVerifyWithOcrresponseBody.d.ts +8 -8
  75. package/dist/models/InitFaceVerifyRequest.d.ts +68 -65
  76. package/dist/models/InitFaceVerifyRequest.js.map +1 -1
  77. package/dist/models/InitFaceVerifyResponseBody.d.ts +5 -7
  78. package/dist/models/InitFaceVerifyResponseBody.js.map +1 -1
  79. package/dist/models/PageQueryWhiteListSettingRequest.d.ts +3 -3
  80. package/dist/models/PageQueryWhiteListSettingResponseBody.d.ts +4 -4
  81. package/dist/models/QueryVerifyFlowPackageRequest.d.ts +2 -2
  82. package/dist/models/QueryVerifyFlowPackageResponseBody.d.ts +8 -8
  83. package/dist/models/QueryVerifyInvokeSatisticRequest.d.ts +7 -7
  84. package/dist/models/QueryVerifyInvokeSatisticResponseBody.d.ts +3 -3
  85. package/dist/models/UpdateAntCloudAuthSceneRequest.d.ts +41 -9
  86. package/dist/models/UpdateAntCloudAuthSceneRequest.js +8 -0
  87. package/dist/models/UpdateAntCloudAuthSceneRequest.js.map +1 -1
  88. package/dist/models/model.d.ts +5 -0
  89. package/dist/models/model.js +18 -8
  90. package/dist/models/model.js.map +1 -1
  91. package/package.json +2 -2
  92. package/src/client.ts +267 -90
  93. package/src/models/AigcfaceVerifyRequest.ts +2 -2
  94. package/src/models/AigcfaceVerifyResponseBody.ts +3 -3
  95. package/src/models/CreateAntCloudAuthSceneRequest.ts +50 -10
  96. package/src/models/CreateWhitelistSettingRequest.ts +4 -1
  97. package/src/models/CreateWhitelistSettingResponseBody.ts +1 -1
  98. package/src/models/DescribeFaceVerifyRequest.ts +1 -1
  99. package/src/models/DescribeFaceVerifyResponseBody.ts +15 -5
  100. package/src/models/DescribeInfoCheckExportRecordRequest.ts +14 -14
  101. package/src/models/DescribeInfoCheckExportRecordResponseBody.ts +22 -22
  102. package/src/models/DescribeListAntCloudAuthScenesRequest.ts +1 -1
  103. package/src/models/DescribeListAntCloudAuthScenesResponseBody.ts +55 -15
  104. package/src/models/DescribeListFaceVerifyInfosRequest.ts +1 -0
  105. package/src/models/DescribeListFaceVerifyInfosResponseBody.ts +3 -2
  106. package/src/models/DescribeMetaSearchPageListRequest.ts +22 -22
  107. package/src/models/DescribeMetaSearchPageListResponseBody.ts +77 -77
  108. package/src/models/DescribeMetaStatisticsListRequest.ts +3 -3
  109. package/src/models/DescribeMetaStatisticsListResponseBody.ts +10 -10
  110. package/src/models/DescribeMetaStatisticsPageListRequest.ts +19 -19
  111. package/src/models/DescribeMetaStatisticsPageListResponseBody.ts +34 -34
  112. package/src/models/DescribePageFaceVerifyDataRequest.ts +2 -2
  113. package/src/models/DescribePageFaceVerifyDataResponseBody.ts +3 -3
  114. package/src/models/DescribeVerifyDeviceRiskStatisticsRequest.ts +4 -4
  115. package/src/models/DescribeVerifyDeviceRiskStatisticsResponseBody.ts +2 -2
  116. package/src/models/DescribeVerifyFailStatisticsRequest.ts +9 -9
  117. package/src/models/DescribeVerifyFailStatisticsResponseBody.ts +3 -3
  118. package/src/models/DescribeVerifyPersonasDeviceModelStatisticsRequest.ts +2 -2
  119. package/src/models/DescribeVerifyPersonasDeviceModelStatisticsResponseBody.ts +2 -2
  120. package/src/models/DescribeVerifyPersonasOsStatisticsRequest.ts +2 -2
  121. package/src/models/DescribeVerifyPersonasOsStatisticsResponseBody.ts +3 -3
  122. package/src/models/DescribeVerifyPersonasProvinceStatisticsRequest.ts +2 -2
  123. package/src/models/DescribeVerifyPersonasProvinceStatisticsResponseBody.ts +1 -1
  124. package/src/models/DescribeVerifyPersonasSexStatisticsRequest.ts +2 -2
  125. package/src/models/DescribeVerifyPersonasSexStatisticsResponseBody.ts +15 -15
  126. package/src/models/DescribeVerifySearchPageListRequest.ts +24 -24
  127. package/src/models/DescribeVerifySearchPageListResponseBody.ts +29 -29
  128. package/src/models/DescribeVerifyStatisticsRequest.ts +4 -4
  129. package/src/models/DescribeVerifyStatisticsResponseBody.ts +17 -17
  130. package/src/models/DescribeWhitelistSettingRequest.ts +8 -5
  131. package/src/models/DescribeWhitelistSettingResponseBody.ts +6 -3
  132. package/src/models/Id3metaVerifyAdvanceRequest.ts +19 -16
  133. package/src/models/Id3metaVerifyProadvanceRequest.ts +144 -0
  134. package/src/models/Id3metaVerifyProrequest.ts +143 -0
  135. package/src/models/Id3metaVerifyProresponse.ts +40 -0
  136. package/src/models/Id3metaVerifyProresponseBody.ts +159 -0
  137. package/src/models/Id3metaVerifyRequest.ts +19 -16
  138. package/src/models/Id3metaVerifyResponseBody.ts +33 -8
  139. package/src/models/Id3metaVerifyWithOcradvanceRequest.ts +4 -4
  140. package/src/models/Id3metaVerifyWithOcrrequest.ts +4 -4
  141. package/src/models/Id3metaVerifyWithOcrresponseBody.ts +8 -8
  142. package/src/models/InitFaceVerifyRequest.ts +68 -65
  143. package/src/models/InitFaceVerifyResponseBody.ts +5 -7
  144. package/src/models/PageQueryWhiteListSettingRequest.ts +3 -3
  145. package/src/models/PageQueryWhiteListSettingResponseBody.ts +4 -4
  146. package/src/models/QueryVerifyFlowPackageRequest.ts +2 -2
  147. package/src/models/QueryVerifyFlowPackageResponseBody.ts +8 -8
  148. package/src/models/QueryVerifyInvokeSatisticRequest.ts +7 -7
  149. package/src/models/QueryVerifyInvokeSatisticResponseBody.ts +3 -3
  150. package/src/models/UpdateAntCloudAuthSceneRequest.ts +49 -9
  151. package/src/models/model.ts +5 -0
@@ -7,9 +7,9 @@ export class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
7
7
  * @remarks
8
8
  * The identity verification result. Valid values:
9
9
  *
10
- * - 1: Consistent.
11
- * - 2: Inconsistent.
12
- * - 3: No record found.
10
+ * - 1: verification is consistent.
11
+ * - 2: verification is inconsistent.
12
+ * - 3: no record found.
13
13
  *
14
14
  * @example
15
15
  * 1
@@ -26,6 +26,31 @@ export class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
26
26
  */
27
27
  faceDetail?: string;
28
28
  /**
29
+ * @remarks
30
+ * The authoritative source verification details. Valid values:
31
+ *
32
+ * - 101: authentication passed.
33
+ *
34
+ * - 201: authentication failed. The name does not match the ID card number.
35
+ *
36
+ * - 202: authentication failed. The person is suspected to be the ID holder.
37
+ *
38
+ * - 203: authentication failed. No photo exists in the database.
39
+ *
40
+ * - 204: authentication failed. The person is not the same individual.
41
+ *
42
+ * - 205: authentication failed. Modeling of the image to be compared failed.
43
+ *
44
+ * - 206: authentication failed. The image format is incorrect.
45
+ *
46
+ * - 207: authentication failed. The uploaded image is too small. Upload a new image.
47
+ *
48
+ * - 208: authentication failed. The quality of the uploaded portrait photo is poor. Upload a new photo.
49
+ *
50
+ * - 301: no record found. The ID number does not exist in the database.
51
+ *
52
+ * - 302: no record found. Verification cannot be performed.
53
+ *
29
54
  * @example
30
55
  * 101
31
56
  */
@@ -58,12 +83,12 @@ export class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
58
83
  export class Id3MetaVerifyResponseBody extends $dara.Model {
59
84
  /**
60
85
  * @remarks
61
- * The response code. A value of 200 indicates success. Other values indicate failure.
86
+ * The response code. 200 indicates success. Other values indicate failure.
62
87
  *
63
88
  * **Important**
64
89
  *
65
- * - This parameter indicates only whether the API call is successful. For more information about return codes, see error codes.
66
- * - Check the fields in ResultObject for the business verification result.
90
+ * - This parameter indicates whether the API call is successful. For more information about return codes, see error codes.
91
+ * - Check the business verification result in the fields of ResultObject.
67
92
  *
68
93
  * @example
69
94
  * 200
@@ -71,11 +96,11 @@ export class Id3MetaVerifyResponseBody extends $dara.Model {
71
96
  code?: string;
72
97
  /**
73
98
  * @remarks
74
- * The response message of the API call.
99
+ * The response message.
75
100
  *
76
101
  * **Important**
77
102
  *
78
- * This parameter indicates only whether the API call is abnormal.
103
+ * This parameter only indicates whether the API call is abnormal.
79
104
  *
80
105
  * @example
81
106
  * success
@@ -9,7 +9,7 @@ export class Id3MetaVerifyWithOCRAdvanceRequest extends $dara.Model {
9
9
  * The input stream of the portrait side image of the ID card. Specify either CertUrl or CertFile.
10
10
  *
11
11
  * @example
12
- * 无
12
+ * None.
13
13
  */
14
14
  certFileObject?: Readable;
15
15
  /**
@@ -17,12 +17,12 @@ export class Id3MetaVerifyWithOCRAdvanceRequest extends $dara.Model {
17
17
  * The image of the national emblem side of the ID card. Specify either CertNationalUrl or CertNationalFile, or leave both empty.
18
18
  *
19
19
  * @example
20
- * 无
20
+ * None.
21
21
  */
22
22
  certNationalFileObject?: Readable;
23
23
  /**
24
24
  * @remarks
25
- * The URL of the national emblem side image of the ID card. Specify a publicly accessible HTTP or HTTPS URL. Specify either CertNationalUrl or CertNationalFile, or leave both empty.
25
+ * The URL of the national emblem side image of the ID card. A publicly accessible HTTP or HTTPS URL. Specify either CertNationalUrl or CertNationalFile, or leave both empty.
26
26
  *
27
27
  * @example
28
28
  * https://www.aliyun.com/cert.jpeg
@@ -30,7 +30,7 @@ export class Id3MetaVerifyWithOCRAdvanceRequest extends $dara.Model {
30
30
  certNationalUrl?: string;
31
31
  /**
32
32
  * @remarks
33
- * The image of the portrait side of the ID card. Specify a publicly accessible HTTP or HTTPS URL. Specify either CertUrl or CertFile.
33
+ * The image of the portrait side of the ID card. A publicly accessible HTTP or HTTPS URL. Specify either CertUrl or CertFile.
34
34
  *
35
35
  * @example
36
36
  * https://www.aliyun.com/cert.jpeg
@@ -8,7 +8,7 @@ export class Id3MetaVerifyWithOCRRequest extends $dara.Model {
8
8
  * The input stream of the portrait side image of the ID card. Specify either CertUrl or CertFile.
9
9
  *
10
10
  * @example
11
- * 无
11
+ * None.
12
12
  */
13
13
  certFile?: string;
14
14
  /**
@@ -16,12 +16,12 @@ export class Id3MetaVerifyWithOCRRequest extends $dara.Model {
16
16
  * The image of the national emblem side of the ID card. Specify either CertNationalUrl or CertNationalFile, or leave both empty.
17
17
  *
18
18
  * @example
19
- * 无
19
+ * None.
20
20
  */
21
21
  certNationalFile?: string;
22
22
  /**
23
23
  * @remarks
24
- * The URL of the national emblem side image of the ID card. Specify a publicly accessible HTTP or HTTPS URL. Specify either CertNationalUrl or CertNationalFile, or leave both empty.
24
+ * The URL of the national emblem side image of the ID card. A publicly accessible HTTP or HTTPS URL. Specify either CertNationalUrl or CertNationalFile, or leave both empty.
25
25
  *
26
26
  * @example
27
27
  * https://www.aliyun.com/cert.jpeg
@@ -29,7 +29,7 @@ export class Id3MetaVerifyWithOCRRequest extends $dara.Model {
29
29
  certNationalUrl?: string;
30
30
  /**
31
31
  * @remarks
32
- * The image of the portrait side of the ID card. Specify a publicly accessible HTTP or HTTPS URL. Specify either CertUrl or CertFile.
32
+ * The image of the portrait side of the ID card. A publicly accessible HTTP or HTTPS URL. Specify either CertUrl or CertFile.
33
33
  *
34
34
  * @example
35
35
  * https://www.aliyun.com/cert.jpeg
@@ -7,9 +7,9 @@ export class Id3MetaVerifyWithOCRResponseBodyResultObject extends $dara.Model {
7
7
  * @remarks
8
8
  * The identity verification result. Valid values:
9
9
  *
10
- * - 1: consistent.
11
- * - 2: inconsistent.
12
- * - 3: no record found.
10
+ * - 1: Consistent.
11
+ * - 2: Inconsistent.
12
+ * - 3: No record found.
13
13
  *
14
14
  * @example
15
15
  * 1
@@ -17,10 +17,10 @@ export class Id3MetaVerifyWithOCRResponseBodyResultObject extends $dara.Model {
17
17
  bizCode?: string;
18
18
  /**
19
19
  * @remarks
20
- * {"address":"浙江省杭州市余*****","birthDate":"19901226","certName":"张三","certNo":"1234561990122*****","nationality":"汉","authority":"xxx公安局","startDate":"20201130","endDate":"20301130"}.
20
+ * {"address":"No. XX, XX Road, Hangzhou, Zhejiang","birthDate":"19901226","certName":"John","certNo":"1234561990122*****","nationality":"Han","authority":"XXX Public Security Bureau","startDate":"20201130","endDate":"20301130"}
21
21
  *
22
22
  * @example
23
- * OCR读取的身份证信息。
23
+ * The ID card information extracted by OCR.
24
24
  */
25
25
  cardInfo?: string;
26
26
  /**
@@ -63,8 +63,8 @@ export class Id3MetaVerifyWithOCRResponseBody extends $dara.Model {
63
63
  * @remarks
64
64
  * The response code. 200 indicates success. Other values indicate failure. **Important**
65
65
  *
66
- * - This parameter indicates only whether the API call was made correctly. For more information about return codes, see error codes.
67
- * - Check the fields in ResultObject for the business verification result.
66
+ * - This parameter indicates whether the API was called correctly. For more information about return codes, refer to the error codes.
67
+ * - Check the business verification result in the fields of ResultObject.
68
68
  *
69
69
  * @example
70
70
  * 200
@@ -72,7 +72,7 @@ export class Id3MetaVerifyWithOCRResponseBody extends $dara.Model {
72
72
  code?: string;
73
73
  /**
74
74
  * @remarks
75
- * The response message of the API call. This parameter indicates only whether an exception occurred during the API call.
75
+ * The response message. Important: This parameter only indicates whether the API call is abnormal.
76
76
  *
77
77
  * @example
78
78
  * success
@@ -7,13 +7,13 @@ export class InitFaceVerifyRequest extends $dara.Model {
7
7
  * @remarks
8
8
  * Specifies whether the SDK enables strict face quality detection:
9
9
  *
10
- * - **Y**: enabled.
10
+ * - **Y**: Enabled.
11
11
  *
12
- * - **N**: disabled (default).
12
+ * - **N**: Disabled (default).
13
13
  *
14
14
  *
15
15
  * >
16
- * > - If this parameter is enabled, the SDK must integrate the [strict face quality detection module](https://www.alibabacloud.com/help/en/id-verification/financial-grade-id-verification/description-of-sdk-package-clipping). Strict quality detection may reduce the face authentication success rate.
16
+ * > - If this parameter is enabled, the SDK must integrate the [strict face quality detection module](https://www.alibabacloud.com/help/en/id-verification/financial-grade-id-verification/description-of-sdk-package-clipping). Strict quality detection may reduce the face recognition success rate.
17
17
  * > - Only Android SDK 2.3.24 and later versions are supported.
18
18
  *
19
19
  * @example
@@ -32,7 +32,7 @@ export class InitFaceVerifyRequest extends $dara.Model {
32
32
  * @remarks
33
33
  * The date of birth on the certificate.
34
34
  *
35
- * This field is required when **CertType** is set to **PASSPORT** and **Mode** is set to **3**.
35
+ * This field is required when the certificate type **CertType** is set to **PASSPORT** and **Mode** is set to **3**.
36
36
  *
37
37
  * @example
38
38
  * 1993-10-10
@@ -50,13 +50,13 @@ export class InitFaceVerifyRequest extends $dara.Model {
50
50
  callbackToken?: string;
51
51
  /**
52
52
  * @remarks
53
- * The callback URL for the authentication result. The callback request method is GET by default, and the callback URL must start with `https`. After authentication is complete, the platform calls back this URL and automatically appends the `certifyId` and `passed` fields. The `passed` field returns the subcode value. Example: `https://www.alibabacloud.com?callbackToken=1000004826&certifyId=shaxxxx&passed=200.`
53
+ * The callback notification URL for the authentication result. The default callback request method is GET, and the callback URL must start with `https`. After authentication is complete, the platform calls back this URL and automatically appends the `certifyId` and `passed` fields. The `passed` field returns the subcode value. Example: `https://www.aliyun.com?callbackToken=1000004826&certifyId=shaxxxx&passed=200.`
54
54
  *
55
55
  * <notice>
56
56
  *
57
- * - The callback is triggered only when authentication is complete (including both passed and failed). If the user abandons authentication, an abnormal break occurs, or authentication is not performed, no notification is sent. After receiving the callback notification, invoke the query operation to obtain authentication details if needed.
58
- * - The URL is validated for public network access before the operation is invoked. If the URL is not accessible over the public network, a 401 error is returned.
59
- * - After receiving the callback, return HTTP status code 200. Otherwise, a retry is triggered with two callbacks within 3 seconds.
57
+ * - The callback is triggered only when authentication is complete (including both passed and failed). If authentication is abandoned, abnormally breaks, or is not performed, no notification is sent. After receiving the callback notification, you can use the query operation to obtain authentication details if needed.
58
+ * - The accessibility of the provided URL is verified before the operation is invoked. If the URL cannot be accessed through public network access, error 401 is returned.
59
+ * - After receiving the callback, your service must return HTTP status code 200. Otherwise, a retry is triggered with two callbacks within 3 seconds.
60
60
  *
61
61
  * </notice>
62
62
  *
@@ -68,11 +68,11 @@ export class InitFaceVerifyRequest extends $dara.Model {
68
68
  * @remarks
69
69
  * Specifies whether to enable the camera selection feature:
70
70
  *
71
- * - **Y**: enabled.
71
+ * - **Y**: Enabled.
72
72
  *
73
- * - **N**: disabled (default).
73
+ * - **N**: Disabled (default).
74
74
  *
75
- * > This feature takes effect only for PC integration mode. After this feature is enabled, users can select a camera for authentication.
75
+ * > This feature takes effect only for PC integration mode. After it is enabled, users can select a camera for authentication.
76
76
  *
77
77
  * @example
78
78
  * N
@@ -83,7 +83,7 @@ export class InitFaceVerifyRequest extends $dara.Model {
83
83
  * The real name.
84
84
  *
85
85
  * @example
86
- * 张三
86
+ * Wang Shanshan
87
87
  */
88
88
  certName?: string;
89
89
  /**
@@ -107,9 +107,9 @@ export class InitFaceVerifyRequest extends $dara.Model {
107
107
  * @remarks
108
108
  * >Warning: This parameter will be deprecated.</warning>
109
109
  *
110
- * The CertifyId from a previous successful ID Verification. The photo from that authentication is used as the comparison photo.
110
+ * The CertifyId from a previous successful ID Verification session. The photo from that authentication is used as the comparison photo.
111
111
  *
112
- * > You can use one of the following four methods to submit a photo: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS. Select only one method.
112
+ * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, and OSS), select only one.
113
113
  *
114
114
  * @example
115
115
  * 0bfa7c493f850e5178b9f8613634c9xx
@@ -119,9 +119,9 @@ export class InitFaceVerifyRequest extends $dara.Model {
119
119
  * @remarks
120
120
  * The type of the returned **CertifyUrl**. Valid values:
121
121
  *
122
- * - **L**: original long URL.
122
+ * - **L**: Original long URL.
123
123
  *
124
- * - **S** (default): short URL.
124
+ * - **S** (default): Short URL.
125
125
  *
126
126
  * @example
127
127
  * L
@@ -139,28 +139,31 @@ export class InitFaceVerifyRequest extends $dara.Model {
139
139
  certifyUrlType?: string;
140
140
  /**
141
141
  * @remarks
142
- * Specifies whether to allow cropping of the face photo. By default, cropping is not allowed.
142
+ * Specifies whether to allow cropping of face images. Cropping is not allowed by default.
143
143
  *
144
- * - T: allows cropping.
144
+ * - T: Cropping is allowed.
145
145
  *
146
- * - F: does not allow cropping.
146
+ * - F: Cropping is not allowed.
147
147
  *
148
- * > If the requested image is not captured by a standard liveness detection SDK, allow cropping of the face photo. After this feature is enabled, the requested image is cropped and corrected before the request is sent to the service.
148
+ * > If the requested image is not captured by a standard liveness detection SDK, allow cropping of face images. After this feature is enabled, the requested image is first cropped and corrected before the request is sent to the service.
149
149
  *
150
150
  * @example
151
151
  * T
152
152
  */
153
153
  crop?: string;
154
154
  /**
155
+ * @remarks
156
+ * Specifies whether to enable beauty mode: Y/N.
157
+ *
155
158
  * @example
156
159
  * Y
157
160
  */
158
161
  enableBeauty?: string;
159
162
  /**
160
163
  * @remarks
161
- * The encryption algorithm. Currently, only the SM2 algorithm is supported.
164
+ * The encryption algorithm. Currently, only the SM2 national cryptographic algorithm is supported.
162
165
  *
163
- * After encrypted transmission is enabled, pass in the encrypted CertName and CertNo. For more information about encryption, refer to [Parameter encryption description](https://www.alibabacloud.com/help/en/id-verification/financial-grade-id-verification/description-of-parameter-encryption#task-2229332).
166
+ * After encrypted transmission is enabled, pass in the encrypted CertName and CertNo. For encryption instructions, refer to [Parameter encryption description](https://www.alibabacloud.com/help/en/id-verification/financial-grade-id-verification/description-of-parameter-encryption#task-2229332).
164
167
  *
165
168
  * @example
166
169
  * SM2
@@ -170,7 +173,7 @@ export class InitFaceVerifyRequest extends $dara.Model {
170
173
  * @remarks
171
174
  * The Base64-encoded photo.
172
175
  *
173
- * > You can use one of the following four methods to submit a photo: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS. Select only one method.
176
+ * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, and OSS), select only one.
174
177
  *
175
178
  * @example
176
179
  * /9j/4AAQSkZJRgABAQAASxxxxxxx
@@ -180,7 +183,7 @@ export class InitFaceVerifyRequest extends $dara.Model {
180
183
  * @remarks
181
184
  * The OSS photo URL. Currently, only authorized OSS photo URLs are supported.
182
185
  *
183
- * > You can use one of the following four methods to submit a photo: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS. Select only one method.
186
+ * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, and OSS), select only one.
184
187
  *
185
188
  * @example
186
189
  * https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg
@@ -200,9 +203,9 @@ export class InitFaceVerifyRequest extends $dara.Model {
200
203
  faceGuardOutput?: string;
201
204
  /**
202
205
  * @remarks
203
- * Specifies whether to display the "I have completed authentication" button on the H5 fallback page after authentication is complete:
204
- * - **Y**: enabled.
205
- * - **N** (default): disabled.
206
+ * Specifies whether to display the "I have completed authentication" button on the H5 degradation page after authentication is complete:
207
+ * - **Y**: Enabled.
208
+ * - **N** (default): Disabled.
206
209
  *
207
210
  * @example
208
211
  * Y
@@ -236,11 +239,11 @@ export class InitFaceVerifyRequest extends $dara.Model {
236
239
  * @remarks
237
240
  * The method for obtaining passport NFC verification elements:
238
241
  *
239
- * - **1**: user input. The end user manually enters certificate element information using the UI provided by the Alibaba Cloud SDK.
242
+ * - **1**: User input. The end user manually enters certificate element information using the UI provided by the Alibaba Cloud SDK.
240
243
  *
241
- * - **3**: external parameter input. Certificate element information is passed in externally.
244
+ * - **3**: External parameter input. Certificate element information is passed in externally.
242
245
  *
243
- * > To decode the encrypted information on the passport chip through NFC, three passport elements are required: name, date of birth, and certificate expiration date.
246
+ * > NFC decoding of passport chip encrypted information requires three passport elements: name, date of birth, and certificate expiration date.
244
247
  *
245
248
  * @example
246
249
  * 1
@@ -254,15 +257,15 @@ export class InitFaceVerifyRequest extends $dara.Model {
254
257
  * Note:
255
258
  * The liveness detection type supports only the following values. Custom actions or combinations are not supported.
256
259
  *
257
- * - **LIVENESS** (default): blink
260
+ * - **LIVENESS** (default): Blink.
258
261
  *
259
- * - **PHOTINUS_LIVENESS**: blink + colorful light
262
+ * - **PHOTINUS_LIVENESS**: Blink + colorful light.
260
263
  *
261
- * - **MULTI_ACTION**: blink + head shake (the order of blink and head shake is random)
264
+ * - **MULTI_ACTION**: Blink + head shake (the order of blink and head shake is random).
262
265
  *
263
- * - **MOVE_ACTION** (recommended): move closer/farther + blink
266
+ * - **MOVE_ACTION** (recommended): Move closer/farther + blink.
264
267
  *
265
- * - **MOVE_PHOTINUS**: move closer/farther + colorful light
268
+ * - **MOVE_PHOTINUS**: Move closer/farther + colorful light.
266
269
  *
267
270
  * >
268
271
  * >- **The default liveness detection type** is supported in the following versions:
@@ -279,9 +282,9 @@ export class InitFaceVerifyRequest extends $dara.Model {
279
282
  * @remarks
280
283
  * Specifies whether to block authentication when multiple faces are detected on the device. Valid values:
281
284
  *
282
- * - **Y**: blocked. The client prompts the user to redo face authentication.
285
+ * - **Y**: Block. The client prompts the user to redo face recognition.
283
286
  *
284
- * - **N** (default): not blocked. The largest face in the frame is sent to the server for security detection.
287
+ * - **N** (default): Do not block. The largest face in the frame is sent to the server for security detection.
285
288
  *
286
289
  * @example
287
290
  * Y
@@ -291,7 +294,7 @@ export class InitFaceVerifyRequest extends $dara.Model {
291
294
  * @remarks
292
295
  * The bucket name of the authorized OSS space.
293
296
  *
294
- * > You can use one of the following four methods to submit a photo: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS. Select only one method.
297
+ * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, and OSS), select only one.
295
298
  *
296
299
  * @example
297
300
  * cn-shanghai-aliyun-cloudauth-xxxxx
@@ -301,7 +304,7 @@ export class InitFaceVerifyRequest extends $dara.Model {
301
304
  * @remarks
302
305
  * The file name in the authorized OSS space.
303
306
  *
304
- * > You can use one of the following four methods to submit a photo: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS. Select only one method.
307
+ * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, and OSS), select only one.
305
308
  *
306
309
  * @example
307
310
  * verify/xxxxx/xxxxxx.jpeg
@@ -311,7 +314,7 @@ export class InitFaceVerifyRequest extends $dara.Model {
311
314
  * @remarks
312
315
  * The unique identifier of the merchant request.
313
316
  *
314
- * The value is a 32-character alphanumeric string. The first few characters are a custom abbreviation defined by the merchant, the middle part can be a time segment, and the last part can be a random or incremental sequence.
317
+ * The value is a 32-character alphanumeric string. The first few characters are a custom abbreviation defined by the merchant, the middle part can use a time segment, and the last part can use a random or incremental sequence.
315
318
  *
316
319
  * @example
317
320
  * e0c34a77f5ac40a5aa5e6ed20c353888
@@ -319,17 +322,17 @@ export class InitFaceVerifyRequest extends $dara.Model {
319
322
  outerOrderNo?: string;
320
323
  /**
321
324
  * @remarks
322
- * The fallback configuration when WebRTC or WebAssembly is incompatible during mobile H5 authentication.
325
+ * The degradation configuration when WebRTC or WebAssembly incompatibility occurs during mobile H5 authentication.
323
326
  *
324
- * - **keep**: fallback is not supported. The system returns directly.
327
+ * - **keep**: Degradation is not supported. The system returns directly.
325
328
  *
326
- * - **url** (default): fallback is supported. An authentication URL is returned. The user opens or switches to a browser to authenticate using this URL.
329
+ * - **url** (default): Degradation is supported. An authentication URL is returned. The user opens or switches to a browser to authenticate using this URL.
327
330
  *
328
- * - **video**: fallback is supported. The system camera records a 3 to 5 second blink video for authentication.
331
+ * - **video**: Degradation is supported. The system camera is used to record a 3-5 second blink video for authentication.
329
332
  *
330
333
  *
331
334
  * >
332
- * > When the fallback mode is Video, the following features are disabled and product security is reduced. Configure this mode only for security scenarios.
335
+ * > When the degradation mode is Video, the following features become ineffective and product security is reduced. Configure this mode only for security scenarios.
333
336
  * > - The liveness detection type setting does not take effect.
334
337
  * > - The VideoEvidence feature is not supported.
335
338
  *
@@ -340,9 +343,9 @@ export class InitFaceVerifyRequest extends $dara.Model {
340
343
  /**
341
344
  * @remarks
342
345
  * A fixed value. This parameter varies depending on the product plan:
343
- * - APP authentication plan: set to ID_PRO.
344
- * - Face liveness verification plan: set to PV_FV.
345
- * - Liveness detection plan: set to LR_FR.
346
+ * - APP authentication plan: The fixed value is ID_PRO.
347
+ * - Face liveness verification plan: The fixed value is PV_FV.
348
+ * - Liveness detection plan: The fixed value is LR_FR.
346
349
  *
347
350
  * @example
348
351
  * ID_PRO
@@ -352,9 +355,9 @@ export class InitFaceVerifyRequest extends $dara.Model {
352
355
  * @remarks
353
356
  * Specifies whether to enable the rare character mode:
354
357
  *
355
- * - **Y**: enabled. An information input box is displayed before authentication. The user must enter the name with rare characters and the ID card number, and agree to the protocol before starting the authentication process.
358
+ * - **Y**: Enabled. An information input box pops up before authentication, requiring the user to enter the rare character name and ID card number and agree to the agreement before starting the authentication process.
356
359
  *
357
- * - **N**: disabled (default).
360
+ * - **N**: Disabled (default).
358
361
  *
359
362
  * @example
360
363
  * Y
@@ -364,9 +367,9 @@ export class InitFaceVerifyRequest extends $dara.Model {
364
367
  * @remarks
365
368
  * Specifies whether to read the certificate photo:
366
369
  *
367
- * - **Y**: read.
370
+ * - **Y**: Read.
368
371
  *
369
- * - **N**: do not read.
372
+ * - **N**: Do not read.
370
373
  *
371
374
  * > If the certificate face photo is needed in subsequent authentication steps, set this parameter to Y.
372
375
  *
@@ -376,7 +379,7 @@ export class InitFaceVerifyRequest extends $dara.Model {
376
379
  readImg?: string;
377
380
  /**
378
381
  * @remarks
379
- * The redirect URL for the merchant business page.
382
+ * The target URL to which the merchant business page redirects.
380
383
  *
381
384
  * @example
382
385
  * www.aliyun.com
@@ -384,7 +387,7 @@ export class InitFaceVerifyRequest extends $dara.Model {
384
387
  returnUrl?: string;
385
388
  /**
386
389
  * @remarks
387
- * The authentication scenario ID.
390
+ * The authentication scene ID.
388
391
  *
389
392
  * @example
390
393
  * 1000000006
@@ -392,16 +395,16 @@ export class InitFaceVerifyRequest extends $dara.Model {
392
395
  sceneId?: number;
393
396
  /**
394
397
  * @remarks
395
- * The elderly-friendly configuration parameter. This parameter takes effect for each authentication request. You can select different parameters for each authentication request based on the business attributes, customer distribution, and operational characteristics of your app. Valid values (default: 0):
398
+ * The elderly-friendly configuration parameter. This parameter takes effect for each authentication request. You can select different parameters for each authentication request based on the business attributes, customer distribution, and operational characteristics of your app. Valid values:
396
399
  *
397
- * - **0**: disabled. The elderly-friendly mode is not enabled for the current authentication request.
400
+ * - **0** (default): Disabled. The current authentication request does not enable elderly-friendly mode.
398
401
  *
399
- * - **1**: enabled. The elderly-friendly mode is enabled for the current authentication request.
402
+ * - **1**: Enabled. The current authentication request enables elderly-friendly mode.
400
403
  *
401
- * - **2**: user choice.
404
+ * - **2**: User choice.
402
405
  *
403
406
  *
404
- * Allows the end user to select the authentication mode. The product guide page provides two authentication entries: "Start Authentication" and "Elderly Authentication Mode". When the user selects "Elderly Authentication Mode", the system enters elderly-friendly mode.
407
+ * Allows end users to select the authentication mode. The product guide page provides two authentication entries: "Start Authentication" and "Senior Authentication Mode". When the user selects "Senior Authentication Mode", the system enters elderly-friendly mode.
405
408
  * >
406
409
  * > - The elderly-friendly parameter takes effect only when the liveness detection type **Model** is set to **LIVENESS** or **MULTI_ACTION**.
407
410
  *
@@ -431,7 +434,7 @@ export class InitFaceVerifyRequest extends $dara.Model {
431
434
  * @remarks
432
435
  * The certificate expiration date.
433
436
  *
434
- * This field is required when **CertType** is set to **PASSPORT** and **Mode** is set to **3**.
437
+ * This field is required when the certificate type **CertType** is set to **PASSPORT** and **Mode** is set to **3**.
435
438
  *
436
439
  * @example
437
440
  * 2039-06-10
@@ -441,9 +444,9 @@ export class InitFaceVerifyRequest extends $dara.Model {
441
444
  * @remarks
442
445
  * Specifies whether to enable video evidence:
443
446
  *
444
- * - **true**: enabled.
447
+ * - **true**: Enabled.
445
448
  *
446
- * - **false**: disabled (default).
449
+ * - **false**: Disabled (default).
447
450
  *
448
451
  * > Because video files are large, the system discards video files to prioritize the transmission of essential authentication images when the network is unstable. Set video as a weak dependency in your business logic.
449
452
  *
@@ -455,12 +458,12 @@ export class InitFaceVerifyRequest extends $dara.Model {
455
458
  * @remarks
456
459
  * The custom voluntary content. This parameter is required when personalized settings are enabled. The format is a JSON string of a String List.
457
460
  *
458
- * - For read-aloud scenarios: the content cannot exceed 60 Chinese characters (excluding punctuation), and the List contains only 1 element.
461
+ * - For read-aloud scenarios: The content cannot exceed 60 Chinese characters (excluding punctuation), and the List contains only 1 element.
459
462
  *
460
- * - For Q&A scenarios: a maximum of 3 questions can be set. Each question cannot exceed 30 Chinese characters, and each question is a separate element in the List.
463
+ * - For Q&A scenarios: A maximum of 3 questions can be set. Each question cannot exceed 30 Chinese characters. Each question is a separate element in the List.
461
464
  *
462
465
  * @example
463
- * ["本人王先生同意***协议。"]
466
+ * ["I, Mr. Wang, agree to the *** agreement."]
464
467
  */
465
468
  voluntaryCustomizedContent?: string;
466
469
  static names(): { [key: string]: string } {
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class InitFaceVerifyResponseBodyResultObject extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The unique identifier for ID Verification.
8
+ * The unique identifier of the ID Verification session.
9
9
  *
10
10
  * @example
11
11
  * 91707dc296d469ad38e4c5efa6a0f24b
@@ -13,18 +13,16 @@ export class InitFaceVerifyResponseBodyResultObject extends $dara.Model {
13
13
  certifyId?: string;
14
14
  /**
15
15
  * @remarks
16
- * The URL for performing ID Verification in a web browser. After authentication is complete, the page redirects based on the ReturnUrl parameter.
16
+ * The URL for performing ID Verification in a web browser. After authentication ends, the page redirects based on the ReturnUrl input parameter.
17
17
  *
18
18
  * >Notice:
19
19
  *
20
- * - The CertifyUrl returned by the initialization operation is **valid for 30 minutes and can be submitted for authentication only once**. Use it within the validity period and do not reuse it.
21
- * - This parameter requires the **MetaInfo** parameter to be correctly passed in to return a CertifyUrl that matches the client. If the URL cannot be obtained, check whether **MetaInfo** and other input parameters are correct.
20
+ * - The CertifyUrl returned by the initialization operation is **valid for 30 minutes and can only be submitted once for authentication**. Use it within the validity period and avoid reuse.
21
+ * - This parameter requires the correct **MetaInfo** input to return a CertifyUrl that matches the client. If it cannot be obtained, check whether **MetaInfo** and other input parameters are correct.
22
22
  *
23
23
  * - The domain name of this URL may change with service updates. To ensure normal service availability, do not apply access control to this domain name.
24
24
  *
25
- * - Do not use incognito mode or modify the URL during browser redirection. Otherwise, a **signature exception** error may occur.
26
- *
27
- * .
25
+ * - When redirecting in a browser, do not use incognito mode or modify the URL. Otherwise, a **signature exception** error may occur.
28
26
  *
29
27
  * @example
30
28
  * https://t.aliyun.com/****
@@ -13,7 +13,7 @@ export class PageQueryWhiteListSettingRequest extends $dara.Model {
13
13
  certNo?: string;
14
14
  /**
15
15
  * @remarks
16
- * The unique identifier of the ID Verification request.
16
+ * The unique identifier of the ID Verification.
17
17
  *
18
18
  * @example
19
19
  * sha75b4e19a1ddda059b920757b0e12b
@@ -37,7 +37,7 @@ export class PageQueryWhiteListSettingRequest extends $dara.Model {
37
37
  pageSize?: number;
38
38
  /**
39
39
  * @remarks
40
- * The verification scenario ID. This ID is automatically generated after you create a verification scenario in the console. For more information about how to create a verification scenario, refer to Add a verification scenario.
40
+ * The verification scenario ID. This ID is automatically generated after you create a verification scenario in the console. For information about how to create a verification scenario, see Add a verification scenario.
41
41
  *
42
42
  * @example
43
43
  * 1000000xxx
@@ -57,7 +57,7 @@ export class PageQueryWhiteListSettingRequest extends $dara.Model {
57
57
  *
58
58
  * - DELETE: Deleted.
59
59
  * - VALID: Not deleted and within the validity period (valid).
60
- * - INVALID: Not deleted but outside the validity period (invalid).
60
+ * - INVALID: Not deleted but not within the validity period (invalid).
61
61
  *
62
62
  * @example
63
63
  * VALID
@@ -13,7 +13,7 @@ export class PageQueryWhiteListSettingResponseBodyResultObject extends $dara.Mod
13
13
  certNo?: string;
14
14
  /**
15
15
  * @remarks
16
- * The unique identifier of the ID Verification request.
16
+ * The unique identifier of the ID Verification.
17
17
  *
18
18
  * @example
19
19
  * sha43d9cabd52d370d9f4cca9468f71e
@@ -73,7 +73,7 @@ export class PageQueryWhiteListSettingResponseBodyResultObject extends $dara.Mod
73
73
  *
74
74
  * - DELETE: Deleted.
75
75
  * - VALID: Not deleted and within the validity period (valid).
76
- * - INVALID: Not deleted but outside the validity period (invalid).
76
+ * - INVALID: Not deleted but not within the validity period (invalid).
77
77
  *
78
78
  * @example
79
79
  * VALID
@@ -81,7 +81,7 @@ export class PageQueryWhiteListSettingResponseBodyResultObject extends $dara.Mod
81
81
  status?: string;
82
82
  /**
83
83
  * @remarks
84
- * The end date of the validity period.
84
+ * The end date of the validity period. Format: YYYY-MM-DD HH:mm:ss, for example, 2024-09-02 13:57:51.
85
85
  *
86
86
  * @example
87
87
  * 2024-09-02 13:57:51
@@ -89,7 +89,7 @@ export class PageQueryWhiteListSettingResponseBodyResultObject extends $dara.Mod
89
89
  validEndDate?: string;
90
90
  /**
91
91
  * @remarks
92
- * The start date of the validity period.
92
+ * The start date of the validity period. Format: YYYY-MM-DD HH:mm:ss, for example, 2024-08-30 13:57:51.
93
93
  *
94
94
  * @example
95
95
  * 2024-08-30 13:57:51