@regulaforensics/facesdk-webclient 7.4.2-nightly → 7.4.23

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 (5) hide show
  1. package/README.md +1 -1
  2. package/dist/main/index.cjs +1 -1
  3. package/dist/module/index.js +1 -1
  4. package/lib/index.d.ts +887 -472
  5. package/package.json +15 -14
package/lib/index.d.ts CHANGED
@@ -1,9 +1,9 @@
1
1
  import { AxiosRequestConfig, AxiosInstance } from "axios";
2
2
  /**
3
- * Regula FaceSDK Web API
4
- * Regula FaceSDK Web API # 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
3
+ * Regula Face SDK Web API
4
+ * <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
5
5
  *
6
- * The version of the OpenAPI document: 5.2.0
6
+ * The version of the OpenAPI document: 6.2.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -83,10 +83,10 @@ export class Configuration {
83
83
  isJsonMime(mime: string): boolean;
84
84
  }
85
85
  /**
86
- * Regula FaceSDK Web API
87
- * Regula FaceSDK Web API # 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
86
+ * Regula Face SDK Web API
87
+ * <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
88
88
  *
89
- * The version of the OpenAPI document: 5.2.0
89
+ * The version of the OpenAPI document: 6.2.0
90
90
  *
91
91
  *
92
92
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -94,54 +94,155 @@ export class Configuration {
94
94
  * Do not edit the class manually.
95
95
  */
96
96
  /**
97
- * The aspect ratio according to which face alignment is performed during face detection.
97
+ * Set to resize the original image.
98
98
  * @export
99
- * @enum {string}
99
+ * @interface ResizeOptions
100
100
  */
101
- export const FaceImageQualityAlignType: {
102
- readonly ALIGN_3x4: 0;
103
- readonly ALIGN_4x5: 1;
104
- readonly ALIGN_2x3: 2;
105
- readonly ALIGN_1x1: 3;
106
- readonly ALIGN_7x9: 4;
107
- };
108
- export type FaceImageQualityAlignType = (typeof FaceImageQualityAlignType)[keyof typeof FaceImageQualityAlignType];
101
+ export interface ResizeOptions {
102
+ /**
103
+ * Resized image width, px.
104
+ * @type {number}
105
+ * @memberof ResizeOptions
106
+ */
107
+ 'width'?: number;
108
+ /**
109
+ * Resized image height, px.
110
+ * @type {number}
111
+ * @memberof ResizeOptions
112
+ */
113
+ 'height'?: number;
114
+ /**
115
+ * Resized image quality, percent.
116
+ * @type {number}
117
+ * @memberof ResizeOptions
118
+ */
119
+ 'quality'?: number;
120
+ }
121
+ type Base64String = string;
122
+ type ImageData = Base64String | ArrayBuffer;
109
123
  /**
110
- * Whether to return the Base64 of an aligned and cropped portrait in the crop field.
124
+ * Uploaded image.
111
125
  * @export
112
- * @interface Crop
126
+ * @interface AddImageToPersonRequestImage
113
127
  */
114
- export interface Crop {
128
+ export interface AddImageToPersonRequestImage {
129
+ /**
130
+ * Original media type of the uploaded image.
131
+ * @type {string}
132
+ * @memberof AddImageToPersonRequestImage
133
+ */
134
+ 'contentType'?: string;
115
135
  /**
116
136
  *
117
- * @type {FaceImageQualityAlignType}
118
- * @memberof Crop
137
+ * @type {ImageData}
138
+ * @memberof AddImageToPersonRequestImage
119
139
  */
120
- 'type'?: FaceImageQualityAlignType;
140
+ 'content'?: ImageData;
121
141
  /**
122
- * The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
123
- * @type {Array<number>}
124
- * @memberof Crop
142
+ * Image URL.
143
+ * @type {string}
144
+ * @memberof AddImageToPersonRequestImage
125
145
  */
126
- 'padColor'?: Array<number>;
146
+ 'imageUrl'?: string;
127
147
  /**
128
- * The resize value in case type matches this value. If it doesn\'t, no resize is done.
129
- * @type {Array<number>}
130
- * @memberof Crop
148
+ *
149
+ * @type {ResizeOptions}
150
+ * @memberof AddImageToPersonRequestImage
131
151
  */
132
- 'size'?: Array<number>;
152
+ 'resizeOptions'?: ResizeOptions;
153
+ }
154
+ /**
155
+ * Image in the request data, includes image and contentType.
156
+ * @export
157
+ * @interface AddImageToPersonRequest
158
+ */
159
+ export interface AddImageToPersonRequest {
133
160
  /**
134
- * Whether to return the coordinates of the rectangle with the face in the original image prepared for the face crop.
135
- * @type {boolean}
136
- * @memberof Crop
161
+ * Session identificator.
162
+ * @type {string}
163
+ * @memberof AddImageToPersonRequest
137
164
  */
138
- 'returnOriginalRect'?: boolean;
165
+ 'tag'?: string;
166
+ /**
167
+ *
168
+ * @type {AddImageToPersonRequestImage}
169
+ * @memberof AddImageToPersonRequest
170
+ */
171
+ 'image': AddImageToPersonRequestImage;
172
+ /**
173
+ * The similarity threshold.
174
+ * @type {number}
175
+ * @memberof AddImageToPersonRequest
176
+ */
177
+ 'threshold'?: number;
178
+ /**
179
+ * The maximum number of results to be returned.
180
+ * @type {number}
181
+ * @memberof AddImageToPersonRequest
182
+ */
183
+ 'limit'?: number;
184
+ }
185
+ /**
186
+ * Regula Face SDK Web API
187
+ * <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
188
+ *
189
+ * The version of the OpenAPI document: 6.2.0
190
+ *
191
+ *
192
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
193
+ * https://openapi-generator.tech
194
+ * Do not edit the class manually.
195
+ */
196
+ /**
197
+ * Image in the response.
198
+ * @export
199
+ * @interface AddImageToPersonResponse
200
+ */
201
+ export interface AddImageToPersonResponse {
202
+ /**
203
+ * Response image ID. The list is sorted by decreasing ID value.
204
+ * @type {string}
205
+ * @memberof AddImageToPersonResponse
206
+ */
207
+ 'id'?: string;
208
+ /**
209
+ * Original media type of the returned image.
210
+ * @type {string}
211
+ * @memberof AddImageToPersonResponse
212
+ */
213
+ 'contentType'?: string;
214
+ /**
215
+ * Returned image creation date.
216
+ * @type {string}
217
+ * @memberof AddImageToPersonResponse
218
+ */
219
+ 'createdAt'?: string;
220
+ /**
221
+ * Returned image path.
222
+ * @type {string}
223
+ * @memberof AddImageToPersonResponse
224
+ */
225
+ 'path'?: string;
226
+ /**
227
+ * Returned image URL.
228
+ * @type {string}
229
+ * @memberof AddImageToPersonResponse
230
+ */
231
+ 'url'?: string;
232
+ /**
233
+ * A free-form object containing person\'s extended attributes.
234
+ * @type {{ [key: string]: object; }}
235
+ * @memberof AddImageToPersonResponse
236
+ */
237
+ 'metadata'?: {
238
+ [key: string]: object;
239
+ };
139
240
  }
140
241
  /**
141
- * Regula FaceSDK Web API
142
- * Regula FaceSDK Web API # 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
242
+ * Regula Face SDK Web API
243
+ * <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
143
244
  *
144
- * The version of the OpenAPI document: 5.2.0
245
+ * The version of the OpenAPI document: 6.2.0
145
246
  *
146
247
  *
147
248
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -149,7 +250,7 @@ export interface Crop {
149
250
  * Do not edit the class manually.
150
251
  */
151
252
  /**
152
- * Face attributes.
253
+ * The name of the attribute. For definitions, see the [FaceAttribute enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-attribute/).
153
254
  * @export
154
255
  * @enum {string}
155
256
  */
@@ -170,42 +271,78 @@ export const FaceAttribute: {
170
271
  };
171
272
  export type FaceAttribute = (typeof FaceAttribute)[keyof typeof FaceAttribute];
172
273
  /**
173
- * The configuration that defines the list of returned quality check characteristics.
274
+ * The configuration that defines the list of returned attribute check characteristics.
174
275
  * @export
175
- * @interface QualityConfig
276
+ * @interface AttributeConfig
176
277
  */
177
- export interface QualityConfig {
278
+ export interface AttributeConfig {
178
279
  /**
179
280
  *
180
281
  * @type {FaceAttribute}
181
- * @memberof QualityConfig
282
+ * @memberof AttributeConfig
182
283
  */
183
284
  'name'?: FaceAttribute;
184
- /**
185
- * The range of applicable values for this characteristic. If the returned in the Response value fits this range, the value is identified as compliant with the requirements.
186
- * @type {Array<number>}
187
- * @memberof QualityConfig
188
- */
189
- 'range'?: Array<number>;
190
285
  }
191
286
  /**
192
- * Whether to evaluate attributes, such as age and emotions.
287
+ * Regula Face SDK Web API
288
+ * <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
289
+ *
290
+ * The version of the OpenAPI document: 6.2.0
291
+ *
292
+ *
293
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
294
+ * https://openapi-generator.tech
295
+ * Do not edit the class manually.
296
+ */
297
+ /**
298
+ * 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`.
193
299
  * @export
194
- * @interface DetectRequestAttributes
300
+ * @enum {string}
195
301
  */
196
- export interface DetectRequestAttributes {
302
+ export const FaceImageQualityAlignType: {
303
+ readonly ALIGN_3x4: 0;
304
+ readonly ALIGN_4x5: 1;
305
+ readonly ALIGN_2x3: 2;
306
+ readonly ALIGN_1x1: 3;
307
+ readonly ALIGN_7x9: 4;
308
+ };
309
+ export type FaceImageQualityAlignType = (typeof FaceImageQualityAlignType)[keyof typeof FaceImageQualityAlignType];
310
+ /**
311
+ * Whether to return a Base64-encoded image of an aligned and cropped portrait in the `crop` field. Alignment is performed according to `type`; if a head on the original image is tilted, for the returned portrait it is aligned in a straight vertical line. If there are more than one face in the photo, all the faces are detected and processed, and separate portraits for each face are returned. So, if there are five people in the photo, you\'ll get five processed portraits. Each portrait can be downloaded.
312
+ * @export
313
+ * @interface Crop
314
+ */
315
+ export interface Crop {
197
316
  /**
198
317
  *
199
- * @type {Array<QualityConfig>}
200
- * @memberof DetectRequestAttributes
318
+ * @type {FaceImageQualityAlignType}
319
+ * @memberof Crop
201
320
  */
202
- 'config'?: Array<QualityConfig>;
321
+ 'type'?: FaceImageQualityAlignType;
322
+ /**
323
+ * The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
324
+ * @type {Array<number>}
325
+ * @memberof Crop
326
+ */
327
+ 'padColor'?: Array<number>;
328
+ /**
329
+ * The resize value in case `type` matches this value. If it doesn\'t, no resize is performed.
330
+ * @type {Array<number>}
331
+ * @memberof Crop
332
+ */
333
+ 'size'?: Array<number>;
334
+ /**
335
+ * Whether to return the coordinates of the rectangle with the face in the original image prepared for the face crop.
336
+ * @type {boolean}
337
+ * @memberof Crop
338
+ */
339
+ 'returnOriginalRect'?: boolean;
203
340
  }
204
341
  /**
205
- * Regula FaceSDK Web API
206
- * Regula FaceSDK Web API # 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
342
+ * Regula Face SDK Web API
343
+ * <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
207
344
  *
208
- * The version of the OpenAPI document: 5.2.0
345
+ * The version of the OpenAPI document: 6.2.0
209
346
  *
210
347
  *
211
348
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -213,7 +350,7 @@ export interface DetectRequestAttributes {
213
350
  * Do not edit the class manually.
214
351
  */
215
352
  /**
216
- * Face detection scenario.
353
+ * Face detection scenario. If applied and the scenario is found, the parameters are set automatically and any other parameters mentioned in the request are ignored. If not set, left empty, or the name is not found, the processing is performed according to the set parameters. You can find detailed descriptions of available scenarios on the [Scenarios page](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/scenarios/).
217
354
  * @export
218
355
  * @enum {string}
219
356
  */
@@ -226,10 +363,11 @@ export const FaceQualityScenarios: {
226
363
  readonly CROP_CENTRAL_FACE: "CropCentralFace";
227
364
  readonly CROP_ALL_FACES: "CropAllFaces";
228
365
  readonly THUMBNAIL: "Thumbnail";
366
+ readonly EMPTY: "";
229
367
  };
230
368
  export type FaceQualityScenarios = (typeof FaceQualityScenarios)[keyof typeof FaceQualityScenarios];
231
369
  /**
232
- * Whether to process the uploaded image according to the indicated settings.
370
+ * Allows to process the uploaded image according to the indicated settings.
233
371
  * @export
234
372
  * @interface OutputImageParams
235
373
  */
@@ -248,7 +386,106 @@ export interface OutputImageParams {
248
386
  'crop'?: Crop;
249
387
  }
250
388
  /**
251
- * Whether to perform the portrait quality check.
389
+ * If set, the selected attributes, such as age or emotions, are evaluated.
390
+ * @export
391
+ * @interface ProcessParamAttributes
392
+ */
393
+ export interface ProcessParamAttributes {
394
+ /**
395
+ * The list of attributes for evaluation.
396
+ * @type {Array<AttributeConfig>}
397
+ * @memberof ProcessParamAttributes
398
+ */
399
+ 'config'?: Array<AttributeConfig>;
400
+ }
401
+ /**
402
+ * Regula Face SDK Web API
403
+ * <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
404
+ *
405
+ * The version of the OpenAPI document: 6.2.0
406
+ *
407
+ *
408
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
409
+ * https://openapi-generator.tech
410
+ * Do not edit the class manually.
411
+ */
412
+ /**
413
+ * The name of the quality check characteristic. For definitions, see the [FaceQualityConfigName enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-quality-config-name/).
414
+ * @export
415
+ * @enum {string}
416
+ */
417
+ export const FaceQualityConfigName: {
418
+ readonly IMAGE_WIDTH: "ImageWidth";
419
+ readonly IMAGE_HEIGHT: "ImageHeight";
420
+ readonly IMAGE_WIDTH_TO_HEIGHT: "ImageWidthToHeight";
421
+ readonly IMAGE_CHANNELS_NUMBER: "ImageChannelsNumber";
422
+ readonly PADDING_RATIO: "PaddingRatio";
423
+ readonly FACE_MID_POINT_HORIZONTAL_POSITION: "FaceMidPointHorizontalPosition";
424
+ readonly FACE_MID_POINT_VERTICAL_POSITION: "FaceMidPointVerticalPosition";
425
+ readonly HEAD_WIDTH_RATIO: "HeadWidthRatio";
426
+ readonly HEAD_HEIGHT_RATIO: "HeadHeightRatio";
427
+ readonly EYES_DISTANCE: "EyesDistance";
428
+ readonly YAW: "Yaw";
429
+ readonly PITCH: "Pitch";
430
+ readonly ROLL: "Roll";
431
+ readonly BLUR_LEVEL: "BlurLevel";
432
+ readonly NOISE_LEVEL: "NoiseLevel";
433
+ readonly EYE_RIGHT_CLOSED: "EyeRightClosed";
434
+ readonly EYE_LEFT_CLOSED: "EyeLeftClosed";
435
+ readonly EYE_RIGHT_OCCLUDED: "EyeRightOccluded";
436
+ readonly EYE_LEFT_OCCLUDED: "EyeLeftOccluded";
437
+ readonly EYES_RED: "EyesRed";
438
+ readonly EYE_RIGHT_COVERED_WITH_HAIR: "EyeRightCoveredWithHair";
439
+ readonly EYE_LEFT_COVERED_WITH_HAIR: "EyeLeftCoveredWithHair";
440
+ readonly OFF_GAZE: "OffGaze";
441
+ readonly FACE_DYNAMIC_RANGE: "FaceDynamicRange";
442
+ readonly UNNATURAL_SKIN_TONE: "UnnaturalSkinTone";
443
+ readonly TOO_DARK: "TooDark";
444
+ readonly TOO_LIGHT: "TooLight";
445
+ readonly FACE_GLARE: "FaceGlare";
446
+ readonly SHADOWS_ON_FACE: "ShadowsOnFace";
447
+ readonly DARK_GLASSES: "DarkGlasses";
448
+ readonly REFLECTION_ON_GLASSES: "ReflectionOnGlasses";
449
+ readonly FRAMES_TOO_HEAVY: "FramesTooHeavy";
450
+ readonly FACE_OCCLUDED: "FaceOccluded";
451
+ readonly HEAD_COVERING: "HeadCovering";
452
+ readonly BACKGROUND_UNIFORMITY: "BackgroundUniformity";
453
+ readonly SHADOWS_ON_BACKGROUND: "ShadowsOnBackground";
454
+ readonly OTHER_FACES: "OtherFaces";
455
+ readonly SHOULDERS_POSE: "ShouldersPose";
456
+ readonly EXPRESSION_LEVEL: "ExpressionLevel";
457
+ readonly MOUTH_OPEN: "MouthOpen";
458
+ readonly FOREHEAD_COVERING: "ForeheadCovering";
459
+ readonly SMILE: "Smile";
460
+ readonly STRONG_MAKEUP: "StrongMakeup";
461
+ readonly HEADPHONES: "Headphones";
462
+ readonly MEDICAL_MASK: "MedicalMask";
463
+ readonly BACKGROUND_COLOR_MATCH: "BackgroundColorMatch";
464
+ readonly ART_FACE: "ArtFace";
465
+ readonly CONTACT_LENSES: "ContactLenses";
466
+ };
467
+ export type FaceQualityConfigName = (typeof FaceQualityConfigName)[keyof typeof FaceQualityConfigName];
468
+ /**
469
+ * The configuration that defines the list of returned quality check characteristics.
470
+ * @export
471
+ * @interface QualityConfig
472
+ */
473
+ export interface QualityConfig {
474
+ /**
475
+ *
476
+ * @type {FaceQualityConfigName}
477
+ * @memberof QualityConfig
478
+ */
479
+ 'name'?: FaceQualityConfigName;
480
+ /**
481
+ * 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.
482
+ * @type {Array<number>}
483
+ * @memberof QualityConfig
484
+ */
485
+ 'range'?: Array<number>;
486
+ }
487
+ /**
488
+ * If set, the face image quality check is performed according to the set scenario or characteristics.
252
489
  * @export
253
490
  * @interface QualityRequest
254
491
  */
@@ -260,7 +497,7 @@ export interface QualityRequest {
260
497
  */
261
498
  'backgroundMatchColor'?: Array<number>;
262
499
  /**
263
- *
500
+ * The list of quality check characteristics.
264
501
  * @type {Array<QualityConfig>}
265
502
  * @memberof QualityRequest
266
503
  */
@@ -279,7 +516,7 @@ export interface ProcessParam {
279
516
  */
280
517
  'scenario'?: FaceQualityScenarios;
281
518
  /**
282
- * Whether to process only the central face on the image (true) or all the faces (false).
519
+ * Whether to process only the central face in the image. If set to `false`, all the faces are processed.
283
520
  * @type {boolean}
284
521
  * @memberof ProcessParam
285
522
  */
@@ -297,14 +534,12 @@ export interface ProcessParam {
297
534
  */
298
535
  'quality'?: QualityRequest;
299
536
  /**
300
- * Whether to evaluate attributes, such as age and emotions.
301
- * @type {boolean}
537
+ *
538
+ * @type {ProcessParamAttributes}
302
539
  * @memberof ProcessParam
303
540
  */
304
- 'attributes'?: boolean;
541
+ 'attributes'?: ProcessParamAttributes;
305
542
  }
306
- type Base64String = string;
307
- type ImageData = Base64String | ArrayBuffer;
308
543
  /**
309
544
  *
310
545
  * @export
@@ -312,7 +547,7 @@ type ImageData = Base64String | ArrayBuffer;
312
547
  */
313
548
  export interface DetectRequest {
314
549
  /**
315
- * Session identificator.
550
+ * Session identificator, should be unique for each session.
316
551
  * @type {string}
317
552
  * @memberof DetectRequest
318
553
  */
@@ -330,23 +565,18 @@ export interface DetectRequest {
330
565
  */
331
566
  'image'?: ImageData;
332
567
  /**
333
- * Whether to return the cropped portrains with the detected faces.
568
+ * Use `processParam.outputImageParams.crop` instead.
334
569
  * @type {boolean}
335
570
  * @memberof DetectRequest
571
+ * @deprecated
336
572
  */
337
573
  'thumbnails'?: boolean;
338
- /**
339
- *
340
- * @type {DetectRequestAttributes}
341
- * @memberof DetectRequest
342
- */
343
- 'attributes'?: DetectRequestAttributes;
344
574
  }
345
575
  /**
346
- * Regula FaceSDK Web API
347
- * Regula FaceSDK Web API # 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
576
+ * Regula Face SDK Web API
577
+ * <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
348
578
  *
349
- * The version of the OpenAPI document: 5.2.0
579
+ * The version of the OpenAPI document: 6.2.0
350
580
  *
351
581
  *
352
582
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -354,66 +584,31 @@ export interface DetectRequest {
354
584
  * Do not edit the class manually.
355
585
  */
356
586
  /**
357
- * All image characteristics that can be assessed during face image quality assessment.
587
+ *
358
588
  * @export
359
- * @enum {string}
589
+ * @interface DetectionAttributes
360
590
  */
361
- export const FaceQualityConfigName: {
362
- readonly IMAGE_WIDTH: "ImageWidth";
363
- readonly IMAGE_HEIGHT: "ImageHeight";
364
- readonly IMAGE_WIDTH_TO_HEIGHT: "ImageWidthToHeight";
365
- readonly IMAGE_CHANNELS_NUMBER: "ImageChannelsNumber";
366
- readonly PADDING_RATIO: "PaddingRatio";
367
- readonly FACE_MID_POINT_HORIZONTAL_POSITION: "FaceMidPointHorizontalPosition";
368
- readonly FACE_MID_POINT_VERTICAL_POSITION: "FaceMidPointVerticalPosition";
369
- readonly HEAD_WIDTH_RATIO: "HeadWidthRatio";
370
- readonly HEAD_HEIGHT_RATIO: "HeadHeightRatio";
371
- readonly EYES_DISTANCE: "EyesDistance";
372
- readonly YAW: "Yaw";
373
- readonly PITCH: "Pitch";
374
- readonly ROLL: "Roll";
375
- readonly BLUR_LEVEL: "BlurLevel";
376
- readonly NOISE_LEVEL: "NoiseLevel";
377
- readonly EYE_RIGHT_CLOSED: "EyeRightClosed";
378
- readonly EYE_LEFT_CLOSED: "EyeLeftClosed";
379
- readonly EYE_RIGHT_OCCLUDED: "EyeRightOccluded";
380
- readonly EYE_LEFT_OCCLUDED: "EyeLeftOccluded";
381
- readonly EYES_RED: "EyesRed";
382
- readonly EYE_RIGHT_COVERED_WITH_HAIR: "EyeRightCoveredWithHair";
383
- readonly EYE_LEFT_COVERED_WITH_HAIR: "EyeLeftCoveredWithHair";
384
- readonly OFF_GAZE: "OffGaze";
385
- readonly FACE_DYNAMIC_RANGE: "FaceDynamicRange";
386
- readonly UNNATURAL_SKIN_TONE: "UnnaturalSkinTone";
387
- readonly TOO_DARK: "TooDark";
388
- readonly TOO_LIGHT: "TooLight";
389
- readonly FACE_GLARE: "FaceGlare";
390
- readonly SHADOWS_ON_FACE: "ShadowsOnFace";
391
- readonly DARK_GLASSES: "DarkGlasses";
392
- readonly REFLECTION_ON_GLASSES: "ReflectionOnGlasses";
393
- readonly FRAMES_TOO_HEAVY: "FramesTooHeavy";
394
- readonly FACE_OCCLUDED: "FaceOccluded";
395
- readonly HEAD_COVERING: "HeadCovering";
396
- readonly BACKGROUND_UNIFORMITY: "BackgroundUniformity";
397
- readonly SHADOWS_ON_BACKGROUND: "ShadowsOnBackground";
398
- readonly OTHER_FACES: "OtherFaces";
399
- readonly SHOULDERS_POSE: "ShouldersPose";
400
- readonly EXPRESSION_LEVEL: "ExpressionLevel";
401
- readonly MOUTH_OPEN: "MouthOpen";
402
- readonly FOREHEAD_COVERING: "ForeheadCovering";
403
- readonly SMILE: "Smile";
404
- readonly STRONG_MAKEUP: "StrongMakeup";
405
- readonly HEADPHONES: "Headphones";
406
- readonly MEDICAL_MASK: "MedicalMask";
407
- readonly BACKGROUND_COLOR_MATCH: "BackgroundColorMatch";
408
- readonly ART_FACE: "ArtFace";
409
- readonly CONTACT_LENSES: "ContactLenses";
410
- };
411
- export type FaceQualityConfigName = (typeof FaceQualityConfigName)[keyof typeof FaceQualityConfigName];
591
+ export interface DetectionAttributes {
592
+ /**
593
+ *
594
+ * @type {Array<{ [key: string]: object; }>}
595
+ * @memberof DetectionAttributes
596
+ */
597
+ 'details'?: Array<{
598
+ [key: string]: object;
599
+ }>;
600
+ /**
601
+ * The elapsed time for attribute detection.
602
+ * @type {number}
603
+ * @memberof DetectionAttributes
604
+ */
605
+ 'elapsedTime'?: number;
606
+ }
412
607
  /**
413
- * Regula FaceSDK Web API
414
- * Regula FaceSDK Web API # 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
608
+ * Regula Face SDK Web API
609
+ * <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
415
610
  *
416
- * The version of the OpenAPI document: 5.2.0
611
+ * The version of the OpenAPI document: 6.2.0
417
612
  *
418
613
  *
419
614
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -437,10 +632,10 @@ export const FaceImageQualityGroups: {
437
632
  };
438
633
  export type FaceImageQualityGroups = (typeof FaceImageQualityGroups)[keyof typeof FaceImageQualityGroups];
439
634
  /**
440
- * Regula FaceSDK Web API
441
- * Regula FaceSDK Web API # 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
635
+ * Regula Face SDK Web API
636
+ * <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
442
637
  *
443
- * The version of the OpenAPI document: 5.2.0
638
+ * The version of the OpenAPI document: 6.2.0
444
639
  *
445
640
  *
446
641
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -496,10 +691,10 @@ export interface QualityDetail {
496
691
  'value'?: number;
497
692
  }
498
693
  /**
499
- * Regula FaceSDK Web API
500
- * Regula FaceSDK Web API # 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
694
+ * Regula Face SDK Web API
695
+ * <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
501
696
  *
502
- * The version of the OpenAPI document: 5.2.0
697
+ * The version of the OpenAPI document: 6.2.0
503
698
  *
504
699
  *
505
700
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -604,12 +799,10 @@ export interface Detection {
604
799
  'crop'?: ImageData;
605
800
  /**
606
801
  *
607
- * @type {{ [key: string]: object; }}
802
+ * @type {DetectionAttributes}
608
803
  * @memberof Detection
609
804
  */
610
- 'attributes'?: {
611
- [key: string]: object;
612
- };
805
+ 'attributes'?: DetectionAttributes;
613
806
  /**
614
807
  * Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
615
808
  * @type {Array<Array<number>>}
@@ -629,9 +822,10 @@ export interface Detection {
629
822
  */
630
823
  'roi': Array<number>;
631
824
  /**
632
- * Base64 of the cropped portrait.
825
+ * See `crop` instead.
633
826
  * @type {string}
634
827
  * @memberof Detection
828
+ * @deprecated
635
829
  */
636
830
  'thumbnail'?: string;
637
831
  }
@@ -686,10 +880,10 @@ export interface DetectResponseAllOf {
686
880
  'results'?: DetectResult;
687
881
  }
688
882
  /**
689
- * Regula FaceSDK Web API
690
- * Regula FaceSDK Web API # 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
883
+ * Regula Face SDK Web API
884
+ * <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
691
885
  *
692
- * The version of the OpenAPI document: 5.2.0
886
+ * The version of the OpenAPI document: 6.2.0
693
887
  *
694
888
  *
695
889
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -697,7 +891,7 @@ export interface DetectResponseAllOf {
697
891
  * Do not edit the class manually.
698
892
  */
699
893
  /**
700
- * The result code, see enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/
894
+ * The result code, see the [FaceSDKResultCode enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/).
701
895
  * @export
702
896
  * @enum {string}
703
897
  */
@@ -741,6 +935,8 @@ export const FaceSDKResultCode: {
741
935
  readonly FACER_TIMEOUT_LIVENESS_TRANSACTION: 250;
742
936
  readonly FACER_FAILED_LIVENESS_TRANSACTION: 251;
743
937
  readonly FACER_ABORTED_LIVENESS_TRANSACTION: 252;
938
+ readonly FACER_GENERAL_ERROR: 253;
939
+ readonly FACER_PASSIVE_LIVENESS_FAIL: 254;
744
940
  };
745
941
  export type FaceSDKResultCode = (typeof FaceSDKResultCode)[keyof typeof FaceSDKResultCode];
746
942
  /**
@@ -762,10 +958,10 @@ export interface FaceSDKResult {
762
958
  */
763
959
  export type DetectResponse = DetectResponseAllOf & FaceSDKResult;
764
960
  /**
765
- * Regula FaceSDK Web API
766
- * Regula FaceSDK Web API # 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
961
+ * Regula Face SDK Web API
962
+ * <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
767
963
  *
768
- * The version of the OpenAPI document: 5.2.0
964
+ * The version of the OpenAPI document: 6.2.0
769
965
  *
770
966
  *
771
967
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -803,17 +999,24 @@ export interface DetectionFace {
803
999
  */
804
1000
  'roi'?: Array<number>;
805
1001
  /**
806
- * Base64 of the cropped portrait.
1002
+ * See `crop` instead.
807
1003
  * @type {string}
808
1004
  * @memberof DetectionFace
1005
+ * @deprecated
809
1006
  */
810
1007
  'thumbnail'?: string;
1008
+ /**
1009
+ * Base64-encoded aligned and cropped portrait.
1010
+ * @type {string}
1011
+ * @memberof DetectionFace
1012
+ */
1013
+ 'crop'?: string;
811
1014
  }
812
1015
  /**
813
- * Regula FaceSDK Web API
814
- * Regula FaceSDK Web API # 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
1016
+ * Regula Face SDK Web API
1017
+ * <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
815
1018
  *
816
- * The version of the OpenAPI document: 5.2.0
1019
+ * The version of the OpenAPI document: 6.2.0
817
1020
  *
818
1021
  *
819
1022
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -852,10 +1055,10 @@ export interface PersonAllOf {
852
1055
  'groups'?: Array<string>;
853
1056
  }
854
1057
  /**
855
- * Regula FaceSDK Web API
856
- * Regula FaceSDK Web API # 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
1058
+ * Regula Face SDK Web API
1059
+ * <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
857
1060
  *
858
- * The version of the OpenAPI document: 5.2.0
1061
+ * The version of the OpenAPI document: 6.2.0
859
1062
  *
860
1063
  *
861
1064
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -869,17 +1072,17 @@ export interface PersonAllOf {
869
1072
  */
870
1073
  export interface PersonFields {
871
1074
  /**
872
- * Session identificator.
1075
+ * Person\'s name.
873
1076
  * @type {string}
874
1077
  * @memberof PersonFields
875
1078
  */
876
- 'tag'?: string;
1079
+ 'name': string;
877
1080
  /**
878
- * Person name.
1081
+ * 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.
879
1082
  * @type {string}
880
1083
  * @memberof PersonFields
881
1084
  */
882
- 'name'?: string;
1085
+ 'externalId'?: string;
883
1086
  /**
884
1087
  * A free-form object containing person\'s extended attributes.
885
1088
  * @type {{ [key: string]: object; }}
@@ -894,6 +1097,12 @@ export interface PersonFields {
894
1097
  * @memberof PersonFields
895
1098
  */
896
1099
  'groups'?: Array<string>;
1100
+ /**
1101
+ * The lifespan of the Person\'s records, seconds. Optional.
1102
+ * @type {number}
1103
+ * @memberof PersonFields
1104
+ */
1105
+ 'ttl'?: number | null;
897
1106
  }
898
1107
  /**
899
1108
  * @type Person
@@ -902,10 +1111,10 @@ export interface PersonFields {
902
1111
  */
903
1112
  export type Person = PersonAllOf & PersonFields;
904
1113
  /**
905
- * Regula FaceSDK Web API
906
- * Regula FaceSDK Web API # 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
1114
+ * Regula Face SDK Web API
1115
+ * <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
907
1116
  *
908
- * The version of the OpenAPI document: 5.2.0
1117
+ * The version of the OpenAPI document: 6.2.0
909
1118
  *
910
1119
  *
911
1120
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -964,10 +1173,10 @@ export interface Image {
964
1173
  };
965
1174
  }
966
1175
  /**
967
- * Regula FaceSDK Web API
968
- * Regula FaceSDK Web API # 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
1176
+ * Regula Face SDK Web API
1177
+ * <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
969
1178
  *
970
- * The version of the OpenAPI document: 5.2.0
1179
+ * The version of the OpenAPI document: 6.2.0
971
1180
  *
972
1181
  *
973
1182
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1005,7 +1214,7 @@ export type RecognizeImage = Image & RecognizeImageAllOf;
1005
1214
  */
1006
1215
  export interface PersonWithImagesAllOf {
1007
1216
  /**
1008
- *
1217
+ * Detected Persons.
1009
1218
  * @type {Array<RecognizeImage>}
1010
1219
  * @memberof PersonWithImagesAllOf
1011
1220
  */
@@ -1017,34 +1226,80 @@ export interface PersonWithImagesAllOf {
1017
1226
  */
1018
1227
  export type PersonWithImages = Person & PersonWithImagesAllOf;
1019
1228
  /**
1020
- *
1229
+ *
1230
+ * @export
1231
+ * @interface FacesResponseAllOf
1232
+ */
1233
+ export interface FacesResponseAllOf {
1234
+ /**
1235
+ * Detected Persons.
1236
+ * @type {Array<PersonWithImages>}
1237
+ * @memberof FacesResponseAllOf
1238
+ */
1239
+ 'persons'?: Array<PersonWithImages>;
1240
+ /**
1241
+ *
1242
+ * @type {number}
1243
+ * @memberof FacesResponseAllOf
1244
+ */
1245
+ 'rotationAngle'?: number;
1246
+ }
1247
+ /**
1248
+ * @type FacesResponse
1249
+ * @export
1250
+ */
1251
+ export type FacesResponse = DetectionFace & FacesResponseAllOf;
1252
+ /**
1253
+ * Regula Face SDK Web API
1254
+ * <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
1255
+ *
1256
+ * The version of the OpenAPI document: 6.2.0
1257
+ *
1258
+ *
1259
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1260
+ * https://openapi-generator.tech
1261
+ * Do not edit the class manually.
1262
+ */
1263
+ /**
1264
+ * 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.
1265
+ * @export
1266
+ * @enum {string}
1267
+ */
1268
+ export const FilterOp: {
1269
+ readonly IN: "in";
1270
+ readonly NOT_IN: "nin";
1271
+ };
1272
+ export type FilterOp = (typeof FilterOp)[keyof typeof FilterOp];
1273
+ /**
1274
+ * 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.
1021
1275
  * @export
1022
- * @interface FacesResponseAllOf
1276
+ * @interface FilterSearchRequest
1023
1277
  */
1024
- export interface FacesResponseAllOf {
1278
+ export interface FilterSearchRequest {
1025
1279
  /**
1026
1280
  *
1027
- * @type {Array<PersonWithImages>}
1028
- * @memberof FacesResponseAllOf
1281
+ * @type {FilterOp}
1282
+ * @memberof FilterSearchRequest
1029
1283
  */
1030
- 'persons'?: Array<PersonWithImages>;
1284
+ 'op'?: FilterOp;
1031
1285
  /**
1032
- *
1033
- * @type {number}
1034
- * @memberof FacesResponseAllOf
1286
+ * `name` of the Person.
1287
+ * @type {string}
1288
+ * @memberof FilterSearchRequest
1035
1289
  */
1036
- 'rotationAngle'?: number;
1290
+ 'field'?: string;
1291
+ /**
1292
+ * The list of `name` values against which the `field` is compared.
1293
+ * @type {Array<string>}
1294
+ * @memberof FilterSearchRequest
1295
+ */
1296
+ 'value'?: Array<string>;
1037
1297
  }
1038
1298
  /**
1039
- * @type FacesResponse
1040
- * @export
1041
- */
1042
- export type FacesResponse = DetectionFace & FacesResponseAllOf;
1043
- /**
1044
- * Regula FaceSDK Web API
1045
- * Regula FaceSDK Web API # 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
1299
+ * Regula Face SDK Web API
1300
+ * <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
1046
1301
  *
1047
- * The version of the OpenAPI document: 5.2.0
1302
+ * The version of the OpenAPI document: 6.2.0
1048
1303
  *
1049
1304
  *
1050
1305
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1071,10 +1326,10 @@ export interface GroupAllOf {
1071
1326
  'createdAt'?: string;
1072
1327
  }
1073
1328
  /**
1074
- * Regula FaceSDK Web API
1075
- * Regula FaceSDK Web API # 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
1329
+ * Regula Face SDK Web API
1330
+ * <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
1331
  *
1077
- * The version of the OpenAPI document: 5.2.0
1332
+ * The version of the OpenAPI document: 6.2.0
1078
1333
  *
1079
1334
  *
1080
1335
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1082,27 +1337,21 @@ export interface GroupAllOf {
1082
1337
  * Do not edit the class manually.
1083
1338
  */
1084
1339
  /**
1085
- * Request body of the group to create data, includes name and metadata.
1340
+ * Response group create data, includes name and metadata.
1086
1341
  * @export
1087
- * @interface GroupToCreate
1342
+ * @interface GroupResponse
1088
1343
  */
1089
- export interface GroupToCreate {
1090
- /**
1091
- * Session identificator.
1092
- * @type {string}
1093
- * @memberof GroupToCreate
1094
- */
1095
- 'tag'?: string;
1344
+ export interface GroupResponse {
1096
1345
  /**
1097
1346
  * Group to create name.
1098
1347
  * @type {string}
1099
- * @memberof GroupToCreate
1348
+ * @memberof GroupResponse
1100
1349
  */
1101
1350
  'name'?: string;
1102
1351
  /**
1103
1352
  * A free-form object containing group\'s extended attributes.
1104
1353
  * @type {{ [key: string]: object; }}
1105
- * @memberof GroupToCreate
1354
+ * @memberof GroupResponse
1106
1355
  */
1107
1356
  'metadata'?: {
1108
1357
  [key: string]: object;
@@ -1112,7 +1361,7 @@ export interface GroupToCreate {
1112
1361
  * @type Group
1113
1362
  * @export
1114
1363
  */
1115
- export type Group = GroupAllOf & GroupToCreate;
1364
+ export type Group = GroupAllOf & GroupResponse;
1116
1365
  /**
1117
1366
  *
1118
1367
  * @export
@@ -1127,10 +1376,10 @@ export interface GroupPageAllOf {
1127
1376
  'items'?: Array<Group>;
1128
1377
  }
1129
1378
  /**
1130
- * Regula FaceSDK Web API
1131
- * Regula FaceSDK Web API # 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
1379
+ * Regula Face SDK Web API
1380
+ * <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
1132
1381
  *
1133
- * The version of the OpenAPI document: 5.2.0
1382
+ * The version of the OpenAPI document: 6.2.0
1134
1383
  *
1135
1384
  *
1136
1385
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1162,10 +1411,10 @@ export interface Page {
1162
1411
  */
1163
1412
  export type GroupPage = GroupPageAllOf & Page;
1164
1413
  /**
1165
- * Regula FaceSDK Web API
1166
- * Regula FaceSDK Web API # 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
1414
+ * Regula Face SDK Web API
1415
+ * <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
1167
1416
  *
1168
- * The version of the OpenAPI document: 5.2.0
1417
+ * The version of the OpenAPI document: 6.2.0
1169
1418
  *
1170
1419
  *
1171
1420
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1173,60 +1422,31 @@ export type GroupPage = GroupPageAllOf & Page;
1173
1422
  * Do not edit the class manually.
1174
1423
  */
1175
1424
  /**
1176
- * Set to resize the original image.
1177
- * @export
1178
- * @interface ResizeOptions
1179
- */
1180
- export interface ResizeOptions {
1181
- /**
1182
- * Resized image width, px.
1183
- * @type {number}
1184
- * @memberof ResizeOptions
1185
- */
1186
- 'width'?: number;
1187
- /**
1188
- * Resized image height, px.
1189
- * @type {number}
1190
- * @memberof ResizeOptions
1191
- */
1192
- 'height'?: number;
1193
- /**
1194
- * Resized image quality, percent.
1195
- * @type {number}
1196
- * @memberof ResizeOptions
1197
- */
1198
- 'quality'?: number;
1199
- }
1200
- /**
1201
- * Uploaded image.
1425
+ * Request body of the group to create data, includes name and metadata.
1202
1426
  * @export
1203
- * @interface ImageFieldsImage
1427
+ * @interface GroupToCreate
1204
1428
  */
1205
- export interface ImageFieldsImage {
1429
+ export interface GroupToCreate {
1206
1430
  /**
1207
- * Original media type of the uploaded image.
1431
+ * Session identificator.
1208
1432
  * @type {string}
1209
- * @memberof ImageFieldsImage
1210
- */
1211
- 'contentType'?: string;
1212
- /**
1213
- *
1214
- * @type {ImageData}
1215
- * @memberof ImageFieldsImage
1433
+ * @memberof GroupToCreate
1216
1434
  */
1217
- 'content'?: ImageData;
1435
+ 'tag'?: string;
1218
1436
  /**
1219
- * Image URL.
1437
+ * Group to create name.
1220
1438
  * @type {string}
1221
- * @memberof ImageFieldsImage
1439
+ * @memberof GroupToCreate
1222
1440
  */
1223
- 'imageUrl'?: string;
1441
+ 'name': string;
1224
1442
  /**
1225
- *
1226
- * @type {ResizeOptions}
1227
- * @memberof ImageFieldsImage
1443
+ * A free-form object containing group\'s extended attributes.
1444
+ * @type {{ [key: string]: object; }}
1445
+ * @memberof GroupToCreate
1228
1446
  */
1229
- 'resizeOptions'?: ResizeOptions;
1447
+ 'metadata': {
1448
+ [key: string]: object;
1449
+ };
1230
1450
  }
1231
1451
  /**
1232
1452
  * Image in the request data, includes image and contentType.
@@ -1235,17 +1455,17 @@ export interface ImageFieldsImage {
1235
1455
  */
1236
1456
  export interface ImageFields {
1237
1457
  /**
1238
- * Session identificator.
1458
+ * Session identificator, should be unique for each session.
1239
1459
  * @type {string}
1240
1460
  * @memberof ImageFields
1241
1461
  */
1242
1462
  'tag'?: string;
1243
1463
  /**
1244
1464
  *
1245
- * @type {ImageFieldsImage}
1465
+ * @type {AddImageToPersonRequestImage}
1246
1466
  * @memberof ImageFields
1247
1467
  */
1248
- 'image'?: ImageFieldsImage;
1468
+ 'image'?: AddImageToPersonRequestImage;
1249
1469
  /**
1250
1470
  *
1251
1471
  * @type {OutputImageParams}
@@ -1253,7 +1473,7 @@ export interface ImageFields {
1253
1473
  */
1254
1474
  'outputImageParams'?: OutputImageParams;
1255
1475
  /**
1256
- * Whether to detect all faces in the image. If set to false, only the most central face is detected.
1476
+ * Whether to detect all faces in the image. If set to `false`, only the most central face is detected.
1257
1477
  * @type {boolean}
1258
1478
  * @memberof ImageFields
1259
1479
  */
@@ -1290,10 +1510,10 @@ export interface ImagePageAllOf {
1290
1510
  */
1291
1511
  export type ImagePage = ImagePageAllOf & Page;
1292
1512
  /**
1293
- * Regula FaceSDK Web API
1294
- * Regula FaceSDK Web API # 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
1513
+ * Regula Face SDK Web API
1514
+ * <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
1295
1515
  *
1296
- * The version of the OpenAPI document: 5.2.0
1516
+ * The version of the OpenAPI document: 6.2.0
1297
1517
  *
1298
1518
  *
1299
1519
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1301,7 +1521,7 @@ export type ImagePage = ImagePageAllOf & Page;
1301
1521
  * Do not edit the class manually.
1302
1522
  */
1303
1523
  /**
1304
- * The type of the image, defines the way the comparison is performed. See the enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/image-source/
1524
+ * 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/).
1305
1525
  * @export
1306
1526
  * @enum {string}
1307
1527
  */
@@ -1312,8 +1532,30 @@ export const ImageSource: {
1312
1532
  readonly DOCUMENT_WITH_LIVE: 4;
1313
1533
  readonly EXTERNAL: 5;
1314
1534
  readonly GHOST: 6;
1535
+ readonly BARCODE: 7;
1315
1536
  };
1316
1537
  export type ImageSource = (typeof ImageSource)[keyof typeof ImageSource];
1538
+ /**
1539
+ * Regula Face SDK Web API
1540
+ * <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
1541
+ *
1542
+ * The version of the OpenAPI document: 6.2.0
1543
+ *
1544
+ *
1545
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1546
+ * https://openapi-generator.tech
1547
+ * Do not edit the class manually.
1548
+ */
1549
+ /**
1550
+ * 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)
1551
+ * @export
1552
+ * @enum {string}
1553
+ */
1554
+ export const LivenessType: {
1555
+ readonly ACTIVE: 0;
1556
+ readonly PASSIVE: 1;
1557
+ };
1558
+ export type LivenessType = (typeof LivenessType)[keyof typeof LivenessType];
1317
1559
  /**
1318
1560
  *
1319
1561
  * @export
@@ -1340,74 +1582,29 @@ export interface MatchAndSearchRequestAllOfImages {
1340
1582
  */
1341
1583
  export interface MatchAndSearchRequestAllOf {
1342
1584
  /**
1343
- * Session identificator.
1585
+ * Session identificator, should be unique for each session.
1344
1586
  * @type {string}
1345
1587
  * @memberof MatchAndSearchRequestAllOf
1346
1588
  */
1347
1589
  'tag'?: string;
1348
1590
  /**
1349
- * Array of Person images.
1591
+ * Person\'s images.
1350
1592
  * @type {Array<MatchAndSearchRequestAllOfImages>}
1351
1593
  * @memberof MatchAndSearchRequestAllOf
1352
1594
  */
1353
1595
  'images'?: Array<MatchAndSearchRequestAllOfImages>;
1354
- }
1355
- /**
1356
- * Regula FaceSDK Web API
1357
- * Regula FaceSDK Web API # 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
1358
- *
1359
- * The version of the OpenAPI document: 5.2.0
1360
- *
1361
- *
1362
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1363
- * https://openapi-generator.tech
1364
- * Do not edit the class manually.
1365
- */
1366
- /**
1367
- * If a person is not found, a new person entry is created using the descriptor calculated while searching.
1368
- * @export
1369
- * @interface SearchParametersCreatePerson
1370
- */
1371
- export interface SearchParametersCreatePerson {
1372
- /**
1373
- * Person\'s name.
1374
- * @type {string}
1375
- * @memberof SearchParametersCreatePerson
1376
- */
1377
- 'name'?: string;
1378
- /**
1379
- * A free-form object containing person\'s extended attributes.
1380
- * @type {{ [key: string]: object; }}
1381
- * @memberof SearchParametersCreatePerson
1382
- */
1383
- 'metadata'?: {
1384
- [key: string]: object;
1385
- };
1386
- }
1387
- /**
1388
- * Request search data.
1389
- * @export
1390
- * @interface SearchParameters
1391
- */
1392
- export interface SearchParameters {
1393
- /**
1394
- *
1395
- * @type {SearchParametersCreatePerson}
1396
- * @memberof SearchParameters
1397
- */
1398
- 'createPerson'?: SearchParametersCreatePerson;
1399
1596
  /**
1400
1597
  * IDs of the groups in which the search is performed.
1401
- * @type {Array<number>}
1402
- * @memberof SearchParameters
1598
+ * @type {Array<string>}
1599
+ * @memberof MatchAndSearchRequestAllOf
1403
1600
  */
1404
- 'groupIds'?: Array<number>;
1601
+ 'groupIds'?: Array<string>;
1405
1602
  }
1406
1603
  /**
1407
1604
  * @type MatchAndSearchRequest
1408
1605
  * @export
1409
1606
  */
1410
- export type MatchAndSearchRequest = MatchAndSearchRequestAllOf & SearchParameters;
1607
+ export type MatchAndSearchRequest = MatchAndSearchRequestAllOf;
1411
1608
  /**
1412
1609
  *
1413
1610
  * @export
@@ -1415,13 +1612,13 @@ export type MatchAndSearchRequest = MatchAndSearchRequestAllOf & SearchParameter
1415
1612
  */
1416
1613
  export interface MatchAndSearchResponseAllOfDetections {
1417
1614
  /**
1418
- *
1615
+ * Detected faces.
1419
1616
  * @type {Array<FacesResponse>}
1420
1617
  * @memberof MatchAndSearchResponseAllOfDetections
1421
1618
  */
1422
1619
  'faces'?: Array<FacesResponse>;
1423
1620
  /**
1424
- * 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.
1621
+ * 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.
1425
1622
  * @type {number}
1426
1623
  * @memberof MatchAndSearchResponseAllOfDetections
1427
1624
  */
@@ -1440,7 +1637,7 @@ export interface MatchAndSearchResponseAllOfDetections {
1440
1637
  */
1441
1638
  export interface MatchImageResult {
1442
1639
  /**
1443
- * 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.
1640
+ * 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.
1444
1641
  * @type {number}
1445
1642
  * @memberof MatchImageResult
1446
1643
  */
@@ -1458,7 +1655,7 @@ export interface MatchImageResult {
1458
1655
  */
1459
1656
  'first'?: ImageSource;
1460
1657
  /**
1461
- * 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.
1658
+ * 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.
1462
1659
  * @type {number}
1463
1660
  * @memberof MatchImageResult
1464
1661
  */
@@ -1495,13 +1692,13 @@ export interface MatchImageResult {
1495
1692
  */
1496
1693
  export interface MatchAndSearchResponseAllOf {
1497
1694
  /**
1498
- *
1695
+ * The match and search results.
1499
1696
  * @type {Array<MatchImageResult>}
1500
1697
  * @memberof MatchAndSearchResponseAllOf
1501
1698
  */
1502
1699
  'results'?: Array<MatchImageResult>;
1503
1700
  /**
1504
- *
1701
+ * Time the processing has taken, ms.
1505
1702
  * @type {number}
1506
1703
  * @memberof MatchAndSearchResponseAllOf
1507
1704
  */
@@ -1515,7 +1712,7 @@ export interface MatchAndSearchResponseAllOf {
1515
1712
  [key: string]: object;
1516
1713
  };
1517
1714
  /**
1518
- *
1715
+ * The detection results.
1519
1716
  * @type {Array<MatchAndSearchResponseAllOfDetections>}
1520
1717
  * @memberof MatchAndSearchResponseAllOf
1521
1718
  */
@@ -1533,7 +1730,7 @@ export type MatchAndSearchResponse = FaceSDKResult & MatchAndSearchResponseAllOf
1533
1730
  */
1534
1731
  export interface MatchImage {
1535
1732
  /**
1536
- * 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.
1733
+ * 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.
1537
1734
  * @type {number}
1538
1735
  * @memberof MatchImage
1539
1736
  */
@@ -1551,7 +1748,7 @@ export interface MatchImage {
1551
1748
  */
1552
1749
  'data': ImageData;
1553
1750
  /**
1554
- * Whether to detect all faces in the image. If set to false, only the most central face is detected.
1751
+ * Whether to detect all faces in the image. If set to `false`, only the most central face is detected.
1555
1752
  * @type {boolean}
1556
1753
  * @memberof MatchImage
1557
1754
  */
@@ -1564,13 +1761,13 @@ export interface MatchImage {
1564
1761
  */
1565
1762
  export interface MatchImageDetection {
1566
1763
  /**
1567
- * The array of detected faces.
1764
+ * Detected faces.
1568
1765
  * @type {Array<DetectionFace>}
1569
1766
  * @memberof MatchImageDetection
1570
1767
  */
1571
1768
  'faces'?: Array<DetectionFace>;
1572
1769
  /**
1573
- * 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.
1770
+ * 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.
1574
1771
  * @type {number}
1575
1772
  * @memberof MatchImageDetection
1576
1773
  */
@@ -1589,53 +1786,174 @@ export interface MatchImageDetection {
1589
1786
  */
1590
1787
  export interface MatchRequest {
1591
1788
  /**
1592
- * Session identificator.
1789
+ * Session identificator, should be unique for each session.
1593
1790
  * @type {string}
1594
1791
  * @memberof MatchRequest
1595
1792
  */
1596
- 'tag'?: string;
1793
+ 'tag'?: string;
1794
+ /**
1795
+ * Use `outputImageParams.crop` instead.
1796
+ * @type {any}
1797
+ * @memberof MatchRequest
1798
+ * @deprecated
1799
+ */
1800
+ 'thumbnails'?: any;
1801
+ /**
1802
+ * All images included in the comparison.
1803
+ * @type {Array<MatchImage>}
1804
+ * @memberof MatchRequest
1805
+ */
1806
+ 'images': Array<MatchImage>;
1807
+ /**
1808
+ *
1809
+ * @type {OutputImageParams}
1810
+ * @memberof MatchRequest
1811
+ */
1812
+ 'outputImageParams'?: OutputImageParams;
1813
+ }
1814
+ /**
1815
+ *
1816
+ * @export
1817
+ * @interface MatchResponseAllOf
1818
+ */
1819
+ export interface MatchResponseAllOf {
1820
+ /**
1821
+ * The detection results.
1822
+ * @type {Array<MatchImageDetection>}
1823
+ * @memberof MatchResponseAllOf
1824
+ */
1825
+ 'detections'?: Array<MatchImageDetection>;
1826
+ /**
1827
+ * The comparison results.
1828
+ * @type {Array<MatchImageResult>}
1829
+ * @memberof MatchResponseAllOf
1830
+ */
1831
+ 'results'?: Array<MatchImageResult>;
1832
+ /**
1833
+ * A free-form object containing person\'s extended attributes.
1834
+ * @type {{ [key: string]: object; }}
1835
+ * @memberof MatchResponseAllOf
1836
+ */
1837
+ 'metadata'?: {
1838
+ [key: string]: object;
1839
+ };
1840
+ }
1841
+ /**
1842
+ * @type MatchResponse
1843
+ * @export
1844
+ */
1845
+ export type MatchResponse = FaceSDKResult & MatchResponseAllOf;
1846
+ /**
1847
+ * Regula Face SDK Web API
1848
+ * <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
1849
+ *
1850
+ * The version of the OpenAPI document: 6.2.0
1851
+ *
1852
+ *
1853
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1854
+ * https://openapi-generator.tech
1855
+ * Do not edit the class manually.
1856
+ */
1857
+ /**
1858
+ *
1859
+ * @export
1860
+ * @interface OperationLog
1861
+ */
1862
+ export interface OperationLog {
1863
+ /**
1864
+ * Status code.
1865
+ * @type {number}
1866
+ * @memberof OperationLog
1867
+ */
1868
+ 'statusCode'?: number;
1869
+ /**
1870
+ * Error type.
1871
+ * @type {string}
1872
+ * @memberof OperationLog
1873
+ */
1874
+ 'type'?: string;
1875
+ /**
1876
+ * Error message.
1877
+ * @type {string}
1878
+ * @memberof OperationLog
1879
+ */
1880
+ 'msg'?: string;
1881
+ /**
1882
+ * A free-form object containing group\'s extended attributes.
1883
+ * @type {{ [key: string]: object; }}
1884
+ * @memberof OperationLog
1885
+ */
1886
+ 'metadata'?: {
1887
+ [key: string]: object;
1888
+ };
1889
+ }
1890
+ /**
1891
+ * Regula Face SDK Web API
1892
+ * <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
1893
+ *
1894
+ * The version of the OpenAPI document: 6.2.0
1895
+ *
1896
+ *
1897
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1898
+ * https://openapi-generator.tech
1899
+ * Do not edit the class manually.
1900
+ */
1901
+ /**
1902
+ * Person Request body: name and metadata.
1903
+ * @export
1904
+ * @interface PersonToUpdateFields
1905
+ */
1906
+ export interface PersonToUpdateFields {
1907
+ /**
1908
+ * 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.
1909
+ * @type {string}
1910
+ * @memberof PersonToUpdateFields
1911
+ */
1912
+ 'externalId'?: string;
1913
+ /**
1914
+ * Person\'s name.
1915
+ * @type {string}
1916
+ * @memberof PersonToUpdateFields
1917
+ */
1918
+ 'name'?: string;
1597
1919
  /**
1598
- * Whether to return thumbnails: Base64 cropped images that contain vertically aligned faces.
1599
- * @type {boolean}
1600
- * @memberof MatchRequest
1920
+ * A free-form object containing person\'s extended attributes.
1921
+ * @type {{ [key: string]: object; }}
1922
+ * @memberof PersonToUpdateFields
1601
1923
  */
1602
- 'thumbnails'?: boolean;
1924
+ 'metadata'?: {
1925
+ [key: string]: object;
1926
+ };
1603
1927
  /**
1604
- * The array of all images included in the comparison.
1605
- * @type {Array<MatchImage>}
1606
- * @memberof MatchRequest
1928
+ * 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.
1929
+ * @type {Array<string>}
1930
+ * @memberof PersonToUpdateFields
1607
1931
  */
1608
- 'images': Array<MatchImage>;
1932
+ 'groups'?: Array<string>;
1609
1933
  }
1610
1934
  /**
1611
1935
  *
1612
1936
  * @export
1613
- * @interface MatchResponseAllOf
1937
+ * @interface PersonsPageAllOf
1614
1938
  */
1615
- export interface MatchResponseAllOf {
1616
- /**
1617
- * The array of detected faces.
1618
- * @type {Array<MatchImageDetection>}
1619
- * @memberof MatchResponseAllOf
1620
- */
1621
- 'detections'?: Array<MatchImageDetection>;
1939
+ export interface PersonsPageAllOf {
1622
1940
  /**
1623
- * The array of matching results.
1624
- * @type {Array<MatchImageResult>}
1625
- * @memberof MatchResponseAllOf
1941
+ *
1942
+ * @type {Array<Person>}
1943
+ * @memberof PersonsPageAllOf
1626
1944
  */
1627
- 'results'?: Array<MatchImageResult>;
1945
+ 'items'?: Array<Person>;
1628
1946
  }
1629
1947
  /**
1630
- * @type MatchResponse
1948
+ * @type PersonsPage
1631
1949
  * @export
1632
1950
  */
1633
- export type MatchResponse = FaceSDKResult & MatchResponseAllOf;
1951
+ export type PersonsPage = Page & PersonsPageAllOf;
1634
1952
  /**
1635
- * Regula FaceSDK Web API
1636
- * Regula FaceSDK Web API # 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
1953
+ * Regula Face SDK Web API
1954
+ * <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
1637
1955
  *
1638
- * The version of the OpenAPI document: 5.2.0
1956
+ * The version of the OpenAPI document: 6.2.0
1639
1957
  *
1640
1958
  *
1641
1959
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1645,33 +1963,33 @@ export type MatchResponse = FaceSDKResult & MatchResponseAllOf;
1645
1963
  /**
1646
1964
  *
1647
1965
  * @export
1648
- * @interface OperationLog
1966
+ * @interface SearchBadParams
1649
1967
  */
1650
- export interface OperationLog {
1968
+ export interface SearchBadParams {
1651
1969
  /**
1652
- * Status code.
1970
+ *
1971
+ * @type {string}
1972
+ * @memberof SearchBadParams
1973
+ */
1974
+ 'msg'?: string;
1975
+ /**
1976
+ *
1653
1977
  * @type {number}
1654
- * @memberof OperationLog
1978
+ * @memberof SearchBadParams
1655
1979
  */
1656
1980
  'statusCode'?: number;
1657
1981
  /**
1658
- * Error type.
1982
+ *
1659
1983
  * @type {string}
1660
- * @memberof OperationLog
1984
+ * @memberof SearchBadParams
1661
1985
  */
1662
1986
  'type'?: string;
1663
- /**
1664
- * Error message.
1665
- * @type {string}
1666
- * @memberof OperationLog
1667
- */
1668
- 'msg'?: string;
1669
1987
  }
1670
1988
  /**
1671
- * Regula FaceSDK Web API
1672
- * Regula FaceSDK Web API # 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
1989
+ * Regula Face SDK Web API
1990
+ * <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
1673
1991
  *
1674
- * The version of the OpenAPI document: 5.2.0
1992
+ * The version of the OpenAPI document: 6.2.0
1675
1993
  *
1676
1994
  *
1677
1995
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1752,110 +2070,92 @@ export interface SearchDetection {
1752
2070
  'versionSDK'?: string;
1753
2071
  }
1754
2072
  /**
1755
- * Person data.
1756
- * @export
1757
- * @interface SearchPersonAllOf
1758
- */
1759
- export interface SearchPersonAllOf {
1760
- /**
1761
- *
1762
- * @type {SearchDetection}
1763
- * @memberof SearchPersonAllOf
1764
- */
1765
- 'detection'?: SearchDetection;
1766
- /**
1767
- * Array of Person images.
1768
- * @type {Array<RecognizeImage>}
1769
- * @memberof SearchPersonAllOf
1770
- */
1771
- 'images'?: Array<RecognizeImage>;
1772
- }
1773
- /**
1774
- * @type SearchPerson
1775
- * @export
2073
+ * Regula Face SDK Web API
2074
+ * <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
2075
+ *
2076
+ * The version of the OpenAPI document: 6.2.0
2077
+ *
2078
+ *
2079
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2080
+ * https://openapi-generator.tech
2081
+ * Do not edit the class manually.
1776
2082
  */
1777
- export type SearchPerson = Person & SearchPersonAllOf;
1778
2083
  /**
1779
- *
2084
+ * If a person is not found, a new person entry is created using the descriptor calculated while searching.
1780
2085
  * @export
1781
- * @interface PersonCreatedResponse
2086
+ * @interface SearchParametersCreatePerson
1782
2087
  */
1783
- export interface PersonCreatedResponse {
1784
- /**
1785
- * Result code.
1786
- * @type {number}
1787
- * @memberof PersonCreatedResponse
1788
- */
1789
- 'code'?: number;
2088
+ export interface SearchParametersCreatePerson {
1790
2089
  /**
1791
- * Array of Person images.
1792
- * @type {Array<SearchPerson>}
1793
- * @memberof PersonCreatedResponse
2090
+ * Person\'s name.
2091
+ * @type {string}
2092
+ * @memberof SearchParametersCreatePerson
1794
2093
  */
1795
- 'persons'?: Array<SearchPerson>;
2094
+ 'name'?: string;
1796
2095
  /**
1797
2096
  * A free-form object containing person\'s extended attributes.
1798
2097
  * @type {{ [key: string]: object; }}
1799
- * @memberof PersonCreatedResponse
2098
+ * @memberof SearchParametersCreatePerson
1800
2099
  */
1801
2100
  'metadata'?: {
1802
2101
  [key: string]: object;
1803
2102
  };
2103
+ /**
2104
+ * The lifespan of the Person\'s records, seconds. Optional.
2105
+ * @type {number}
2106
+ * @memberof SearchParametersCreatePerson
2107
+ */
2108
+ 'ttl'?: number | null;
1804
2109
  }
1805
2110
  /**
1806
- *
2111
+ * Request search data.
1807
2112
  * @export
1808
- * @interface PersonsPageAllOf
2113
+ * @interface SearchParameters
1809
2114
  */
1810
- export interface PersonsPageAllOf {
2115
+ export interface SearchParameters {
1811
2116
  /**
1812
2117
  *
1813
- * @type {Array<Person>}
1814
- * @memberof PersonsPageAllOf
2118
+ * @type {SearchParametersCreatePerson}
2119
+ * @memberof SearchParameters
1815
2120
  */
1816
- 'items'?: Array<Person>;
2121
+ 'createPerson'?: SearchParametersCreatePerson;
2122
+ /**
2123
+ * IDs of the groups in which the search is performed.
2124
+ * @type {Array<string>}
2125
+ * @memberof SearchParameters
2126
+ */
2127
+ 'groupIds'?: Array<string>;
2128
+ /**
2129
+ *
2130
+ * @type {FilterSearchRequest}
2131
+ * @memberof SearchParameters
2132
+ */
2133
+ 'filter'?: FilterSearchRequest;
1817
2134
  }
1818
2135
  /**
1819
- * @type PersonsPage
1820
- * @export
1821
- */
1822
- export type PersonsPage = Page & PersonsPageAllOf;
1823
- /**
1824
- * Regula FaceSDK Web API
1825
- * Regula FaceSDK Web API # 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
1826
- *
1827
- * The version of the OpenAPI document: 5.2.0
1828
- *
1829
- *
1830
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1831
- * https://openapi-generator.tech
1832
- * Do not edit the class manually.
1833
- */
1834
- /**
1835
- *
2136
+ * Person data.
1836
2137
  * @export
1837
- * @interface SearchBadParams
2138
+ * @interface SearchPersonAllOf
1838
2139
  */
1839
- export interface SearchBadParams {
1840
- /**
1841
- *
1842
- * @type {string}
1843
- * @memberof SearchBadParams
1844
- */
1845
- 'msg'?: string;
2140
+ export interface SearchPersonAllOf {
1846
2141
  /**
1847
2142
  *
1848
- * @type {number}
1849
- * @memberof SearchBadParams
2143
+ * @type {SearchDetection}
2144
+ * @memberof SearchPersonAllOf
1850
2145
  */
1851
- 'statusCode'?: number;
2146
+ 'detection'?: SearchDetection;
1852
2147
  /**
1853
- *
1854
- * @type {string}
1855
- * @memberof SearchBadParams
2148
+ * Array of Person images.
2149
+ * @type {Array<RecognizeImage>}
2150
+ * @memberof SearchPersonAllOf
1856
2151
  */
1857
- 'type'?: string;
2152
+ 'images'?: Array<RecognizeImage>;
1858
2153
  }
2154
+ /**
2155
+ * @type SearchPerson
2156
+ * @export
2157
+ */
2158
+ export type SearchPerson = Person & SearchPersonAllOf;
1859
2159
  /**
1860
2160
  * @type SearchRequest
1861
2161
  * @export
@@ -1868,29 +2168,56 @@ export type SearchRequest = ImageFields & SearchParameters;
1868
2168
  */
1869
2169
  export interface SearchResult {
1870
2170
  /**
1871
- * Search result code.
2171
+ * Result code. It is returned only with response 200.
1872
2172
  * @type {number}
1873
2173
  * @memberof SearchResult
1874
2174
  */
1875
2175
  'code'?: number;
1876
2176
  /**
1877
- * Person data.
2177
+ * Array of Person images. It is returned only with response 200.
1878
2178
  * @type {Array<SearchPerson>}
1879
2179
  * @memberof SearchResult
1880
2180
  */
1881
2181
  'persons'?: Array<SearchPerson>;
2182
+ /**
2183
+ * Person ID. The list of persons is sorted by decreasing ID value.
2184
+ * @type {string}
2185
+ * @memberof SearchResult
2186
+ */
2187
+ 'id'?: string | null;
2188
+ /**
2189
+ * Person creation date.
2190
+ * @type {string}
2191
+ * @memberof SearchResult
2192
+ */
2193
+ 'createdAt'?: string | null;
2194
+ /**
2195
+ * Person update date.
2196
+ * @type {string}
2197
+ * @memberof SearchResult
2198
+ */
2199
+ 'updatedAt'?: string | null;
2200
+ /**
2201
+ * List of groups this person belongs to.
2202
+ * @type {Array<string>}
2203
+ * @memberof SearchResult
2204
+ */
2205
+ 'groups'?: Array<string> | null;
2206
+ /**
2207
+ * Person\'s name.
2208
+ * @type {string}
2209
+ * @memberof SearchResult
2210
+ */
2211
+ 'name'?: string | null;
2212
+ /**
2213
+ * A free-form object containing person\'s extended attributes. Available when a person is being created
2214
+ * @type {{ [key: string]: object; }}
2215
+ * @memberof SearchResult
2216
+ */
2217
+ 'metadata'?: {
2218
+ [key: string]: object;
2219
+ };
1882
2220
  }
1883
- /**
1884
- * Regula FaceSDK Web API
1885
- * Regula FaceSDK Web API # 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
1886
- *
1887
- * The version of the OpenAPI document: 5.2.0
1888
- *
1889
- *
1890
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1891
- * https://openapi-generator.tech
1892
- * Do not edit the class manually.
1893
- */
1894
2221
  /**
1895
2222
  *
1896
2223
  * @export
@@ -1898,19 +2225,19 @@ export interface SearchResult {
1898
2225
  */
1899
2226
  export interface TransactionInfo {
1900
2227
  /**
1901
- * Result code, one of the FaceSDKResultCode enum values. See the enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/
2228
+ * Result code, see the [FaceSDKResultCode enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/).
1902
2229
  * @type {number}
1903
2230
  * @memberof TransactionInfo
1904
2231
  */
1905
2232
  'code'?: number;
1906
2233
  /**
1907
- * Whether the liveness detection is confirmed (0) or not (1).
2234
+ * Whether the liveness detection is confirmed `0` or not `1`.
1908
2235
  * @type {number}
1909
2236
  * @memberof TransactionInfo
1910
2237
  */
1911
2238
  'status'?: number;
1912
2239
  /**
1913
- * Session identificator.
2240
+ * Session identificator, should be unique for each session.
1914
2241
  * @type {string}
1915
2242
  * @memberof TransactionInfo
1916
2243
  */
@@ -1922,25 +2249,21 @@ export interface TransactionInfo {
1922
2249
  */
1923
2250
  'transactionId'?: string;
1924
2251
  /**
1925
- * Link to the session video.
2252
+ * Link to the session video, depends on the selected storage type. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/storage/)
1926
2253
  * @type {string}
1927
2254
  * @memberof TransactionInfo
1928
2255
  */
1929
2256
  'video'?: string;
1930
- /**
1931
- * List of base64 images
1932
- * @type {Array<string>}
1933
- * @memberof TransactionInfo
1934
- */
1935
- 'images'?: Array<string>;
1936
2257
  /**
1937
2258
  * Approximate age with an accuracy of +/-3 years.
1938
- * @type {number}
2259
+ * @type {Array<{ [key: string]: object; }>}
1939
2260
  * @memberof TransactionInfo
1940
2261
  */
1941
- 'estimatedAge'?: number;
2262
+ 'age'?: Array<{
2263
+ [key: string]: object;
2264
+ }>;
1942
2265
  /**
1943
- * Link to the portrait.
2266
+ * Link to the portrait, depends on the selected storage type. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/storage/)
1944
2267
  * @type {string}
1945
2268
  * @memberof TransactionInfo
1946
2269
  */
@@ -1953,12 +2276,18 @@ export interface TransactionInfo {
1953
2276
  'metadata'?: {
1954
2277
  [key: string]: object;
1955
2278
  };
2279
+ /**
2280
+ *
2281
+ * @type {LivenessType}
2282
+ * @memberof TransactionInfo
2283
+ */
2284
+ 'type'?: LivenessType;
1956
2285
  }
1957
2286
  /**
1958
- * Regula FaceSDK Web API
1959
- * Regula FaceSDK Web API # 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
2287
+ * Regula Face SDK Web API
2288
+ * <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
1960
2289
  *
1961
- * The version of the OpenAPI document: 5.2.0
2290
+ * The version of the OpenAPI document: 6.2.0
1962
2291
  *
1963
2292
  *
1964
2293
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1984,10 +2313,96 @@ export interface UpdateGroup {
1984
2313
  */
1985
2314
  'removeItems'?: Array<string>;
1986
2315
  }
2316
+ type TDetection = {
2317
+ /**
2318
+ *
2319
+ * @type {ImageData}
2320
+ * @memberof Detection
2321
+ */
2322
+ crop?: ImageData;
2323
+ /**
2324
+ *
2325
+ * @memberof Detection
2326
+ */
2327
+ attributes?: {
2328
+ /**
2329
+ *
2330
+ * @type {Array<{ name?: string; confidence?: number; value?: any; }>}
2331
+ */
2332
+ details?: {
2333
+ name?: string;
2334
+ confidence?: number;
2335
+ value?: any;
2336
+ }[];
2337
+ /**
2338
+ * The elapsed time for attribute detection.
2339
+ * @type {number}
2340
+ */
2341
+ elapsedTime?: number;
2342
+ };
2343
+ /**
2344
+ * Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
2345
+ * @type {Array<Array<number>>}
2346
+ * @memberof Detection
2347
+ */
2348
+ landmarks: Array<Array<number>>;
2349
+ /**
2350
+ *
2351
+ * @type {DetectionQuality}
2352
+ * @memberof Detection
2353
+ */
2354
+ quality?: DetectionQuality;
2355
+ /**
2356
+ * 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.
2357
+ * @type {Array<number>}
2358
+ * @memberof Detection
2359
+ */
2360
+ roi: Array<number>;
2361
+ /**
2362
+ * Base64 of the cropped portrait.
2363
+ * @type {string}
2364
+ * @memberof Detection
2365
+ */
2366
+ thumbnail?: string;
2367
+ };
2368
+ type TDetectResponse = {
2369
+ results?: {
2370
+ /**
2371
+ *
2372
+ * @type {Array<Detection>}
2373
+ * @memberof DetectResult
2374
+ */
2375
+ detections: Array<TDetection>;
2376
+ /**
2377
+ * Internal.
2378
+ * @type {number}
2379
+ * @memberof DetectResult
2380
+ */
2381
+ detectorType?: number;
2382
+ /**
2383
+ * Internal.
2384
+ * @type {number}
2385
+ * @memberof DetectResult
2386
+ */
2387
+ landmarksType?: number;
2388
+ /**
2389
+ *
2390
+ * @type {FaceQualityScenarios}
2391
+ * @memberof DetectResult
2392
+ */
2393
+ scenario?: FaceQualityScenarios;
2394
+ /**
2395
+ * The total time taken for the detection.
2396
+ * @type {number}
2397
+ * @memberof DetectResult
2398
+ */
2399
+ timer?: number;
2400
+ };
2401
+ } & FaceSDKResult;
1987
2402
  declare class MatchingApi {
1988
2403
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
1989
- match(compareRequest: MatchRequest, xRequestID: string, options?: AxiosRequestConfig): Promise<MatchResponse>;
1990
- detect(detectRequest: DetectRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<DetectResponse>;
2404
+ match(compareRequest: MatchRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<MatchResponse>;
2405
+ detect(detectRequest: DetectRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<TDetectResponse>;
1991
2406
  }
1992
2407
  declare class GroupApi {
1993
2408
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
@@ -2002,7 +2417,7 @@ declare class GroupApi {
2002
2417
  declare class PersonApi {
2003
2418
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
2004
2419
  createPerson(personFields: PersonFields, xRequestID?: string, options?: AxiosRequestConfig): Promise<Person>;
2005
- addImageToPerson(personId: string, imageFields: ImageFields, xRequestID?: string, options?: AxiosRequestConfig): Promise<Image>;
2420
+ addImageToPerson(personId: string, imageFields: AddImageToPersonRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<Image>;
2006
2421
  deleteImageOfPerson(imageId: string, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
2007
2422
  deletePerson(personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
2008
2423
  getAllGroupsByPersonId(page: number, size: number, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<GroupPage>;
@@ -2021,7 +2436,7 @@ declare class DiagnosticsApi {
2021
2436
  }
2022
2437
  declare class Liveness20Api {
2023
2438
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
2024
- getLivenessTransactionInfo(transactionId: number, options?: AxiosRequestConfig): Promise<TransactionInfo>;
2439
+ getLivenessTransactionInfo(transactionId: string, options?: AxiosRequestConfig): Promise<TransactionInfo>;
2025
2440
  }
2026
2441
  export class FaceSdk {
2027
2442
  protected basePath: string;