@regulaforensics/facesdk-webclient 8.1.408-nightly → 8.1.410-nightly

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 +412 -1462
  3. package/dist/index.js +1639 -1879
  4. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -2,132 +2,76 @@ import { AxiosInstance } from 'axios';
2
2
  import { AxiosRequestConfig } from 'axios';
3
3
 
4
4
  /**
5
+ * @type AddImageToPersonRequest
5
6
  * Image in the request data, includes image and contentType.
6
- * @export
7
- * @interface AddImageToPersonRequest
8
7
  */
9
- export declare interface AddImageToPersonRequest {
8
+ export declare type AddImageToPersonRequest = AddImageToPersonRequestData & TransactionLabels;
9
+
10
+ export declare interface AddImageToPersonRequestData {
10
11
  /**
11
12
  * Session identificator.
12
- * @type {string}
13
- * @memberof AddImageToPersonRequest
14
13
  */
15
14
  'tag'?: string;
16
- /**
17
- *
18
- * @type {AddImageToPersonRequestImage}
19
- * @memberof AddImageToPersonRequest
20
- */
21
15
  'image': AddImageToPersonRequestImage;
22
16
  /**
23
17
  * The similarity threshold.
24
- * @type {number}
25
- * @memberof AddImageToPersonRequest
26
18
  */
27
19
  'threshold'?: number;
28
20
  /**
29
21
  * The maximum number of results to be returned.
30
- * @type {number}
31
- * @memberof AddImageToPersonRequest
32
22
  */
33
23
  '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;
46
24
  }
47
25
 
48
26
  /**
49
27
  * Uploaded image.
50
- * @export
51
- * @interface AddImageToPersonRequestImage
52
28
  */
53
29
  export declare interface AddImageToPersonRequestImage {
54
30
  /**
55
31
  * Original media type of the uploaded image.
56
- * @type {string}
57
- * @memberof AddImageToPersonRequestImage
58
32
  */
59
33
  'contentType'?: string;
60
34
  /**
61
- *
62
- * @type {ImageData}
63
- * @memberof AddImageToPersonRequestImage
35
+ * Base64-encoded image.
64
36
  */
65
- 'content'?: ImageData_2;
37
+ 'content'?: string;
66
38
  /**
67
39
  * Image URL.
68
- * @type {string}
69
- * @memberof AddImageToPersonRequestImage
70
40
  */
71
41
  'imageUrl'?: string;
72
- /**
73
- *
74
- * @type {ResizeOptions}
75
- * @memberof AddImageToPersonRequestImage
76
- */
77
42
  'resizeOptions'?: ResizeOptions;
78
43
  }
79
44
 
80
45
  /**
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.
46
+ * NOTE: This file is auto generated by OpenAPI Generator.
47
+ * Do not edit the file manually.
90
48
  */
91
49
  /**
92
50
  * Image in the response.
93
- * @export
94
- * @interface AddImageToPersonResponse
95
51
  */
96
52
  export declare interface AddImageToPersonResponse {
97
53
  /**
98
54
  * Response image ID. The list is sorted by decreasing ID value.
99
- * @type {string}
100
- * @memberof AddImageToPersonResponse
101
55
  */
102
56
  'id'?: string;
103
57
  /**
104
58
  * Original media type of the returned image.
105
- * @type {string}
106
- * @memberof AddImageToPersonResponse
107
59
  */
108
60
  'contentType'?: string;
109
61
  /**
110
62
  * Returned image creation date.
111
- * @type {string}
112
- * @memberof AddImageToPersonResponse
113
63
  */
114
64
  'createdAt'?: string;
115
65
  /**
116
66
  * Returned image path.
117
- * @type {string}
118
- * @memberof AddImageToPersonResponse
119
67
  */
120
68
  'path'?: string;
121
69
  /**
122
70
  * Returned image URL.
123
- * @type {string}
124
- * @memberof AddImageToPersonResponse
125
71
  */
126
72
  'url'?: string;
127
73
  /**
128
74
  * A free-form object containing person\'s extended attributes.
129
- * @type {{ [key: string]: any; }}
130
- * @memberof AddImageToPersonResponse
131
75
  */
132
76
  'metadata'?: {
133
77
  [key: string]: any;
@@ -136,60 +80,52 @@ export declare interface AddImageToPersonResponse {
136
80
 
137
81
  /**
138
82
  * The configuration that defines the list of returned attribute check characteristics.
139
- * @export
140
- * @interface AttributeConfig
141
83
  */
142
84
  export declare interface AttributeConfig {
143
- /**
144
- *
145
- * @type {FaceAttribute}
146
- * @memberof AttributeConfig
147
- */
148
85
  'name'?: FaceAttribute;
149
86
  }
150
87
 
151
- export declare type Base64String = string;
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
+ /**
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/).
95
+ */
96
+ 'value'?: Array<number>;
97
+ }
152
98
 
153
99
  export declare class Configuration {
154
100
  /**
155
101
  * parameter for apiKey security
156
102
  * @param name security name
157
- * @memberof Configuration
158
103
  */
159
104
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
160
105
  /**
161
106
  * parameter for basic security
162
- *
163
- * @type {string}
164
- * @memberof Configuration
165
107
  */
166
108
  username?: string;
167
109
  /**
168
110
  * parameter for basic security
169
- *
170
- * @type {string}
171
- * @memberof Configuration
172
111
  */
173
112
  password?: string;
174
113
  /**
175
114
  * parameter for oauth2 security
176
115
  * @param name security name
177
116
  * @param scopes oauth2 scope
178
- * @memberof Configuration
179
117
  */
180
118
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
181
119
  /**
182
120
  * override base path
183
- *
184
- * @type {string}
185
- * @memberof Configuration
186
121
  */
187
122
  basePath?: string;
123
+ /**
124
+ * override server index
125
+ */
126
+ serverIndex?: number;
188
127
  /**
189
128
  * base options for axios calls
190
- *
191
- * @type {any}
192
- * @memberof Configuration
193
129
  */
194
130
  baseOptions?: any;
195
131
  /**
@@ -215,15 +151,8 @@ export declare class Configuration {
215
151
  }
216
152
 
217
153
  /**
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.
154
+ * NOTE: This file is auto generated by OpenAPI Generator.
155
+ * Do not edit the file manually.
227
156
  */
228
157
  export declare interface ConfigurationParameters {
229
158
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
@@ -231,601 +160,394 @@ export declare interface ConfigurationParameters {
231
160
  password?: string;
232
161
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
233
162
  basePath?: string;
163
+ serverIndex?: number;
234
164
  baseOptions?: any;
235
165
  formDataCtor?: new () => any;
236
166
  }
237
167
 
238
168
  /**
239
169
  * 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
242
170
  */
243
171
  export declare interface Crop {
244
- /**
245
- *
246
- * @type {FaceImageQualityAlignType}
247
- * @memberof Crop
248
- */
249
172
  'type'?: FaceImageQualityAlignType;
250
173
  /**
251
174
  * 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
254
175
  */
255
176
  'padColor'?: Array<number>;
256
177
  /**
257
178
  * The resize value in case `type` matches this value. If it doesn\'t, no resize is performed.
258
- * @type {Array<number>}
259
- * @memberof Crop
260
179
  */
261
180
  'size'?: Array<number>;
262
181
  }
263
182
 
264
183
  /**
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
184
+ * NOTE: This file is auto generated by OpenAPI Generator.
185
+ * Do not edit the file manually.
279
186
  */
280
- export declare interface DetectAttributesDetails {
187
+ export declare interface DetailItem {
281
188
  /**
282
189
  * The name of the attribute.
283
- * @type {string}
284
- * @memberof DetectAttributesDetails
285
190
  */
286
191
  '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>;
293
192
  }
294
193
 
295
194
  /**
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.
195
+ * @type DetectAttributesDetails
305
196
  */
306
- /**
307
- *
308
- * @export
309
- * @interface DetectDetailsMeta
310
- */
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
- }
197
+ export declare type DetectAttributesDetails = AttributesData & DetailItem;
331
198
 
332
199
  /**
333
- *
334
- * @export
335
- * @interface Detection
200
+ * @type DetectDetailsMeta
336
201
  */
202
+ export declare type DetectDetailsMeta = DetailItem & DetectMetaData;
203
+
337
204
  export declare interface Detection {
338
205
  /**
339
- *
340
- * @type {ImageData}
341
- * @memberof Detection
342
- */
343
- 'crop'?: ImageData_2;
344
- /**
345
- *
346
- * @type {DetectionAttributes}
347
- * @memberof Detection
206
+ * Base64-encoded image.
348
207
  */
208
+ 'crop'?: string;
349
209
  'attributes'?: DetectionAttributes;
350
210
  /**
351
211
  * 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
354
212
  */
355
213
  'landmarks': Array<Array<number>>;
356
- /**
357
- *
358
- * @type {DetectionQuality}
359
- * @memberof Detection
360
- */
361
214
  'quality'?: DetectionQuality;
362
215
  /**
363
216
  * 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
366
217
  */
367
218
  'roi': Array<number>;
368
219
  }
369
220
 
370
221
  /**
371
222
  * 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
374
223
  */
375
224
  export declare interface DetectionAttributes {
376
225
  /**
377
226
  * Attributes assessment details. Returns `DetectDetailsMeta` or `DetectAttributesDetails`.
378
- * @type {Array<DetectionAttributesDetailsInner>}
379
- * @memberof DetectionAttributes
380
227
  */
381
228
  'details'?: Array<DetectionAttributesDetailsInner>;
382
229
  /**
383
230
  * Server processing time for attribute detection, ms.
384
- * @type {number}
385
- * @memberof DetectionAttributes
386
231
  */
387
232
  'elapsedTime'?: number;
388
233
  }
389
234
 
390
235
  /**
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.
236
+ * @type DetectionAttributesDetailsInner
400
237
  */
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
- }
238
+ export declare type DetectionAttributesDetailsInner = DetectAttributesDetails | DetectDetailsMeta;
426
239
 
427
240
  /**
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
241
+ * NOTE: This file is auto generated by OpenAPI Generator.
242
+ * Do not edit the file manually.
442
243
  */
443
244
  export declare interface DetectionFace {
444
245
  /**
445
246
  * The detected face index number.
446
- * @type {number}
447
- * @memberof DetectionFace
448
247
  */
449
248
  'faceIndex'?: number;
450
249
  /**
451
250
  * 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
454
251
  */
455
252
  'landmarks'?: Array<Array<number>>;
456
253
  /**
457
254
  * Angle of rotation of the face from the vertical axis, degrees.
458
- * @type {number}
459
- * @memberof DetectionFace
460
255
  */
461
256
  'rotationAngle'?: number;
462
257
  /**
463
258
  * 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
466
259
  */
467
260
  'roi'?: Array<number>;
468
261
  /**
469
262
  * Base64-encoded aligned and cropped portrait.
470
- * @type {string}
471
- * @memberof DetectionFace
472
263
  */
473
264
  'crop'?: string;
474
265
  }
475
266
 
476
267
  /**
477
268
  * 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
480
269
  */
481
270
  export declare interface DetectionQuality {
482
271
  /**
483
272
  * Non-compliant assessment characteristics.
484
- * @type {Array<FaceQualityConfigName>}
485
- * @memberof DetectionQuality
486
273
  */
487
274
  'nonCompliant'?: Array<FaceQualityConfigName>;
488
275
  /**
489
276
  * 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
492
277
  */
493
278
  'detailsGroups'?: Array<QualityDetailsGroups>;
494
279
  /**
495
280
  * Assessment characteristics that were set in the request.
496
- * @type {Array<QualityDetail>}
497
- * @memberof DetectionQuality
498
281
  */
499
282
  'details'?: Array<QualityDetail>;
500
283
  /**
501
284
  * 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
504
285
  */
505
286
  'score'?: number;
506
287
  /**
507
288
  * Server processing time for quality assessment, ms.
508
- * @type {number}
509
- * @memberof DetectionQuality
510
289
  */
511
290
  'elapsedTime'?: number;
512
291
  }
513
292
 
514
293
  /**
515
- *
516
- * @export
517
- * @interface DetectRequest
294
+ * NOTE: This file is auto generated by OpenAPI Generator.
295
+ * Do not edit the file manually.
518
296
  */
519
- export declare interface DetectRequest {
297
+ export declare interface DetectMetaData {
520
298
  /**
521
- * Session identificator, should be unique for each session.
522
- * @type {string}
523
- * @memberof DetectRequest
524
- */
525
- 'tag'?: string;
526
- /**
527
- *
528
- * @type {ProcessParam}
529
- * @memberof DetectRequest
299
+ * The confidence in the estimated value, `1.0` is for 100% confidence.
530
300
  */
531
- 'processParam'?: ProcessParam;
301
+ 'confidence'?: number;
532
302
  /**
533
- *
534
- * @type {ImageData}
535
- * @memberof DetectRequest
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/).
536
304
  */
537
- 'image'?: ImageData_2;
305
+ 'value'?: string;
306
+ }
307
+
308
+ /**
309
+ * @type DetectRequest
310
+ */
311
+ export declare type DetectRequest = DetectRequestData & TransactionLabels;
312
+
313
+ export declare interface DetectRequestData {
538
314
  /**
539
- * A label used to group transactions by customers, applications, or other criteria.
540
- * @type {string}
541
- * @memberof DetectRequest
315
+ * Session identificator, should be unique for each session.
542
316
  */
543
- 'tenant'?: string;
317
+ 'tag'?: string;
318
+ 'processParam'?: ProcessParam;
544
319
  /**
545
- * A label used to differentiate transactions by development stages.
546
- * @type {string}
547
- * @memberof DetectRequest
320
+ * Base64-encoded image.
548
321
  */
549
- 'env'?: string;
322
+ 'image'?: string;
550
323
  }
551
324
 
552
325
  /**
553
326
  * @type DetectResponse
554
- * @export
555
327
  */
556
- export declare type DetectResponse = DetectResponseAllOf & FaceSDKResult;
328
+ export declare type DetectResponse = DetectResponseResults & FaceSDKResult;
557
329
 
558
- /**
559
- *
560
- * @export
561
- * @interface DetectResponseAllOf
562
- */
563
- export declare interface DetectResponseAllOf {
564
- /**
565
- *
566
- * @type {DetectResult}
567
- * @memberof DetectResponseAllOf
568
- */
330
+ export declare interface DetectResponseResults {
569
331
  'results'?: DetectResult;
570
332
  }
571
333
 
572
334
  /**
573
335
  * The detection results.
574
- * @export
575
- * @interface DetectResult
576
336
  */
577
337
  export declare interface DetectResult {
578
338
  /**
579
339
  * The array of performed checks.
580
- * @type {Array<Detection>}
581
- * @memberof DetectResult
582
340
  */
583
341
  'detections': Array<Detection>;
584
342
  /**
585
343
  * Internal.
586
- * @type {number}
587
- * @memberof DetectResult
588
344
  */
589
345
  'detectorType'?: number;
590
346
  /**
591
347
  * Internal.
592
- * @type {number}
593
- * @memberof DetectResult
594
348
  */
595
349
  'landmarksType'?: number;
596
350
  /**
597
351
  * The face detection scenario that was set in the `processParam.scenario` field of the request.
598
- * @type {string}
599
- * @memberof DetectResult
600
352
  */
601
353
  'scenario'?: string;
602
354
  /**
603
355
  * Server processing time, ms. Does not include the time taken to receive the request or deliver the response.
604
- * @type {number}
605
- * @memberof DetectResult
606
356
  */
607
357
  'elapsedTime'?: number;
608
358
  }
609
359
 
610
360
  /**
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
361
+ * NOTE: This file is auto generated by OpenAPI Generator.
362
+ * Do not edit the file manually.
625
363
  */
626
364
  export declare interface DeviceInfo {
627
365
  /**
628
366
  * Application name.
629
- * @type {string}
630
- * @memberof DeviceInfo
631
367
  */
632
368
  'app': string;
633
369
  /**
634
370
  * Unique license identifier.
635
- * @type {string}
636
- * @memberof DeviceInfo
637
371
  */
638
372
  'licenseId': string | null;
639
373
  /**
640
374
  * License serial number.
641
- * @type {string}
642
- * @memberof DeviceInfo
643
375
  */
644
376
  'licenseSerial': string | null;
645
377
  /**
646
378
  * License validity date.
647
- * @type {string}
648
- * @memberof DeviceInfo
649
379
  */
650
380
  'licenseValidUntil': string | null;
651
381
  /**
652
382
  * Product version.
653
- * @type {string}
654
- * @memberof DeviceInfo
655
383
  */
656
384
  'version': string | null;
657
385
  }
658
386
 
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>>;
663
- }
664
-
387
+ /**
388
+ * NOTE: This file is auto generated by OpenAPI Generator.
389
+ * Do not edit the file manually.
390
+ */
665
391
  /**
666
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/).
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];
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"
408
+ }
687
409
 
410
+ /**
411
+ * NOTE: This file is auto generated by OpenAPI Generator.
412
+ * Do not edit the file manually.
413
+ */
688
414
  /**
689
415
  * 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}
692
416
  */
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];
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
+ }
702
424
 
425
+ /**
426
+ * NOTE: This file is auto generated by OpenAPI Generator.
427
+ * Do not edit the file manually.
428
+ */
703
429
  /**
704
430
  * 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}
707
431
  */
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];
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
+ }
720
442
 
443
+ /**
444
+ * NOTE: This file is auto generated by OpenAPI Generator.
445
+ * Do not edit the file manually.
446
+ */
721
447
  /**
722
448
  * 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}
725
449
  */
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];
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
+ }
738
460
 
461
+ /**
462
+ * NOTE: This file is auto generated by OpenAPI Generator.
463
+ * Do not edit the file manually.
464
+ */
739
465
  /**
740
466
  * 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}
743
467
  */
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];
468
+ export declare enum FaceImageQualityStatus {
469
+ QUALITY_STATUS_FALSE = 0,
470
+ QUALITY_STATUS_TRUE = 1,
471
+ QUALITY_STATUS_UNDETERMINED = 2
472
+ }
751
473
 
474
+ /**
475
+ * NOTE: This file is auto generated by OpenAPI Generator.
476
+ * Do not edit the file manually.
477
+ */
752
478
  /**
753
479
  * 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/).
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
-
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
+ */
810
536
  /**
811
537
  * 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/).
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];
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
+ }
829
551
 
830
552
  export declare class FaceSdk {
831
553
  protected basePath: string;
@@ -834,236 +556,166 @@ export declare class FaceSdk {
834
556
  groupApi: GroupApi;
835
557
  personApi: PersonApi;
836
558
  searchApi: SearchApi;
837
- diagnosticsApi: DiagnosticsApi;
838
559
  livenessApi: Liveness20Api;
560
+ healthcheckApi: HealthcheckApi;
839
561
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
840
562
  }
841
563
 
842
- /**
843
- *
844
- * @export
845
- * @interface FaceSDKResult
846
- */
847
564
  export declare interface FaceSDKResult {
848
- /**
849
- *
850
- * @type {FaceSDKResultCode}
851
- * @memberof FaceSDKResult
852
- */
853
565
  'code': FaceSDKResultCode;
854
566
  }
855
567
 
568
+ /**
569
+ * NOTE: This file is auto generated by OpenAPI Generator.
570
+ * Do not edit the file manually.
571
+ */
856
572
  /**
857
573
  * The result code, see the [FaceSDKResultCode enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/).
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];
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
+ }
906
618
 
907
619
  /**
908
620
  * @type FacesResponse
909
- * @export
910
621
  */
911
- export declare type FacesResponse = DetectionFace & FacesResponseAllOf;
622
+ export declare type FacesResponse = DetectionFace & FacesResponseData;
912
623
 
913
- /**
914
- *
915
- * @export
916
- * @interface FacesResponseAllOf
917
- */
918
- export declare interface FacesResponseAllOf {
624
+ export declare interface FacesResponseData {
919
625
  /**
920
626
  * Detected Persons.
921
- * @type {Array<PersonWithImages>}
922
- * @memberof FacesResponseAllOf
923
627
  */
924
628
  'persons'?: Array<PersonWithImages>;
925
- /**
926
- *
927
- * @type {number}
928
- * @memberof FacesResponseAllOf
929
- */
930
- 'rotationAngle'?: number;
931
629
  }
932
630
 
631
+ /**
632
+ * NOTE: This file is auto generated by OpenAPI Generator.
633
+ * Do not edit the file manually.
634
+ */
933
635
  /**
934
636
  * 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}
937
637
  */
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];
638
+ export declare enum FilterOp {
639
+ IN = "in",
640
+ NOT_IN = "nin"
641
+ }
944
642
 
945
643
  /**
946
644
  * 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
949
645
  */
950
646
  export declare interface FilterSearchRequest {
951
- /**
952
- *
953
- * @type {FilterOp}
954
- * @memberof FilterSearchRequest
955
- */
956
647
  'op'?: FilterOp;
957
648
  /**
958
649
  * `name` of the Person.
959
- * @type {string}
960
- * @memberof FilterSearchRequest
961
650
  */
962
651
  'field'?: string;
963
652
  /**
964
653
  * The list of `name` values against which the `field` is compared.
965
- * @type {Array<string>}
966
- * @memberof FilterSearchRequest
967
654
  */
968
655
  'value'?: Array<string>;
969
656
  }
970
657
 
971
658
  /**
972
659
  * @type Group
973
- * @export
974
660
  */
975
- export declare type Group = GroupAllOf & GroupResponse;
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
+ }
976
674
 
977
675
  /**
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.
676
+ * NOTE: This file is auto generated by OpenAPI Generator.
677
+ * Do not edit the file manually.
987
678
  */
988
679
  /**
989
680
  * Additional group data in the response, includes id and createdAt.
990
- * @export
991
- * @interface GroupAllOf
992
681
  */
993
- export declare interface GroupAllOf {
682
+ export declare interface GroupData {
994
683
  /**
995
684
  * Group ID.
996
- * @type {string}
997
- * @memberof GroupAllOf
998
685
  */
999
686
  'id'?: string;
1000
687
  /**
1001
688
  * Group creation date.
1002
- * @type {string}
1003
- * @memberof GroupAllOf
1004
689
  */
1005
690
  'createdAt'?: string;
1006
691
  }
1007
692
 
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
-
1020
693
  /**
1021
694
  * @type GroupPage
1022
- * @export
1023
695
  */
1024
- export declare type GroupPage = GroupPageAllOf & Page;
696
+ export declare type GroupPage = GroupPageItems & Page;
1025
697
 
1026
- /**
1027
- *
1028
- * @export
1029
- * @interface GroupPageAllOf
1030
- */
1031
- export declare interface GroupPageAllOf {
698
+ export declare interface GroupPageItems {
1032
699
  /**
1033
700
  * Array of Groups that are found during the search.
1034
- * @type {Array<Group>}
1035
- * @memberof GroupPageAllOf
1036
701
  */
1037
702
  'items'?: Array<Group>;
1038
703
  }
1039
704
 
1040
705
  /**
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.
706
+ * NOTE: This file is auto generated by OpenAPI Generator.
707
+ * Do not edit the file manually.
1050
708
  */
1051
709
  /**
1052
710
  * Response group create data, includes name and metadata.
1053
- * @export
1054
- * @interface GroupResponse
1055
711
  */
1056
712
  export declare interface GroupResponse {
1057
713
  /**
1058
714
  * Group to create name.
1059
- * @type {string}
1060
- * @memberof GroupResponse
1061
715
  */
1062
716
  'name'?: string;
1063
717
  /**
1064
718
  * A free-form object containing group\'s extended attributes.
1065
- * @type {{ [key: string]: any; }}
1066
- * @memberof GroupResponse
1067
719
  */
1068
720
  'metadata'?: {
1069
721
  [key: string]: any;
@@ -1071,38 +723,23 @@ export declare interface GroupResponse {
1071
723
  }
1072
724
 
1073
725
  /**
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.
726
+ * NOTE: This file is auto generated by OpenAPI Generator.
727
+ * Do not edit the file manually.
1083
728
  */
1084
729
  /**
1085
730
  * Request body of the group to create data, includes name and metadata.
1086
- * @export
1087
- * @interface GroupToCreate
1088
731
  */
1089
732
  export declare interface GroupToCreate {
1090
733
  /**
1091
734
  * Session identificator.
1092
- * @type {string}
1093
- * @memberof GroupToCreate
1094
735
  */
1095
736
  'tag'?: string;
1096
737
  /**
1097
738
  * Group to create name.
1098
- * @type {string}
1099
- * @memberof GroupToCreate
1100
739
  */
1101
740
  'name': string;
1102
741
  /**
1103
742
  * A free-form object containing group\'s extended attributes.
1104
- * @type {{ [key: string]: any; }}
1105
- * @memberof GroupToCreate
1106
743
  */
1107
744
  'metadata': {
1108
745
  [key: string]: any;
@@ -1117,68 +754,43 @@ export declare class HealthcheckApi {
1117
754
  }
1118
755
 
1119
756
  /**
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.
757
+ * NOTE: This file is auto generated by OpenAPI Generator.
758
+ * Do not edit the file manually.
1129
759
  */
1130
760
  /**
1131
761
  * Image in the response.
1132
- * @export
1133
- * @interface Image
1134
762
  */
1135
763
  declare interface Image_2 {
1136
764
  /**
1137
765
  * Response image ID. The list is sorted by decreasing ID value.
1138
- * @type {string}
1139
- * @memberof Image
1140
766
  */
1141
767
  'id'?: string;
1142
768
  /**
1143
769
  * Base64-encoded image. Returned only if `withImages` is set to true in the request.
1144
- * @type {string}
1145
- * @memberof Image
1146
770
  */
1147
771
  'content'?: string;
1148
772
  /**
1149
773
  * Original media type of the returned image.
1150
- * @type {string}
1151
- * @memberof Image
1152
774
  */
1153
775
  'contentType'?: string;
1154
776
  /**
1155
777
  * Returned image creation date.
1156
- * @type {string}
1157
- * @memberof Image
1158
778
  */
1159
779
  'createdAt'?: string;
1160
780
  /**
1161
781
  * Returned image update date.
1162
- * @type {string}
1163
- * @memberof Image
1164
782
  */
1165
783
  'updatedAt'?: string;
1166
784
  /**
1167
785
  * Returned image path.
1168
- * @type {string}
1169
- * @memberof Image
1170
786
  */
1171
787
  'path'?: string;
1172
788
  /**
1173
789
  * Returned image URL.
1174
- * @type {string}
1175
- * @memberof Image
1176
790
  */
1177
791
  'url'?: string;
1178
792
  /**
1179
793
  * A free-form object containing person\'s extended attributes.
1180
- * @type {{ [key: string]: any; }}
1181
- * @memberof Image
1182
794
  */
1183
795
  'metadata'?: {
1184
796
  [key: string]: any;
@@ -1186,89 +798,74 @@ declare interface Image_2 {
1186
798
  }
1187
799
  export { Image_2 as Image }
1188
800
 
1189
- declare type ImageData_2 = Base64String | ArrayBuffer;
1190
- export { ImageData_2 as ImageData }
1191
-
1192
801
  /**
1193
802
  * Image in the request data, includes image and contentType.
1194
- * @export
1195
- * @interface ImageFields
1196
803
  */
1197
804
  export declare interface ImageFields {
1198
805
  /**
1199
806
  * Session identificator, should be unique for each session.
1200
- * @type {string}
1201
- * @memberof ImageFields
1202
807
  */
1203
808
  'tag'?: string;
1204
- /**
1205
- *
1206
- * @type {AddImageToPersonRequestImage}
1207
- * @memberof ImageFields
1208
- */
1209
- 'image'?: AddImageToPersonRequestImage;
1210
- /**
1211
- *
1212
- * @type {OutputImageParams}
1213
- * @memberof ImageFields
1214
- */
809
+ 'image'?: ImageFieldsImage;
1215
810
  'outputImageParams'?: OutputImageParams;
1216
811
  /**
1217
812
  * 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
1220
813
  */
1221
814
  'detectAll'?: boolean;
1222
815
  /**
1223
816
  * The similarity threshold.
1224
- * @type {number}
1225
- * @memberof ImageFields
1226
817
  */
1227
818
  'threshold'?: number;
1228
819
  /**
1229
820
  * The maximum number of results to be returned.
1230
- * @type {number}
1231
- * @memberof ImageFields
1232
821
  */
1233
822
  'limit'?: number;
1234
823
  }
1235
824
 
1236
825
  /**
1237
- * @type ImagePage
1238
- * @export
826
+ * Uploaded image.
1239
827
  */
1240
- export declare type ImagePage = ImagePageAllOf & Page;
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
+ }
1241
843
 
1242
844
  /**
1243
- * Image page.
1244
- * @export
1245
- * @interface ImagePageAllOf
845
+ * @type ImagePage
1246
846
  */
1247
- export declare interface ImagePageAllOf {
1248
- /**
1249
- *
1250
- * @type {Array<Image>}
1251
- * @memberof ImagePageAllOf
1252
- */
847
+ export declare type ImagePage = ImagePageItems & Page;
848
+
849
+ export declare interface ImagePageItems {
1253
850
  'items'?: Array<Image_2>;
1254
851
  }
1255
852
 
1256
853
  /**
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}
854
+ * NOTE: This file is auto generated by OpenAPI Generator.
855
+ * Do not edit the file manually.
1260
856
  */
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];
857
+ /**
858
+ * Face photo image source types: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/image-source/
859
+ */
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
+ }
1272
869
 
1273
870
  export declare class Liveness20Api {
1274
871
  private superClass;
@@ -1277,156 +874,95 @@ export declare class Liveness20Api {
1277
874
  }
1278
875
 
1279
876
  /**
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}
877
+ * NOTE: This file is auto generated by OpenAPI Generator.
878
+ * Do not edit the file manually.
1283
879
  */
1284
- export declare const LivenessType: {
1285
- readonly ACTIVE: 0;
1286
- readonly PASSIVE: 1;
1287
- };
1288
-
1289
- export declare type LivenessType = typeof LivenessType[keyof typeof LivenessType];
1290
-
1291
880
  /**
1292
- *
1293
- * @export
1294
- * @interface MatchAndSearchRequest
881
+ * 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)
1295
882
  */
883
+ export declare enum LivenessType {
884
+ ACTIVE = 0,
885
+ PASSIVE = 1
886
+ }
887
+
1296
888
  export declare interface MatchAndSearchRequest {
1297
889
  /**
1298
890
  * Session identificator, should be unique for each session.
1299
- * @type {string}
1300
- * @memberof MatchAndSearchRequest
1301
891
  */
1302
892
  'tag'?: string;
1303
893
  /**
1304
894
  * An array of images to be processed. At least two images must be provided.
1305
- * @type {Array<MatchAndSearchRequestImagesInner>}
1306
- * @memberof MatchAndSearchRequest
1307
895
  */
1308
- 'images'?: Array<MatchAndSearchRequestImagesInner>;
896
+ 'images'?: Array<MatchAndSearchRequestImagesItem>;
1309
897
  /**
1310
898
  * IDs of the groups in which the search is performed.
1311
- * @type {Array<string>}
1312
- * @memberof MatchAndSearchRequest
1313
899
  */
1314
900
  'groupIds'?: Array<string>;
1315
901
  /**
1316
902
  * The similarity threshold.
1317
- * @type {number}
1318
- * @memberof MatchAndSearchRequest
1319
903
  */
1320
904
  'threshold'?: number;
1321
905
  /**
1322
906
  * The maximum number of results to be returned.
1323
- * @type {number}
1324
- * @memberof MatchAndSearchRequest
1325
907
  */
1326
908
  'limit'?: number;
1327
909
  /**
1328
910
  * A label used to group transactions by customers, applications, or other criteria.
1329
- * @type {string}
1330
- * @memberof MatchAndSearchRequest
1331
911
  */
1332
912
  'tenant'?: string;
1333
913
  /**
1334
914
  * A label used to differentiate transactions by development stages.
1335
- * @type {string}
1336
- * @memberof MatchAndSearchRequest
1337
915
  */
1338
916
  'env'?: string;
1339
917
  }
1340
918
 
1341
- /**
1342
- *
1343
- * @export
1344
- * @interface MatchAndSearchRequestImagesInner
1345
- */
1346
- export declare interface MatchAndSearchRequestImagesInner {
919
+ export declare interface MatchAndSearchRequestImagesItem {
1347
920
  /**
1348
- *
1349
- * @type {ImageData}
1350
- * @memberof MatchAndSearchRequestImagesInner
921
+ * Base64-encoded image.
1351
922
  */
1352
- 'content'?: ImageData_2;
923
+ 'content'?: string;
1353
924
  /**
1354
925
  * Image URL.
1355
- * @type {string}
1356
- * @memberof MatchAndSearchRequestImagesInner
1357
926
  */
1358
927
  'imageUrl'?: string;
1359
- /**
1360
- *
1361
- * @type {ImageSource}
1362
- * @memberof MatchAndSearchRequestImagesInner
1363
- */
1364
928
  'type'?: ImageSource;
1365
929
  }
1366
930
 
1367
931
  /**
1368
932
  * @type MatchAndSearchResponse
1369
- * @export
1370
933
  */
1371
- export declare type MatchAndSearchResponse = FaceSDKResult & MatchAndSearchResponseAllOf;
934
+ export declare type MatchAndSearchResponse = FaceSDKResult & MatchAndSearchResponseData;
1372
935
 
1373
- /**
1374
- *
1375
- * @export
1376
- * @interface MatchAndSearchResponseAllOf
1377
- */
1378
- export declare interface MatchAndSearchResponseAllOf {
936
+ export declare interface MatchAndSearchResponseData {
1379
937
  /**
1380
938
  * The match and search results.
1381
- * @type {Array<MatchImageResult>}
1382
- * @memberof MatchAndSearchResponseAllOf
1383
939
  */
1384
940
  'results'?: Array<MatchImageResult>;
1385
941
  /**
1386
942
  * Server processing time, ms. Does not include the time taken to receive the request or deliver the response.
1387
- * @type {number}
1388
- * @memberof MatchAndSearchResponseAllOf
1389
943
  */
1390
944
  'elapsedTime'?: number;
1391
945
  /**
1392
946
  * A free-form object containing person\'s extended attributes.
1393
- * @type {{ [key: string]: any; }}
1394
- * @memberof MatchAndSearchResponseAllOf
1395
947
  */
1396
948
  'metadata'?: {
1397
949
  [key: string]: any;
1398
950
  };
1399
951
  /**
1400
952
  * The detection results.
1401
- * @type {Array<MatchAndSearchResponseAllOfDetections>}
1402
- * @memberof MatchAndSearchResponseAllOf
1403
953
  */
1404
- 'detections'?: Array<MatchAndSearchResponseAllOfDetections>;
954
+ 'detections'?: Array<MatchAndSearchResponseDataDetectionsItem>;
1405
955
  }
1406
956
 
1407
- /**
1408
- *
1409
- * @export
1410
- * @interface MatchAndSearchResponseAllOfDetections
1411
- */
1412
- export declare interface MatchAndSearchResponseAllOfDetections {
957
+ export declare interface MatchAndSearchResponseDataDetectionsItem {
1413
958
  /**
1414
959
  * Detected faces.
1415
- * @type {Array<FacesResponse>}
1416
- * @memberof MatchAndSearchResponseAllOfDetections
1417
960
  */
1418
961
  'faces'?: Array<FacesResponse>;
1419
962
  /**
1420
963
  * 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
1423
964
  */
1424
965
  'imageIndex'?: number;
1425
- /**
1426
- *
1427
- * @type {FaceSDKResultCode}
1428
- * @memberof MatchAndSearchResponseAllOfDetections
1429
- */
1430
966
  'status'?: FaceSDKResultCode;
1431
967
  }
1432
968
 
@@ -1434,189 +970,99 @@ export declare class MatchApi {
1434
970
  private superClass;
1435
971
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
1436
972
  match(compareRequest: MatchRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<MatchResponse>;
1437
- detect(detectRequest: DetectRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<TDetectResponse>;
973
+ detect(detectRequest: DetectRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<DetectResponse>;
1438
974
  }
1439
975
 
1440
- /**
1441
- *
1442
- * @export
1443
- * @interface MatchImage
1444
- */
1445
976
  export declare interface MatchImage {
1446
977
  /**
1447
978
  * 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
1450
979
  */
1451
980
  'index'?: number;
1452
- /**
1453
- *
1454
- * @type {ImageSource}
1455
- * @memberof MatchImage
1456
- */
1457
981
  'type'?: ImageSource;
1458
982
  /**
1459
- *
1460
- * @type {ImageData}
1461
- * @memberof MatchImage
983
+ * Base64-encoded image.
1462
984
  */
1463
- 'data': ImageData_2;
985
+ 'data': string;
1464
986
  /**
1465
987
  * 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
1468
988
  */
1469
989
  'detectAll'?: boolean;
1470
990
  }
1471
991
 
1472
- /**
1473
- *
1474
- * @export
1475
- * @interface MatchImageDetection
1476
- */
1477
992
  export declare interface MatchImageDetection {
1478
993
  /**
1479
994
  * Detected faces.
1480
- * @type {Array<DetectionFace>}
1481
- * @memberof MatchImageDetection
1482
995
  */
1483
996
  'faces'?: Array<DetectionFace>;
1484
997
  /**
1485
998
  * 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
1488
999
  */
1489
1000
  'imageIndex': number;
1490
- /**
1491
- *
1492
- * @type {FaceSDKResultCode}
1493
- * @memberof MatchImageDetection
1494
- */
1495
1001
  'status': FaceSDKResultCode;
1496
1002
  }
1497
1003
 
1498
- /**
1499
- *
1500
- * @export
1501
- * @interface MatchImageResult
1502
- */
1503
1004
  export declare interface MatchImageResult {
1504
1005
  /**
1505
1006
  * 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
1508
1007
  */
1509
1008
  'firstIndex': number;
1510
1009
  /**
1511
1010
  * The detected face index number.
1512
- * @type {number}
1513
- * @memberof MatchImageResult
1514
1011
  */
1515
1012
  'firstFaceIndex'?: number;
1516
- /**
1517
- *
1518
- * @type {ImageSource}
1519
- * @memberof MatchImageResult
1520
- */
1521
1013
  'first'?: ImageSource;
1522
1014
  /**
1523
1015
  * 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
1526
1016
  */
1527
1017
  'secondIndex': number;
1528
1018
  /**
1529
1019
  * The detected face index number.
1530
- * @type {number}
1531
- * @memberof MatchImageResult
1532
1020
  */
1533
1021
  'secondFaceIndex'?: number;
1534
- /**
1535
- *
1536
- * @type {ImageSource}
1537
- * @memberof MatchImageResult
1538
- */
1539
1022
  'second'?: ImageSource;
1540
1023
  /**
1541
1024
  * A dimensionless number that shows how similar the compared faces are. 0—absolutely identical faces.
1542
- * @type {number}
1543
- * @memberof MatchImageResult
1544
1025
  */
1545
1026
  'score'?: number;
1546
1027
  /**
1547
1028
  * The detected faces similarity, %. 100%—absolutely identical faces, 0%—absolutely not identical.
1548
- * @type {number}
1549
- * @memberof MatchImageResult
1550
1029
  */
1551
1030
  'similarity'?: number;
1552
1031
  }
1553
1032
 
1554
1033
  /**
1555
- *
1556
- * @export
1557
- * @interface MatchRequest
1034
+ * @type MatchRequest
1558
1035
  */
1559
- export declare interface MatchRequest {
1036
+ export declare type MatchRequest = MatchRequestData & TransactionLabels;
1037
+
1038
+ export declare interface MatchRequestData {
1560
1039
  /**
1561
1040
  * Session identificator, should be unique for each session.
1562
- * @type {string}
1563
- * @memberof MatchRequest
1564
1041
  */
1565
1042
  'tag'?: string;
1566
1043
  /**
1567
1044
  * An array of images to be processed. At least two images must be provided.
1568
- * @type {Array<MatchImage>}
1569
- * @memberof MatchRequest
1570
1045
  */
1571
1046
  'images': Array<MatchImage>;
1572
- /**
1573
- *
1574
- * @type {OutputImageParams}
1575
- * @memberof MatchRequest
1576
- */
1577
1047
  '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;
1590
1048
  }
1591
1049
 
1592
1050
  /**
1593
1051
  * @type MatchResponse
1594
- * @export
1595
1052
  */
1596
- export declare type MatchResponse = FaceSDKResult & MatchResponseAllOf;
1053
+ export declare type MatchResponse = FaceSDKResult & MatchResponseData;
1597
1054
 
1598
- /**
1599
- *
1600
- * @export
1601
- * @interface MatchResponseAllOf
1602
- */
1603
- export declare interface MatchResponseAllOf {
1055
+ export declare interface MatchResponseData {
1604
1056
  /**
1605
1057
  * The detection results.
1606
- * @type {Array<MatchImageDetection>}
1607
- * @memberof MatchResponseAllOf
1608
1058
  */
1609
1059
  'detections'?: Array<MatchImageDetection>;
1610
1060
  /**
1611
1061
  * The comparison results.
1612
- * @type {Array<MatchImageResult>}
1613
- * @memberof MatchResponseAllOf
1614
1062
  */
1615
1063
  'results'?: Array<MatchImageResult>;
1616
1064
  /**
1617
1065
  * A free-form object containing person\'s extended attributes.
1618
- * @type {{ [key: string]: any; }}
1619
- * @memberof MatchResponseAllOf
1620
1066
  */
1621
1067
  'metadata'?: {
1622
1068
  [key: string]: any;
@@ -1624,44 +1070,24 @@ export declare interface MatchResponseAllOf {
1624
1070
  }
1625
1071
 
1626
1072
  /**
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
1073
+ * NOTE: This file is auto generated by OpenAPI Generator.
1074
+ * Do not edit the file manually.
1641
1075
  */
1642
1076
  export declare interface OperationLog {
1643
1077
  /**
1644
1078
  * Status code.
1645
- * @type {number}
1646
- * @memberof OperationLog
1647
1079
  */
1648
1080
  'statusCode'?: number;
1649
1081
  /**
1650
1082
  * Error type.
1651
- * @type {string}
1652
- * @memberof OperationLog
1653
1083
  */
1654
1084
  'type'?: string;
1655
1085
  /**
1656
1086
  * Error message.
1657
- * @type {string}
1658
- * @memberof OperationLog
1659
1087
  */
1660
1088
  'msg'?: string;
1661
1089
  /**
1662
1090
  * A free-form object containing group\'s extended attributes.
1663
- * @type {{ [key: string]: any; }}
1664
- * @memberof OperationLog
1665
1091
  */
1666
1092
  'metadata'?: {
1667
1093
  [key: string]: any;
@@ -1670,51 +1096,29 @@ export declare interface OperationLog {
1670
1096
 
1671
1097
  /**
1672
1098
  * Allows to process the uploaded image according to the indicated settings.
1673
- * @export
1674
- * @interface OutputImageParams
1675
1099
  */
1676
1100
  export declare interface OutputImageParams {
1677
1101
  /**
1678
1102
  * 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
1681
1103
  */
1682
1104
  'backgroundColor'?: Array<number>;
1683
- /**
1684
- *
1685
- * @type {Crop}
1686
- * @memberof OutputImageParams
1687
- */
1688
1105
  'crop'?: Crop;
1689
1106
  }
1690
1107
 
1691
1108
  /**
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.
1109
+ * NOTE: This file is auto generated by OpenAPI Generator.
1110
+ * Do not edit the file manually.
1701
1111
  */
1702
1112
  /**
1703
1113
  * Information about current page number and total pages count
1704
- * @export
1705
- * @interface Page
1706
1114
  */
1707
1115
  export declare interface Page {
1708
1116
  /**
1709
1117
  * Current page number.
1710
- * @type {number}
1711
- * @memberof Page
1712
1118
  */
1713
1119
  'page'?: number;
1714
1120
  /**
1715
1121
  * Total number of pages.
1716
- * @type {number}
1717
- * @memberof Page
1718
1122
  */
1719
1123
  'totalPages'?: number;
1720
1124
  }
@@ -1722,435 +1126,237 @@ export declare interface Page {
1722
1126
  /**
1723
1127
  * @type Person
1724
1128
  * Person response body: person ID, creation date, update date if any.
1725
- * @export
1726
1129
  */
1727
- export declare type Person = PersonAllOf & PersonFields;
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
+ }
1728
1145
 
1729
1146
  /**
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
1147
+ * NOTE: This file is auto generated by OpenAPI Generator.
1148
+ * Do not edit the file manually.
1744
1149
  */
1745
- export declare interface PersonAllOf {
1150
+ export declare interface PersonData {
1746
1151
  /**
1747
1152
  * Person ID. The list of persons is sorted by decreasing ID value.
1748
- * @type {string}
1749
- * @memberof PersonAllOf
1750
1153
  */
1751
1154
  'id'?: string;
1752
1155
  /**
1753
1156
  * Person creation date.
1754
- * @type {string}
1755
- * @memberof PersonAllOf
1756
1157
  */
1757
1158
  'createdAt'?: string;
1758
1159
  /**
1759
1160
  * Person update date.
1760
- * @type {string}
1761
- * @memberof PersonAllOf
1762
1161
  */
1763
1162
  '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>;
1784
1163
  }
1785
1164
 
1786
1165
  /**
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.
1166
+ * NOTE: This file is auto generated by OpenAPI Generator.
1167
+ * Do not edit the file manually.
1796
1168
  */
1797
1169
  /**
1798
1170
  * Person Request body: name and metadata.
1799
- * @export
1800
- * @interface PersonFields
1801
1171
  */
1802
1172
  export declare interface PersonFields {
1803
1173
  /**
1804
1174
  * Person\'s name.
1805
- * @type {string}
1806
- * @memberof PersonFields
1807
1175
  */
1808
1176
  'name': string;
1809
1177
  /**
1810
1178
  * 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
1813
1179
  */
1814
1180
  'externalId'?: string;
1815
1181
  /**
1816
1182
  * A free-form object containing person\'s extended attributes.
1817
- * @type {{ [key: string]: any; }}
1818
- * @memberof PersonFields
1819
1183
  */
1820
1184
  'metadata'?: {
1821
1185
  [key: string]: any;
1822
1186
  };
1823
1187
  /**
1824
1188
  * 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
1827
1189
  */
1828
1190
  'groups'?: Array<string>;
1829
1191
  /**
1830
1192
  * Person expiration date.
1831
- * @type {string}
1832
- * @memberof PersonFields
1833
1193
  */
1834
1194
  'expireAt'?: string;
1835
1195
  }
1836
1196
 
1197
+ export declare interface PersonItems {
1198
+ 'items'?: Array<Person>;
1199
+ }
1200
+
1837
1201
  /**
1838
1202
  * @type PersonsPage
1839
- * @export
1840
1203
  */
1841
- export declare type PersonsPage = Page & PersonsPageAllOf;
1204
+ export declare type PersonsPage = Page & PersonItems;
1842
1205
 
1843
1206
  /**
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.
1207
+ * NOTE: This file is auto generated by OpenAPI Generator.
1208
+ * Do not edit the file manually.
1867
1209
  */
1868
1210
  /**
1869
1211
  * Person Request body: name and metadata.
1870
- * @export
1871
- * @interface PersonToUpdateFields
1872
1212
  */
1873
1213
  export declare interface PersonToUpdateFields {
1874
1214
  /**
1875
1215
  * 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
1878
1216
  */
1879
1217
  'externalId'?: string;
1880
1218
  /**
1881
1219
  * Person\'s name.
1882
- * @type {string}
1883
- * @memberof PersonToUpdateFields
1884
1220
  */
1885
1221
  'name'?: string;
1886
1222
  /**
1887
1223
  * A free-form object containing person\'s extended attributes.
1888
- * @type {{ [key: string]: any; }}
1889
- * @memberof PersonToUpdateFields
1890
1224
  */
1891
1225
  'metadata'?: {
1892
1226
  [key: string]: any;
1893
1227
  };
1894
1228
  /**
1895
1229
  * 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
1898
1230
  */
1899
1231
  'groups'?: Array<string>;
1900
1232
  }
1901
1233
 
1902
1234
  /**
1903
1235
  * @type PersonWithImages
1904
- * @export
1905
1236
  */
1906
- export declare type PersonWithImages = Person & PersonWithImagesAllOf;
1237
+ export declare type PersonWithImages = Person & PersonWithImagesData;
1907
1238
 
1908
- /**
1909
- *
1910
- * @export
1911
- * @interface PersonWithImagesAllOf
1912
- */
1913
- export declare interface PersonWithImagesAllOf {
1239
+ export declare interface PersonWithImagesData {
1914
1240
  /**
1915
1241
  * Detected Persons.
1916
- * @type {Array<RecognizeImage>}
1917
- * @memberof PersonWithImagesAllOf
1918
1242
  */
1919
1243
  'images'?: Array<RecognizeImage>;
1920
1244
  }
1921
1245
 
1922
1246
  /**
1923
1247
  * The processing parameters.
1924
- * @export
1925
- * @interface ProcessParam
1926
1248
  */
1927
1249
  export declare interface ProcessParam {
1928
- /**
1929
- *
1930
- * @type {FaceQualityScenarios}
1931
- * @memberof ProcessParam
1932
- */
1933
1250
  'scenario'?: FaceQualityScenarios;
1934
1251
  /**
1935
1252
  * 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
1938
1253
  */
1939
1254
  'onlyCentralFace'?: boolean;
1940
- /**
1941
- *
1942
- * @type {OutputImageParams}
1943
- * @memberof ProcessParam
1944
- */
1945
1255
  'outputImageParams'?: OutputImageParams;
1946
- /**
1947
- *
1948
- * @type {QualityRequest}
1949
- * @memberof ProcessParam
1950
- */
1951
1256
  'quality'?: QualityRequest;
1952
- /**
1953
- *
1954
- * @type {ProcessParamAttributes}
1955
- * @memberof ProcessParam
1956
- */
1957
1257
  'attributes'?: ProcessParamAttributes;
1958
1258
  }
1959
1259
 
1960
1260
  /**
1961
1261
  * 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
1964
1262
  */
1965
1263
  export declare interface ProcessParamAttributes {
1966
1264
  /**
1967
1265
  * The list of attributes for evaluation.
1968
- * @type {Array<AttributeConfig>}
1969
- * @memberof ProcessParamAttributes
1970
1266
  */
1971
1267
  'config'?: Array<AttributeConfig>;
1972
1268
  }
1973
1269
 
1974
1270
  /**
1975
1271
  * The configuration that defines the list of returned quality check characteristics.
1976
- * @export
1977
- * @interface QualityConfig
1978
1272
  */
1979
1273
  export declare interface QualityConfig {
1980
- /**
1981
- *
1982
- * @type {FaceQualityConfigName}
1983
- * @memberof QualityConfig
1984
- */
1985
1274
  'name'?: FaceQualityConfigName;
1986
1275
  /**
1987
1276
  * 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
1990
1277
  */
1991
1278
  'range'?: Array<number>;
1992
1279
  }
1993
1280
 
1994
- /**
1995
- *
1996
- * @export
1997
- * @interface QualityDetail
1998
- */
1999
1281
  export declare interface QualityDetail {
2000
- /**
2001
- *
2002
- * @type {FaceImageQualityGroups}
2003
- * @memberof QualityDetail
2004
- */
2005
1282
  'groupId'?: FaceImageQualityGroups;
2006
- /**
2007
- *
2008
- * @type {FaceQualityConfigName}
2009
- * @memberof QualityDetail
2010
- */
2011
1283
  'name'?: FaceQualityConfigName;
2012
1284
  /**
2013
1285
  * 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
2016
1286
  */
2017
1287
  'range'?: Array<number>;
2018
- /**
2019
- *
2020
- * @type {FaceImageQualityStatus}
2021
- * @memberof QualityDetail
2022
- */
2023
1288
  'status'?: FaceImageQualityStatus;
2024
1289
  /**
2025
1290
  * The result value for the characteristic, returned in set units.
2026
- * @type {number}
2027
- * @memberof QualityDetail
2028
1291
  */
2029
1292
  'value'?: number;
2030
1293
  }
2031
1294
 
2032
- /**
2033
- *
2034
- * @export
2035
- * @interface QualityDetailsGroups
2036
- */
2037
1295
  export declare interface QualityDetailsGroups {
2038
- /**
2039
- *
2040
- * @type {FaceImageQualityGroups}
2041
- * @memberof QualityDetailsGroups
2042
- */
2043
1296
  'groupId'?: FaceImageQualityGroups;
2044
- /**
2045
- *
2046
- * @type {FaceImageQualityGroupsStrings}
2047
- * @memberof QualityDetailsGroups
2048
- */
2049
1297
  'name'?: FaceImageQualityGroupsStrings;
2050
1298
  /**
2051
1299
  * The total number of characteristics in the group.
2052
- * @type {number}
2053
- * @memberof QualityDetailsGroups
2054
1300
  */
2055
1301
  'totalCount'?: number;
2056
1302
  /**
2057
1303
  * The number of compliant characteristics in the group.
2058
- * @type {number}
2059
- * @memberof QualityDetailsGroups
2060
1304
  */
2061
1305
  'compliantCount'?: number;
2062
1306
  }
2063
1307
 
2064
1308
  /**
2065
1309
  * 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
2068
1310
  */
2069
1311
  export declare interface QualityRequest {
2070
1312
  /**
2071
1313
  * 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
2074
1314
  */
2075
1315
  'backgroundMatchColor'?: Array<number>;
2076
1316
  /**
2077
1317
  * The list of quality check characteristics.
2078
- * @type {Array<QualityConfig>}
2079
- * @memberof QualityRequest
2080
1318
  */
2081
1319
  'config'?: Array<QualityConfig>;
2082
1320
  }
2083
1321
 
2084
1322
  /**
2085
1323
  * @type RecognizeImage
2086
- * @export
2087
1324
  */
2088
- export declare type RecognizeImage = Image_2 & RecognizeImageAllOf;
1325
+ export declare type RecognizeImage = Image_2 & RecognizeImageData;
2089
1326
 
2090
1327
  /**
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.
1328
+ * NOTE: This file is auto generated by OpenAPI Generator.
1329
+ * Do not edit the file manually.
2100
1330
  */
2101
- /**
2102
- *
2103
- * @export
2104
- * @interface RecognizeImageAllOf
2105
- */
2106
- export declare interface RecognizeImageAllOf {
1331
+ export declare interface RecognizeImageData {
2107
1332
  /**
2108
1333
  * Similarity score.
2109
- * @type {number}
2110
- * @memberof RecognizeImageAllOf
2111
1334
  */
2112
1335
  'similarity'?: number;
2113
1336
  /**
2114
1337
  * Similarity distance score: the lower the distance, the higher the face\'s similarity.
2115
- * @type {number}
2116
- * @memberof RecognizeImageAllOf
2117
1338
  */
2118
1339
  'distance'?: number;
2119
1340
  }
2120
1341
 
2121
1342
  /**
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.
1343
+ * NOTE: This file is auto generated by OpenAPI Generator.
1344
+ * Do not edit the file manually.
2131
1345
  */
2132
1346
  /**
2133
1347
  * Set to resize the original image.
2134
- * @export
2135
- * @interface ResizeOptions
2136
1348
  */
2137
1349
  export declare interface ResizeOptions {
2138
1350
  /**
2139
1351
  * Resized image width, px.
2140
- * @type {number}
2141
- * @memberof ResizeOptions
2142
1352
  */
2143
1353
  'width'?: number;
2144
1354
  /**
2145
1355
  * Resized image height, px.
2146
- * @type {number}
2147
- * @memberof ResizeOptions
2148
1356
  */
2149
1357
  'height'?: number;
2150
1358
  /**
2151
1359
  * Resized image quality, percent.
2152
- * @type {number}
2153
- * @memberof ResizeOptions
2154
1360
  */
2155
1361
  'quality'?: number;
2156
1362
  }
@@ -2162,456 +1368,200 @@ export declare class SearchApi {
2162
1368
  }
2163
1369
 
2164
1370
  /**
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
1371
+ * NOTE: This file is auto generated by OpenAPI Generator.
1372
+ * Do not edit the file manually.
2179
1373
  */
2180
1374
  export declare interface SearchBadParams {
2181
- /**
2182
- *
2183
- * @type {string}
2184
- * @memberof SearchBadParams
2185
- */
2186
1375
  'msg'?: string;
2187
- /**
2188
- *
2189
- * @type {number}
2190
- * @memberof SearchBadParams
2191
- */
2192
1376
  'statusCode'?: number;
2193
- /**
2194
- *
2195
- * @type {string}
2196
- * @memberof SearchBadParams
2197
- */
2198
1377
  'type'?: string;
2199
1378
  }
2200
1379
 
2201
1380
  /**
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.
1381
+ * NOTE: This file is auto generated by OpenAPI Generator.
1382
+ * Do not edit the file manually.
2211
1383
  */
2212
1384
  /**
2213
1385
  * The array of identified persons.
2214
- * @export
2215
- * @interface SearchDetection
2216
1386
  */
2217
1387
  export declare interface SearchDetection {
2218
1388
  /**
2219
1389
  * Internal.
2220
- * @type {number}
2221
- * @memberof SearchDetection
2222
1390
  */
2223
1391
  'code'?: number;
2224
1392
  /**
2225
1393
  * Base64 of the aligned and cropped portrait.
2226
- * @type {string}
2227
- * @memberof SearchDetection
2228
1394
  */
2229
1395
  'crop'?: string;
2230
1396
  /**
2231
1397
  * Internal.
2232
- * @type {number}
2233
- * @memberof SearchDetection
2234
1398
  */
2235
1399
  'detectorType'?: number;
2236
1400
  /**
2237
1401
  * Internal.
2238
- * @type {string}
2239
- * @memberof SearchDetection
2240
1402
  */
2241
1403
  'hash'?: string;
2242
1404
  /**
2243
1405
  * Internal.
2244
- * @type {number}
2245
- * @memberof SearchDetection
2246
1406
  */
2247
1407
  'idx'?: number;
2248
1408
  /**
2249
1409
  * Internal.
2250
- * @type {string}
2251
- * @memberof SearchDetection
2252
1410
  */
2253
1411
  'image'?: string;
2254
1412
  /**
2255
1413
  * 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
2258
1414
  */
2259
1415
  'landmarks'?: Array<Array<number>>;
2260
1416
  /**
2261
1417
  * Internal.
2262
- * @type {number}
2263
- * @memberof SearchDetection
2264
1418
  */
2265
1419
  'landmarksType'?: number;
2266
1420
  /**
2267
1421
  * Internal.
2268
- * @type {string}
2269
- * @memberof SearchDetection
2270
1422
  */
2271
1423
  'msg'?: string;
2272
1424
  /**
2273
1425
  * 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
2276
1426
  */
2277
1427
  'roi'?: Array<number>;
2278
- /**
2279
- *
2280
- * @type {string}
2281
- * @memberof SearchDetection
2282
- */
2283
1428
  'versionSDK'?: string;
2284
1429
  }
2285
1430
 
2286
1431
  /**
2287
1432
  * Request search data.
2288
- * @export
2289
- * @interface SearchParameters
2290
1433
  */
2291
1434
  export declare interface SearchParameters {
2292
- /**
2293
- *
2294
- * @type {SearchParametersCreatePerson}
2295
- * @memberof SearchParameters
2296
- */
2297
1435
  'createPerson'?: SearchParametersCreatePerson;
2298
1436
  /**
2299
1437
  * IDs of the groups in which the search is performed.
2300
- * @type {Array<string>}
2301
- * @memberof SearchParameters
2302
1438
  */
2303
1439
  'groupIds'?: Array<string>;
2304
- /**
2305
- *
2306
- * @type {FilterSearchRequest}
2307
- * @memberof SearchParameters
2308
- */
2309
1440
  'filter'?: FilterSearchRequest;
2310
1441
  }
2311
1442
 
2312
1443
  /**
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.
1444
+ * NOTE: This file is auto generated by OpenAPI Generator.
1445
+ * Do not edit the file manually.
2322
1446
  */
2323
1447
  /**
2324
1448
  * If a person is not found, a new person entry is created using the descriptor calculated while searching.
2325
- * @export
2326
- * @interface SearchParametersCreatePerson
2327
1449
  */
2328
1450
  export declare interface SearchParametersCreatePerson {
2329
1451
  /**
2330
1452
  * Person\'s name.
2331
- * @type {string}
2332
- * @memberof SearchParametersCreatePerson
2333
1453
  */
2334
1454
  'name'?: string;
2335
1455
  /**
2336
1456
  * A free-form object containing person\'s extended attributes.
2337
- * @type {{ [key: string]: any; }}
2338
- * @memberof SearchParametersCreatePerson
2339
1457
  */
2340
1458
  'metadata'?: {
2341
1459
  [key: string]: any;
2342
1460
  };
2343
1461
  /**
2344
1462
  * The lifespan of the Person\'s records, seconds. Optional.
2345
- * @type {number}
2346
- * @memberof SearchParametersCreatePerson
2347
1463
  */
2348
- 'ttl'?: number | null;
1464
+ 'ttl'?: number;
2349
1465
  }
2350
1466
 
2351
1467
  /**
2352
1468
  * @type SearchPerson
2353
- * @export
2354
1469
  */
2355
- export declare type SearchPerson = Person & SearchPersonAllOf;
1470
+ export declare type SearchPerson = Person & SearchPersonData;
2356
1471
 
2357
- /**
2358
- * Person data.
2359
- * @export
2360
- * @interface SearchPersonAllOf
2361
- */
2362
- export declare interface SearchPersonAllOf {
2363
- /**
2364
- *
2365
- * @type {SearchDetection}
2366
- * @memberof SearchPersonAllOf
2367
- */
1472
+ export declare interface SearchPersonData {
2368
1473
  'detection'?: SearchDetection;
2369
1474
  /**
2370
1475
  * Array of Person images.
2371
- * @type {Array<RecognizeImage>}
2372
- * @memberof SearchPersonAllOf
2373
1476
  */
2374
1477
  'images'?: Array<RecognizeImage>;
2375
1478
  }
2376
1479
 
2377
1480
  /**
2378
1481
  * @type SearchRequest
2379
- * @export
2380
1482
  */
2381
- export declare type SearchRequest = ImageFields & SearchParameters & SearchRequestAllOf;
1483
+ export declare type SearchRequest = ImageFields & SearchParameters & TransactionLabels;
2382
1484
 
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
- */
2419
1485
  export declare interface SearchResult {
2420
1486
  /**
2421
1487
  * Result code. It is returned only with response 200.
2422
- * @type {number}
2423
- * @memberof SearchResult
2424
1488
  */
2425
1489
  'code'?: number;
2426
1490
  /**
2427
1491
  * Array of Person images. It is returned only with response 200.
2428
- * @type {Array<SearchPerson>}
2429
- * @memberof SearchResult
2430
1492
  */
2431
1493
  'persons'?: Array<SearchPerson>;
2432
1494
  }
2433
1495
 
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
- */
2527
1496
  export declare interface TransactionInfo {
2528
1497
  /**
2529
1498
  * 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
2532
1499
  */
2533
1500
  'code'?: number;
2534
1501
  /**
2535
1502
  * Whether the liveness detection is confirmed `0` or not `1`.
2536
- * @type {number}
2537
- * @memberof TransactionInfo
2538
1503
  */
2539
1504
  'status'?: number;
2540
1505
  /**
2541
1506
  * Session identificator, should be unique for each session.
2542
- * @type {string}
2543
- * @memberof TransactionInfo
2544
1507
  */
2545
1508
  'tag'?: string;
2546
1509
  /**
2547
1510
  * Transaction ID, there can be several transactions within one session.
2548
- * @type {string}
2549
- * @memberof TransactionInfo
2550
1511
  */
2551
1512
  'transactionId'?: string;
2552
1513
  /**
2553
1514
  * 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
2556
1515
  */
2557
1516
  'video'?: string;
2558
1517
  /**
2559
1518
  * Approximate age with an accuracy of +/-3 years.
2560
- * @type {Array<{ [key: string]: any; }>}
2561
- * @memberof TransactionInfo
2562
1519
  */
2563
1520
  'age'?: Array<{
2564
1521
  [key: string]: any;
2565
1522
  }>;
2566
1523
  /**
2567
1524
  * 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
2570
1525
  */
2571
1526
  'portrait'?: string;
2572
1527
  /**
2573
1528
  * A free-form object containing person\'s extended attributes.
2574
- * @type {{ [key: string]: any; }}
2575
- * @memberof TransactionInfo
2576
1529
  */
2577
1530
  'metadata'?: {
2578
1531
  [key: string]: any;
2579
1532
  };
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 {
2580
1541
  /**
2581
- *
2582
- * @type {LivenessType}
2583
- * @memberof TransactionInfo
1542
+ * A label used to group transactions by customers, applications, or other criteria.
2584
1543
  */
2585
- 'type'?: LivenessType;
1544
+ 'tenant'?: string;
1545
+ /**
1546
+ * A label used to differentiate transactions by development stages.
1547
+ */
1548
+ 'env'?: string;
2586
1549
  }
2587
1550
 
2588
1551
  /**
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.
1552
+ * NOTE: This file is auto generated by OpenAPI Generator.
1553
+ * Do not edit the file manually.
2598
1554
  */
2599
1555
  /**
2600
1556
  * Update group.
2601
- * @export
2602
- * @interface UpdateGroup
2603
1557
  */
2604
1558
  export declare interface UpdateGroup {
2605
1559
  /**
2606
1560
  * Add items.
2607
- * @type {Array<string>}
2608
- * @memberof UpdateGroup
2609
1561
  */
2610
1562
  'addItems'?: Array<string>;
2611
1563
  /**
2612
1564
  * Remove items.
2613
- * @type {Array<string>}
2614
- * @memberof UpdateGroup
2615
1565
  */
2616
1566
  'removeItems'?: Array<string>;
2617
1567
  }