@alicloud/cloudauth20190307 3.9.4 → 3.10.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 (137) hide show
  1. package/dist/client.d.ts +271 -10
  2. package/dist/client.js +393 -10
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/ContrastFaceVerifyAdvanceRequest.d.ts +93 -0
  5. package/dist/models/ContrastFaceVerifyAdvanceRequest.js.map +1 -1
  6. package/dist/models/ContrastFaceVerifyRequest.d.ts +93 -0
  7. package/dist/models/ContrastFaceVerifyRequest.js.map +1 -1
  8. package/dist/models/ContrastFaceVerifyResponseBody.d.ts +32 -0
  9. package/dist/models/ContrastFaceVerifyResponseBody.js.map +1 -1
  10. package/dist/models/CreateAuthKeyRequest.d.ts +12 -0
  11. package/dist/models/CreateAuthKeyRequest.js.map +1 -1
  12. package/dist/models/CreateAuthKeyResponseBody.d.ts +6 -0
  13. package/dist/models/CreateAuthKeyResponseBody.js.map +1 -1
  14. package/dist/models/CreateVerifySettingRequest.d.ts +18 -0
  15. package/dist/models/CreateVerifySettingRequest.js.map +1 -1
  16. package/dist/models/CreateVerifySettingResponseBody.d.ts +20 -0
  17. package/dist/models/CreateVerifySettingResponseBody.js.map +1 -1
  18. package/dist/models/CredentialVerifyRequest.d.ts +132 -0
  19. package/dist/models/CredentialVerifyRequest.js.map +1 -1
  20. package/dist/models/CredentialVerifyResponseBody.d.ts +103 -0
  21. package/dist/models/CredentialVerifyResponseBody.js.map +1 -1
  22. package/dist/models/CredentialVerifyShrinkRequest.d.ts +116 -0
  23. package/dist/models/CredentialVerifyShrinkRequest.js.map +1 -1
  24. package/dist/models/DescribeCardVerifyRequest.d.ts +3 -0
  25. package/dist/models/DescribeCardVerifyRequest.js.map +1 -1
  26. package/dist/models/DescribeCardVerifyResponseBody.d.ts +52 -0
  27. package/dist/models/DescribeCardVerifyResponseBody.js.map +1 -1
  28. package/dist/models/DescribeDeviceInfoRequest.d.ts +21 -0
  29. package/dist/models/DescribeDeviceInfoRequest.js.map +1 -1
  30. package/dist/models/DescribeDeviceInfoResponseBody.d.ts +31 -0
  31. package/dist/models/DescribeDeviceInfoResponseBody.js.map +1 -1
  32. package/dist/models/DescribeFaceGuardRiskRequest.d.ts +14 -0
  33. package/dist/models/DescribeFaceGuardRiskRequest.js.map +1 -1
  34. package/dist/models/DescribeFaceGuardRiskResponseBody.d.ts +32 -1
  35. package/dist/models/DescribeFaceGuardRiskResponseBody.js.map +1 -1
  36. package/dist/models/DescribeFaceVerifyRequest.d.ts +9 -0
  37. package/dist/models/DescribeFaceVerifyRequest.js.map +1 -1
  38. package/dist/models/DescribeFaceVerifyResponseBody.d.ts +59 -0
  39. package/dist/models/DescribeFaceVerifyResponseBody.js.map +1 -1
  40. package/dist/models/DescribeOssUploadTokenResponseBody.d.ts +28 -0
  41. package/dist/models/DescribeOssUploadTokenResponseBody.js.map +1 -1
  42. package/dist/models/DescribePageFaceVerifyDataRequest.d.ts +18 -0
  43. package/dist/models/DescribePageFaceVerifyDataRequest.js.map +1 -1
  44. package/dist/models/DescribePageFaceVerifyDataResponseBody.d.ts +50 -0
  45. package/dist/models/DescribePageFaceVerifyDataResponseBody.js.map +1 -1
  46. package/dist/models/DescribeSmartStatisticsPageListRequest.d.ts +13 -0
  47. package/dist/models/DescribeSmartStatisticsPageListRequest.js.map +1 -1
  48. package/dist/models/DescribeSmartStatisticsPageListResponseBody.d.ts +44 -0
  49. package/dist/models/DescribeSmartStatisticsPageListResponseBody.js.map +1 -1
  50. package/dist/models/DescribeVerifyResultRequest.d.ts +4 -0
  51. package/dist/models/DescribeVerifyResultRequest.js.map +1 -1
  52. package/dist/models/DescribeVerifyResultResponseBody.d.ts +125 -0
  53. package/dist/models/DescribeVerifyResultResponseBody.js.map +1 -1
  54. package/dist/models/DescribeVerifySdkrequest.d.ts +2 -0
  55. package/dist/models/DescribeVerifySdkrequest.js.map +1 -1
  56. package/dist/models/DescribeVerifySdkresponseBody.d.ts +6 -0
  57. package/dist/models/DescribeVerifySdkresponseBody.js.map +1 -1
  58. package/dist/models/DescribeVerifyTokenRequest.d.ts +49 -0
  59. package/dist/models/DescribeVerifyTokenRequest.js.map +1 -1
  60. package/dist/models/DescribeVerifyTokenResponseBody.d.ts +34 -0
  61. package/dist/models/DescribeVerifyTokenResponseBody.js.map +1 -1
  62. package/dist/models/DetectFaceAttributesRequest.d.ts +5 -0
  63. package/dist/models/DetectFaceAttributesRequest.js.map +1 -1
  64. package/dist/models/DetectFaceAttributesResponseBody.d.ts +100 -0
  65. package/dist/models/DetectFaceAttributesResponseBody.js.map +1 -1
  66. package/dist/models/Id3metaVerifyAdvanceRequest.d.ts +87 -0
  67. package/dist/models/Id3metaVerifyAdvanceRequest.js +67 -0
  68. package/dist/models/Id3metaVerifyAdvanceRequest.js.map +1 -0
  69. package/dist/models/Id3metaVerifyRequest.d.ts +86 -0
  70. package/dist/models/Id3metaVerifyRequest.js +68 -0
  71. package/dist/models/Id3metaVerifyRequest.js.map +1 -0
  72. package/dist/models/Id3metaVerifyResponse.d.ts +19 -0
  73. package/dist/models/Id3metaVerifyResponse.js +69 -0
  74. package/dist/models/Id3metaVerifyResponse.js.map +1 -0
  75. package/dist/models/Id3metaVerifyResponseBody.d.ts +83 -0
  76. package/dist/models/Id3metaVerifyResponseBody.js +88 -0
  77. package/dist/models/Id3metaVerifyResponseBody.js.map +1 -0
  78. package/dist/models/InitFaceVerifyRequest.d.ts +348 -0
  79. package/dist/models/InitFaceVerifyRequest.js +2 -0
  80. package/dist/models/InitFaceVerifyRequest.js.map +1 -1
  81. package/dist/models/InitFaceVerifyResponseBody.d.ts +32 -0
  82. package/dist/models/InitFaceVerifyResponseBody.js.map +1 -1
  83. package/dist/models/LivenessFaceVerifyRequest.d.ts +46 -0
  84. package/dist/models/LivenessFaceVerifyRequest.js.map +1 -1
  85. package/dist/models/LivenessFaceVerifyResponseBody.d.ts +29 -0
  86. package/dist/models/LivenessFaceVerifyResponseBody.js.map +1 -1
  87. package/dist/models/VerifyMaterialRequest.d.ts +24 -0
  88. package/dist/models/VerifyMaterialRequest.js.map +1 -1
  89. package/dist/models/VerifyMaterialResponseBody.d.ts +118 -0
  90. package/dist/models/VerifyMaterialResponseBody.js.map +1 -1
  91. package/dist/models/model.d.ts +5 -0
  92. package/dist/models/model.js +15 -5
  93. package/dist/models/model.js.map +1 -1
  94. package/package.json +1 -1
  95. package/src/client.ts +407 -10
  96. package/src/models/ContrastFaceVerifyAdvanceRequest.ts +93 -0
  97. package/src/models/ContrastFaceVerifyRequest.ts +93 -0
  98. package/src/models/ContrastFaceVerifyResponseBody.ts +32 -0
  99. package/src/models/CreateAuthKeyRequest.ts +12 -0
  100. package/src/models/CreateAuthKeyResponseBody.ts +6 -0
  101. package/src/models/CreateVerifySettingRequest.ts +18 -0
  102. package/src/models/CreateVerifySettingResponseBody.ts +20 -0
  103. package/src/models/CredentialVerifyRequest.ts +132 -0
  104. package/src/models/CredentialVerifyResponseBody.ts +103 -0
  105. package/src/models/CredentialVerifyShrinkRequest.ts +116 -0
  106. package/src/models/DescribeCardVerifyRequest.ts +3 -0
  107. package/src/models/DescribeCardVerifyResponseBody.ts +52 -0
  108. package/src/models/DescribeDeviceInfoRequest.ts +21 -0
  109. package/src/models/DescribeDeviceInfoResponseBody.ts +31 -0
  110. package/src/models/DescribeFaceGuardRiskRequest.ts +14 -0
  111. package/src/models/DescribeFaceGuardRiskResponseBody.ts +32 -1
  112. package/src/models/DescribeFaceVerifyRequest.ts +9 -0
  113. package/src/models/DescribeFaceVerifyResponseBody.ts +59 -0
  114. package/src/models/DescribeOssUploadTokenResponseBody.ts +28 -0
  115. package/src/models/DescribePageFaceVerifyDataRequest.ts +18 -0
  116. package/src/models/DescribePageFaceVerifyDataResponseBody.ts +50 -0
  117. package/src/models/DescribeSmartStatisticsPageListRequest.ts +13 -0
  118. package/src/models/DescribeSmartStatisticsPageListResponseBody.ts +44 -0
  119. package/src/models/DescribeVerifyResultRequest.ts +4 -0
  120. package/src/models/DescribeVerifyResultResponseBody.ts +125 -0
  121. package/src/models/DescribeVerifySdkrequest.ts +2 -0
  122. package/src/models/DescribeVerifySdkresponseBody.ts +6 -0
  123. package/src/models/DescribeVerifyTokenRequest.ts +49 -0
  124. package/src/models/DescribeVerifyTokenResponseBody.ts +34 -0
  125. package/src/models/DetectFaceAttributesRequest.ts +5 -0
  126. package/src/models/DetectFaceAttributesResponseBody.ts +100 -0
  127. package/src/models/Id3metaVerifyAdvanceRequest.ts +110 -0
  128. package/src/models/Id3metaVerifyRequest.ts +109 -0
  129. package/src/models/Id3metaVerifyResponse.ts +40 -0
  130. package/src/models/Id3metaVerifyResponseBody.ts +117 -0
  131. package/src/models/InitFaceVerifyRequest.ts +350 -0
  132. package/src/models/InitFaceVerifyResponseBody.ts +32 -0
  133. package/src/models/LivenessFaceVerifyRequest.ts +46 -0
  134. package/src/models/LivenessFaceVerifyResponseBody.ts +29 -0
  135. package/src/models/VerifyMaterialRequest.ts +24 -0
  136. package/src/models/VerifyMaterialResponseBody.ts +118 -0
  137. package/src/models/model.ts +5 -0
@@ -0,0 +1,83 @@
1
+ import * as $dara from '@darabonba/typescript';
2
+ export declare class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
3
+ /**
4
+ * @remarks
5
+ * Identity verification result:
6
+ *
7
+ * - 1: Consistent
8
+ * - 2: Inconsistent
9
+ * - 3: No record found
10
+ *
11
+ * @example
12
+ * 1
13
+ */
14
+ bizCode?: string;
15
+ /**
16
+ * @remarks
17
+ * Image comparison score.
18
+ *
19
+ * @example
20
+ * {
21
+ * "verifyScore": 50.28594166529785
22
+ * }
23
+ */
24
+ faceDetail?: string;
25
+ static names(): {
26
+ [key: string]: string;
27
+ };
28
+ static types(): {
29
+ [key: string]: any;
30
+ };
31
+ validate(): void;
32
+ constructor(map?: {
33
+ [key: string]: any;
34
+ });
35
+ }
36
+ export declare class Id3MetaVerifyResponseBody extends $dara.Model {
37
+ /**
38
+ * @remarks
39
+ * Return code: 200 indicates success, others indicate failure.
40
+ * **Important**
41
+ * - This parameter indicates whether the interface was called correctly. For detailed return code explanations, please refer to the error codes.
42
+ * - Check the business verification result through the fields in `ResultObject`.
43
+ *
44
+ * @example
45
+ * 200
46
+ */
47
+ code?: string;
48
+ /**
49
+ * @remarks
50
+ * Interface call return message.
51
+ *
52
+ * **Important**
53
+ *
54
+ * This parameter only indicates whether there was an exception with the interface.
55
+ *
56
+ * @example
57
+ * success
58
+ */
59
+ message?: string;
60
+ /**
61
+ * @remarks
62
+ * Request ID.
63
+ *
64
+ * @example
65
+ * 130A2C10-B9EE-4D84-88E3-5384FF03****
66
+ */
67
+ requestId?: string;
68
+ /**
69
+ * @remarks
70
+ * Result object.
71
+ */
72
+ resultObject?: Id3MetaVerifyResponseBodyResultObject;
73
+ static names(): {
74
+ [key: string]: string;
75
+ };
76
+ static types(): {
77
+ [key: string]: any;
78
+ };
79
+ validate(): void;
80
+ constructor(map?: {
81
+ [key: string]: any;
82
+ });
83
+ }
@@ -0,0 +1,88 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
35
+ Object.defineProperty(exports, "__esModule", { value: true });
36
+ exports.Id3MetaVerifyResponseBody = exports.Id3MetaVerifyResponseBodyResultObject = void 0;
37
+ // This file is auto-generated, don't edit it
38
+ const $dara = __importStar(require("@darabonba/typescript"));
39
+ class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
40
+ static names() {
41
+ return {
42
+ bizCode: 'BizCode',
43
+ faceDetail: 'FaceDetail',
44
+ };
45
+ }
46
+ static types() {
47
+ return {
48
+ bizCode: 'string',
49
+ faceDetail: 'string',
50
+ };
51
+ }
52
+ validate() {
53
+ super.validate();
54
+ }
55
+ constructor(map) {
56
+ super(map);
57
+ }
58
+ }
59
+ exports.Id3MetaVerifyResponseBodyResultObject = Id3MetaVerifyResponseBodyResultObject;
60
+ class Id3MetaVerifyResponseBody extends $dara.Model {
61
+ static names() {
62
+ return {
63
+ code: 'Code',
64
+ message: 'Message',
65
+ requestId: 'RequestId',
66
+ resultObject: 'ResultObject',
67
+ };
68
+ }
69
+ static types() {
70
+ return {
71
+ code: 'string',
72
+ message: 'string',
73
+ requestId: 'string',
74
+ resultObject: Id3MetaVerifyResponseBodyResultObject,
75
+ };
76
+ }
77
+ validate() {
78
+ if (this.resultObject && typeof this.resultObject.validate === 'function') {
79
+ this.resultObject.validate();
80
+ }
81
+ super.validate();
82
+ }
83
+ constructor(map) {
84
+ super(map);
85
+ }
86
+ }
87
+ exports.Id3MetaVerifyResponseBody = Id3MetaVerifyResponseBody;
88
+ //# sourceMappingURL=Id3metaVerifyResponseBody.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Id3metaVerifyResponseBody.js","sourceRoot":"","sources":["../../src/models/Id3metaVerifyResponseBody.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,qCAAsC,SAAQ,KAAK,CAAC,KAAK;IAuBpE,MAAM,CAAC,KAAK;QACV,OAAO;YACL,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,YAAY;SACzB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,OAAO,EAAE,QAAQ;YACjB,UAAU,EAAE,QAAQ;SACrB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA5CD,sFA4CC;AAED,MAAa,yBAA0B,SAAQ,KAAK,CAAC,KAAK;IAqCxD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,WAAW;YACtB,YAAY,EAAE,cAAc;SAC7B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,QAAQ;YACnB,YAAY,EAAE,qCAAqC;SACpD,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,IAAI,CAAC,YAAY,IAAI,OAAQ,IAAI,CAAC,YAAoB,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;YACjF,IAAI,CAAC,YAAoB,CAAC,QAAQ,EAAE,CAAC;QACxC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAjED,8DAiEC"}
@@ -1,101 +1,449 @@
1
1
  import * as $dara from '@darabonba/typescript';
2
2
  export declare class InitFaceVerifyRequest extends $dara.Model {
3
+ /**
4
+ * @remarks
5
+ * Whether the SDK enables strict face quality detection:
6
+ *
7
+ * - **Y**: Enable
8
+ *
9
+ * - **N** (default): Disable
10
+ *
11
+ *
12
+ * >
13
+ * > - If this parameter is enabled, the SDK needs to integrate the [strict face quality detection module](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/description-of-sdk-package-clipping?spm=a2c4g.11186623.0.0.1a9d35c6ySFUPW). Enabling strict quality detection may decrease the success rate of user face recognition.
14
+ * > - Only supported in Android SDK version 2.3.24 and above.
15
+ *
16
+ * @example
17
+ * N
18
+ */
3
19
  appQualityCheck?: string;
20
+ /**
21
+ * @remarks
22
+ * User authorization ID, with a maximum length of 64 characters.
23
+ *
24
+ * @example
25
+ * 92d46b9e9e2d703f2897f350d5bd4149
26
+ */
4
27
  authId?: string;
28
+ /**
29
+ * @remarks
30
+ * Date of birth on the document.
31
+ *
32
+ * This field is required when the document type **CertType** is **PASSPORT** and **Mode** is **3**.
33
+ *
34
+ * @example
35
+ * 1993-10-10
36
+ */
5
37
  birthday?: string;
38
+ /**
39
+ * @remarks
40
+ * Security token, generated by you, used for preventing duplication and tampering.
41
+ *
42
+ * If this value is set, the **CallbackToken** field will be displayed in the callback address.
43
+ *
44
+ * @example
45
+ * NMjvQanQgplBSaEI0sL86WnQplB
46
+ */
6
47
  callbackToken?: string;
48
+ /**
49
+ * @remarks
50
+ * Callback notification address for the authentication result, with the default callback request method being GET. The callback address must start with `https`. After completing the authentication, the platform will call back this address and automatically add the `certifyId` and `passed` fields, where the value of the `passed` field is the subcode, for example: `https://www.aliyun.com?callbackToken=1000004826&certifyId=shaxxxx&passed=200`.
51
+ *
52
+ * <notice>
53
+ *
54
+ * - Callbacks are triggered only when the authentication is completed (including both successful and unsuccessful authentications). If the authentication is abandoned, interrupted abnormally, or not performed, no notification will be sent. It is recommended that you retrieve detailed authentication information through a query interface if needed after receiving the callback notification.
55
+ * - The accessibility of the provided address will be verified before the API call. If the address cannot be accessed over the public network, a 401 error will be returned.
56
+ * - The callback interface must return an HTTP status code of 200; otherwise, it will trigger a retry, with two callbacks within 3 seconds.
57
+ *
58
+ * </notice>
59
+ *
60
+ * @example
61
+ * https://www.aliyun.com
62
+ */
7
63
  callbackUrl?: string;
64
+ /**
65
+ * @remarks
66
+ * Whether to enable the camera selection feature:
67
+ *
68
+ * - **Y**: Enable
69
+ *
70
+ * - **N** (default): Disable
71
+ *
72
+ * > This feature only takes effect in PC integration mode. When enabled, it allows users to select the camera for authentication.
73
+ *
74
+ * @example
75
+ * N
76
+ */
8
77
  cameraSelection?: string;
78
+ /**
79
+ * @remarks
80
+ * Real name.
81
+ *
82
+ * @example
83
+ * 张三
84
+ */
9
85
  certName?: string;
10
86
  /**
87
+ * @remarks
88
+ * Document number.
89
+ *
11
90
  * @example
12
91
  * 330103xxxxxxxxxxxx
13
92
  */
14
93
  certNo?: string;
15
94
  /**
95
+ * @remarks
96
+ * Document type.
97
+ * Currently, only IDENTITY_CARD (ID card) is supported.
98
+ *
16
99
  * @example
17
100
  * IDENTITY_CARD
18
101
  */
19
102
  certType?: string;
20
103
  /**
104
+ * @remarks
105
+ * >Warning: To be deprecated
106
+ *
107
+ * Previously passed CertifyId for real-person authentication, where the photo taken during authentication is used as the comparison photo.
108
+ *
109
+ * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.
110
+ *
21
111
  * @example
22
112
  * 0bfa7c493f850e5178b9f8613634c9xx
23
113
  */
24
114
  certifyId?: string;
115
+ /**
116
+ * @remarks
117
+ * Types of **CertifyUrl** returned, including:
118
+ *
119
+ * - **L**: Original long link
120
+ *
121
+ * - **S** (default): Short link
122
+ *
123
+ * @example
124
+ * L
125
+ */
25
126
  certifyUrlStyle?: string;
127
+ /**
128
+ * @remarks
129
+ * Web SDK device type, with values **WEB** or **H5**.
130
+ *
131
+ * > Only Web SDK device types are supported.
132
+ *
133
+ * @example
134
+ * WEB
135
+ */
26
136
  certifyUrlType?: string;
137
+ /**
138
+ * @remarks
139
+ * Whether to allow cropping of the face image, with the default being not allowed.
140
+ *
141
+ * - T: Indicates allowing cropping.
142
+ *
143
+ * - F: Indicates not allowing cropping.
144
+ *
145
+ * > If the image you are requesting is not from a standard liveness detection SDK, it is recommended to allow face image cropping. When this feature is enabled, the requested image will first undergo face cropping and alignment, and then the service request will be initiated.
146
+ *
147
+ * @example
148
+ * T
149
+ */
27
150
  crop?: string;
151
+ /**
152
+ * @remarks
153
+ * Encryption algorithm to be used, currently supporting only the SM2 national encryption algorithm.
154
+ *
155
+ * After enabling encrypted transmission, you need to pass in the encrypted CertName and CertNo. For how to encrypt, please refer to [Parameter Encryption Instructions](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/description-of-parameter-encryption?spm=a2c4g.11186623.0.0.1a9d566eWdqwy8#task-2229332).
156
+ *
157
+ * @example
158
+ * SM2
159
+ */
28
160
  encryptType?: string;
29
161
  /**
162
+ * @remarks
163
+ * Base64 encoded photo.
164
+ *
165
+ * > Choose one of the following methods to upload the image: FaceContrastPicture, FaceContrastPictureUrl, CertifyId, or OSS.
166
+ *
30
167
  * @example
31
168
  * /9j/4AAQSkZJRgABAQAASxxxxxxx
32
169
  */
33
170
  faceContrastPicture?: string;
34
171
  /**
172
+ * @remarks
173
+ * OSS photo address, currently only supports authorized OSS photo addresses.
174
+ *
175
+ * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.
176
+ *
35
177
  * @example
36
178
  * https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg
37
179
  */
38
180
  faceContrastPictureUrl?: string;
181
+ /**
182
+ * @remarks
183
+ * Device assistant label type, with the value: **DeviceRisk**.
184
+ *
185
+ * >
186
+ * > - Choosing to output the device assistant will incur additional costs. For details, see [Paid Value-Added Services](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/face-guard?spm=a2c4g.11186623.0.0.443e5522rbHsR4).
187
+ * > - If you do not need to output the device assistant label, you can either not pass the parameter or pass an empty value.
188
+ *
189
+ * @example
190
+ * DeviceRisk
191
+ */
39
192
  faceGuardOutput?: string;
40
193
  /**
194
+ * @remarks
195
+ * User\\"s IP address.
196
+ *
41
197
  * @example
42
198
  * 114.xxx.xxx.xxx
43
199
  */
44
200
  ip?: string;
45
201
  /**
202
+ * @remarks
203
+ * Metainfo environment parameter, which needs to be obtained through the client SDK.
204
+ *
46
205
  * @example
47
206
  * {"zimVer":"3.0.0","appVersion": "1","bioMetaInfo": "4.1.0:11501568,0","appName": "com.aliyun.antcloudauth","deviceType": "ios","osVersion": "iOS 10.3.2","apdidToken": "","deviceModel": "iPhone9,1"}
48
207
  */
49
208
  metaInfo?: string;
50
209
  /**
210
+ * @remarks
211
+ * User\\"s phone number.
212
+ *
51
213
  * @example
52
214
  * 130xxxxxxxx
53
215
  */
54
216
  mobile?: string;
217
+ /**
218
+ * @remarks
219
+ * Method to obtain passport NFC verification elements:
220
+ *
221
+ * - **1**: User input, where the end-user manually inputs the document information using the UI interface provided by the Alibaba Cloud SDK.
222
+ *
223
+ * - **3**: External parameter input, where the document information is passed through external parameters.
224
+ *
225
+ * > When decoding the encrypted information from the passport chip using NFC, three elements of the passport need to be obtained, including name, date of birth, and document expiration date.
226
+ *
227
+ * @example
228
+ * 1
229
+ */
55
230
  mode?: string;
231
+ /**
232
+ * @remarks
233
+ * Liveness detection type, with values:
234
+ * > Only the following liveness detection types are supported; custom actions or combinations are not supported at this time.
235
+ *
236
+ * Note
237
+ * Only the following liveness detection types are supported; custom actions or combinations are not supported at this time.
238
+ *
239
+ * - **LIVENESS** (default): Blinking
240
+ *
241
+ * - **PHOTINUS_LIVENESS**: Blinking + Colorful Light
242
+ *
243
+ * - **MULTI_ACTION**: Blinking + Head Shaking (the order of blinking and head shaking is random)
244
+ *
245
+ * - **MOVE_ACTION** (recommended): Moving Closer and Farther + Blinking
246
+ *
247
+ * - **MOVE_PHOTINUS**: Moving Closer and Farther + Colorful Light
248
+ *
249
+ * >
250
+ * >- The **default liveness detection type** is supported in the following versions:
251
+ * > - Android SDK 1.2.6 and above
252
+ * > - iOS SDK 1.2.4 and above
253
+ * > - Harmony SDK 1.0.0 and above
254
+ * >- Other types are supported in the latest SDK versions for Android/iOS/Harmony. It is recommended to integrate the latest version.
255
+ *
256
+ * @example
257
+ * MOVE_ACTION
258
+ */
56
259
  model?: string;
57
260
  /**
261
+ * @remarks
262
+ * Whether to intercept when multiple faces are detected, with the following values:
263
+ *
264
+ * - **Y**: Intercept, and the client prompts the user to re-scan their face.
265
+ *
266
+ * - **N** (default): Do not intercept, and send the largest face in the scanned image to the server for security checks.
267
+ *
268
+ * @example
269
+ * Y
270
+ */
271
+ needMultiFaceCheck?: string;
272
+ /**
273
+ * @remarks
274
+ * Authorized OSS bucket name.
275
+ *
276
+ * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.
277
+ *
58
278
  * @example
59
279
  * cn-shanghai-aliyun-cloudauth-xxxxx
60
280
  */
61
281
  ossBucketName?: string;
62
282
  /**
283
+ * @remarks
284
+ * Authorized OSS object name.
285
+ *
286
+ * > Among the four image input methods (FaceContrastPicture, FaceContrastPictureUrl, CertifyId, OSS), choose one to input.
287
+ *
63
288
  * @example
64
289
  * verify/xxxxx/xxxxxx.jpeg
65
290
  */
66
291
  ossObjectName?: string;
67
292
  /**
293
+ * @remarks
294
+ * Unique identifier for the merchant\\"s request.
295
+ *
296
+ * The value is a 32-character alphanumeric combination. The first few characters are a custom abbreviation defined by the merchant, followed by a period, and the latter part can be a random or incremental sequence.
297
+ *
68
298
  * @example
69
299
  * e0c34a77f5ac40a5aa5e6ed20c353888
70
300
  */
71
301
  outerOrderNo?: string;
302
+ /**
303
+ * @remarks
304
+ * Degradation configuration for mobile H5 authentication when WebRTC or Webassembly is incompatible.
305
+ *
306
+ * - **keep**: Does not support degradation, returns directly.
307
+ *
308
+ * - **url** (default): Supports degradation, returns an authentication URL. Users can use this URL to open or switch browsers for authentication.
309
+ *
310
+ * - **video**: Supports degradation, uses the system camera to record a 3~5 second blinking video for authentication.
311
+ *
312
+ *
313
+ * >
314
+ * > When the degradation mode is Video, the following functions will be disabled, and the product security will decrease. It is recommended to configure it only for secure scenarios.
315
+ * > - Liveness detection type settings will not take effect.
316
+ * > - The VideoEvidence function is not supported.
317
+ *
318
+ * @example
319
+ * url
320
+ */
72
321
  procedurePriority?: string;
73
322
  /**
323
+ * @remarks
324
+ * Fixed value. The parameter value differs based on the product solution:
325
+ * - APP Authentication Scheme: Fixed value is ID_PRO
326
+ * - Live Face Verification Scheme: Fixed value is PV_FV
327
+ * - Liveness Detection Scheme: Fixed value is LR_FR
328
+ *
74
329
  * @example
75
330
  * ID_PRO
76
331
  */
77
332
  productCode?: string;
333
+ /**
334
+ * @remarks
335
+ * Whether to enable rare character mode:
336
+ *
337
+ * - **Y**: Enable. A message input box will pop up before the user authenticates, requiring the input of the rare character name and ID number. The user must agree to the terms before starting the authentication process.
338
+ *
339
+ * - **N**: Not enabled (default)
340
+ *
341
+ * @example
342
+ * Y
343
+ */
78
344
  rarelyCharacters?: string;
345
+ /**
346
+ * @remarks
347
+ * Whether to read the document photo:
348
+ *
349
+ * - **Y**: Read
350
+ *
351
+ * - **N**: Do not read
352
+ *
353
+ * > If the document face photo is needed in subsequent authentication steps, it is recommended to set this parameter to Y.
354
+ *
355
+ * @example
356
+ * Y
357
+ */
79
358
  readImg?: string;
80
359
  /**
360
+ * @remarks
361
+ * Target URL for the merchant\\"s business page to redirect to.
362
+ *
81
363
  * @example
82
364
  * www.aliyun.com
83
365
  */
84
366
  returnUrl?: string;
85
367
  /**
368
+ * @remarks
369
+ * Authentication Scene ID.
370
+ *
86
371
  * @example
87
372
  * 1000000006
88
373
  */
89
374
  sceneId?: number;
375
+ /**
376
+ * @remarks
377
+ * Aging-friendly configuration parameters that take effect for each authentication request. You can choose different parameters based on your app\\"s business attributes, customer distribution, operational characteristics, etc., for each authentication request. The options include the following, with the default being 0.
378
+ *
379
+ * - **0**: Not enabled, indicating that the current authentication request does not enable aging-friendly mode.
380
+ *
381
+ * - **1**: Enabled, indicating that the current authentication request enables aging-friendly mode.
382
+ *
383
+ * - **2**: User choice.
384
+ *
385
+ *
386
+ * Supports end-users in choosing the authentication mode. The product guide page provides two authentication entry points: \\"Enable Authentication\\" and \\"Elderly Authentication Mode\\". When the user selects \\"Elderly Authentication Mode\\", the system enters aging-friendly mode.
387
+ * >
388
+ * > - Aging-friendly parameters are only effective when the liveness detection type **Model** is set to **LIVENESS** or **MULTI_ACTION**.
389
+ *
390
+ * @example
391
+ * 0
392
+ */
90
393
  suitableType?: string;
394
+ /**
395
+ * @remarks
396
+ * UI configuration file URL.
397
+ *
398
+ * You can view the complete configuration in the [Web SDK UI Customization Description](https://help.aliyun.com/zh/id-verification/financial-grade-id-verification/web-sdk-ui-custom-configuration-description?spm=a2c4g.11186623.0.0.4c683f5c8K3I9p).
399
+ *
400
+ * @example
401
+ * www.aliyundoc.com
402
+ */
91
403
  uiCustomUrl?: string;
92
404
  /**
405
+ * @remarks
406
+ * Custom user ID for the customer\\"s business, please ensure it is unique.
407
+ *
93
408
  * @example
94
409
  * 123456789
95
410
  */
96
411
  userId?: string;
412
+ /**
413
+ * @remarks
414
+ * Document expiration date.
415
+ *
416
+ * This field is required when the document type **CertType** is **PASSPORT** and **Mode** is **3**.
417
+ *
418
+ * @example
419
+ * 2039-06-10
420
+ */
97
421
  validityDate?: string;
422
+ /**
423
+ * @remarks
424
+ * Whether to enable video evidence:
425
+ *
426
+ * - **true**: Enable
427
+ *
428
+ * - **false** (default): Disable
429
+ *
430
+ * > Due to the large size of video files, when the network is unstable, the system will discard the video file to prioritize the transmission of necessary images for authentication. It is recommended that your business set a weak dependency on the video.
431
+ *
432
+ * @example
433
+ * false
434
+ */
98
435
  videoEvidence?: string;
436
+ /**
437
+ * @remarks
438
+ * Customized content. Required when personalized settings are enabled. The format is a JSON String of a String List.
439
+ *
440
+ * - For the follow-reading scenario: It should not exceed 60 Chinese characters (excluding punctuation), and the List contains only one element.
441
+ *
442
+ * - For the Q&A scenario: Up to 3 questions can be set, with each question not exceeding 30 Chinese characters, and each question being an element in the List.
443
+ *
444
+ * @example
445
+ * ["本人王先生同意***协议。"]
446
+ */
99
447
  voluntaryCustomizedContent?: string;
100
448
  static names(): {
101
449
  [key: string]: string;
@@ -61,6 +61,7 @@ class InitFaceVerifyRequest extends $dara.Model {
61
61
  mobile: 'Mobile',
62
62
  mode: 'Mode',
63
63
  model: 'Model',
64
+ needMultiFaceCheck: 'NeedMultiFaceCheck',
64
65
  ossBucketName: 'OssBucketName',
65
66
  ossObjectName: 'OssObjectName',
66
67
  outerOrderNo: 'OuterOrderNo',
@@ -102,6 +103,7 @@ class InitFaceVerifyRequest extends $dara.Model {
102
103
  mobile: 'string',
103
104
  mode: 'string',
104
105
  model: 'string',
106
+ needMultiFaceCheck: 'string',
105
107
  ossBucketName: 'string',
106
108
  ossObjectName: 'string',
107
109
  outerOrderNo: 'string',
@@ -1 +1 @@
1
- {"version":3,"file":"InitFaceVerifyRequest.js","sourceRoot":"","sources":["../../src/models/InitFaceVerifyRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,qBAAsB,SAAQ,KAAK,CAAC,KAAK;IAkGpD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,iBAAiB;YAClC,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,UAAU;YACpB,aAAa,EAAE,eAAe;YAC9B,WAAW,EAAE,aAAa;YAC1B,eAAe,EAAE,iBAAiB;YAClC,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,UAAU;YACpB,SAAS,EAAE,WAAW;YACtB,eAAe,EAAE,iBAAiB;YAClC,cAAc,EAAE,gBAAgB;YAChC,IAAI,EAAE,MAAM;YACZ,WAAW,EAAE,aAAa;YAC1B,mBAAmB,EAAE,qBAAqB;YAC1C,sBAAsB,EAAE,wBAAwB;YAChD,eAAe,EAAE,iBAAiB;YAClC,EAAE,EAAE,IAAI;YACR,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,aAAa,EAAE,eAAe;YAC9B,aAAa,EAAE,eAAe;YAC9B,YAAY,EAAE,cAAc;YAC5B,iBAAiB,EAAE,mBAAmB;YACtC,WAAW,EAAE,aAAa;YAC1B,gBAAgB,EAAE,kBAAkB;YACpC,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,WAAW;YACtB,OAAO,EAAE,SAAS;YAClB,YAAY,EAAE,cAAc;YAC5B,WAAW,EAAE,aAAa;YAC1B,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,cAAc;YAC5B,aAAa,EAAE,eAAe;YAC9B,0BAA0B,EAAE,4BAA4B;SACzD,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,QAAQ;YACzB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,QAAQ;YAClB,aAAa,EAAE,QAAQ;YACvB,WAAW,EAAE,QAAQ;YACrB,eAAe,EAAE,QAAQ;YACzB,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,QAAQ;YACnB,eAAe,EAAE,QAAQ;YACzB,cAAc,EAAE,QAAQ;YACxB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,QAAQ;YACrB,mBAAmB,EAAE,QAAQ;YAC7B,sBAAsB,EAAE,QAAQ;YAChC,eAAe,EAAE,QAAQ;YACzB,EAAE,EAAE,QAAQ;YACZ,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,QAAQ;YACf,aAAa,EAAE,QAAQ;YACvB,aAAa,EAAE,QAAQ;YACvB,YAAY,EAAE,QAAQ;YACtB,iBAAiB,EAAE,QAAQ;YAC3B,WAAW,EAAE,QAAQ;YACrB,gBAAgB,EAAE,QAAQ;YAC1B,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,QAAQ;YACjB,YAAY,EAAE,QAAQ;YACtB,WAAW,EAAE,QAAQ;YACrB,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,QAAQ;YACtB,aAAa,EAAE,QAAQ;YACvB,0BAA0B,EAAE,QAAQ;SACrC,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA7LD,sDA6LC"}
1
+ {"version":3,"file":"InitFaceVerifyRequest.js","sourceRoot":"","sources":["../../src/models/InitFaceVerifyRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,qBAAsB,SAAQ,KAAK,CAAC,KAAK;IA8bpD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,iBAAiB;YAClC,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,UAAU;YACpB,aAAa,EAAE,eAAe;YAC9B,WAAW,EAAE,aAAa;YAC1B,eAAe,EAAE,iBAAiB;YAClC,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,UAAU;YACpB,SAAS,EAAE,WAAW;YACtB,eAAe,EAAE,iBAAiB;YAClC,cAAc,EAAE,gBAAgB;YAChC,IAAI,EAAE,MAAM;YACZ,WAAW,EAAE,aAAa;YAC1B,mBAAmB,EAAE,qBAAqB;YAC1C,sBAAsB,EAAE,wBAAwB;YAChD,eAAe,EAAE,iBAAiB;YAClC,EAAE,EAAE,IAAI;YACR,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,kBAAkB,EAAE,oBAAoB;YACxC,aAAa,EAAE,eAAe;YAC9B,aAAa,EAAE,eAAe;YAC9B,YAAY,EAAE,cAAc;YAC5B,iBAAiB,EAAE,mBAAmB;YACtC,WAAW,EAAE,aAAa;YAC1B,gBAAgB,EAAE,kBAAkB;YACpC,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,WAAW;YACtB,OAAO,EAAE,SAAS;YAClB,YAAY,EAAE,cAAc;YAC5B,WAAW,EAAE,aAAa;YAC1B,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,cAAc;YAC5B,aAAa,EAAE,eAAe;YAC9B,0BAA0B,EAAE,4BAA4B;SACzD,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,QAAQ;YACzB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,QAAQ;YAClB,aAAa,EAAE,QAAQ;YACvB,WAAW,EAAE,QAAQ;YACrB,eAAe,EAAE,QAAQ;YACzB,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,QAAQ;YACnB,eAAe,EAAE,QAAQ;YACzB,cAAc,EAAE,QAAQ;YACxB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,QAAQ;YACrB,mBAAmB,EAAE,QAAQ;YAC7B,sBAAsB,EAAE,QAAQ;YAChC,eAAe,EAAE,QAAQ;YACzB,EAAE,EAAE,QAAQ;YACZ,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,QAAQ;YACf,kBAAkB,EAAE,QAAQ;YAC5B,aAAa,EAAE,QAAQ;YACvB,aAAa,EAAE,QAAQ;YACvB,YAAY,EAAE,QAAQ;YACtB,iBAAiB,EAAE,QAAQ;YAC3B,WAAW,EAAE,QAAQ;YACrB,gBAAgB,EAAE,QAAQ;YAC1B,OAAO,EAAE,QAAQ;YACjB,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,QAAQ;YACjB,YAAY,EAAE,QAAQ;YACtB,WAAW,EAAE,QAAQ;YACrB,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,QAAQ;YACtB,aAAa,EAAE,QAAQ;YACvB,0BAA0B,EAAE,QAAQ;SACrC,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA3hBD,sDA2hBC"}