@regulaforensics/facesdk-webclient 8.1.442-nightly → 8.1.443-rc

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 (4) hide show
  1. package/dist/index.cjs +6 -6
  2. package/dist/index.d.ts +1462 -412
  3. package/dist/index.js +1879 -1639
  4. package/package.json +8 -8
package/dist/index.d.ts CHANGED
@@ -2,76 +2,132 @@ import { AxiosInstance } from 'axios';
2
2
  import { AxiosRequestConfig } from 'axios';
3
3
 
4
4
  /**
5
- * @type AddImageToPersonRequest
6
5
  * Image in the request data, includes image and contentType.
6
+ * @export
7
+ * @interface AddImageToPersonRequest
7
8
  */
8
- export declare type AddImageToPersonRequest = AddImageToPersonRequestData & TransactionLabels;
9
-
10
- export declare interface AddImageToPersonRequestData {
9
+ export declare interface AddImageToPersonRequest {
11
10
  /**
12
11
  * Session identificator.
12
+ * @type {string}
13
+ * @memberof AddImageToPersonRequest
13
14
  */
14
15
  'tag'?: string;
16
+ /**
17
+ *
18
+ * @type {AddImageToPersonRequestImage}
19
+ * @memberof AddImageToPersonRequest
20
+ */
15
21
  'image': AddImageToPersonRequestImage;
16
22
  /**
17
23
  * The similarity threshold.
24
+ * @type {number}
25
+ * @memberof AddImageToPersonRequest
18
26
  */
19
27
  'threshold'?: number;
20
28
  /**
21
29
  * The maximum number of results to be returned.
30
+ * @type {number}
31
+ * @memberof AddImageToPersonRequest
22
32
  */
23
33
  'limit'?: number;
34
+ /**
35
+ * A label used to group transactions by customers, applications, or other criteria.
36
+ * @type {string}
37
+ * @memberof AddImageToPersonRequest
38
+ */
39
+ 'tenant'?: string;
40
+ /**
41
+ * A label used to differentiate transactions by development stages.
42
+ * @type {string}
43
+ * @memberof AddImageToPersonRequest
44
+ */
45
+ 'env'?: string;
24
46
  }
25
47
 
26
48
  /**
27
49
  * Uploaded image.
50
+ * @export
51
+ * @interface AddImageToPersonRequestImage
28
52
  */
29
53
  export declare interface AddImageToPersonRequestImage {
30
54
  /**
31
55
  * Original media type of the uploaded image.
56
+ * @type {string}
57
+ * @memberof AddImageToPersonRequestImage
32
58
  */
33
59
  'contentType'?: string;
34
60
  /**
35
- * Base64-encoded image.
61
+ *
62
+ * @type {ImageData}
63
+ * @memberof AddImageToPersonRequestImage
36
64
  */
37
- 'content'?: string;
65
+ 'content'?: ImageData_2;
38
66
  /**
39
67
  * Image URL.
68
+ * @type {string}
69
+ * @memberof AddImageToPersonRequestImage
40
70
  */
41
71
  'imageUrl'?: string;
72
+ /**
73
+ *
74
+ * @type {ResizeOptions}
75
+ * @memberof AddImageToPersonRequestImage
76
+ */
42
77
  'resizeOptions'?: ResizeOptions;
43
78
  }
44
79
 
45
80
  /**
46
- * NOTE: This file is auto generated by OpenAPI Generator.
47
- * Do not edit the file manually.
81
+ * Regula Face SDK Web API
82
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
83
+ *
84
+ * The version of the OpenAPI document: 7.2.0
85
+ *
86
+ *
87
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
88
+ * https://openapi-generator.tech
89
+ * Do not edit the class manually.
48
90
  */
49
91
  /**
50
92
  * Image in the response.
93
+ * @export
94
+ * @interface AddImageToPersonResponse
51
95
  */
52
96
  export declare interface AddImageToPersonResponse {
53
97
  /**
54
98
  * Response image ID. The list is sorted by decreasing ID value.
99
+ * @type {string}
100
+ * @memberof AddImageToPersonResponse
55
101
  */
56
102
  'id'?: string;
57
103
  /**
58
104
  * Original media type of the returned image.
105
+ * @type {string}
106
+ * @memberof AddImageToPersonResponse
59
107
  */
60
108
  'contentType'?: string;
61
109
  /**
62
110
  * Returned image creation date.
111
+ * @type {string}
112
+ * @memberof AddImageToPersonResponse
63
113
  */
64
114
  'createdAt'?: string;
65
115
  /**
66
116
  * Returned image path.
117
+ * @type {string}
118
+ * @memberof AddImageToPersonResponse
67
119
  */
68
120
  'path'?: string;
69
121
  /**
70
122
  * Returned image URL.
123
+ * @type {string}
124
+ * @memberof AddImageToPersonResponse
71
125
  */
72
126
  'url'?: string;
73
127
  /**
74
128
  * A free-form object containing person\'s extended attributes.
129
+ * @type {{ [key: string]: any; }}
130
+ * @memberof AddImageToPersonResponse
75
131
  */
76
132
  'metadata'?: {
77
133
  [key: string]: any;
@@ -80,52 +136,60 @@ export declare interface AddImageToPersonResponse {
80
136
 
81
137
  /**
82
138
  * The configuration that defines the list of returned attribute check characteristics.
139
+ * @export
140
+ * @interface AttributeConfig
83
141
  */
84
142
  export declare interface AttributeConfig {
85
- 'name'?: FaceAttribute;
86
- }
87
-
88
- /**
89
- * NOTE: This file is auto generated by OpenAPI Generator.
90
- * Do not edit the file manually.
91
- */
92
- export declare interface AttributesData {
93
143
  /**
94
- * The estimated value for the attribute, see the [Returned values column](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/attributes-detection/).
144
+ *
145
+ * @type {FaceAttribute}
146
+ * @memberof AttributeConfig
95
147
  */
96
- 'value'?: Array<number>;
148
+ 'name'?: FaceAttribute;
97
149
  }
98
150
 
151
+ export declare type Base64String = string;
152
+
99
153
  export declare class Configuration {
100
154
  /**
101
155
  * parameter for apiKey security
102
156
  * @param name security name
157
+ * @memberof Configuration
103
158
  */
104
159
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
105
160
  /**
106
161
  * parameter for basic security
162
+ *
163
+ * @type {string}
164
+ * @memberof Configuration
107
165
  */
108
166
  username?: string;
109
167
  /**
110
168
  * parameter for basic security
169
+ *
170
+ * @type {string}
171
+ * @memberof Configuration
111
172
  */
112
173
  password?: string;
113
174
  /**
114
175
  * parameter for oauth2 security
115
176
  * @param name security name
116
177
  * @param scopes oauth2 scope
178
+ * @memberof Configuration
117
179
  */
118
180
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
119
181
  /**
120
182
  * override base path
183
+ *
184
+ * @type {string}
185
+ * @memberof Configuration
121
186
  */
122
187
  basePath?: string;
123
- /**
124
- * override server index
125
- */
126
- serverIndex?: number;
127
188
  /**
128
189
  * base options for axios calls
190
+ *
191
+ * @type {any}
192
+ * @memberof Configuration
129
193
  */
130
194
  baseOptions?: any;
131
195
  /**
@@ -151,8 +215,15 @@ export declare class Configuration {
151
215
  }
152
216
 
153
217
  /**
154
- * NOTE: This file is auto generated by OpenAPI Generator.
155
- * Do not edit the file manually.
218
+ * Regula Face SDK Web API
219
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
220
+ *
221
+ * The version of the OpenAPI document: 7.2.0
222
+ *
223
+ *
224
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
225
+ * https://openapi-generator.tech
226
+ * Do not edit the class manually.
156
227
  */
157
228
  export declare interface ConfigurationParameters {
158
229
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
@@ -160,394 +231,601 @@ export declare interface ConfigurationParameters {
160
231
  password?: string;
161
232
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
162
233
  basePath?: string;
163
- serverIndex?: number;
164
234
  baseOptions?: any;
165
235
  formDataCtor?: new () => any;
166
236
  }
167
237
 
168
238
  /**
169
239
  * Whether to return a Base64-encoded image of each aligned and cropped portrait in the `crop` field. Faces are aligned to a straight vertical line based on the value in the `crop.type` field, correcting any tilt present in the original image. If the image contains multiple faces, the system will detect and process each face separately, returning individual portraits. For example, if there are five people in the photo, five processed portraits will be returned. Each portrait is available for download.
240
+ * @export
241
+ * @interface Crop
170
242
  */
171
243
  export declare interface Crop {
244
+ /**
245
+ *
246
+ * @type {FaceImageQualityAlignType}
247
+ * @memberof Crop
248
+ */
172
249
  'type'?: FaceImageQualityAlignType;
173
250
  /**
174
251
  * The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
252
+ * @type {Array<number>}
253
+ * @memberof Crop
175
254
  */
176
255
  'padColor'?: Array<number>;
177
256
  /**
178
257
  * The resize value in case `type` matches this value. If it doesn\'t, no resize is performed.
258
+ * @type {Array<number>}
259
+ * @memberof Crop
179
260
  */
180
261
  'size'?: Array<number>;
181
262
  }
182
263
 
183
264
  /**
184
- * NOTE: This file is auto generated by OpenAPI Generator.
185
- * Do not edit the file manually.
265
+ * Regula Face SDK Web API
266
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
267
+ *
268
+ * The version of the OpenAPI document: 7.2.0
269
+ *
270
+ *
271
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
272
+ * https://openapi-generator.tech
273
+ * Do not edit the class manually.
274
+ */
275
+ /**
276
+ *
277
+ * @export
278
+ * @interface DetectAttributesDetails
186
279
  */
187
- export declare interface DetailItem {
280
+ export declare interface DetectAttributesDetails {
188
281
  /**
189
282
  * The name of the attribute.
283
+ * @type {string}
284
+ * @memberof DetectAttributesDetails
190
285
  */
191
286
  'name'?: string;
287
+ /**
288
+ * The estimated value for the attribute, see the [Returned values column](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/attributes-detection/).
289
+ * @type {Array<number>}
290
+ * @memberof DetectAttributesDetails
291
+ */
292
+ 'value'?: Array<number>;
192
293
  }
193
294
 
194
295
  /**
195
- * @type DetectAttributesDetails
296
+ * Regula Face SDK Web API
297
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
298
+ *
299
+ * The version of the OpenAPI document: 7.2.0
300
+ *
301
+ *
302
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
303
+ * https://openapi-generator.tech
304
+ * Do not edit the class manually.
196
305
  */
197
- export declare type DetectAttributesDetails = AttributesData & DetailItem;
198
-
199
306
  /**
200
- * @type DetectDetailsMeta
307
+ *
308
+ * @export
309
+ * @interface DetectDetailsMeta
201
310
  */
202
- export declare type DetectDetailsMeta = DetailItem & DetectMetaData;
311
+ export declare interface DetectDetailsMeta {
312
+ /**
313
+ * The confidence in the estimated value, `1.0` is for 100% confidence.
314
+ * @type {number}
315
+ * @memberof DetectDetailsMeta
316
+ */
317
+ 'confidence'?: number;
318
+ /**
319
+ * The estimated value for the attribute, see the [Returned values column](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/attributes-detection/).
320
+ * @type {string}
321
+ * @memberof DetectDetailsMeta
322
+ */
323
+ 'value'?: string;
324
+ /**
325
+ * The name of the attribute.
326
+ * @type {string}
327
+ * @memberof DetectDetailsMeta
328
+ */
329
+ 'name'?: string;
330
+ }
203
331
 
332
+ /**
333
+ *
334
+ * @export
335
+ * @interface Detection
336
+ */
204
337
  export declare interface Detection {
205
338
  /**
206
- * Base64-encoded image.
339
+ *
340
+ * @type {ImageData}
341
+ * @memberof Detection
342
+ */
343
+ 'crop'?: ImageData_2;
344
+ /**
345
+ *
346
+ * @type {DetectionAttributes}
347
+ * @memberof Detection
207
348
  */
208
- 'crop'?: string;
209
349
  'attributes'?: DetectionAttributes;
210
350
  /**
211
351
  * Absolute coordinates (X,Y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
352
+ * @type {Array<Array<number>>}
353
+ * @memberof Detection
212
354
  */
213
355
  'landmarks': Array<Array<number>>;
356
+ /**
357
+ *
358
+ * @type {DetectionQuality}
359
+ * @memberof Detection
360
+ */
214
361
  'quality'?: DetectionQuality;
215
362
  /**
216
363
  * The rectangular area of a detected face that is represented by a set of four elements: the X and Y coordinates of the top-left point, and the width and height dimensions of the rectangle.
364
+ * @type {Array<number>}
365
+ * @memberof Detection
217
366
  */
218
367
  'roi': Array<number>;
219
368
  }
220
369
 
221
370
  /**
222
371
  * The evaluated attributes, see the [Attributes List](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/attributes-detection/) for details.
372
+ * @export
373
+ * @interface DetectionAttributes
223
374
  */
224
375
  export declare interface DetectionAttributes {
225
376
  /**
226
377
  * Attributes assessment details. Returns `DetectDetailsMeta` or `DetectAttributesDetails`.
378
+ * @type {Array<DetectionAttributesDetailsInner>}
379
+ * @memberof DetectionAttributes
227
380
  */
228
381
  'details'?: Array<DetectionAttributesDetailsInner>;
229
382
  /**
230
383
  * Server processing time for attribute detection, ms.
384
+ * @type {number}
385
+ * @memberof DetectionAttributes
231
386
  */
232
387
  'elapsedTime'?: number;
233
388
  }
234
389
 
235
390
  /**
236
- * @type DetectionAttributesDetailsInner
391
+ * Regula Face SDK Web API
392
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
393
+ *
394
+ * The version of the OpenAPI document: 7.2.0
395
+ *
396
+ *
397
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
398
+ * https://openapi-generator.tech
399
+ * Do not edit the class manually.
237
400
  */
238
- export declare type DetectionAttributesDetailsInner = DetectAttributesDetails | DetectDetailsMeta;
401
+ /**
402
+ *
403
+ * @export
404
+ * @interface DetectionAttributesDetailsInner
405
+ */
406
+ export declare interface DetectionAttributesDetailsInner {
407
+ /**
408
+ * The name of the attribute.
409
+ * @type {string}
410
+ * @memberof DetectionAttributesDetailsInner
411
+ */
412
+ 'name'?: string;
413
+ /**
414
+ * The estimated value for the attribute, see the [Returned values column](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/attributes-detection/).
415
+ * @type {string}
416
+ * @memberof DetectionAttributesDetailsInner
417
+ */
418
+ 'value'?: string;
419
+ /**
420
+ * The confidence in the estimated value, `1.0` is for 100% confidence.
421
+ * @type {number}
422
+ * @memberof DetectionAttributesDetailsInner
423
+ */
424
+ 'confidence'?: number;
425
+ }
239
426
 
240
427
  /**
241
- * NOTE: This file is auto generated by OpenAPI Generator.
242
- * Do not edit the file manually.
428
+ * Regula Face SDK Web API
429
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
430
+ *
431
+ * The version of the OpenAPI document: 7.2.0
432
+ *
433
+ *
434
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
435
+ * https://openapi-generator.tech
436
+ * Do not edit the class manually.
437
+ */
438
+ /**
439
+ *
440
+ * @export
441
+ * @interface DetectionFace
243
442
  */
244
443
  export declare interface DetectionFace {
245
444
  /**
246
445
  * The detected face index number.
446
+ * @type {number}
447
+ * @memberof DetectionFace
247
448
  */
248
449
  'faceIndex'?: number;
249
450
  /**
250
451
  * Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
452
+ * @type {Array<Array<number>>}
453
+ * @memberof DetectionFace
251
454
  */
252
455
  'landmarks'?: Array<Array<number>>;
253
456
  /**
254
457
  * Angle of rotation of the face from the vertical axis, degrees.
458
+ * @type {number}
459
+ * @memberof DetectionFace
255
460
  */
256
461
  'rotationAngle'?: number;
257
462
  /**
258
463
  * The rectangular area of a detected face that is represented by a set of four elements: the X and Y coordinates of the top-left point, and the width and height dimensions of the rectangle.
464
+ * @type {Array<number>}
465
+ * @memberof DetectionFace
259
466
  */
260
467
  'roi'?: Array<number>;
261
468
  /**
262
469
  * Base64-encoded aligned and cropped portrait.
470
+ * @type {string}
471
+ * @memberof DetectionFace
263
472
  */
264
473
  'crop'?: string;
265
474
  }
266
475
 
267
476
  /**
268
477
  * The portrait quality assessment results, see [Face Image Quality Characteristics](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/face-image-quality-check/). If not set in request, no quality check is performed.
478
+ * @export
479
+ * @interface DetectionQuality
269
480
  */
270
481
  export declare interface DetectionQuality {
271
482
  /**
272
483
  * Non-compliant assessment characteristics.
484
+ * @type {Array<FaceQualityConfigName>}
485
+ * @memberof DetectionQuality
273
486
  */
274
487
  'nonCompliant'?: Array<FaceQualityConfigName>;
275
488
  /**
276
489
  * Assessment results for each [group of characteristics](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-groups/).
490
+ * @type {Array<QualityDetailsGroups>}
491
+ * @memberof DetectionQuality
277
492
  */
278
493
  'detailsGroups'?: Array<QualityDetailsGroups>;
279
494
  /**
280
495
  * Assessment characteristics that were set in the request.
496
+ * @type {Array<QualityDetail>}
497
+ * @memberof DetectionQuality
281
498
  */
282
499
  'details'?: Array<QualityDetail>;
283
500
  /**
284
501
  * Returns the estimated portrait quality assessment result, a number from `0` to `1`, where `1` is for absolute compliance.
502
+ * @type {number}
503
+ * @memberof DetectionQuality
285
504
  */
286
505
  'score'?: number;
287
506
  /**
288
507
  * Server processing time for quality assessment, ms.
508
+ * @type {number}
509
+ * @memberof DetectionQuality
289
510
  */
290
511
  'elapsedTime'?: number;
291
512
  }
292
513
 
293
514
  /**
294
- * NOTE: This file is auto generated by OpenAPI Generator.
295
- * Do not edit the file manually.
515
+ *
516
+ * @export
517
+ * @interface DetectRequest
296
518
  */
297
- export declare interface DetectMetaData {
519
+ export declare interface DetectRequest {
298
520
  /**
299
- * The confidence in the estimated value, `1.0` is for 100% confidence.
521
+ * Session identificator, should be unique for each session.
522
+ * @type {string}
523
+ * @memberof DetectRequest
300
524
  */
301
- 'confidence'?: number;
525
+ 'tag'?: string;
302
526
  /**
303
- * The estimated value for the attribute, see the [Returned values column](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/attributes-detection/).
527
+ *
528
+ * @type {ProcessParam}
529
+ * @memberof DetectRequest
304
530
  */
305
- 'value'?: string;
306
- }
307
-
308
- /**
309
- * @type DetectRequest
310
- */
311
- export declare type DetectRequest = DetectRequestData & TransactionLabels;
312
-
313
- export declare interface DetectRequestData {
531
+ 'processParam'?: ProcessParam;
314
532
  /**
315
- * Session identificator, should be unique for each session.
533
+ *
534
+ * @type {ImageData}
535
+ * @memberof DetectRequest
316
536
  */
317
- 'tag'?: string;
318
- 'processParam'?: ProcessParam;
537
+ 'image'?: ImageData_2;
319
538
  /**
320
- * Base64-encoded image.
539
+ * A label used to group transactions by customers, applications, or other criteria.
540
+ * @type {string}
541
+ * @memberof DetectRequest
321
542
  */
322
- 'image'?: string;
543
+ 'tenant'?: string;
544
+ /**
545
+ * A label used to differentiate transactions by development stages.
546
+ * @type {string}
547
+ * @memberof DetectRequest
548
+ */
549
+ 'env'?: string;
323
550
  }
324
551
 
325
552
  /**
326
553
  * @type DetectResponse
554
+ * @export
327
555
  */
328
- export declare type DetectResponse = DetectResponseResults & FaceSDKResult;
556
+ export declare type DetectResponse = DetectResponseAllOf & FaceSDKResult;
329
557
 
330
- export declare interface DetectResponseResults {
558
+ /**
559
+ *
560
+ * @export
561
+ * @interface DetectResponseAllOf
562
+ */
563
+ export declare interface DetectResponseAllOf {
564
+ /**
565
+ *
566
+ * @type {DetectResult}
567
+ * @memberof DetectResponseAllOf
568
+ */
331
569
  'results'?: DetectResult;
332
570
  }
333
571
 
334
572
  /**
335
573
  * The detection results.
574
+ * @export
575
+ * @interface DetectResult
336
576
  */
337
577
  export declare interface DetectResult {
338
578
  /**
339
579
  * The array of performed checks.
580
+ * @type {Array<Detection>}
581
+ * @memberof DetectResult
340
582
  */
341
583
  'detections': Array<Detection>;
342
584
  /**
343
585
  * Internal.
586
+ * @type {number}
587
+ * @memberof DetectResult
344
588
  */
345
589
  'detectorType'?: number;
346
590
  /**
347
591
  * Internal.
592
+ * @type {number}
593
+ * @memberof DetectResult
348
594
  */
349
595
  'landmarksType'?: number;
350
596
  /**
351
597
  * The face detection scenario that was set in the `processParam.scenario` field of the request.
598
+ * @type {string}
599
+ * @memberof DetectResult
352
600
  */
353
601
  'scenario'?: string;
354
602
  /**
355
603
  * Server processing time, ms. Does not include the time taken to receive the request or deliver the response.
604
+ * @type {number}
605
+ * @memberof DetectResult
356
606
  */
357
607
  'elapsedTime'?: number;
358
608
  }
359
609
 
360
610
  /**
361
- * NOTE: This file is auto generated by OpenAPI Generator.
362
- * Do not edit the file manually.
611
+ * Regula Face SDK Web API
612
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
613
+ *
614
+ * The version of the OpenAPI document: 7.2.0
615
+ *
616
+ *
617
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
618
+ * https://openapi-generator.tech
619
+ * Do not edit the class manually.
620
+ */
621
+ /**
622
+ *
623
+ * @export
624
+ * @interface DeviceInfo
363
625
  */
364
626
  export declare interface DeviceInfo {
365
627
  /**
366
628
  * Application name.
629
+ * @type {string}
630
+ * @memberof DeviceInfo
367
631
  */
368
632
  'app': string;
369
633
  /**
370
634
  * Unique license identifier.
635
+ * @type {string}
636
+ * @memberof DeviceInfo
371
637
  */
372
638
  'licenseId': string | null;
373
639
  /**
374
640
  * License serial number.
641
+ * @type {string}
642
+ * @memberof DeviceInfo
375
643
  */
376
644
  'licenseSerial': string | null;
377
645
  /**
378
646
  * License validity date.
647
+ * @type {string}
648
+ * @memberof DeviceInfo
379
649
  */
380
650
  'licenseValidUntil': string | null;
381
651
  /**
382
652
  * Product version.
653
+ * @type {string}
654
+ * @memberof DeviceInfo
383
655
  */
384
656
  'version': string | null;
385
657
  }
386
658
 
387
- /**
388
- * NOTE: This file is auto generated by OpenAPI Generator.
389
- * Do not edit the file manually.
390
- */
391
- /**
392
- * The name of the attribute. For definitions, see the [FaceAttribute enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-attribute/).
393
- */
394
- export declare enum FaceAttribute {
395
- AGE = "Age",
396
- EMOTION = "Emotion",
397
- EYE_LEFT = "EyeLeft",
398
- EYE_RIGHT = "EyeRight",
399
- SMILE = "Smile",
400
- GLASSES = "Glasses",
401
- HEAD_COVERING = "HeadCovering",
402
- FOREHEAD_COVERING = "ForeheadCovering",
403
- MOUTH = "Mouth",
404
- MEDICAL_MASK = "MedicalMask",
405
- OCCLUSION = "Occlusion",
406
- STRONG_MAKEUP = "StrongMakeup",
407
- HEADPHONES = "Headphones"
659
+ export declare class DiagnosticsApi {
660
+ private superClass;
661
+ constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
662
+ readiness(xRequestID?: string, options?: AxiosRequestConfig): Promise<Record<string, unknown>>;
408
663
  }
409
664
 
410
665
  /**
411
- * NOTE: This file is auto generated by OpenAPI Generator.
412
- * Do not edit the file manually.
413
- */
666
+ * The name of the attribute. For definitions, see the [FaceAttribute enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-attribute/).
667
+ * @export
668
+ * @enum {string}
669
+ */
670
+ export declare const FaceAttribute: {
671
+ readonly AGE: "Age";
672
+ readonly EMOTION: "Emotion";
673
+ readonly EYE_LEFT: "EyeLeft";
674
+ readonly EYE_RIGHT: "EyeRight";
675
+ readonly SMILE: "Smile";
676
+ readonly GLASSES: "Glasses";
677
+ readonly HEAD_COVERING: "HeadCovering";
678
+ readonly FOREHEAD_COVERING: "ForeheadCovering";
679
+ readonly MOUTH: "Mouth";
680
+ readonly MEDICAL_MASK: "MedicalMask";
681
+ readonly OCCLUSION: "Occlusion";
682
+ readonly STRONG_MAKEUP: "StrongMakeup";
683
+ readonly HEADPHONES: "Headphones";
684
+ };
685
+
686
+ export declare type FaceAttribute = typeof FaceAttribute[keyof typeof FaceAttribute];
687
+
414
688
  /**
415
689
  * The aspect ratio according to which face alignment is performed. See the [FaceImageQualityAlignType enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-align-type/). To get a thumbnail with aspect ratio 3:4, set `0`.
690
+ * @export
691
+ * @enum {string}
416
692
  */
417
- export declare enum FaceImageQualityAlignType {
418
- ALIGN_3x4 = 0,
419
- ALIGN_4x5 = 1,
420
- ALIGN_2x3 = 2,
421
- ALIGN_1x1 = 3,
422
- ALIGN_7x9 = 4
423
- }
693
+ export declare const FaceImageQualityAlignType: {
694
+ readonly ALIGN_3x4: 0;
695
+ readonly ALIGN_4x5: 1;
696
+ readonly ALIGN_2x3: 2;
697
+ readonly ALIGN_1x1: 3;
698
+ readonly ALIGN_7x9: 4;
699
+ };
700
+
701
+ export declare type FaceImageQualityAlignType = typeof FaceImageQualityAlignType[keyof typeof FaceImageQualityAlignType];
424
702
 
425
- /**
426
- * NOTE: This file is auto generated by OpenAPI Generator.
427
- * Do not edit the file manually.
428
- */
429
703
  /**
430
704
  * The group ID of the characteristic, see the [FaceImageQualityGroups enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-groups/) for details.
705
+ * @export
706
+ * @enum {string}
431
707
  */
432
- export declare enum FaceImageQualityGroups {
433
- IMAGE_CHARACTERISTICS = 1,
434
- HEAD_SIZE_AND_POSITIONS = 2,
435
- FACE_QUALITY = 3,
436
- EYES_CHARACTERISTICS = 4,
437
- SHADOWS_AND_LIGHTNING = 5,
438
- POSE_AND_EXPRESSION = 6,
439
- HEAD_OCCLUSION = 7,
440
- BACKGROUND = 8
441
- }
708
+ export declare const FaceImageQualityGroups: {
709
+ readonly IMAGE_CHARACTERISTICS: 1;
710
+ readonly HEAD_SIZE_AND_POSITIONS: 2;
711
+ readonly FACE_QUALITY: 3;
712
+ readonly EYES_CHARACTERISTICS: 4;
713
+ readonly SHADOWS_AND_LIGHTNING: 5;
714
+ readonly POSE_AND_EXPRESSION: 6;
715
+ readonly HEAD_OCCLUSION: 7;
716
+ readonly BACKGROUND: 8;
717
+ };
718
+
719
+ export declare type FaceImageQualityGroups = typeof FaceImageQualityGroups[keyof typeof FaceImageQualityGroups];
442
720
 
443
- /**
444
- * NOTE: This file is auto generated by OpenAPI Generator.
445
- * Do not edit the file manually.
446
- */
447
721
  /**
448
722
  * Face image quality assessment group name, see [FaceImageQualityGroups](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-groups/).
723
+ * @export
724
+ * @enum {string}
449
725
  */
450
- export declare enum FaceImageQualityGroupsStrings {
451
- IMAGE_CHARACTERISTICS = "ImageCharacteristics",
452
- HEAD_SIZE_AND_POSITIONS = "HeadSizeAndPosition",
453
- FACE_QUALITY = "FaceQuality",
454
- EYES_CHARACTERISTICS = "EyesCharacteristics",
455
- SHADOWS_AND_LIGHTNING = "ShadowsAndLightning",
456
- POSE_AND_EXPRESSION = "PoseAndExpression",
457
- HEAD_OCCLUSION = "HeadOcclusion",
458
- BACKGROUND = "Background"
459
- }
726
+ export declare const FaceImageQualityGroupsStrings: {
727
+ readonly IMAGE_CHARACTERISTICS: "ImageCharacteristics";
728
+ readonly HEAD_SIZE_AND_POSITIONS: "HeadSizeAndPosition";
729
+ readonly FACE_QUALITY: "FaceQuality";
730
+ readonly EYES_CHARACTERISTICS: "EyesCharacteristics";
731
+ readonly SHADOWS_AND_LIGHTNING: "ShadowsAndLightning";
732
+ readonly POSE_AND_EXPRESSION: "PoseAndExpression";
733
+ readonly HEAD_OCCLUSION: "HeadOcclusion";
734
+ readonly BACKGROUND: "Background";
735
+ };
736
+
737
+ export declare type FaceImageQualityGroupsStrings = typeof FaceImageQualityGroupsStrings[keyof typeof FaceImageQualityGroupsStrings];
460
738
 
461
- /**
462
- * NOTE: This file is auto generated by OpenAPI Generator.
463
- * Do not edit the file manually.
464
- */
465
739
  /**
466
740
  * The processing status returned for each quality characteristic, see the [FaceImageQualityStatus enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-status/).
741
+ * @export
742
+ * @enum {string}
467
743
  */
468
- export declare enum FaceImageQualityStatus {
469
- QUALITY_STATUS_FALSE = 0,
470
- QUALITY_STATUS_TRUE = 1,
471
- QUALITY_STATUS_UNDETERMINED = 2
472
- }
744
+ export declare const FaceImageQualityStatus: {
745
+ readonly QUALITY_STATUS_FALSE: 0;
746
+ readonly QUALITY_STATUS_TRUE: 1;
747
+ readonly QUALITY_STATUS_UNDETERMINED: 2;
748
+ };
749
+
750
+ export declare type FaceImageQualityStatus = typeof FaceImageQualityStatus[keyof typeof FaceImageQualityStatus];
473
751
 
474
- /**
475
- * NOTE: This file is auto generated by OpenAPI Generator.
476
- * Do not edit the file manually.
477
- */
478
752
  /**
479
753
  * The name of the characteristic. For definitions, see the [FaceQualityConfigName enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-quality-config-name/).
480
- */
481
- export declare enum FaceQualityConfigName {
482
- IMAGE_WIDTH = "ImageWidth",
483
- IMAGE_HEIGHT = "ImageHeight",
484
- IMAGE_WIDTH_TO_HEIGHT = "ImageWidthToHeight",
485
- IMAGE_CHANNELS_NUMBER = "ImageChannelsNumber",
486
- PADDING_RATIO = "PaddingRatio",
487
- FACE_MID_POINT_HORIZONTAL_POSITION = "FaceMidPointHorizontalPosition",
488
- FACE_MID_POINT_VERTICAL_POSITION = "FaceMidPointVerticalPosition",
489
- HEAD_WIDTH_RATIO = "HeadWidthRatio",
490
- HEAD_HEIGHT_RATIO = "HeadHeightRatio",
491
- EYES_DISTANCE = "EyesDistance",
492
- YAW = "Yaw",
493
- PITCH = "Pitch",
494
- ROLL = "Roll",
495
- BLUR_LEVEL = "BlurLevel",
496
- NOISE_LEVEL = "NoiseLevel",
497
- EYE_RIGHT_CLOSED = "EyeRightClosed",
498
- EYE_LEFT_CLOSED = "EyeLeftClosed",
499
- EYE_RIGHT_OCCLUDED = "EyeRightOccluded",
500
- EYE_LEFT_OCCLUDED = "EyeLeftOccluded",
501
- EYES_RED = "EyesRed",
502
- EYE_RIGHT_COVERED_WITH_HAIR = "EyeRightCoveredWithHair",
503
- EYE_LEFT_COVERED_WITH_HAIR = "EyeLeftCoveredWithHair",
504
- OFF_GAZE = "OffGaze",
505
- FACE_DYNAMIC_RANGE = "FaceDynamicRange",
506
- UNNATURAL_SKIN_TONE = "UnnaturalSkinTone",
507
- TOO_DARK = "TooDark",
508
- TOO_LIGHT = "TooLight",
509
- FACE_GLARE = "FaceGlare",
510
- SHADOWS_ON_FACE = "ShadowsOnFace",
511
- DARK_GLASSES = "DarkGlasses",
512
- REFLECTION_ON_GLASSES = "ReflectionOnGlasses",
513
- FRAMES_TOO_HEAVY = "FramesTooHeavy",
514
- FACE_OCCLUDED = "FaceOccluded",
515
- HEAD_COVERING = "HeadCovering",
516
- BACKGROUND_UNIFORMITY = "BackgroundUniformity",
517
- SHADOWS_ON_BACKGROUND = "ShadowsOnBackground",
518
- OTHER_FACES = "OtherFaces",
519
- SHOULDERS_POSE = "ShouldersPose",
520
- EXPRESSION_LEVEL = "ExpressionLevel",
521
- MOUTH_OPEN = "MouthOpen",
522
- FOREHEAD_COVERING = "ForeheadCovering",
523
- SMILE = "Smile",
524
- STRONG_MAKEUP = "StrongMakeup",
525
- HEADPHONES = "Headphones",
526
- MEDICAL_MASK = "MedicalMask",
527
- BACKGROUND_COLOR_MATCH = "BackgroundColorMatch",
528
- ART_FACE = "ArtFace",
529
- CONTACT_LENSES = "ContactLenses"
530
- }
531
-
532
- /**
533
- * NOTE: This file is auto generated by OpenAPI Generator.
534
- * Do not edit the file manually.
535
- */
754
+ * @export
755
+ * @enum {string}
756
+ */
757
+ export declare const FaceQualityConfigName: {
758
+ readonly IMAGE_WIDTH: "ImageWidth";
759
+ readonly IMAGE_HEIGHT: "ImageHeight";
760
+ readonly IMAGE_WIDTH_TO_HEIGHT: "ImageWidthToHeight";
761
+ readonly IMAGE_CHANNELS_NUMBER: "ImageChannelsNumber";
762
+ readonly PADDING_RATIO: "PaddingRatio";
763
+ readonly FACE_MID_POINT_HORIZONTAL_POSITION: "FaceMidPointHorizontalPosition";
764
+ readonly FACE_MID_POINT_VERTICAL_POSITION: "FaceMidPointVerticalPosition";
765
+ readonly HEAD_WIDTH_RATIO: "HeadWidthRatio";
766
+ readonly HEAD_HEIGHT_RATIO: "HeadHeightRatio";
767
+ readonly EYES_DISTANCE: "EyesDistance";
768
+ readonly YAW: "Yaw";
769
+ readonly PITCH: "Pitch";
770
+ readonly ROLL: "Roll";
771
+ readonly BLUR_LEVEL: "BlurLevel";
772
+ readonly NOISE_LEVEL: "NoiseLevel";
773
+ readonly EYE_RIGHT_CLOSED: "EyeRightClosed";
774
+ readonly EYE_LEFT_CLOSED: "EyeLeftClosed";
775
+ readonly EYE_RIGHT_OCCLUDED: "EyeRightOccluded";
776
+ readonly EYE_LEFT_OCCLUDED: "EyeLeftOccluded";
777
+ readonly EYES_RED: "EyesRed";
778
+ readonly EYE_RIGHT_COVERED_WITH_HAIR: "EyeRightCoveredWithHair";
779
+ readonly EYE_LEFT_COVERED_WITH_HAIR: "EyeLeftCoveredWithHair";
780
+ readonly OFF_GAZE: "OffGaze";
781
+ readonly FACE_DYNAMIC_RANGE: "FaceDynamicRange";
782
+ readonly UNNATURAL_SKIN_TONE: "UnnaturalSkinTone";
783
+ readonly TOO_DARK: "TooDark";
784
+ readonly TOO_LIGHT: "TooLight";
785
+ readonly FACE_GLARE: "FaceGlare";
786
+ readonly SHADOWS_ON_FACE: "ShadowsOnFace";
787
+ readonly DARK_GLASSES: "DarkGlasses";
788
+ readonly REFLECTION_ON_GLASSES: "ReflectionOnGlasses";
789
+ readonly FRAMES_TOO_HEAVY: "FramesTooHeavy";
790
+ readonly FACE_OCCLUDED: "FaceOccluded";
791
+ readonly HEAD_COVERING: "HeadCovering";
792
+ readonly BACKGROUND_UNIFORMITY: "BackgroundUniformity";
793
+ readonly SHADOWS_ON_BACKGROUND: "ShadowsOnBackground";
794
+ readonly OTHER_FACES: "OtherFaces";
795
+ readonly SHOULDERS_POSE: "ShouldersPose";
796
+ readonly EXPRESSION_LEVEL: "ExpressionLevel";
797
+ readonly MOUTH_OPEN: "MouthOpen";
798
+ readonly FOREHEAD_COVERING: "ForeheadCovering";
799
+ readonly SMILE: "Smile";
800
+ readonly STRONG_MAKEUP: "StrongMakeup";
801
+ readonly HEADPHONES: "Headphones";
802
+ readonly MEDICAL_MASK: "MedicalMask";
803
+ readonly BACKGROUND_COLOR_MATCH: "BackgroundColorMatch";
804
+ readonly ART_FACE: "ArtFace";
805
+ readonly CONTACT_LENSES: "ContactLenses";
806
+ };
807
+
808
+ export declare type FaceQualityConfigName = typeof FaceQualityConfigName[keyof typeof FaceQualityConfigName];
809
+
536
810
  /**
537
811
  * Face detection scenario. If set and the scenario is found, it automatically applies the relevant parameters, overriding any other parameters specified in the request. If the scenario is not set, is empty, or the name is not recognized, processing will follow the parameters directly set in the request. For detailed descriptions of available scenarios, refer to the [Scenarios page](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/scenarios/).
538
- */
539
- export declare enum FaceQualityScenarios {
540
- OLD_MODE = "OldMode",
541
- QUALITY_FULL = "QualityFull",
542
- QUALITY_ICAO = "QualityICAO",
543
- QUALITY_VISA_SCHENGEN = "QualityVisaSchengen",
544
- QUALITY_VISA_USA = "QualityVisaUSA",
545
- CROP_CENTRAL_FACE = "CropCentralFace",
546
- CROP_ALL_FACES = "CropAllFaces",
547
- THUMBNAIL = "Thumbnail",
548
- ATTRIBUTES_ALL = "AttributesAll",
549
- EMPTY = ""
550
- }
812
+ * @export
813
+ * @enum {string}
814
+ */
815
+ export declare const FaceQualityScenarios: {
816
+ readonly OLD_MODE: "OldMode";
817
+ readonly QUALITY_FULL: "QualityFull";
818
+ readonly QUALITY_ICAO: "QualityICAO";
819
+ readonly QUALITY_VISA_SCHENGEN: "QualityVisaSchengen";
820
+ readonly QUALITY_VISA_USA: "QualityVisaUSA";
821
+ readonly CROP_CENTRAL_FACE: "CropCentralFace";
822
+ readonly CROP_ALL_FACES: "CropAllFaces";
823
+ readonly THUMBNAIL: "Thumbnail";
824
+ readonly ATTRIBUTES_ALL: "AttributesAll";
825
+ readonly EMPTY: "";
826
+ };
827
+
828
+ export declare type FaceQualityScenarios = typeof FaceQualityScenarios[keyof typeof FaceQualityScenarios];
551
829
 
552
830
  export declare class FaceSdk {
553
831
  protected basePath: string;
@@ -556,166 +834,236 @@ export declare class FaceSdk {
556
834
  groupApi: GroupApi;
557
835
  personApi: PersonApi;
558
836
  searchApi: SearchApi;
837
+ diagnosticsApi: DiagnosticsApi;
559
838
  livenessApi: Liveness20Api;
560
- healthcheckApi: HealthcheckApi;
561
839
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
562
840
  }
563
841
 
842
+ /**
843
+ *
844
+ * @export
845
+ * @interface FaceSDKResult
846
+ */
564
847
  export declare interface FaceSDKResult {
848
+ /**
849
+ *
850
+ * @type {FaceSDKResultCode}
851
+ * @memberof FaceSDKResult
852
+ */
565
853
  'code': FaceSDKResultCode;
566
854
  }
567
855
 
568
- /**
569
- * NOTE: This file is auto generated by OpenAPI Generator.
570
- * Do not edit the file manually.
571
- */
572
856
  /**
573
857
  * The result code, see the [FaceSDKResultCode enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/).
574
- */
575
- export declare enum FaceSDKResultCode {
576
- FACER_OK = 0,
577
- FR_IMAGE_EMPTY = 1,
578
- FR_FACE_NOT_DETECTED = 2,
579
- FR_LANDMARKS_NOT_DETECTED = 3,
580
- FR_FACE_ALIGHNER_FAILED = 4,
581
- FR_DESCRIPTOR_EXTRACTOR_ERROR = 5,
582
- FR_IMAGE_DECODE_ERROR = 6,
583
- FR_INTERNAL_ERROR = 7,
584
- FACER_CONFIG_ERROR = 199,
585
- FACER_NO_LICENSE = 200,
586
- FACER_IS_NOT_INITIALIZED = 201,
587
- FACER_COMMAND_IS_NOT_SUPPORTED = 202,
588
- FACER_COMMAND_PARAMS_READ_ERROR = 203,
589
- FACER_LESS_THAN_TWO_IMAGES_IN_REQUEST = 224,
590
- FACER_VIDEO_DECODE_ERROR = 227,
591
- FACER_NOT_ENOUGH_FRAMES = 228,
592
- FACER_OUTPUT_IS_NOT_DEFINED = 229,
593
- FACER_CLOSED_EYES_DETECTED = 230,
594
- FACER_LOW_QUALITY = 231,
595
- FACER_HIGH_ASYMMETRY = 232,
596
- FACER_FACE_OVER_EMOTIONAL = 233,
597
- FACER_SUNGLASSES_DETECTED = 234,
598
- FACER_SMALL_AGE = 235,
599
- FACER_HEADDRESS_DETECTED = 236,
600
- FACER_FACES_NOT_MATCHED = 237,
601
- FACER_IMAGES_COUNT_LIMIT_EXCEEDED = 238,
602
- FACER_MEDICINE_MASK_DETECTED = 239,
603
- FACER_OCCLUSION_DETECTED = 240,
604
- FACER_FOREHEAD_GLASSES_DETECTED = 242,
605
- FACER_MOUTH_OPENED = 243,
606
- FACER_ART_MASK_DETECTED = 244,
607
- FACER_ELECTRONIC_DEVICE_DETECTED = 245,
608
- FACER_TRACK_BREAK = 246,
609
- FACER_WRONG_GEO = 247,
610
- FACER_WRONG_OF = 248,
611
- FACER_WRONG_VIEW = 249,
612
- FACER_TIMEOUT_LIVENESS_TRANSACTION = 250,
613
- FACER_FAILED_LIVENESS_TRANSACTION = 251,
614
- FACER_ABORTED_LIVENESS_TRANSACTION = 252,
615
- FACER_GENERAL_ERROR = 253,
616
- FACER_PASSIVE_LIVENESS_FAIL = 254
617
- }
858
+ * @export
859
+ * @enum {string}
860
+ */
861
+ export declare const FaceSDKResultCode: {
862
+ readonly FACER_OK: 0;
863
+ readonly FR_IMAGE_EMPTY: 1;
864
+ readonly FR_FACE_NOT_DETECTED: 2;
865
+ readonly FR_LANDMARKS_NOT_DETECTED: 3;
866
+ readonly FR_FACE_ALIGHNER_FAILED: 4;
867
+ readonly FR_DESCRIPTOR_EXTRACTOR_ERROR: 5;
868
+ readonly FR_IMAGE_DECODE_ERROR: 6;
869
+ readonly FR_INTERNAL_ERROR: 7;
870
+ readonly FACER_CONFIG_ERROR: 199;
871
+ readonly FACER_NO_LICENSE: 200;
872
+ readonly FACER_IS_NOT_INITIALIZED: 201;
873
+ readonly FACER_COMMAND_IS_NOT_SUPPORTED: 202;
874
+ readonly FACER_COMMAND_PARAMS_READ_ERROR: 203;
875
+ readonly FACER_LESS_THAN_TWO_IMAGES_IN_REQUEST: 224;
876
+ readonly FACER_VIDEO_DECODE_ERROR: 227;
877
+ readonly FACER_NOT_ENOUGH_FRAMES: 228;
878
+ readonly FACER_OUTPUT_IS_NOT_DEFINED: 229;
879
+ readonly FACER_CLOSED_EYES_DETECTED: 230;
880
+ readonly FACER_LOW_QUALITY: 231;
881
+ readonly FACER_HIGH_ASYMMETRY: 232;
882
+ readonly FACER_FACE_OVER_EMOTIONAL: 233;
883
+ readonly FACER_SUNGLASSES_DETECTED: 234;
884
+ readonly FACER_SMALL_AGE: 235;
885
+ readonly FACER_HEADDRESS_DETECTED: 236;
886
+ readonly FACER_FACES_NOT_MATCHED: 237;
887
+ readonly FACER_IMAGES_COUNT_LIMIT_EXCEEDED: 238;
888
+ readonly FACER_MEDICINE_MASK_DETECTED: 239;
889
+ readonly FACER_OCCLUSION_DETECTED: 240;
890
+ readonly FACER_FOREHEAD_GLASSES_DETECTED: 242;
891
+ readonly FACER_MOUTH_OPENED: 243;
892
+ readonly FACER_ART_MASK_DETECTED: 244;
893
+ readonly FACER_ELECTRONIC_DEVICE_DETECTED: 245;
894
+ readonly FACER_TRACK_BREAK: 246;
895
+ readonly FACER_WRONG_GEO: 247;
896
+ readonly FACER_WRONG_OF: 248;
897
+ readonly FACER_WRONG_VIEW: 249;
898
+ readonly FACER_TIMEOUT_LIVENESS_TRANSACTION: 250;
899
+ readonly FACER_FAILED_LIVENESS_TRANSACTION: 251;
900
+ readonly FACER_ABORTED_LIVENESS_TRANSACTION: 252;
901
+ readonly FACER_GENERAL_ERROR: 253;
902
+ readonly FACER_PASSIVE_LIVENESS_FAIL: 254;
903
+ };
904
+
905
+ export declare type FaceSDKResultCode = typeof FaceSDKResultCode[keyof typeof FaceSDKResultCode];
618
906
 
619
907
  /**
620
908
  * @type FacesResponse
909
+ * @export
621
910
  */
622
- export declare type FacesResponse = DetectionFace & FacesResponseData;
911
+ export declare type FacesResponse = DetectionFace & FacesResponseAllOf;
623
912
 
624
- export declare interface FacesResponseData {
913
+ /**
914
+ *
915
+ * @export
916
+ * @interface FacesResponseAllOf
917
+ */
918
+ export declare interface FacesResponseAllOf {
625
919
  /**
626
920
  * Detected Persons.
921
+ * @type {Array<PersonWithImages>}
922
+ * @memberof FacesResponseAllOf
627
923
  */
628
924
  'persons'?: Array<PersonWithImages>;
925
+ /**
926
+ *
927
+ * @type {number}
928
+ * @memberof FacesResponseAllOf
929
+ */
930
+ 'rotationAngle'?: number;
629
931
  }
630
932
 
631
- /**
632
- * NOTE: This file is auto generated by OpenAPI Generator.
633
- * Do not edit the file manually.
634
- */
635
933
  /**
636
934
  * The filter condition, determines the type of comparison to be performed on the `name` values of the Person entity. <br><br>When set to `in`, the `name` values of the Person should match any of the values specified in the `value` list. <br><br>When set to `nin`, the `name` values of the Person should not match any of the values specified in the `value` list.
935
+ * @export
936
+ * @enum {string}
637
937
  */
638
- export declare enum FilterOp {
639
- IN = "in",
640
- NOT_IN = "nin"
641
- }
938
+ export declare const FilterOp: {
939
+ readonly IN: "in";
940
+ readonly NOT_IN: "nin";
941
+ };
942
+
943
+ export declare type FilterOp = typeof FilterOp[keyof typeof FilterOp];
642
944
 
643
945
  /**
644
946
  * Allows to filter the search results based on the Person\'s `name`. If enabled, only the search results that meet the filter condition will be returned.
947
+ * @export
948
+ * @interface FilterSearchRequest
645
949
  */
646
950
  export declare interface FilterSearchRequest {
951
+ /**
952
+ *
953
+ * @type {FilterOp}
954
+ * @memberof FilterSearchRequest
955
+ */
647
956
  'op'?: FilterOp;
648
957
  /**
649
958
  * `name` of the Person.
959
+ * @type {string}
960
+ * @memberof FilterSearchRequest
650
961
  */
651
962
  'field'?: string;
652
963
  /**
653
964
  * The list of `name` values against which the `field` is compared.
965
+ * @type {Array<string>}
966
+ * @memberof FilterSearchRequest
654
967
  */
655
968
  'value'?: Array<string>;
656
969
  }
657
970
 
658
971
  /**
659
972
  * @type Group
973
+ * @export
660
974
  */
661
- export declare type Group = GroupData & GroupResponse;
662
-
663
- export declare class GroupApi {
664
- private superClass;
665
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
666
- createGroup(groupToCreate: GroupToCreate, xRequestID?: string, options?: AxiosRequestConfig): Promise<Group>;
667
- deleteGroup(groupId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
668
- getAllGroups(page: number, size: number, xRequestID?: string, options?: AxiosRequestConfig): Promise<GroupPage>;
669
- getAllPersonsByGroupId(page: number, size: number, groupId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<PersonsPage>;
670
- getGroup(groupId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<Group>;
671
- updateGroup(groupId: string, groupToCreate: GroupToCreate, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
672
- updatePersonsInGroup(groupId: string, updateGroup: UpdateGroup, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
673
- }
975
+ export declare type Group = GroupAllOf & GroupResponse;
674
976
 
675
977
  /**
676
- * NOTE: This file is auto generated by OpenAPI Generator.
677
- * Do not edit the file manually.
978
+ * Regula Face SDK Web API
979
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
980
+ *
981
+ * The version of the OpenAPI document: 7.2.0
982
+ *
983
+ *
984
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
985
+ * https://openapi-generator.tech
986
+ * Do not edit the class manually.
678
987
  */
679
988
  /**
680
989
  * Additional group data in the response, includes id and createdAt.
990
+ * @export
991
+ * @interface GroupAllOf
681
992
  */
682
- export declare interface GroupData {
993
+ export declare interface GroupAllOf {
683
994
  /**
684
995
  * Group ID.
996
+ * @type {string}
997
+ * @memberof GroupAllOf
685
998
  */
686
999
  'id'?: string;
687
1000
  /**
688
1001
  * Group creation date.
1002
+ * @type {string}
1003
+ * @memberof GroupAllOf
689
1004
  */
690
1005
  'createdAt'?: string;
691
1006
  }
692
1007
 
1008
+ export declare class GroupApi {
1009
+ private superClass;
1010
+ constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
1011
+ createGroup(groupToCreate: GroupToCreate, xRequestID?: string, options?: AxiosRequestConfig): Promise<Group>;
1012
+ deleteGroup(groupId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
1013
+ getAllGroups(page: number, size: number, xRequestID?: string, options?: AxiosRequestConfig): Promise<GroupPage>;
1014
+ getAllPersonsByGroupId(page: number, size: number, groupId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<PersonsPage>;
1015
+ getGroup(groupId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<Group>;
1016
+ updateGroup(groupId: string, groupToCreate: GroupToCreate, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
1017
+ updatePersonsInGroup(groupId: string, updateGroup: UpdateGroup, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
1018
+ }
1019
+
693
1020
  /**
694
1021
  * @type GroupPage
1022
+ * @export
695
1023
  */
696
- export declare type GroupPage = GroupPageItems & Page;
1024
+ export declare type GroupPage = GroupPageAllOf & Page;
697
1025
 
698
- export declare interface GroupPageItems {
1026
+ /**
1027
+ *
1028
+ * @export
1029
+ * @interface GroupPageAllOf
1030
+ */
1031
+ export declare interface GroupPageAllOf {
699
1032
  /**
700
1033
  * Array of Groups that are found during the search.
1034
+ * @type {Array<Group>}
1035
+ * @memberof GroupPageAllOf
701
1036
  */
702
1037
  'items'?: Array<Group>;
703
1038
  }
704
1039
 
705
1040
  /**
706
- * NOTE: This file is auto generated by OpenAPI Generator.
707
- * Do not edit the file manually.
1041
+ * Regula Face SDK Web API
1042
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1043
+ *
1044
+ * The version of the OpenAPI document: 7.2.0
1045
+ *
1046
+ *
1047
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1048
+ * https://openapi-generator.tech
1049
+ * Do not edit the class manually.
708
1050
  */
709
1051
  /**
710
1052
  * Response group create data, includes name and metadata.
1053
+ * @export
1054
+ * @interface GroupResponse
711
1055
  */
712
1056
  export declare interface GroupResponse {
713
1057
  /**
714
1058
  * Group to create name.
1059
+ * @type {string}
1060
+ * @memberof GroupResponse
715
1061
  */
716
1062
  'name'?: string;
717
1063
  /**
718
1064
  * A free-form object containing group\'s extended attributes.
1065
+ * @type {{ [key: string]: any; }}
1066
+ * @memberof GroupResponse
719
1067
  */
720
1068
  'metadata'?: {
721
1069
  [key: string]: any;
@@ -723,23 +1071,38 @@ export declare interface GroupResponse {
723
1071
  }
724
1072
 
725
1073
  /**
726
- * NOTE: This file is auto generated by OpenAPI Generator.
727
- * Do not edit the file manually.
1074
+ * Regula Face SDK Web API
1075
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1076
+ *
1077
+ * The version of the OpenAPI document: 7.2.0
1078
+ *
1079
+ *
1080
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1081
+ * https://openapi-generator.tech
1082
+ * Do not edit the class manually.
728
1083
  */
729
1084
  /**
730
1085
  * Request body of the group to create data, includes name and metadata.
1086
+ * @export
1087
+ * @interface GroupToCreate
731
1088
  */
732
1089
  export declare interface GroupToCreate {
733
1090
  /**
734
1091
  * Session identificator.
1092
+ * @type {string}
1093
+ * @memberof GroupToCreate
735
1094
  */
736
1095
  'tag'?: string;
737
1096
  /**
738
1097
  * Group to create name.
1098
+ * @type {string}
1099
+ * @memberof GroupToCreate
739
1100
  */
740
1101
  'name': string;
741
1102
  /**
742
1103
  * A free-form object containing group\'s extended attributes.
1104
+ * @type {{ [key: string]: any; }}
1105
+ * @memberof GroupToCreate
743
1106
  */
744
1107
  'metadata': {
745
1108
  [key: string]: any;
@@ -754,43 +1117,68 @@ export declare class HealthcheckApi {
754
1117
  }
755
1118
 
756
1119
  /**
757
- * NOTE: This file is auto generated by OpenAPI Generator.
758
- * Do not edit the file manually.
1120
+ * Regula Face SDK Web API
1121
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1122
+ *
1123
+ * The version of the OpenAPI document: 7.2.0
1124
+ *
1125
+ *
1126
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1127
+ * https://openapi-generator.tech
1128
+ * Do not edit the class manually.
759
1129
  */
760
1130
  /**
761
1131
  * Image in the response.
1132
+ * @export
1133
+ * @interface Image
762
1134
  */
763
1135
  declare interface Image_2 {
764
1136
  /**
765
1137
  * Response image ID. The list is sorted by decreasing ID value.
1138
+ * @type {string}
1139
+ * @memberof Image
766
1140
  */
767
1141
  'id'?: string;
768
1142
  /**
769
1143
  * Base64-encoded image. Returned only if `withImages` is set to true in the request.
1144
+ * @type {string}
1145
+ * @memberof Image
770
1146
  */
771
1147
  'content'?: string;
772
1148
  /**
773
1149
  * Original media type of the returned image.
1150
+ * @type {string}
1151
+ * @memberof Image
774
1152
  */
775
1153
  'contentType'?: string;
776
1154
  /**
777
1155
  * Returned image creation date.
1156
+ * @type {string}
1157
+ * @memberof Image
778
1158
  */
779
1159
  'createdAt'?: string;
780
1160
  /**
781
1161
  * Returned image update date.
1162
+ * @type {string}
1163
+ * @memberof Image
782
1164
  */
783
1165
  'updatedAt'?: string;
784
1166
  /**
785
1167
  * Returned image path.
1168
+ * @type {string}
1169
+ * @memberof Image
786
1170
  */
787
1171
  'path'?: string;
788
1172
  /**
789
1173
  * Returned image URL.
1174
+ * @type {string}
1175
+ * @memberof Image
790
1176
  */
791
1177
  'url'?: string;
792
1178
  /**
793
1179
  * A free-form object containing person\'s extended attributes.
1180
+ * @type {{ [key: string]: any; }}
1181
+ * @memberof Image
794
1182
  */
795
1183
  'metadata'?: {
796
1184
  [key: string]: any;
@@ -798,74 +1186,89 @@ declare interface Image_2 {
798
1186
  }
799
1187
  export { Image_2 as Image }
800
1188
 
1189
+ declare type ImageData_2 = Base64String | ArrayBuffer;
1190
+ export { ImageData_2 as ImageData }
1191
+
801
1192
  /**
802
1193
  * Image in the request data, includes image and contentType.
1194
+ * @export
1195
+ * @interface ImageFields
803
1196
  */
804
1197
  export declare interface ImageFields {
805
1198
  /**
806
1199
  * Session identificator, should be unique for each session.
1200
+ * @type {string}
1201
+ * @memberof ImageFields
807
1202
  */
808
1203
  'tag'?: string;
809
- 'image'?: ImageFieldsImage;
1204
+ /**
1205
+ *
1206
+ * @type {AddImageToPersonRequestImage}
1207
+ * @memberof ImageFields
1208
+ */
1209
+ 'image'?: AddImageToPersonRequestImage;
1210
+ /**
1211
+ *
1212
+ * @type {OutputImageParams}
1213
+ * @memberof ImageFields
1214
+ */
810
1215
  'outputImageParams'?: OutputImageParams;
811
1216
  /**
812
1217
  * Whether to detect all faces in the image. If set to `false`, only the most central face is detected.
1218
+ * @type {boolean}
1219
+ * @memberof ImageFields
813
1220
  */
814
1221
  'detectAll'?: boolean;
815
1222
  /**
816
1223
  * The similarity threshold.
1224
+ * @type {number}
1225
+ * @memberof ImageFields
817
1226
  */
818
1227
  'threshold'?: number;
819
1228
  /**
820
1229
  * The maximum number of results to be returned.
1230
+ * @type {number}
1231
+ * @memberof ImageFields
821
1232
  */
822
1233
  'limit'?: number;
823
1234
  }
824
1235
 
825
1236
  /**
826
- * Uploaded image.
1237
+ * @type ImagePage
1238
+ * @export
827
1239
  */
828
- export declare interface ImageFieldsImage {
829
- /**
830
- * Original media type of the uploaded image.
831
- */
832
- 'contentType'?: string;
833
- /**
834
- * Base64-encoded image.
835
- */
836
- 'content'?: string;
837
- /**
838
- * Image URL.
839
- */
840
- 'imageUrl'?: string;
841
- 'resizeOptions'?: ResizeOptions;
842
- }
1240
+ export declare type ImagePage = ImagePageAllOf & Page;
843
1241
 
844
1242
  /**
845
- * @type ImagePage
1243
+ * Image page.
1244
+ * @export
1245
+ * @interface ImagePageAllOf
846
1246
  */
847
- export declare type ImagePage = ImagePageItems & Page;
848
-
849
- export declare interface ImagePageItems {
1247
+ export declare interface ImagePageAllOf {
1248
+ /**
1249
+ *
1250
+ * @type {Array<Image>}
1251
+ * @memberof ImagePageAllOf
1252
+ */
850
1253
  'items'?: Array<Image_2>;
851
1254
  }
852
1255
 
853
1256
  /**
854
- * NOTE: This file is auto generated by OpenAPI Generator.
855
- * Do not edit the file manually.
856
- */
857
- /**
858
- * Face photo image source types: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/image-source/
1257
+ * The type of the image, defines the way the comparison is performed, see the [ImageSource enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/image-source/).
1258
+ * @export
1259
+ * @enum {string}
859
1260
  */
860
- export declare enum ImageSource {
861
- DOCUMENT_PRINTED = 1,
862
- DOCUMENT_RFID = 2,
863
- LIVE = 3,
864
- DOCUMENT_WITH_LIVE = 4,
865
- EXTERNAL = 5,
866
- GHOST = 6,
867
- BARCODE = 7
868
- }
1261
+ export declare const ImageSource: {
1262
+ readonly DOCUMENT_PRINTED: 1;
1263
+ readonly DOCUMENT_RFID: 2;
1264
+ readonly LIVE: 3;
1265
+ readonly DOCUMENT_WITH_LIVE: 4;
1266
+ readonly EXTERNAL: 5;
1267
+ readonly GHOST: 6;
1268
+ readonly BARCODE: 7;
1269
+ };
1270
+
1271
+ export declare type ImageSource = typeof ImageSource[keyof typeof ImageSource];
869
1272
 
870
1273
  export declare class Liveness20Api {
871
1274
  private superClass;
@@ -873,96 +1276,157 @@ export declare class Liveness20Api {
873
1276
  getLivenessTransactionInfo(transactionId: string, options?: AxiosRequestConfig): Promise<TransactionInfo>;
874
1277
  }
875
1278
 
876
- /**
877
- * NOTE: This file is auto generated by OpenAPI Generator.
878
- * Do not edit the file manually.
879
- */
880
1279
  /**
881
1280
  * Liveness detection can be performed in two modes: active `0` and passive `1`. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/liveness/#active-and-passive-modes)
1281
+ * @export
1282
+ * @enum {string}
882
1283
  */
883
- export declare enum LivenessType {
884
- ACTIVE = 0,
885
- PASSIVE = 1
886
- }
1284
+ export declare const LivenessType: {
1285
+ readonly ACTIVE: 0;
1286
+ readonly PASSIVE: 1;
1287
+ };
887
1288
 
1289
+ export declare type LivenessType = typeof LivenessType[keyof typeof LivenessType];
1290
+
1291
+ /**
1292
+ *
1293
+ * @export
1294
+ * @interface MatchAndSearchRequest
1295
+ */
888
1296
  export declare interface MatchAndSearchRequest {
889
1297
  /**
890
1298
  * Session identificator, should be unique for each session.
1299
+ * @type {string}
1300
+ * @memberof MatchAndSearchRequest
891
1301
  */
892
1302
  'tag'?: string;
893
1303
  /**
894
1304
  * An array of images to be processed. At least two images must be provided.
1305
+ * @type {Array<MatchAndSearchRequestImagesInner>}
1306
+ * @memberof MatchAndSearchRequest
895
1307
  */
896
- 'images'?: Array<MatchAndSearchRequestImagesItem>;
1308
+ 'images'?: Array<MatchAndSearchRequestImagesInner>;
897
1309
  /**
898
1310
  * IDs of the groups in which the search is performed.
1311
+ * @type {Array<string>}
1312
+ * @memberof MatchAndSearchRequest
899
1313
  */
900
1314
  'groupIds'?: Array<string>;
901
1315
  /**
902
1316
  * The similarity threshold.
1317
+ * @type {number}
1318
+ * @memberof MatchAndSearchRequest
903
1319
  */
904
1320
  'threshold'?: number;
905
1321
  /**
906
1322
  * The maximum number of results to be returned.
1323
+ * @type {number}
1324
+ * @memberof MatchAndSearchRequest
907
1325
  */
908
1326
  'limit'?: number;
909
1327
  /**
910
1328
  * A label used to group transactions by customers, applications, or other criteria.
1329
+ * @type {string}
1330
+ * @memberof MatchAndSearchRequest
911
1331
  */
912
1332
  'tenant'?: string;
913
1333
  /**
914
1334
  * A label used to differentiate transactions by development stages.
1335
+ * @type {string}
1336
+ * @memberof MatchAndSearchRequest
915
1337
  */
916
1338
  'env'?: string;
917
1339
  }
918
1340
 
919
- export declare interface MatchAndSearchRequestImagesItem {
1341
+ /**
1342
+ *
1343
+ * @export
1344
+ * @interface MatchAndSearchRequestImagesInner
1345
+ */
1346
+ export declare interface MatchAndSearchRequestImagesInner {
920
1347
  /**
921
- * Base64-encoded image.
1348
+ *
1349
+ * @type {ImageData}
1350
+ * @memberof MatchAndSearchRequestImagesInner
922
1351
  */
923
- 'content'?: string;
1352
+ 'content'?: ImageData_2;
924
1353
  /**
925
1354
  * Image URL.
1355
+ * @type {string}
1356
+ * @memberof MatchAndSearchRequestImagesInner
926
1357
  */
927
1358
  'imageUrl'?: string;
1359
+ /**
1360
+ *
1361
+ * @type {ImageSource}
1362
+ * @memberof MatchAndSearchRequestImagesInner
1363
+ */
928
1364
  'type'?: ImageSource;
929
1365
  }
930
1366
 
931
1367
  /**
932
1368
  * @type MatchAndSearchResponse
1369
+ * @export
933
1370
  */
934
- export declare type MatchAndSearchResponse = FaceSDKResult & MatchAndSearchResponseData;
1371
+ export declare type MatchAndSearchResponse = FaceSDKResult & MatchAndSearchResponseAllOf;
935
1372
 
936
- export declare interface MatchAndSearchResponseData {
1373
+ /**
1374
+ *
1375
+ * @export
1376
+ * @interface MatchAndSearchResponseAllOf
1377
+ */
1378
+ export declare interface MatchAndSearchResponseAllOf {
937
1379
  /**
938
1380
  * The match and search results.
1381
+ * @type {Array<MatchImageResult>}
1382
+ * @memberof MatchAndSearchResponseAllOf
939
1383
  */
940
1384
  'results'?: Array<MatchImageResult>;
941
1385
  /**
942
1386
  * Server processing time, ms. Does not include the time taken to receive the request or deliver the response.
1387
+ * @type {number}
1388
+ * @memberof MatchAndSearchResponseAllOf
943
1389
  */
944
1390
  'elapsedTime'?: number;
945
1391
  /**
946
1392
  * A free-form object containing person\'s extended attributes.
1393
+ * @type {{ [key: string]: any; }}
1394
+ * @memberof MatchAndSearchResponseAllOf
947
1395
  */
948
1396
  'metadata'?: {
949
1397
  [key: string]: any;
950
1398
  };
951
1399
  /**
952
1400
  * The detection results.
1401
+ * @type {Array<MatchAndSearchResponseAllOfDetections>}
1402
+ * @memberof MatchAndSearchResponseAllOf
953
1403
  */
954
- 'detections'?: Array<MatchAndSearchResponseDataDetectionsItem>;
1404
+ 'detections'?: Array<MatchAndSearchResponseAllOfDetections>;
955
1405
  }
956
1406
 
957
- export declare interface MatchAndSearchResponseDataDetectionsItem {
1407
+ /**
1408
+ *
1409
+ * @export
1410
+ * @interface MatchAndSearchResponseAllOfDetections
1411
+ */
1412
+ export declare interface MatchAndSearchResponseAllOfDetections {
958
1413
  /**
959
1414
  * Detected faces.
1415
+ * @type {Array<FacesResponse>}
1416
+ * @memberof MatchAndSearchResponseAllOfDetections
960
1417
  */
961
1418
  'faces'?: Array<FacesResponse>;
962
1419
  /**
963
1420
  * The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.
1421
+ * @type {number}
1422
+ * @memberof MatchAndSearchResponseAllOfDetections
964
1423
  */
965
1424
  'imageIndex'?: number;
1425
+ /**
1426
+ *
1427
+ * @type {FaceSDKResultCode}
1428
+ * @memberof MatchAndSearchResponseAllOfDetections
1429
+ */
966
1430
  'status'?: FaceSDKResultCode;
967
1431
  }
968
1432
 
@@ -970,99 +1434,189 @@ export declare class MatchApi {
970
1434
  private superClass;
971
1435
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
972
1436
  match(compareRequest: MatchRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<MatchResponse>;
973
- detect(detectRequest: DetectRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<DetectResponse>;
1437
+ detect(detectRequest: DetectRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<TDetectResponse>;
974
1438
  }
975
1439
 
1440
+ /**
1441
+ *
1442
+ * @export
1443
+ * @interface MatchImage
1444
+ */
976
1445
  export declare interface MatchImage {
977
1446
  /**
978
1447
  * The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.
1448
+ * @type {number}
1449
+ * @memberof MatchImage
979
1450
  */
980
1451
  'index'?: number;
1452
+ /**
1453
+ *
1454
+ * @type {ImageSource}
1455
+ * @memberof MatchImage
1456
+ */
981
1457
  'type'?: ImageSource;
982
1458
  /**
983
- * Base64-encoded image.
1459
+ *
1460
+ * @type {ImageData}
1461
+ * @memberof MatchImage
984
1462
  */
985
- 'data': string;
1463
+ 'data': ImageData_2;
986
1464
  /**
987
1465
  * Whether to detect all faces in the image. If set to `false`, only the most central face is detected.
1466
+ * @type {boolean}
1467
+ * @memberof MatchImage
988
1468
  */
989
1469
  'detectAll'?: boolean;
990
1470
  }
991
1471
 
1472
+ /**
1473
+ *
1474
+ * @export
1475
+ * @interface MatchImageDetection
1476
+ */
992
1477
  export declare interface MatchImageDetection {
993
1478
  /**
994
1479
  * Detected faces.
1480
+ * @type {Array<DetectionFace>}
1481
+ * @memberof MatchImageDetection
995
1482
  */
996
1483
  'faces'?: Array<DetectionFace>;
997
1484
  /**
998
1485
  * The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.
1486
+ * @type {number}
1487
+ * @memberof MatchImageDetection
999
1488
  */
1000
1489
  'imageIndex': number;
1490
+ /**
1491
+ *
1492
+ * @type {FaceSDKResultCode}
1493
+ * @memberof MatchImageDetection
1494
+ */
1001
1495
  'status': FaceSDKResultCode;
1002
1496
  }
1003
1497
 
1498
+ /**
1499
+ *
1500
+ * @export
1501
+ * @interface MatchImageResult
1502
+ */
1004
1503
  export declare interface MatchImageResult {
1005
1504
  /**
1006
1505
  * The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.
1506
+ * @type {number}
1507
+ * @memberof MatchImageResult
1007
1508
  */
1008
1509
  'firstIndex': number;
1009
1510
  /**
1010
1511
  * The detected face index number.
1512
+ * @type {number}
1513
+ * @memberof MatchImageResult
1011
1514
  */
1012
1515
  'firstFaceIndex'?: number;
1516
+ /**
1517
+ *
1518
+ * @type {ImageSource}
1519
+ * @memberof MatchImageResult
1520
+ */
1013
1521
  'first'?: ImageSource;
1014
1522
  /**
1015
1523
  * The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.
1524
+ * @type {number}
1525
+ * @memberof MatchImageResult
1016
1526
  */
1017
1527
  'secondIndex': number;
1018
1528
  /**
1019
1529
  * The detected face index number.
1530
+ * @type {number}
1531
+ * @memberof MatchImageResult
1020
1532
  */
1021
1533
  'secondFaceIndex'?: number;
1534
+ /**
1535
+ *
1536
+ * @type {ImageSource}
1537
+ * @memberof MatchImageResult
1538
+ */
1022
1539
  'second'?: ImageSource;
1023
1540
  /**
1024
1541
  * A dimensionless number that shows how similar the compared faces are. 0—absolutely identical faces.
1542
+ * @type {number}
1543
+ * @memberof MatchImageResult
1025
1544
  */
1026
1545
  'score'?: number;
1027
1546
  /**
1028
1547
  * The detected faces similarity, %. 100%—absolutely identical faces, 0%—absolutely not identical.
1548
+ * @type {number}
1549
+ * @memberof MatchImageResult
1029
1550
  */
1030
1551
  'similarity'?: number;
1031
1552
  }
1032
1553
 
1033
1554
  /**
1034
- * @type MatchRequest
1555
+ *
1556
+ * @export
1557
+ * @interface MatchRequest
1035
1558
  */
1036
- export declare type MatchRequest = MatchRequestData & TransactionLabels;
1037
-
1038
- export declare interface MatchRequestData {
1559
+ export declare interface MatchRequest {
1039
1560
  /**
1040
1561
  * Session identificator, should be unique for each session.
1562
+ * @type {string}
1563
+ * @memberof MatchRequest
1041
1564
  */
1042
1565
  'tag'?: string;
1043
1566
  /**
1044
1567
  * An array of images to be processed. At least two images must be provided.
1568
+ * @type {Array<MatchImage>}
1569
+ * @memberof MatchRequest
1045
1570
  */
1046
1571
  'images': Array<MatchImage>;
1572
+ /**
1573
+ *
1574
+ * @type {OutputImageParams}
1575
+ * @memberof MatchRequest
1576
+ */
1047
1577
  'outputImageParams'?: OutputImageParams;
1578
+ /**
1579
+ * A label used to group transactions by customers, applications, or other criteria.
1580
+ * @type {string}
1581
+ * @memberof MatchRequest
1582
+ */
1583
+ 'tenant'?: string;
1584
+ /**
1585
+ * A label used to differentiate transactions by development stages.
1586
+ * @type {string}
1587
+ * @memberof MatchRequest
1588
+ */
1589
+ 'env'?: string;
1048
1590
  }
1049
1591
 
1050
1592
  /**
1051
1593
  * @type MatchResponse
1594
+ * @export
1052
1595
  */
1053
- export declare type MatchResponse = FaceSDKResult & MatchResponseData;
1596
+ export declare type MatchResponse = FaceSDKResult & MatchResponseAllOf;
1054
1597
 
1055
- export declare interface MatchResponseData {
1598
+ /**
1599
+ *
1600
+ * @export
1601
+ * @interface MatchResponseAllOf
1602
+ */
1603
+ export declare interface MatchResponseAllOf {
1056
1604
  /**
1057
1605
  * The detection results.
1606
+ * @type {Array<MatchImageDetection>}
1607
+ * @memberof MatchResponseAllOf
1058
1608
  */
1059
1609
  'detections'?: Array<MatchImageDetection>;
1060
1610
  /**
1061
1611
  * The comparison results.
1612
+ * @type {Array<MatchImageResult>}
1613
+ * @memberof MatchResponseAllOf
1062
1614
  */
1063
1615
  'results'?: Array<MatchImageResult>;
1064
1616
  /**
1065
1617
  * A free-form object containing person\'s extended attributes.
1618
+ * @type {{ [key: string]: any; }}
1619
+ * @memberof MatchResponseAllOf
1066
1620
  */
1067
1621
  'metadata'?: {
1068
1622
  [key: string]: any;
@@ -1070,24 +1624,44 @@ export declare interface MatchResponseData {
1070
1624
  }
1071
1625
 
1072
1626
  /**
1073
- * NOTE: This file is auto generated by OpenAPI Generator.
1074
- * Do not edit the file manually.
1627
+ * Regula Face SDK Web API
1628
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1629
+ *
1630
+ * The version of the OpenAPI document: 7.2.0
1631
+ *
1632
+ *
1633
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1634
+ * https://openapi-generator.tech
1635
+ * Do not edit the class manually.
1636
+ */
1637
+ /**
1638
+ *
1639
+ * @export
1640
+ * @interface OperationLog
1075
1641
  */
1076
1642
  export declare interface OperationLog {
1077
1643
  /**
1078
1644
  * Status code.
1645
+ * @type {number}
1646
+ * @memberof OperationLog
1079
1647
  */
1080
1648
  'statusCode'?: number;
1081
1649
  /**
1082
1650
  * Error type.
1651
+ * @type {string}
1652
+ * @memberof OperationLog
1083
1653
  */
1084
1654
  'type'?: string;
1085
1655
  /**
1086
1656
  * Error message.
1657
+ * @type {string}
1658
+ * @memberof OperationLog
1087
1659
  */
1088
1660
  'msg'?: string;
1089
1661
  /**
1090
1662
  * A free-form object containing group\'s extended attributes.
1663
+ * @type {{ [key: string]: any; }}
1664
+ * @memberof OperationLog
1091
1665
  */
1092
1666
  'metadata'?: {
1093
1667
  [key: string]: any;
@@ -1096,29 +1670,51 @@ export declare interface OperationLog {
1096
1670
 
1097
1671
  /**
1098
1672
  * Allows to process the uploaded image according to the indicated settings.
1673
+ * @export
1674
+ * @interface OutputImageParams
1099
1675
  */
1100
1676
  export declare interface OutputImageParams {
1101
1677
  /**
1102
1678
  * The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
1679
+ * @type {Array<number>}
1680
+ * @memberof OutputImageParams
1103
1681
  */
1104
1682
  'backgroundColor'?: Array<number>;
1683
+ /**
1684
+ *
1685
+ * @type {Crop}
1686
+ * @memberof OutputImageParams
1687
+ */
1105
1688
  'crop'?: Crop;
1106
1689
  }
1107
1690
 
1108
1691
  /**
1109
- * NOTE: This file is auto generated by OpenAPI Generator.
1110
- * Do not edit the file manually.
1692
+ * Regula Face SDK Web API
1693
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1694
+ *
1695
+ * The version of the OpenAPI document: 7.2.0
1696
+ *
1697
+ *
1698
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1699
+ * https://openapi-generator.tech
1700
+ * Do not edit the class manually.
1111
1701
  */
1112
1702
  /**
1113
1703
  * Information about current page number and total pages count
1704
+ * @export
1705
+ * @interface Page
1114
1706
  */
1115
1707
  export declare interface Page {
1116
1708
  /**
1117
1709
  * Current page number.
1710
+ * @type {number}
1711
+ * @memberof Page
1118
1712
  */
1119
1713
  'page'?: number;
1120
1714
  /**
1121
1715
  * Total number of pages.
1716
+ * @type {number}
1717
+ * @memberof Page
1122
1718
  */
1123
1719
  'totalPages'?: number;
1124
1720
  }
@@ -1126,237 +1722,435 @@ export declare interface Page {
1126
1722
  /**
1127
1723
  * @type Person
1128
1724
  * Person response body: person ID, creation date, update date if any.
1725
+ * @export
1129
1726
  */
1130
- export declare type Person = PersonData & PersonFields;
1131
-
1132
- export declare class PersonApi {
1133
- private superClass;
1134
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
1135
- createPerson(personFields: PersonFields, xRequestID?: string, options?: AxiosRequestConfig): Promise<Person>;
1136
- addImageToPerson(personId: string, imageFields: AddImageToPersonRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<Image_2>;
1137
- deleteImageOfPerson(imageId: string, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
1138
- deletePerson(personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
1139
- getAllGroupsByPersonId(page: number, size: number, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<GroupPage>;
1140
- getAllImagesByPersonId(page: number, size: number, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<ImagePage>;
1141
- getImageOfPerson(imageId: string, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<unknown>;
1142
- getPerson(personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<Person>;
1143
- updatePerson(personId: string, personFields: PersonFields, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
1144
- }
1727
+ export declare type Person = PersonAllOf & PersonFields;
1145
1728
 
1146
1729
  /**
1147
- * NOTE: This file is auto generated by OpenAPI Generator.
1148
- * Do not edit the file manually.
1730
+ * Regula Face SDK Web API
1731
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1732
+ *
1733
+ * The version of the OpenAPI document: 7.2.0
1734
+ *
1735
+ *
1736
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1737
+ * https://openapi-generator.tech
1738
+ * Do not edit the class manually.
1739
+ */
1740
+ /**
1741
+ *
1742
+ * @export
1743
+ * @interface PersonAllOf
1149
1744
  */
1150
- export declare interface PersonData {
1745
+ export declare interface PersonAllOf {
1151
1746
  /**
1152
1747
  * Person ID. The list of persons is sorted by decreasing ID value.
1748
+ * @type {string}
1749
+ * @memberof PersonAllOf
1153
1750
  */
1154
1751
  'id'?: string;
1155
1752
  /**
1156
1753
  * Person creation date.
1754
+ * @type {string}
1755
+ * @memberof PersonAllOf
1157
1756
  */
1158
1757
  'createdAt'?: string;
1159
1758
  /**
1160
1759
  * Person update date.
1760
+ * @type {string}
1761
+ * @memberof PersonAllOf
1161
1762
  */
1162
1763
  'updatedAt'?: string;
1764
+ /**
1765
+ * List of groups this person belongs to.
1766
+ * @type {Array<string>}
1767
+ * @memberof PersonAllOf
1768
+ */
1769
+ 'groups'?: Array<string>;
1770
+ }
1771
+
1772
+ export declare class PersonApi {
1773
+ private superClass;
1774
+ constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
1775
+ createPerson(personFields: PersonFields, xRequestID?: string, options?: AxiosRequestConfig): Promise<Person>;
1776
+ addImageToPerson(personId: string, imageFields: AddImageToPersonRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<Image_2>;
1777
+ deleteImageOfPerson(imageId: string, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
1778
+ deletePerson(personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
1779
+ getAllGroupsByPersonId(page: number, size: number, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<GroupPage>;
1780
+ getAllImagesByPersonId(page: number, size: number, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<ImagePage>;
1781
+ getImageOfPerson(imageId: string, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<unknown>;
1782
+ getPerson(personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<Person>;
1783
+ updatePerson(personId: string, personFields: PersonFields, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
1163
1784
  }
1164
1785
 
1165
1786
  /**
1166
- * NOTE: This file is auto generated by OpenAPI Generator.
1167
- * Do not edit the file manually.
1787
+ * Regula Face SDK Web API
1788
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1789
+ *
1790
+ * The version of the OpenAPI document: 7.2.0
1791
+ *
1792
+ *
1793
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1794
+ * https://openapi-generator.tech
1795
+ * Do not edit the class manually.
1168
1796
  */
1169
1797
  /**
1170
1798
  * Person Request body: name and metadata.
1799
+ * @export
1800
+ * @interface PersonFields
1171
1801
  */
1172
1802
  export declare interface PersonFields {
1173
1803
  /**
1174
1804
  * Person\'s name.
1805
+ * @type {string}
1806
+ * @memberof PersonFields
1175
1807
  */
1176
1808
  'name': string;
1177
1809
  /**
1178
1810
  * Person\'s ID, used for linking search results to an ID in an external system. Can be set when creating a Person, stored in the database, and included in the search to return only Persons with the specified ID. Optional.
1811
+ * @type {string}
1812
+ * @memberof PersonFields
1179
1813
  */
1180
1814
  'externalId'?: string;
1181
1815
  /**
1182
1816
  * A free-form object containing person\'s extended attributes.
1817
+ * @type {{ [key: string]: any; }}
1818
+ * @memberof PersonFields
1183
1819
  */
1184
1820
  'metadata'?: {
1185
1821
  [key: string]: any;
1186
1822
  };
1187
1823
  /**
1188
1824
  * Groups a person should be placed to. If no group is specified in request, a Default group is created and the person is placed to it.
1825
+ * @type {Array<string>}
1826
+ * @memberof PersonFields
1189
1827
  */
1190
1828
  'groups'?: Array<string>;
1191
1829
  /**
1192
1830
  * Person expiration date.
1831
+ * @type {string}
1832
+ * @memberof PersonFields
1193
1833
  */
1194
1834
  'expireAt'?: string;
1195
1835
  }
1196
1836
 
1197
- export declare interface PersonItems {
1198
- 'items'?: Array<Person>;
1199
- }
1200
-
1201
1837
  /**
1202
1838
  * @type PersonsPage
1839
+ * @export
1203
1840
  */
1204
- export declare type PersonsPage = Page & PersonItems;
1841
+ export declare type PersonsPage = Page & PersonsPageAllOf;
1205
1842
 
1206
1843
  /**
1207
- * NOTE: This file is auto generated by OpenAPI Generator.
1208
- * Do not edit the file manually.
1844
+ *
1845
+ * @export
1846
+ * @interface PersonsPageAllOf
1847
+ */
1848
+ export declare interface PersonsPageAllOf {
1849
+ /**
1850
+ *
1851
+ * @type {Array<Person>}
1852
+ * @memberof PersonsPageAllOf
1853
+ */
1854
+ 'items'?: Array<Person>;
1855
+ }
1856
+
1857
+ /**
1858
+ * Regula Face SDK Web API
1859
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1860
+ *
1861
+ * The version of the OpenAPI document: 7.2.0
1862
+ *
1863
+ *
1864
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1865
+ * https://openapi-generator.tech
1866
+ * Do not edit the class manually.
1209
1867
  */
1210
1868
  /**
1211
1869
  * Person Request body: name and metadata.
1870
+ * @export
1871
+ * @interface PersonToUpdateFields
1212
1872
  */
1213
1873
  export declare interface PersonToUpdateFields {
1214
1874
  /**
1215
1875
  * Person\'s ID, used for linking search results to an ID in an external system. Can be set when creating a Person, stored in the database, and included in the search to return only Persons with the specified ID. Optional.
1876
+ * @type {string}
1877
+ * @memberof PersonToUpdateFields
1216
1878
  */
1217
1879
  'externalId'?: string;
1218
1880
  /**
1219
1881
  * Person\'s name.
1882
+ * @type {string}
1883
+ * @memberof PersonToUpdateFields
1220
1884
  */
1221
1885
  'name'?: string;
1222
1886
  /**
1223
1887
  * A free-form object containing person\'s extended attributes.
1888
+ * @type {{ [key: string]: any; }}
1889
+ * @memberof PersonToUpdateFields
1224
1890
  */
1225
1891
  'metadata'?: {
1226
1892
  [key: string]: any;
1227
1893
  };
1228
1894
  /**
1229
1895
  * Groups a person should be placed to. If no group is specified in request, a Default group is created and the person is placed to it.
1896
+ * @type {Array<string>}
1897
+ * @memberof PersonToUpdateFields
1230
1898
  */
1231
1899
  'groups'?: Array<string>;
1232
1900
  }
1233
1901
 
1234
1902
  /**
1235
1903
  * @type PersonWithImages
1904
+ * @export
1236
1905
  */
1237
- export declare type PersonWithImages = Person & PersonWithImagesData;
1906
+ export declare type PersonWithImages = Person & PersonWithImagesAllOf;
1238
1907
 
1239
- export declare interface PersonWithImagesData {
1908
+ /**
1909
+ *
1910
+ * @export
1911
+ * @interface PersonWithImagesAllOf
1912
+ */
1913
+ export declare interface PersonWithImagesAllOf {
1240
1914
  /**
1241
1915
  * Detected Persons.
1916
+ * @type {Array<RecognizeImage>}
1917
+ * @memberof PersonWithImagesAllOf
1242
1918
  */
1243
1919
  'images'?: Array<RecognizeImage>;
1244
1920
  }
1245
1921
 
1246
1922
  /**
1247
1923
  * The processing parameters.
1924
+ * @export
1925
+ * @interface ProcessParam
1248
1926
  */
1249
1927
  export declare interface ProcessParam {
1928
+ /**
1929
+ *
1930
+ * @type {FaceQualityScenarios}
1931
+ * @memberof ProcessParam
1932
+ */
1250
1933
  'scenario'?: FaceQualityScenarios;
1251
1934
  /**
1252
1935
  * Whether to process only the central face in the image. If set to `false`, all the faces are processed.
1936
+ * @type {boolean}
1937
+ * @memberof ProcessParam
1253
1938
  */
1254
1939
  'onlyCentralFace'?: boolean;
1940
+ /**
1941
+ *
1942
+ * @type {OutputImageParams}
1943
+ * @memberof ProcessParam
1944
+ */
1255
1945
  'outputImageParams'?: OutputImageParams;
1946
+ /**
1947
+ *
1948
+ * @type {QualityRequest}
1949
+ * @memberof ProcessParam
1950
+ */
1256
1951
  'quality'?: QualityRequest;
1952
+ /**
1953
+ *
1954
+ * @type {ProcessParamAttributes}
1955
+ * @memberof ProcessParam
1956
+ */
1257
1957
  'attributes'?: ProcessParamAttributes;
1258
1958
  }
1259
1959
 
1260
1960
  /**
1261
1961
  * If set, the selected attributes, such as age or emotions, are evaluated. To check all the available attributes, you can set the `AttributesAll` scenario in `processParam.scenario`.
1962
+ * @export
1963
+ * @interface ProcessParamAttributes
1262
1964
  */
1263
1965
  export declare interface ProcessParamAttributes {
1264
1966
  /**
1265
1967
  * The list of attributes for evaluation.
1968
+ * @type {Array<AttributeConfig>}
1969
+ * @memberof ProcessParamAttributes
1266
1970
  */
1267
1971
  'config'?: Array<AttributeConfig>;
1268
1972
  }
1269
1973
 
1270
1974
  /**
1271
1975
  * The configuration that defines the list of returned quality check characteristics.
1976
+ * @export
1977
+ * @interface QualityConfig
1272
1978
  */
1273
1979
  export declare interface QualityConfig {
1980
+ /**
1981
+ *
1982
+ * @type {FaceQualityConfigName}
1983
+ * @memberof QualityConfig
1984
+ */
1274
1985
  'name'?: FaceQualityConfigName;
1275
1986
  /**
1276
1987
  * The range of applicable values for this characteristic. If the returned in the response value fits this range, the characteristic is identified as compliant with the requirements. For recommended ranges, see [Face Image Quality Assessment](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/face-image-quality-check/).
1988
+ * @type {Array<number>}
1989
+ * @memberof QualityConfig
1277
1990
  */
1278
1991
  'range'?: Array<number>;
1279
1992
  }
1280
1993
 
1994
+ /**
1995
+ *
1996
+ * @export
1997
+ * @interface QualityDetail
1998
+ */
1281
1999
  export declare interface QualityDetail {
2000
+ /**
2001
+ *
2002
+ * @type {FaceImageQualityGroups}
2003
+ * @memberof QualityDetail
2004
+ */
1282
2005
  'groupId'?: FaceImageQualityGroups;
2006
+ /**
2007
+ *
2008
+ * @type {FaceQualityConfigName}
2009
+ * @memberof QualityDetail
2010
+ */
1283
2011
  'name'?: FaceQualityConfigName;
1284
2012
  /**
1285
2013
  * The range of set values for this characteristic, see the [Recommended range column](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/face-image-quality-check/).
2014
+ * @type {Array<number>}
2015
+ * @memberof QualityDetail
1286
2016
  */
1287
2017
  'range'?: Array<number>;
2018
+ /**
2019
+ *
2020
+ * @type {FaceImageQualityStatus}
2021
+ * @memberof QualityDetail
2022
+ */
1288
2023
  'status'?: FaceImageQualityStatus;
1289
2024
  /**
1290
2025
  * The result value for the characteristic, returned in set units.
2026
+ * @type {number}
2027
+ * @memberof QualityDetail
1291
2028
  */
1292
2029
  'value'?: number;
1293
2030
  }
1294
2031
 
2032
+ /**
2033
+ *
2034
+ * @export
2035
+ * @interface QualityDetailsGroups
2036
+ */
1295
2037
  export declare interface QualityDetailsGroups {
2038
+ /**
2039
+ *
2040
+ * @type {FaceImageQualityGroups}
2041
+ * @memberof QualityDetailsGroups
2042
+ */
1296
2043
  'groupId'?: FaceImageQualityGroups;
2044
+ /**
2045
+ *
2046
+ * @type {FaceImageQualityGroupsStrings}
2047
+ * @memberof QualityDetailsGroups
2048
+ */
1297
2049
  'name'?: FaceImageQualityGroupsStrings;
1298
2050
  /**
1299
2051
  * The total number of characteristics in the group.
2052
+ * @type {number}
2053
+ * @memberof QualityDetailsGroups
1300
2054
  */
1301
2055
  'totalCount'?: number;
1302
2056
  /**
1303
2057
  * The number of compliant characteristics in the group.
2058
+ * @type {number}
2059
+ * @memberof QualityDetailsGroups
1304
2060
  */
1305
2061
  'compliantCount'?: number;
1306
2062
  }
1307
2063
 
1308
2064
  /**
1309
2065
  * If set, the face image quality check is performed according to the given list of [characteristics](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/face-image-quality-check/) in `quality.config`.
2066
+ * @export
2067
+ * @interface QualityRequest
1310
2068
  */
1311
2069
  export declare interface QualityRequest {
1312
2070
  /**
1313
2071
  * The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
2072
+ * @type {Array<number>}
2073
+ * @memberof QualityRequest
1314
2074
  */
1315
2075
  'backgroundMatchColor'?: Array<number>;
1316
2076
  /**
1317
2077
  * The list of quality check characteristics.
2078
+ * @type {Array<QualityConfig>}
2079
+ * @memberof QualityRequest
1318
2080
  */
1319
2081
  'config'?: Array<QualityConfig>;
1320
2082
  }
1321
2083
 
1322
2084
  /**
1323
2085
  * @type RecognizeImage
2086
+ * @export
1324
2087
  */
1325
- export declare type RecognizeImage = Image_2 & RecognizeImageData;
2088
+ export declare type RecognizeImage = Image_2 & RecognizeImageAllOf;
1326
2089
 
1327
2090
  /**
1328
- * NOTE: This file is auto generated by OpenAPI Generator.
1329
- * Do not edit the file manually.
2091
+ * Regula Face SDK Web API
2092
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
2093
+ *
2094
+ * The version of the OpenAPI document: 7.2.0
2095
+ *
2096
+ *
2097
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2098
+ * https://openapi-generator.tech
2099
+ * Do not edit the class manually.
1330
2100
  */
1331
- export declare interface RecognizeImageData {
2101
+ /**
2102
+ *
2103
+ * @export
2104
+ * @interface RecognizeImageAllOf
2105
+ */
2106
+ export declare interface RecognizeImageAllOf {
1332
2107
  /**
1333
2108
  * Similarity score.
2109
+ * @type {number}
2110
+ * @memberof RecognizeImageAllOf
1334
2111
  */
1335
2112
  'similarity'?: number;
1336
2113
  /**
1337
2114
  * Similarity distance score: the lower the distance, the higher the face\'s similarity.
2115
+ * @type {number}
2116
+ * @memberof RecognizeImageAllOf
1338
2117
  */
1339
2118
  'distance'?: number;
1340
2119
  }
1341
2120
 
1342
2121
  /**
1343
- * NOTE: This file is auto generated by OpenAPI Generator.
1344
- * Do not edit the file manually.
2122
+ * Regula Face SDK Web API
2123
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
2124
+ *
2125
+ * The version of the OpenAPI document: 7.2.0
2126
+ *
2127
+ *
2128
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2129
+ * https://openapi-generator.tech
2130
+ * Do not edit the class manually.
1345
2131
  */
1346
2132
  /**
1347
2133
  * Set to resize the original image.
2134
+ * @export
2135
+ * @interface ResizeOptions
1348
2136
  */
1349
2137
  export declare interface ResizeOptions {
1350
2138
  /**
1351
2139
  * Resized image width, px.
2140
+ * @type {number}
2141
+ * @memberof ResizeOptions
1352
2142
  */
1353
2143
  'width'?: number;
1354
2144
  /**
1355
2145
  * Resized image height, px.
2146
+ * @type {number}
2147
+ * @memberof ResizeOptions
1356
2148
  */
1357
2149
  'height'?: number;
1358
2150
  /**
1359
2151
  * Resized image quality, percent.
2152
+ * @type {number}
2153
+ * @memberof ResizeOptions
1360
2154
  */
1361
2155
  'quality'?: number;
1362
2156
  }
@@ -1368,200 +2162,456 @@ export declare class SearchApi {
1368
2162
  }
1369
2163
 
1370
2164
  /**
1371
- * NOTE: This file is auto generated by OpenAPI Generator.
1372
- * Do not edit the file manually.
2165
+ * Regula Face SDK Web API
2166
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
2167
+ *
2168
+ * The version of the OpenAPI document: 7.2.0
2169
+ *
2170
+ *
2171
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2172
+ * https://openapi-generator.tech
2173
+ * Do not edit the class manually.
2174
+ */
2175
+ /**
2176
+ *
2177
+ * @export
2178
+ * @interface SearchBadParams
1373
2179
  */
1374
2180
  export declare interface SearchBadParams {
2181
+ /**
2182
+ *
2183
+ * @type {string}
2184
+ * @memberof SearchBadParams
2185
+ */
1375
2186
  'msg'?: string;
2187
+ /**
2188
+ *
2189
+ * @type {number}
2190
+ * @memberof SearchBadParams
2191
+ */
1376
2192
  'statusCode'?: number;
2193
+ /**
2194
+ *
2195
+ * @type {string}
2196
+ * @memberof SearchBadParams
2197
+ */
1377
2198
  'type'?: string;
1378
2199
  }
1379
2200
 
1380
2201
  /**
1381
- * NOTE: This file is auto generated by OpenAPI Generator.
1382
- * Do not edit the file manually.
2202
+ * Regula Face SDK Web API
2203
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
2204
+ *
2205
+ * The version of the OpenAPI document: 7.2.0
2206
+ *
2207
+ *
2208
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2209
+ * https://openapi-generator.tech
2210
+ * Do not edit the class manually.
1383
2211
  */
1384
2212
  /**
1385
2213
  * The array of identified persons.
2214
+ * @export
2215
+ * @interface SearchDetection
1386
2216
  */
1387
2217
  export declare interface SearchDetection {
1388
2218
  /**
1389
2219
  * Internal.
2220
+ * @type {number}
2221
+ * @memberof SearchDetection
1390
2222
  */
1391
2223
  'code'?: number;
1392
2224
  /**
1393
2225
  * Base64 of the aligned and cropped portrait.
2226
+ * @type {string}
2227
+ * @memberof SearchDetection
1394
2228
  */
1395
2229
  'crop'?: string;
1396
2230
  /**
1397
2231
  * Internal.
2232
+ * @type {number}
2233
+ * @memberof SearchDetection
1398
2234
  */
1399
2235
  'detectorType'?: number;
1400
2236
  /**
1401
2237
  * Internal.
2238
+ * @type {string}
2239
+ * @memberof SearchDetection
1402
2240
  */
1403
2241
  'hash'?: string;
1404
2242
  /**
1405
2243
  * Internal.
2244
+ * @type {number}
2245
+ * @memberof SearchDetection
1406
2246
  */
1407
2247
  'idx'?: number;
1408
2248
  /**
1409
2249
  * Internal.
2250
+ * @type {string}
2251
+ * @memberof SearchDetection
1410
2252
  */
1411
2253
  'image'?: string;
1412
2254
  /**
1413
2255
  * Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
2256
+ * @type {Array<Array<number>>}
2257
+ * @memberof SearchDetection
1414
2258
  */
1415
2259
  'landmarks'?: Array<Array<number>>;
1416
2260
  /**
1417
2261
  * Internal.
2262
+ * @type {number}
2263
+ * @memberof SearchDetection
1418
2264
  */
1419
2265
  'landmarksType'?: number;
1420
2266
  /**
1421
2267
  * Internal.
2268
+ * @type {string}
2269
+ * @memberof SearchDetection
1422
2270
  */
1423
2271
  'msg'?: string;
1424
2272
  /**
1425
2273
  * The rectangular area of a detected face that is represented by a set of four elements: the X and Y coordinates of the top-left point, and the width and height dimensions of the rectangle.
2274
+ * @type {Array<number>}
2275
+ * @memberof SearchDetection
1426
2276
  */
1427
2277
  'roi'?: Array<number>;
2278
+ /**
2279
+ *
2280
+ * @type {string}
2281
+ * @memberof SearchDetection
2282
+ */
1428
2283
  'versionSDK'?: string;
1429
2284
  }
1430
2285
 
1431
2286
  /**
1432
2287
  * Request search data.
2288
+ * @export
2289
+ * @interface SearchParameters
1433
2290
  */
1434
2291
  export declare interface SearchParameters {
2292
+ /**
2293
+ *
2294
+ * @type {SearchParametersCreatePerson}
2295
+ * @memberof SearchParameters
2296
+ */
1435
2297
  'createPerson'?: SearchParametersCreatePerson;
1436
2298
  /**
1437
2299
  * IDs of the groups in which the search is performed.
2300
+ * @type {Array<string>}
2301
+ * @memberof SearchParameters
1438
2302
  */
1439
2303
  'groupIds'?: Array<string>;
2304
+ /**
2305
+ *
2306
+ * @type {FilterSearchRequest}
2307
+ * @memberof SearchParameters
2308
+ */
1440
2309
  'filter'?: FilterSearchRequest;
1441
2310
  }
1442
2311
 
1443
2312
  /**
1444
- * NOTE: This file is auto generated by OpenAPI Generator.
1445
- * Do not edit the file manually.
2313
+ * Regula Face SDK Web API
2314
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
2315
+ *
2316
+ * The version of the OpenAPI document: 7.2.0
2317
+ *
2318
+ *
2319
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2320
+ * https://openapi-generator.tech
2321
+ * Do not edit the class manually.
1446
2322
  */
1447
2323
  /**
1448
2324
  * If a person is not found, a new person entry is created using the descriptor calculated while searching.
2325
+ * @export
2326
+ * @interface SearchParametersCreatePerson
1449
2327
  */
1450
2328
  export declare interface SearchParametersCreatePerson {
1451
2329
  /**
1452
2330
  * Person\'s name.
2331
+ * @type {string}
2332
+ * @memberof SearchParametersCreatePerson
1453
2333
  */
1454
2334
  'name'?: string;
1455
2335
  /**
1456
2336
  * A free-form object containing person\'s extended attributes.
2337
+ * @type {{ [key: string]: any; }}
2338
+ * @memberof SearchParametersCreatePerson
1457
2339
  */
1458
2340
  'metadata'?: {
1459
2341
  [key: string]: any;
1460
2342
  };
1461
2343
  /**
1462
2344
  * The lifespan of the Person\'s records, seconds. Optional.
2345
+ * @type {number}
2346
+ * @memberof SearchParametersCreatePerson
1463
2347
  */
1464
- 'ttl'?: number;
2348
+ 'ttl'?: number | null;
1465
2349
  }
1466
2350
 
1467
2351
  /**
1468
2352
  * @type SearchPerson
2353
+ * @export
1469
2354
  */
1470
- export declare type SearchPerson = Person & SearchPersonData;
2355
+ export declare type SearchPerson = Person & SearchPersonAllOf;
1471
2356
 
1472
- export declare interface SearchPersonData {
2357
+ /**
2358
+ * Person data.
2359
+ * @export
2360
+ * @interface SearchPersonAllOf
2361
+ */
2362
+ export declare interface SearchPersonAllOf {
2363
+ /**
2364
+ *
2365
+ * @type {SearchDetection}
2366
+ * @memberof SearchPersonAllOf
2367
+ */
1473
2368
  'detection'?: SearchDetection;
1474
2369
  /**
1475
2370
  * Array of Person images.
2371
+ * @type {Array<RecognizeImage>}
2372
+ * @memberof SearchPersonAllOf
1476
2373
  */
1477
2374
  'images'?: Array<RecognizeImage>;
1478
2375
  }
1479
2376
 
1480
2377
  /**
1481
2378
  * @type SearchRequest
2379
+ * @export
1482
2380
  */
1483
- export declare type SearchRequest = ImageFields & SearchParameters & TransactionLabels;
2381
+ export declare type SearchRequest = ImageFields & SearchParameters & SearchRequestAllOf;
1484
2382
 
2383
+ /**
2384
+ * Regula Face SDK Web API
2385
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
2386
+ *
2387
+ * The version of the OpenAPI document: 7.2.0
2388
+ *
2389
+ *
2390
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2391
+ * https://openapi-generator.tech
2392
+ * Do not edit the class manually.
2393
+ */
2394
+ /**
2395
+ *
2396
+ * @export
2397
+ * @interface SearchRequestAllOf
2398
+ */
2399
+ export declare interface SearchRequestAllOf {
2400
+ /**
2401
+ * A label used to group transactions by customers, applications, or other criteria.
2402
+ * @type {string}
2403
+ * @memberof SearchRequestAllOf
2404
+ */
2405
+ 'tenant'?: string;
2406
+ /**
2407
+ * A label used to differentiate transactions by development stages.
2408
+ * @type {string}
2409
+ * @memberof SearchRequestAllOf
2410
+ */
2411
+ 'env'?: string;
2412
+ }
2413
+
2414
+ /**
2415
+ *
2416
+ * @export
2417
+ * @interface SearchResult
2418
+ */
1485
2419
  export declare interface SearchResult {
1486
2420
  /**
1487
2421
  * Result code. It is returned only with response 200.
2422
+ * @type {number}
2423
+ * @memberof SearchResult
1488
2424
  */
1489
2425
  'code'?: number;
1490
2426
  /**
1491
2427
  * Array of Person images. It is returned only with response 200.
2428
+ * @type {Array<SearchPerson>}
2429
+ * @memberof SearchResult
1492
2430
  */
1493
2431
  'persons'?: Array<SearchPerson>;
1494
2432
  }
1495
2433
 
2434
+ export declare type TDetection = {
2435
+ /**
2436
+ *
2437
+ * @type {ImageData}
2438
+ * @memberof Detection
2439
+ */
2440
+ crop?: ImageData_2;
2441
+ /**
2442
+ *
2443
+ * @memberof Detection
2444
+ */
2445
+ attributes?: {
2446
+ /**
2447
+ *
2448
+ * @type {Array<{ name?: string; confidence?: number; value?: any; }>}
2449
+ */
2450
+ details?: {
2451
+ name?: string;
2452
+ confidence?: number;
2453
+ value?: any;
2454
+ }[];
2455
+ /**
2456
+ * The elapsed time for attribute detection.
2457
+ * @type {number}
2458
+ */
2459
+ elapsedTime?: number;
2460
+ };
2461
+ /**
2462
+ * Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
2463
+ * @type {Array<Array<number>>}
2464
+ * @memberof Detection
2465
+ */
2466
+ landmarks: Array<Array<number>>;
2467
+ /**
2468
+ *
2469
+ * @type {DetectionQuality}
2470
+ * @memberof Detection
2471
+ */
2472
+ quality?: DetectionQuality;
2473
+ /**
2474
+ * The rectangular area of a detected face that is represented by a set of four elements: the X and Y coordinates of the top-left point, and the width and height dimensions of the rectangle.
2475
+ * @type {Array<number>}
2476
+ * @memberof Detection
2477
+ */
2478
+ roi: Array<number>;
2479
+ /**
2480
+ * Base64 of the cropped portrait.
2481
+ * @type {string}
2482
+ * @memberof Detection
2483
+ */
2484
+ thumbnail?: string;
2485
+ };
2486
+
2487
+ export declare type TDetectResponse = {
2488
+ results?: {
2489
+ /**
2490
+ *
2491
+ * @type {Array<Detection>}
2492
+ * @memberof DetectResult
2493
+ */
2494
+ detections: Array<TDetection>;
2495
+ /**
2496
+ * Internal.
2497
+ * @type {number}
2498
+ * @memberof DetectResult
2499
+ */
2500
+ detectorType?: number;
2501
+ /**
2502
+ * Internal.
2503
+ * @type {number}
2504
+ * @memberof DetectResult
2505
+ */
2506
+ landmarksType?: number;
2507
+ /**
2508
+ *
2509
+ * @type {FaceQualityScenarios}
2510
+ * @memberof DetectResult
2511
+ */
2512
+ scenario?: FaceQualityScenarios;
2513
+ /**
2514
+ * The total time taken for the detection.
2515
+ * @type {number}
2516
+ * @memberof DetectResult
2517
+ */
2518
+ timer?: number;
2519
+ };
2520
+ } & FaceSDKResult;
2521
+
2522
+ /**
2523
+ *
2524
+ * @export
2525
+ * @interface TransactionInfo
2526
+ */
1496
2527
  export declare interface TransactionInfo {
1497
2528
  /**
1498
2529
  * Result code, see the [FaceSDKResultCode enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/).
2530
+ * @type {number}
2531
+ * @memberof TransactionInfo
1499
2532
  */
1500
2533
  'code'?: number;
1501
2534
  /**
1502
2535
  * Whether the liveness detection is confirmed `0` or not `1`.
2536
+ * @type {number}
2537
+ * @memberof TransactionInfo
1503
2538
  */
1504
2539
  'status'?: number;
1505
2540
  /**
1506
2541
  * Session identificator, should be unique for each session.
2542
+ * @type {string}
2543
+ * @memberof TransactionInfo
1507
2544
  */
1508
2545
  'tag'?: string;
1509
2546
  /**
1510
2547
  * Transaction ID, there can be several transactions within one session.
2548
+ * @type {string}
2549
+ * @memberof TransactionInfo
1511
2550
  */
1512
2551
  'transactionId'?: string;
1513
2552
  /**
1514
2553
  * Link to the session video, depends on the selected storage type. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/storage/)
2554
+ * @type {string}
2555
+ * @memberof TransactionInfo
1515
2556
  */
1516
2557
  'video'?: string;
1517
2558
  /**
1518
2559
  * Approximate age with an accuracy of +/-3 years.
2560
+ * @type {Array<{ [key: string]: any; }>}
2561
+ * @memberof TransactionInfo
1519
2562
  */
1520
2563
  'age'?: Array<{
1521
2564
  [key: string]: any;
1522
2565
  }>;
1523
2566
  /**
1524
2567
  * Link to the portrait, depends on the selected storage type. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/storage/)
2568
+ * @type {string}
2569
+ * @memberof TransactionInfo
1525
2570
  */
1526
2571
  'portrait'?: string;
1527
2572
  /**
1528
2573
  * A free-form object containing person\'s extended attributes.
2574
+ * @type {{ [key: string]: any; }}
2575
+ * @memberof TransactionInfo
1529
2576
  */
1530
2577
  'metadata'?: {
1531
2578
  [key: string]: any;
1532
2579
  };
1533
- 'type'?: LivenessType;
1534
- }
1535
-
1536
- /**
1537
- * NOTE: This file is auto generated by OpenAPI Generator.
1538
- * Do not edit the file manually.
1539
- */
1540
- export declare interface TransactionLabels {
1541
2580
  /**
1542
- * A label used to group transactions by customers, applications, or other criteria.
1543
- */
1544
- 'tenant'?: string;
1545
- /**
1546
- * A label used to differentiate transactions by development stages.
2581
+ *
2582
+ * @type {LivenessType}
2583
+ * @memberof TransactionInfo
1547
2584
  */
1548
- 'env'?: string;
2585
+ 'type'?: LivenessType;
1549
2586
  }
1550
2587
 
1551
2588
  /**
1552
- * NOTE: This file is auto generated by OpenAPI Generator.
1553
- * Do not edit the file manually.
2589
+ * Regula Face SDK Web API
2590
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
2591
+ *
2592
+ * The version of the OpenAPI document: 7.2.0
2593
+ *
2594
+ *
2595
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2596
+ * https://openapi-generator.tech
2597
+ * Do not edit the class manually.
1554
2598
  */
1555
2599
  /**
1556
2600
  * Update group.
2601
+ * @export
2602
+ * @interface UpdateGroup
1557
2603
  */
1558
2604
  export declare interface UpdateGroup {
1559
2605
  /**
1560
2606
  * Add items.
2607
+ * @type {Array<string>}
2608
+ * @memberof UpdateGroup
1561
2609
  */
1562
2610
  'addItems'?: Array<string>;
1563
2611
  /**
1564
2612
  * Remove items.
2613
+ * @type {Array<string>}
2614
+ * @memberof UpdateGroup
1565
2615
  */
1566
2616
  'removeItems'?: Array<string>;
1567
2617
  }