@regulaforensics/facesdk-webclient 7.2.314-nightly → 7.2.315-nightly
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +5 -5
- package/dist/index.d.ts +252 -152
- package/dist/index.js +1164 -1115
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -69,7 +69,7 @@ export declare interface AddImageToPersonRequestImage {
|
|
|
69
69
|
* Regula Face SDK Web API
|
|
70
70
|
* <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
|
|
71
71
|
*
|
|
72
|
-
* The version of the OpenAPI document:
|
|
72
|
+
* The version of the OpenAPI document: 7.1.0
|
|
73
73
|
*
|
|
74
74
|
*
|
|
75
75
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -114,11 +114,11 @@ export declare interface AddImageToPersonResponse {
|
|
|
114
114
|
'url'?: string;
|
|
115
115
|
/**
|
|
116
116
|
* A free-form object containing person\'s extended attributes.
|
|
117
|
-
* @type {{ [key: string]:
|
|
117
|
+
* @type {{ [key: string]: any; }}
|
|
118
118
|
* @memberof AddImageToPersonResponse
|
|
119
119
|
*/
|
|
120
120
|
'metadata'?: {
|
|
121
|
-
[key: string]:
|
|
121
|
+
[key: string]: any;
|
|
122
122
|
};
|
|
123
123
|
}
|
|
124
124
|
|
|
@@ -206,7 +206,7 @@ export declare class Configuration {
|
|
|
206
206
|
* Regula Face SDK Web API
|
|
207
207
|
* <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
|
|
208
208
|
*
|
|
209
|
-
* The version of the OpenAPI document:
|
|
209
|
+
* The version of the OpenAPI document: 7.1.0
|
|
210
210
|
*
|
|
211
211
|
*
|
|
212
212
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -224,7 +224,7 @@ export declare interface ConfigurationParameters {
|
|
|
224
224
|
}
|
|
225
225
|
|
|
226
226
|
/**
|
|
227
|
-
* Whether to return a Base64-encoded image of
|
|
227
|
+
* Whether to return a Base64-encoded image of each aligned and cropped portrait in the `crop` field. Faces are aligned to a straight vertical line based on the value in the `crop.type` field, correcting any tilt present in the original image. If the image contains multiple faces, the system will detect and process each face separately, returning individual portraits. For example, if there are five people in the photo, five processed portraits will be returned. Each portrait is available for download.
|
|
228
228
|
* @export
|
|
229
229
|
* @interface Crop
|
|
230
230
|
*/
|
|
@@ -247,12 +247,74 @@ export declare interface Crop {
|
|
|
247
247
|
* @memberof Crop
|
|
248
248
|
*/
|
|
249
249
|
'size'?: Array<number>;
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
/**
|
|
253
|
+
* Regula Face SDK Web API
|
|
254
|
+
* <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
|
|
255
|
+
*
|
|
256
|
+
* The version of the OpenAPI document: 7.1.0
|
|
257
|
+
*
|
|
258
|
+
*
|
|
259
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
260
|
+
* https://openapi-generator.tech
|
|
261
|
+
* Do not edit the class manually.
|
|
262
|
+
*/
|
|
263
|
+
/**
|
|
264
|
+
*
|
|
265
|
+
* @export
|
|
266
|
+
* @interface DetectAttributesDetails
|
|
267
|
+
*/
|
|
268
|
+
export declare interface DetectAttributesDetails {
|
|
250
269
|
/**
|
|
251
|
-
*
|
|
252
|
-
* @type {
|
|
253
|
-
* @memberof
|
|
270
|
+
* The name of the attribute.
|
|
271
|
+
* @type {string}
|
|
272
|
+
* @memberof DetectAttributesDetails
|
|
273
|
+
*/
|
|
274
|
+
'name'?: string;
|
|
275
|
+
/**
|
|
276
|
+
* The estimated value for the attribute, see the [Returned values column](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/attributes-detection/).
|
|
277
|
+
* @type {Array<number>}
|
|
278
|
+
* @memberof DetectAttributesDetails
|
|
279
|
+
*/
|
|
280
|
+
'value'?: Array<number>;
|
|
281
|
+
}
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* Regula Face SDK Web API
|
|
285
|
+
* <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
|
|
286
|
+
*
|
|
287
|
+
* The version of the OpenAPI document: 7.1.0
|
|
288
|
+
*
|
|
289
|
+
*
|
|
290
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
291
|
+
* https://openapi-generator.tech
|
|
292
|
+
* Do not edit the class manually.
|
|
293
|
+
*/
|
|
294
|
+
/**
|
|
295
|
+
*
|
|
296
|
+
* @export
|
|
297
|
+
* @interface DetectDetailsMeta
|
|
298
|
+
*/
|
|
299
|
+
export declare interface DetectDetailsMeta {
|
|
300
|
+
/**
|
|
301
|
+
* The confidence in the estimated value, `1.0` is for 100% confidence.
|
|
302
|
+
* @type {number}
|
|
303
|
+
* @memberof DetectDetailsMeta
|
|
304
|
+
*/
|
|
305
|
+
'confidence'?: number;
|
|
306
|
+
/**
|
|
307
|
+
* The estimated value for the attribute, see the [Returned values column](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/attributes-detection/).
|
|
308
|
+
* @type {string}
|
|
309
|
+
* @memberof DetectDetailsMeta
|
|
254
310
|
*/
|
|
255
|
-
'
|
|
311
|
+
'value'?: string;
|
|
312
|
+
/**
|
|
313
|
+
* The name of the attribute.
|
|
314
|
+
* @type {string}
|
|
315
|
+
* @memberof DetectDetailsMeta
|
|
316
|
+
*/
|
|
317
|
+
'name'?: string;
|
|
256
318
|
}
|
|
257
319
|
|
|
258
320
|
/**
|
|
@@ -274,7 +336,7 @@ export declare interface Detection {
|
|
|
274
336
|
*/
|
|
275
337
|
'attributes'?: DetectionAttributes;
|
|
276
338
|
/**
|
|
277
|
-
* Absolute coordinates (
|
|
339
|
+
* Absolute coordinates (X,Y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
|
|
278
340
|
* @type {Array<Array<number>>}
|
|
279
341
|
* @memberof Detection
|
|
280
342
|
*/
|
|
@@ -291,20 +353,33 @@ export declare interface Detection {
|
|
|
291
353
|
* @memberof Detection
|
|
292
354
|
*/
|
|
293
355
|
'roi': Array<number>;
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
/**
|
|
359
|
+
* The evaluated attributes, see the [Attributes List](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/attributes-detection/) for details.
|
|
360
|
+
* @export
|
|
361
|
+
* @interface DetectionAttributes
|
|
362
|
+
*/
|
|
363
|
+
export declare interface DetectionAttributes {
|
|
294
364
|
/**
|
|
295
|
-
*
|
|
296
|
-
* @type {
|
|
297
|
-
* @memberof
|
|
298
|
-
* @deprecated
|
|
365
|
+
* Attributes assessment details. Returns `DetectDetailsMeta` or `DetectAttributesDetails`.
|
|
366
|
+
* @type {Array<DetectionAttributesDetailsInner>}
|
|
367
|
+
* @memberof DetectionAttributes
|
|
299
368
|
*/
|
|
300
|
-
'
|
|
369
|
+
'details'?: Array<DetectionAttributesDetailsInner>;
|
|
370
|
+
/**
|
|
371
|
+
* Server processing time for attribute detection, ms.
|
|
372
|
+
* @type {number}
|
|
373
|
+
* @memberof DetectionAttributes
|
|
374
|
+
*/
|
|
375
|
+
'elapsedTime'?: number;
|
|
301
376
|
}
|
|
302
377
|
|
|
303
378
|
/**
|
|
304
379
|
* Regula Face SDK Web API
|
|
305
380
|
* <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
|
|
306
381
|
*
|
|
307
|
-
* The version of the OpenAPI document:
|
|
382
|
+
* The version of the OpenAPI document: 7.1.0
|
|
308
383
|
*
|
|
309
384
|
*
|
|
310
385
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -314,30 +389,34 @@ export declare interface Detection {
|
|
|
314
389
|
/**
|
|
315
390
|
*
|
|
316
391
|
* @export
|
|
317
|
-
* @interface
|
|
392
|
+
* @interface DetectionAttributesDetailsInner
|
|
318
393
|
*/
|
|
319
|
-
export declare interface
|
|
394
|
+
export declare interface DetectionAttributesDetailsInner {
|
|
320
395
|
/**
|
|
321
|
-
*
|
|
322
|
-
* @type {
|
|
323
|
-
* @memberof
|
|
396
|
+
* The name of the attribute.
|
|
397
|
+
* @type {string}
|
|
398
|
+
* @memberof DetectionAttributesDetailsInner
|
|
324
399
|
*/
|
|
325
|
-
'
|
|
326
|
-
[key: string]: object;
|
|
327
|
-
}>;
|
|
400
|
+
'name'?: string;
|
|
328
401
|
/**
|
|
329
|
-
* The
|
|
402
|
+
* The estimated value for the attribute, see the [Returned values column](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/attributes-detection/).
|
|
403
|
+
* @type {string}
|
|
404
|
+
* @memberof DetectionAttributesDetailsInner
|
|
405
|
+
*/
|
|
406
|
+
'value'?: string;
|
|
407
|
+
/**
|
|
408
|
+
* The confidence in the estimated value, `1.0` is for 100% confidence.
|
|
330
409
|
* @type {number}
|
|
331
|
-
* @memberof
|
|
410
|
+
* @memberof DetectionAttributesDetailsInner
|
|
332
411
|
*/
|
|
333
|
-
'
|
|
412
|
+
'confidence'?: number;
|
|
334
413
|
}
|
|
335
414
|
|
|
336
415
|
/**
|
|
337
416
|
* Regula Face SDK Web API
|
|
338
417
|
* <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
|
|
339
418
|
*
|
|
340
|
-
* The version of the OpenAPI document:
|
|
419
|
+
* The version of the OpenAPI document: 7.1.0
|
|
341
420
|
*
|
|
342
421
|
*
|
|
343
422
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -374,13 +453,6 @@ export declare interface DetectionFace {
|
|
|
374
453
|
* @memberof DetectionFace
|
|
375
454
|
*/
|
|
376
455
|
'roi'?: Array<number>;
|
|
377
|
-
/**
|
|
378
|
-
* See `crop` instead.
|
|
379
|
-
* @type {string}
|
|
380
|
-
* @memberof DetectionFace
|
|
381
|
-
* @deprecated
|
|
382
|
-
*/
|
|
383
|
-
'thumbnail'?: string;
|
|
384
456
|
/**
|
|
385
457
|
* Base64-encoded aligned and cropped portrait.
|
|
386
458
|
* @type {string}
|
|
@@ -390,41 +462,41 @@ export declare interface DetectionFace {
|
|
|
390
462
|
}
|
|
391
463
|
|
|
392
464
|
/**
|
|
393
|
-
*
|
|
465
|
+
* The portrait quality assessment results, see [Face Image Quality Characteristics](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/face-image-quality-check/). If not set in request, no quality check is performed.
|
|
394
466
|
* @export
|
|
395
467
|
* @interface DetectionQuality
|
|
396
468
|
*/
|
|
397
469
|
export declare interface DetectionQuality {
|
|
398
470
|
/**
|
|
399
|
-
*
|
|
471
|
+
* Non-compliant assessment characteristics.
|
|
400
472
|
* @type {Array<FaceQualityConfigName>}
|
|
401
473
|
* @memberof DetectionQuality
|
|
402
474
|
*/
|
|
403
475
|
'nonCompliant'?: Array<FaceQualityConfigName>;
|
|
404
476
|
/**
|
|
405
|
-
*
|
|
477
|
+
* Assessment results for each [group of characteristics](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-groups/).
|
|
406
478
|
* @type {Array<QualityDetailsGroups>}
|
|
407
479
|
* @memberof DetectionQuality
|
|
408
480
|
*/
|
|
409
481
|
'detailsGroups'?: Array<QualityDetailsGroups>;
|
|
410
482
|
/**
|
|
411
|
-
*
|
|
483
|
+
* Assessment characteristics that were set in the request.
|
|
412
484
|
* @type {Array<QualityDetail>}
|
|
413
485
|
* @memberof DetectionQuality
|
|
414
486
|
*/
|
|
415
487
|
'details'?: Array<QualityDetail>;
|
|
416
488
|
/**
|
|
417
|
-
* Returns the estimated portrait quality assessment result, a number from 0 to 1
|
|
489
|
+
* Returns the estimated portrait quality assessment result, a number from `0` to `1`, where `1` is for absolute compliance.
|
|
418
490
|
* @type {number}
|
|
419
491
|
* @memberof DetectionQuality
|
|
420
492
|
*/
|
|
421
493
|
'score'?: number;
|
|
422
494
|
/**
|
|
423
|
-
*
|
|
495
|
+
* Server processing time for quality assessment, ms.
|
|
424
496
|
* @type {number}
|
|
425
497
|
* @memberof DetectionQuality
|
|
426
498
|
*/
|
|
427
|
-
'
|
|
499
|
+
'elapsedTime'?: number;
|
|
428
500
|
}
|
|
429
501
|
|
|
430
502
|
/**
|
|
@@ -452,12 +524,17 @@ export declare interface DetectRequest {
|
|
|
452
524
|
*/
|
|
453
525
|
'image'?: ImageData_2;
|
|
454
526
|
/**
|
|
455
|
-
*
|
|
456
|
-
* @type {
|
|
527
|
+
* A label used to group transactions by customers, applications, or other criteria.
|
|
528
|
+
* @type {string}
|
|
457
529
|
* @memberof DetectRequest
|
|
458
|
-
* @deprecated
|
|
459
530
|
*/
|
|
460
|
-
'
|
|
531
|
+
'tenant'?: string;
|
|
532
|
+
/**
|
|
533
|
+
* A label used to differentiate transactions by development stages.
|
|
534
|
+
* @type {string}
|
|
535
|
+
* @memberof DetectRequest
|
|
536
|
+
*/
|
|
537
|
+
'env'?: string;
|
|
461
538
|
}
|
|
462
539
|
|
|
463
540
|
/**
|
|
@@ -481,13 +558,13 @@ export declare interface DetectResponseAllOf {
|
|
|
481
558
|
}
|
|
482
559
|
|
|
483
560
|
/**
|
|
484
|
-
*
|
|
561
|
+
* The detection results.
|
|
485
562
|
* @export
|
|
486
563
|
* @interface DetectResult
|
|
487
564
|
*/
|
|
488
565
|
export declare interface DetectResult {
|
|
489
566
|
/**
|
|
490
|
-
*
|
|
567
|
+
* The array of performed checks.
|
|
491
568
|
* @type {Array<Detection>}
|
|
492
569
|
* @memberof DetectResult
|
|
493
570
|
*/
|
|
@@ -505,24 +582,24 @@ export declare interface DetectResult {
|
|
|
505
582
|
*/
|
|
506
583
|
'landmarksType'?: number;
|
|
507
584
|
/**
|
|
508
|
-
*
|
|
509
|
-
* @type {
|
|
585
|
+
* The face detection scenario that was set in the `processParam.scenario` field of the request.
|
|
586
|
+
* @type {string}
|
|
510
587
|
* @memberof DetectResult
|
|
511
588
|
*/
|
|
512
|
-
'scenario'?:
|
|
589
|
+
'scenario'?: string;
|
|
513
590
|
/**
|
|
514
|
-
*
|
|
591
|
+
* Server processing time, ms. Does not include the time taken to receive the request or deliver the response.
|
|
515
592
|
* @type {number}
|
|
516
593
|
* @memberof DetectResult
|
|
517
594
|
*/
|
|
518
|
-
'
|
|
595
|
+
'elapsedTime'?: number;
|
|
519
596
|
}
|
|
520
597
|
|
|
521
598
|
/**
|
|
522
599
|
* Regula Face SDK Web API
|
|
523
600
|
* <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
|
|
524
601
|
*
|
|
525
|
-
* The version of the OpenAPI document:
|
|
602
|
+
* The version of the OpenAPI document: 7.1.0
|
|
526
603
|
*
|
|
527
604
|
*
|
|
528
605
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -612,7 +689,7 @@ export declare const FaceImageQualityAlignType: {
|
|
|
612
689
|
export declare type FaceImageQualityAlignType = typeof FaceImageQualityAlignType[keyof typeof FaceImageQualityAlignType];
|
|
613
690
|
|
|
614
691
|
/**
|
|
615
|
-
*
|
|
692
|
+
* The group ID of the characteristic, see the [FaceImageQualityGroups enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-groups/) for details.
|
|
616
693
|
* @export
|
|
617
694
|
* @enum {string}
|
|
618
695
|
*/
|
|
@@ -630,7 +707,7 @@ export declare const FaceImageQualityGroups: {
|
|
|
630
707
|
export declare type FaceImageQualityGroups = typeof FaceImageQualityGroups[keyof typeof FaceImageQualityGroups];
|
|
631
708
|
|
|
632
709
|
/**
|
|
633
|
-
* Face image quality group
|
|
710
|
+
* Face image quality assessment group name, see [FaceImageQualityGroups](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-groups/).
|
|
634
711
|
* @export
|
|
635
712
|
* @enum {string}
|
|
636
713
|
*/
|
|
@@ -648,7 +725,7 @@ export declare const FaceImageQualityGroupsStrings: {
|
|
|
648
725
|
export declare type FaceImageQualityGroupsStrings = typeof FaceImageQualityGroupsStrings[keyof typeof FaceImageQualityGroupsStrings];
|
|
649
726
|
|
|
650
727
|
/**
|
|
651
|
-
* The processing status returned for each
|
|
728
|
+
* The processing status returned for each quality characteristic, see the [FaceImageQualityStatus enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-status/).
|
|
652
729
|
* @export
|
|
653
730
|
* @enum {string}
|
|
654
731
|
*/
|
|
@@ -661,7 +738,7 @@ export declare const FaceImageQualityStatus: {
|
|
|
661
738
|
export declare type FaceImageQualityStatus = typeof FaceImageQualityStatus[keyof typeof FaceImageQualityStatus];
|
|
662
739
|
|
|
663
740
|
/**
|
|
664
|
-
* The name of the
|
|
741
|
+
* The name of the characteristic. For definitions, see the [FaceQualityConfigName enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-quality-config-name/).
|
|
665
742
|
* @export
|
|
666
743
|
* @enum {string}
|
|
667
744
|
*/
|
|
@@ -719,7 +796,7 @@ export declare const FaceQualityConfigName: {
|
|
|
719
796
|
export declare type FaceQualityConfigName = typeof FaceQualityConfigName[keyof typeof FaceQualityConfigName];
|
|
720
797
|
|
|
721
798
|
/**
|
|
722
|
-
* Face detection scenario. If
|
|
799
|
+
* Face detection scenario. If set and the scenario is found, it automatically applies the relevant parameters, overriding any other parameters specified in the request. If the scenario is not set, is empty, or the name is not recognized, processing will follow the parameters directly set in the request. For detailed descriptions of available scenarios, refer to the [Scenarios page](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/scenarios/).
|
|
723
800
|
* @export
|
|
724
801
|
* @enum {string}
|
|
725
802
|
*/
|
|
@@ -732,6 +809,7 @@ export declare const FaceQualityScenarios: {
|
|
|
732
809
|
readonly CROP_CENTRAL_FACE: "CropCentralFace";
|
|
733
810
|
readonly CROP_ALL_FACES: "CropAllFaces";
|
|
734
811
|
readonly THUMBNAIL: "Thumbnail";
|
|
812
|
+
readonly ATTRIBUTES_ALL: "AttributesAll";
|
|
735
813
|
readonly EMPTY: "";
|
|
736
814
|
};
|
|
737
815
|
|
|
@@ -888,7 +966,7 @@ export declare type Group = GroupAllOf & GroupResponse;
|
|
|
888
966
|
* Regula Face SDK Web API
|
|
889
967
|
* <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
|
|
890
968
|
*
|
|
891
|
-
* The version of the OpenAPI document:
|
|
969
|
+
* The version of the OpenAPI document: 7.1.0
|
|
892
970
|
*
|
|
893
971
|
*
|
|
894
972
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -951,7 +1029,7 @@ export declare interface GroupPageAllOf {
|
|
|
951
1029
|
* Regula Face SDK Web API
|
|
952
1030
|
* <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
|
|
953
1031
|
*
|
|
954
|
-
* The version of the OpenAPI document:
|
|
1032
|
+
* The version of the OpenAPI document: 7.1.0
|
|
955
1033
|
*
|
|
956
1034
|
*
|
|
957
1035
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -972,11 +1050,11 @@ export declare interface GroupResponse {
|
|
|
972
1050
|
'name'?: string;
|
|
973
1051
|
/**
|
|
974
1052
|
* A free-form object containing group\'s extended attributes.
|
|
975
|
-
* @type {{ [key: string]:
|
|
1053
|
+
* @type {{ [key: string]: any; }}
|
|
976
1054
|
* @memberof GroupResponse
|
|
977
1055
|
*/
|
|
978
1056
|
'metadata'?: {
|
|
979
|
-
[key: string]:
|
|
1057
|
+
[key: string]: any;
|
|
980
1058
|
};
|
|
981
1059
|
}
|
|
982
1060
|
|
|
@@ -984,7 +1062,7 @@ export declare interface GroupResponse {
|
|
|
984
1062
|
* Regula Face SDK Web API
|
|
985
1063
|
* <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
|
|
986
1064
|
*
|
|
987
|
-
* The version of the OpenAPI document:
|
|
1065
|
+
* The version of the OpenAPI document: 7.1.0
|
|
988
1066
|
*
|
|
989
1067
|
*
|
|
990
1068
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1011,11 +1089,11 @@ export declare interface GroupToCreate {
|
|
|
1011
1089
|
'name': string;
|
|
1012
1090
|
/**
|
|
1013
1091
|
* A free-form object containing group\'s extended attributes.
|
|
1014
|
-
* @type {{ [key: string]:
|
|
1092
|
+
* @type {{ [key: string]: any; }}
|
|
1015
1093
|
* @memberof GroupToCreate
|
|
1016
1094
|
*/
|
|
1017
1095
|
'metadata': {
|
|
1018
|
-
[key: string]:
|
|
1096
|
+
[key: string]: any;
|
|
1019
1097
|
};
|
|
1020
1098
|
}
|
|
1021
1099
|
|
|
@@ -1030,7 +1108,7 @@ export declare class HealthcheckApi {
|
|
|
1030
1108
|
* Regula Face SDK Web API
|
|
1031
1109
|
* <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
|
|
1032
1110
|
*
|
|
1033
|
-
* The version of the OpenAPI document:
|
|
1111
|
+
* The version of the OpenAPI document: 7.1.0
|
|
1034
1112
|
*
|
|
1035
1113
|
*
|
|
1036
1114
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1049,6 +1127,12 @@ declare interface Image_2 {
|
|
|
1049
1127
|
* @memberof Image
|
|
1050
1128
|
*/
|
|
1051
1129
|
'id'?: string;
|
|
1130
|
+
/**
|
|
1131
|
+
* Base64-encoded image. Returned only if `withImages` is set to true in the request.
|
|
1132
|
+
* @type {string}
|
|
1133
|
+
* @memberof Image
|
|
1134
|
+
*/
|
|
1135
|
+
'content'?: string;
|
|
1052
1136
|
/**
|
|
1053
1137
|
* Original media type of the returned image.
|
|
1054
1138
|
* @type {string}
|
|
@@ -1081,11 +1165,11 @@ declare interface Image_2 {
|
|
|
1081
1165
|
'url'?: string;
|
|
1082
1166
|
/**
|
|
1083
1167
|
* A free-form object containing person\'s extended attributes.
|
|
1084
|
-
* @type {{ [key: string]:
|
|
1168
|
+
* @type {{ [key: string]: any; }}
|
|
1085
1169
|
* @memberof Image
|
|
1086
1170
|
*/
|
|
1087
1171
|
'metadata'?: {
|
|
1088
|
-
[key: string]:
|
|
1172
|
+
[key: string]: any;
|
|
1089
1173
|
};
|
|
1090
1174
|
}
|
|
1091
1175
|
export { Image_2 as Image }
|
|
@@ -1222,6 +1306,18 @@ export declare interface MatchAndSearchRequestAllOf {
|
|
|
1222
1306
|
* @memberof MatchAndSearchRequestAllOf
|
|
1223
1307
|
*/
|
|
1224
1308
|
'groupIds'?: Array<string>;
|
|
1309
|
+
/**
|
|
1310
|
+
* A label used to group transactions by customers, applications, or other criteria.
|
|
1311
|
+
* @type {string}
|
|
1312
|
+
* @memberof MatchAndSearchRequestAllOf
|
|
1313
|
+
*/
|
|
1314
|
+
'tenant'?: string;
|
|
1315
|
+
/**
|
|
1316
|
+
* A label used to differentiate transactions by development stages.
|
|
1317
|
+
* @type {string}
|
|
1318
|
+
* @memberof MatchAndSearchRequestAllOf
|
|
1319
|
+
*/
|
|
1320
|
+
'env'?: string;
|
|
1225
1321
|
}
|
|
1226
1322
|
|
|
1227
1323
|
/**
|
|
@@ -1263,18 +1359,18 @@ export declare interface MatchAndSearchResponseAllOf {
|
|
|
1263
1359
|
*/
|
|
1264
1360
|
'results'?: Array<MatchImageResult>;
|
|
1265
1361
|
/**
|
|
1266
|
-
*
|
|
1362
|
+
* Server processing time, ms. Does not include the time taken to receive the request or deliver the response.
|
|
1267
1363
|
* @type {number}
|
|
1268
1364
|
* @memberof MatchAndSearchResponseAllOf
|
|
1269
1365
|
*/
|
|
1270
1366
|
'elapsedTime'?: number;
|
|
1271
1367
|
/**
|
|
1272
1368
|
* A free-form object containing person\'s extended attributes.
|
|
1273
|
-
* @type {{ [key: string]:
|
|
1369
|
+
* @type {{ [key: string]: any; }}
|
|
1274
1370
|
* @memberof MatchAndSearchResponseAllOf
|
|
1275
1371
|
*/
|
|
1276
1372
|
'metadata'?: {
|
|
1277
|
-
[key: string]:
|
|
1373
|
+
[key: string]: any;
|
|
1278
1374
|
};
|
|
1279
1375
|
/**
|
|
1280
1376
|
* The detection results.
|
|
@@ -1443,13 +1539,6 @@ export declare interface MatchRequest {
|
|
|
1443
1539
|
* @memberof MatchRequest
|
|
1444
1540
|
*/
|
|
1445
1541
|
'tag'?: string;
|
|
1446
|
-
/**
|
|
1447
|
-
* Use `outputImageParams.crop` instead.
|
|
1448
|
-
* @type {any}
|
|
1449
|
-
* @memberof MatchRequest
|
|
1450
|
-
* @deprecated
|
|
1451
|
-
*/
|
|
1452
|
-
'thumbnails'?: any;
|
|
1453
1542
|
/**
|
|
1454
1543
|
* All images included in the comparison.
|
|
1455
1544
|
* @type {Array<MatchImage>}
|
|
@@ -1462,6 +1551,18 @@ export declare interface MatchRequest {
|
|
|
1462
1551
|
* @memberof MatchRequest
|
|
1463
1552
|
*/
|
|
1464
1553
|
'outputImageParams'?: OutputImageParams;
|
|
1554
|
+
/**
|
|
1555
|
+
* A label used to group transactions by customers, applications, or other criteria.
|
|
1556
|
+
* @type {string}
|
|
1557
|
+
* @memberof MatchRequest
|
|
1558
|
+
*/
|
|
1559
|
+
'tenant'?: string;
|
|
1560
|
+
/**
|
|
1561
|
+
* A label used to differentiate transactions by development stages.
|
|
1562
|
+
* @type {string}
|
|
1563
|
+
* @memberof MatchRequest
|
|
1564
|
+
*/
|
|
1565
|
+
'env'?: string;
|
|
1465
1566
|
}
|
|
1466
1567
|
|
|
1467
1568
|
/**
|
|
@@ -1490,11 +1591,11 @@ export declare interface MatchResponseAllOf {
|
|
|
1490
1591
|
'results'?: Array<MatchImageResult>;
|
|
1491
1592
|
/**
|
|
1492
1593
|
* A free-form object containing person\'s extended attributes.
|
|
1493
|
-
* @type {{ [key: string]:
|
|
1594
|
+
* @type {{ [key: string]: any; }}
|
|
1494
1595
|
* @memberof MatchResponseAllOf
|
|
1495
1596
|
*/
|
|
1496
1597
|
'metadata'?: {
|
|
1497
|
-
[key: string]:
|
|
1598
|
+
[key: string]: any;
|
|
1498
1599
|
};
|
|
1499
1600
|
}
|
|
1500
1601
|
|
|
@@ -1502,7 +1603,7 @@ export declare interface MatchResponseAllOf {
|
|
|
1502
1603
|
* Regula Face SDK Web API
|
|
1503
1604
|
* <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
|
|
1504
1605
|
*
|
|
1505
|
-
* The version of the OpenAPI document:
|
|
1606
|
+
* The version of the OpenAPI document: 7.1.0
|
|
1506
1607
|
*
|
|
1507
1608
|
*
|
|
1508
1609
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1535,11 +1636,11 @@ export declare interface OperationLog {
|
|
|
1535
1636
|
'msg'?: string;
|
|
1536
1637
|
/**
|
|
1537
1638
|
* A free-form object containing group\'s extended attributes.
|
|
1538
|
-
* @type {{ [key: string]:
|
|
1639
|
+
* @type {{ [key: string]: any; }}
|
|
1539
1640
|
* @memberof OperationLog
|
|
1540
1641
|
*/
|
|
1541
1642
|
'metadata'?: {
|
|
1542
|
-
[key: string]:
|
|
1643
|
+
[key: string]: any;
|
|
1543
1644
|
};
|
|
1544
1645
|
}
|
|
1545
1646
|
|
|
@@ -1567,7 +1668,7 @@ export declare interface OutputImageParams {
|
|
|
1567
1668
|
* Regula Face SDK Web API
|
|
1568
1669
|
* <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
|
|
1569
1670
|
*
|
|
1570
|
-
* The version of the OpenAPI document:
|
|
1671
|
+
* The version of the OpenAPI document: 7.1.0
|
|
1571
1672
|
*
|
|
1572
1673
|
*
|
|
1573
1674
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1605,7 +1706,7 @@ export declare type Person = PersonAllOf & PersonFields;
|
|
|
1605
1706
|
* Regula Face SDK Web API
|
|
1606
1707
|
* <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
|
|
1607
1708
|
*
|
|
1608
|
-
* The version of the OpenAPI document:
|
|
1709
|
+
* The version of the OpenAPI document: 7.1.0
|
|
1609
1710
|
*
|
|
1610
1711
|
*
|
|
1611
1712
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1662,7 +1763,7 @@ export declare class PersonApi {
|
|
|
1662
1763
|
* Regula Face SDK Web API
|
|
1663
1764
|
* <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
|
|
1664
1765
|
*
|
|
1665
|
-
* The version of the OpenAPI document:
|
|
1766
|
+
* The version of the OpenAPI document: 7.1.0
|
|
1666
1767
|
*
|
|
1667
1768
|
*
|
|
1668
1769
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1689,11 +1790,11 @@ export declare interface PersonFields {
|
|
|
1689
1790
|
'externalId'?: string;
|
|
1690
1791
|
/**
|
|
1691
1792
|
* A free-form object containing person\'s extended attributes.
|
|
1692
|
-
* @type {{ [key: string]:
|
|
1793
|
+
* @type {{ [key: string]: any; }}
|
|
1693
1794
|
* @memberof PersonFields
|
|
1694
1795
|
*/
|
|
1695
1796
|
'metadata'?: {
|
|
1696
|
-
[key: string]:
|
|
1797
|
+
[key: string]: any;
|
|
1697
1798
|
};
|
|
1698
1799
|
/**
|
|
1699
1800
|
* 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.
|
|
@@ -1702,11 +1803,11 @@ export declare interface PersonFields {
|
|
|
1702
1803
|
*/
|
|
1703
1804
|
'groups'?: Array<string>;
|
|
1704
1805
|
/**
|
|
1705
|
-
*
|
|
1706
|
-
* @type {
|
|
1806
|
+
* Person expiration date.
|
|
1807
|
+
* @type {string}
|
|
1707
1808
|
* @memberof PersonFields
|
|
1708
1809
|
*/
|
|
1709
|
-
'
|
|
1810
|
+
'expireAt'?: string;
|
|
1710
1811
|
}
|
|
1711
1812
|
|
|
1712
1813
|
/**
|
|
@@ -1729,11 +1830,48 @@ export declare interface PersonsPageAllOf {
|
|
|
1729
1830
|
'items'?: Array<Person>;
|
|
1730
1831
|
}
|
|
1731
1832
|
|
|
1833
|
+
/**
|
|
1834
|
+
* @type PersonsRequest
|
|
1835
|
+
* @export
|
|
1836
|
+
*/
|
|
1837
|
+
export declare type PersonsRequest = PersonFields & PersonsRequestAllOf;
|
|
1838
|
+
|
|
1732
1839
|
/**
|
|
1733
1840
|
* Regula Face SDK Web API
|
|
1734
1841
|
* <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
|
|
1735
1842
|
*
|
|
1736
|
-
* The version of the OpenAPI document:
|
|
1843
|
+
* The version of the OpenAPI document: 7.1.0
|
|
1844
|
+
*
|
|
1845
|
+
*
|
|
1846
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1847
|
+
* https://openapi-generator.tech
|
|
1848
|
+
* Do not edit the class manually.
|
|
1849
|
+
*/
|
|
1850
|
+
/**
|
|
1851
|
+
*
|
|
1852
|
+
* @export
|
|
1853
|
+
* @interface PersonsRequestAllOf
|
|
1854
|
+
*/
|
|
1855
|
+
export declare interface PersonsRequestAllOf {
|
|
1856
|
+
/**
|
|
1857
|
+
* A label used to group transactions by customers, applications, or other criteria.
|
|
1858
|
+
* @type {string}
|
|
1859
|
+
* @memberof PersonsRequestAllOf
|
|
1860
|
+
*/
|
|
1861
|
+
'tenant'?: string;
|
|
1862
|
+
/**
|
|
1863
|
+
* A label used to differentiate transactions by development stages.
|
|
1864
|
+
* @type {string}
|
|
1865
|
+
* @memberof PersonsRequestAllOf
|
|
1866
|
+
*/
|
|
1867
|
+
'env'?: string;
|
|
1868
|
+
}
|
|
1869
|
+
|
|
1870
|
+
/**
|
|
1871
|
+
* Regula Face SDK Web API
|
|
1872
|
+
* <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
|
|
1873
|
+
*
|
|
1874
|
+
* The version of the OpenAPI document: 7.1.0
|
|
1737
1875
|
*
|
|
1738
1876
|
*
|
|
1739
1877
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1760,11 +1898,11 @@ export declare interface PersonToUpdateFields {
|
|
|
1760
1898
|
'name'?: string;
|
|
1761
1899
|
/**
|
|
1762
1900
|
* A free-form object containing person\'s extended attributes.
|
|
1763
|
-
* @type {{ [key: string]:
|
|
1901
|
+
* @type {{ [key: string]: any; }}
|
|
1764
1902
|
* @memberof PersonToUpdateFields
|
|
1765
1903
|
*/
|
|
1766
1904
|
'metadata'?: {
|
|
1767
|
-
[key: string]:
|
|
1905
|
+
[key: string]: any;
|
|
1768
1906
|
};
|
|
1769
1907
|
/**
|
|
1770
1908
|
* 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.
|
|
@@ -1833,7 +1971,7 @@ export declare interface ProcessParam {
|
|
|
1833
1971
|
}
|
|
1834
1972
|
|
|
1835
1973
|
/**
|
|
1836
|
-
* If set, the selected attributes, such as age or emotions, are evaluated.
|
|
1974
|
+
* If set, the selected attributes, such as age or emotions, are evaluated. To check all the available attributes, you can set the `AttributesAll` scenario in `processParam.scenario`.
|
|
1837
1975
|
* @export
|
|
1838
1976
|
* @interface ProcessParamAttributes
|
|
1839
1977
|
*/
|
|
@@ -1859,7 +1997,7 @@ export declare interface QualityConfig {
|
|
|
1859
1997
|
*/
|
|
1860
1998
|
'name'?: FaceQualityConfigName;
|
|
1861
1999
|
/**
|
|
1862
|
-
* 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.
|
|
2000
|
+
* The range of applicable values for this characteristic. If the returned in the response value fits this range, the characteristic is identified as compliant with the requirements. For recommended ranges, see [Face Image Quality Assessment](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/face-image-quality-check/).
|
|
1863
2001
|
* @type {Array<number>}
|
|
1864
2002
|
* @memberof QualityConfig
|
|
1865
2003
|
*/
|
|
@@ -1885,7 +2023,7 @@ export declare interface QualityDetail {
|
|
|
1885
2023
|
*/
|
|
1886
2024
|
'name'?: FaceQualityConfigName;
|
|
1887
2025
|
/**
|
|
1888
|
-
* The range of set values for this characteristic.
|
|
2026
|
+
* The range of set values for this characteristic, see the [Recommended range column](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/face-image-quality-check/).
|
|
1889
2027
|
* @type {Array<number>}
|
|
1890
2028
|
* @memberof QualityDetail
|
|
1891
2029
|
*/
|
|
@@ -1897,7 +2035,7 @@ export declare interface QualityDetail {
|
|
|
1897
2035
|
*/
|
|
1898
2036
|
'status'?: FaceImageQualityStatus;
|
|
1899
2037
|
/**
|
|
1900
|
-
* The
|
|
2038
|
+
* The result value for the characteristic, returned in set units.
|
|
1901
2039
|
* @type {number}
|
|
1902
2040
|
* @memberof QualityDetail
|
|
1903
2041
|
*/
|
|
@@ -1937,7 +2075,7 @@ export declare interface QualityDetailsGroups {
|
|
|
1937
2075
|
}
|
|
1938
2076
|
|
|
1939
2077
|
/**
|
|
1940
|
-
* If set, the face image quality check is performed according to the
|
|
2078
|
+
* If set, the face image quality check is performed according to the given list of [characteristics](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/face-image-quality-check/) in `quality.config`.
|
|
1941
2079
|
* @export
|
|
1942
2080
|
* @interface QualityRequest
|
|
1943
2081
|
*/
|
|
@@ -1966,7 +2104,7 @@ export declare type RecognizeImage = Image_2 & RecognizeImageAllOf;
|
|
|
1966
2104
|
* Regula Face SDK Web API
|
|
1967
2105
|
* <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
|
|
1968
2106
|
*
|
|
1969
|
-
* The version of the OpenAPI document:
|
|
2107
|
+
* The version of the OpenAPI document: 7.1.0
|
|
1970
2108
|
*
|
|
1971
2109
|
*
|
|
1972
2110
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1997,7 +2135,7 @@ export declare interface RecognizeImageAllOf {
|
|
|
1997
2135
|
* Regula Face SDK Web API
|
|
1998
2136
|
* <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
|
|
1999
2137
|
*
|
|
2000
|
-
* The version of the OpenAPI document:
|
|
2138
|
+
* The version of the OpenAPI document: 7.1.0
|
|
2001
2139
|
*
|
|
2002
2140
|
*
|
|
2003
2141
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2033,14 +2171,14 @@ export declare interface ResizeOptions {
|
|
|
2033
2171
|
export declare class SearchApi {
|
|
2034
2172
|
private superClass;
|
|
2035
2173
|
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
2036
|
-
search(searchRequest: SearchRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<SearchResult>;
|
|
2174
|
+
search(searchRequest: SearchRequest, xRequestID?: string, withImages?: boolean, options?: AxiosRequestConfig): Promise<SearchResult>;
|
|
2037
2175
|
}
|
|
2038
2176
|
|
|
2039
2177
|
/**
|
|
2040
2178
|
* Regula Face SDK Web API
|
|
2041
2179
|
* <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
|
|
2042
2180
|
*
|
|
2043
|
-
* The version of the OpenAPI document:
|
|
2181
|
+
* The version of the OpenAPI document: 7.1.0
|
|
2044
2182
|
*
|
|
2045
2183
|
*
|
|
2046
2184
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2077,7 +2215,7 @@ export declare interface SearchBadParams {
|
|
|
2077
2215
|
* Regula Face SDK Web API
|
|
2078
2216
|
* <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
|
|
2079
2217
|
*
|
|
2080
|
-
* The version of the OpenAPI document:
|
|
2218
|
+
* The version of the OpenAPI document: 7.1.0
|
|
2081
2219
|
*
|
|
2082
2220
|
*
|
|
2083
2221
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2188,7 +2326,7 @@ export declare interface SearchParameters {
|
|
|
2188
2326
|
* Regula Face SDK Web API
|
|
2189
2327
|
* <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
|
|
2190
2328
|
*
|
|
2191
|
-
* The version of the OpenAPI document:
|
|
2329
|
+
* The version of the OpenAPI document: 7.1.0
|
|
2192
2330
|
*
|
|
2193
2331
|
*
|
|
2194
2332
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2209,11 +2347,11 @@ export declare interface SearchParametersCreatePerson {
|
|
|
2209
2347
|
'name'?: string;
|
|
2210
2348
|
/**
|
|
2211
2349
|
* A free-form object containing person\'s extended attributes.
|
|
2212
|
-
* @type {{ [key: string]:
|
|
2350
|
+
* @type {{ [key: string]: any; }}
|
|
2213
2351
|
* @memberof SearchParametersCreatePerson
|
|
2214
2352
|
*/
|
|
2215
2353
|
'metadata'?: {
|
|
2216
|
-
[key: string]:
|
|
2354
|
+
[key: string]: any;
|
|
2217
2355
|
};
|
|
2218
2356
|
/**
|
|
2219
2357
|
* The lifespan of the Person\'s records, seconds. Optional.
|
|
@@ -2253,7 +2391,7 @@ export declare interface SearchPersonAllOf {
|
|
|
2253
2391
|
* @type SearchRequest
|
|
2254
2392
|
* @export
|
|
2255
2393
|
*/
|
|
2256
|
-
export declare type SearchRequest = ImageFields & SearchParameters;
|
|
2394
|
+
export declare type SearchRequest = ImageFields & PersonsRequestAllOf & SearchParameters;
|
|
2257
2395
|
|
|
2258
2396
|
/**
|
|
2259
2397
|
*
|
|
@@ -2273,44 +2411,6 @@ export declare interface SearchResult {
|
|
|
2273
2411
|
* @memberof SearchResult
|
|
2274
2412
|
*/
|
|
2275
2413
|
'persons'?: Array<SearchPerson>;
|
|
2276
|
-
/**
|
|
2277
|
-
* Person ID. The list of persons is sorted by decreasing ID value.
|
|
2278
|
-
* @type {string}
|
|
2279
|
-
* @memberof SearchResult
|
|
2280
|
-
*/
|
|
2281
|
-
'id'?: string | null;
|
|
2282
|
-
/**
|
|
2283
|
-
* Person creation date.
|
|
2284
|
-
* @type {string}
|
|
2285
|
-
* @memberof SearchResult
|
|
2286
|
-
*/
|
|
2287
|
-
'createdAt'?: string | null;
|
|
2288
|
-
/**
|
|
2289
|
-
* Person update date.
|
|
2290
|
-
* @type {string}
|
|
2291
|
-
* @memberof SearchResult
|
|
2292
|
-
*/
|
|
2293
|
-
'updatedAt'?: string | null;
|
|
2294
|
-
/**
|
|
2295
|
-
* List of groups this person belongs to.
|
|
2296
|
-
* @type {Array<string>}
|
|
2297
|
-
* @memberof SearchResult
|
|
2298
|
-
*/
|
|
2299
|
-
'groups'?: Array<string> | null;
|
|
2300
|
-
/**
|
|
2301
|
-
* Person\'s name.
|
|
2302
|
-
* @type {string}
|
|
2303
|
-
* @memberof SearchResult
|
|
2304
|
-
*/
|
|
2305
|
-
'name'?: string | null;
|
|
2306
|
-
/**
|
|
2307
|
-
* A free-form object containing person\'s extended attributes. Available when a person is being created
|
|
2308
|
-
* @type {{ [key: string]: object; }}
|
|
2309
|
-
* @memberof SearchResult
|
|
2310
|
-
*/
|
|
2311
|
-
'metadata'?: {
|
|
2312
|
-
[key: string]: object;
|
|
2313
|
-
};
|
|
2314
2414
|
}
|
|
2315
2415
|
|
|
2316
2416
|
export declare type TDetection = {
|
|
@@ -2439,11 +2539,11 @@ export declare interface TransactionInfo {
|
|
|
2439
2539
|
'video'?: string;
|
|
2440
2540
|
/**
|
|
2441
2541
|
* Approximate age with an accuracy of +/-3 years.
|
|
2442
|
-
* @type {Array<{ [key: string]:
|
|
2542
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
2443
2543
|
* @memberof TransactionInfo
|
|
2444
2544
|
*/
|
|
2445
2545
|
'age'?: Array<{
|
|
2446
|
-
[key: string]:
|
|
2546
|
+
[key: string]: any;
|
|
2447
2547
|
}>;
|
|
2448
2548
|
/**
|
|
2449
2549
|
* Link to the portrait, depends on the selected storage type. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/storage/)
|
|
@@ -2453,11 +2553,11 @@ export declare interface TransactionInfo {
|
|
|
2453
2553
|
'portrait'?: string;
|
|
2454
2554
|
/**
|
|
2455
2555
|
* A free-form object containing person\'s extended attributes.
|
|
2456
|
-
* @type {{ [key: string]:
|
|
2556
|
+
* @type {{ [key: string]: any; }}
|
|
2457
2557
|
* @memberof TransactionInfo
|
|
2458
2558
|
*/
|
|
2459
2559
|
'metadata'?: {
|
|
2460
|
-
[key: string]:
|
|
2560
|
+
[key: string]: any;
|
|
2461
2561
|
};
|
|
2462
2562
|
/**
|
|
2463
2563
|
*
|
|
@@ -2471,7 +2571,7 @@ export declare interface TransactionInfo {
|
|
|
2471
2571
|
* Regula Face SDK Web API
|
|
2472
2572
|
* <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
|
|
2473
2573
|
*
|
|
2474
|
-
* The version of the OpenAPI document:
|
|
2574
|
+
* The version of the OpenAPI document: 7.1.0
|
|
2475
2575
|
*
|
|
2476
2576
|
*
|
|
2477
2577
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|