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