@regulaforensics/facesdk-webclient
Version:
JS client for facesdk web service
1,097 lines (1,046 loc) • 111 kB
TypeScript
import { AxiosInstance } from 'axios';
import { AxiosRequestConfig } from 'axios';
/**
* Image in the request data, includes image and contentType.
* @export
* @interface AddImageToPersonRequest
*/
export declare interface AddImageToPersonRequest {
/**
* Session identificator.
* @type {string}
* @memberof AddImageToPersonRequest
*/
'tag'?: string;
/**
*
* @type {AddImageToPersonRequestImage}
* @memberof AddImageToPersonRequest
*/
'image': AddImageToPersonRequestImage;
/**
* The similarity threshold.
* @type {number}
* @memberof AddImageToPersonRequest
*/
'threshold'?: number;
/**
* The maximum number of results to be returned.
* @type {number}
* @memberof AddImageToPersonRequest
*/
'limit'?: number;
/**
* A label used to group transactions by customers, applications, or other criteria.
* @type {string}
* @memberof AddImageToPersonRequest
*/
'tenant'?: string;
/**
* A label used to differentiate transactions by development stages.
* @type {string}
* @memberof AddImageToPersonRequest
*/
'env'?: string;
}
/**
* Uploaded image.
* @export
* @interface AddImageToPersonRequestImage
*/
export declare interface AddImageToPersonRequestImage {
/**
* Original media type of the uploaded image.
* @type {string}
* @memberof AddImageToPersonRequestImage
*/
'contentType'?: string;
/**
*
* @type {ImageData}
* @memberof AddImageToPersonRequestImage
*/
'content'?: ImageData_2;
/**
* Image URL.
* @type {string}
* @memberof AddImageToPersonRequestImage
*/
'imageUrl'?: string;
/**
*
* @type {ResizeOptions}
* @memberof AddImageToPersonRequestImage
*/
'resizeOptions'?: ResizeOptions;
}
/**
* Regula Face SDK Web API
* <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
*
* The version of the OpenAPI document: 7.2.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Image in the response.
* @export
* @interface AddImageToPersonResponse
*/
export declare interface AddImageToPersonResponse {
/**
* Response image ID. The list is sorted by decreasing ID value.
* @type {string}
* @memberof AddImageToPersonResponse
*/
'id'?: string;
/**
* Original media type of the returned image.
* @type {string}
* @memberof AddImageToPersonResponse
*/
'contentType'?: string;
/**
* Returned image creation date.
* @type {string}
* @memberof AddImageToPersonResponse
*/
'createdAt'?: string;
/**
* Returned image path.
* @type {string}
* @memberof AddImageToPersonResponse
*/
'path'?: string;
/**
* Returned image URL.
* @type {string}
* @memberof AddImageToPersonResponse
*/
'url'?: string;
/**
* A free-form object containing person\'s extended attributes.
* @type {{ [key: string]: any; }}
* @memberof AddImageToPersonResponse
*/
'metadata'?: {
[key: string]: any;
};
}
/**
* The configuration that defines the list of returned attribute check characteristics.
* @export
* @interface AttributeConfig
*/
export declare interface AttributeConfig {
/**
*
* @type {FaceAttribute}
* @memberof AttributeConfig
*/
'name'?: FaceAttribute;
}
export declare type Base64String = string;
export declare class Configuration {
/**
* parameter for apiKey security
* @param name security name
* @memberof Configuration
*/
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
/**
* parameter for basic security
*
* @type {string}
* @memberof Configuration
*/
username?: string;
/**
* parameter for basic security
*
* @type {string}
* @memberof Configuration
*/
password?: string;
/**
* parameter for oauth2 security
* @param name security name
* @param scopes oauth2 scope
* @memberof Configuration
*/
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
/**
* override base path
*
* @type {string}
* @memberof Configuration
*/
basePath?: string;
/**
* base options for axios calls
*
* @type {any}
* @memberof Configuration
*/
baseOptions?: any;
/**
* The FormData constructor that will be used to create multipart form data
* requests. You can inject this here so that execution environments that
* do not support the FormData class can still run the generated client.
*
* @type {new () => FormData}
*/
formDataCtor?: new () => any;
constructor(param?: ConfigurationParameters);
/**
* Check if the given MIME is a JSON MIME.
* JSON MIME examples:
* application/json
* application/json; charset=UTF8
* APPLICATION/JSON
* application/vnd.company+json
* @param mime - MIME (Multipurpose Internet Mail Extensions)
* @return True if the given MIME is JSON, false otherwise.
*/
isJsonMime(mime: string): boolean;
}
/**
* Regula Face SDK Web API
* <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
*
* The version of the OpenAPI document: 7.2.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
export declare interface ConfigurationParameters {
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
username?: string;
password?: string;
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
basePath?: string;
baseOptions?: any;
formDataCtor?: new () => any;
}
/**
* 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.
* @export
* @interface Crop
*/
export declare interface Crop {
/**
*
* @type {FaceImageQualityAlignType}
* @memberof Crop
*/
'type'?: FaceImageQualityAlignType;
/**
* The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
* @type {Array<number>}
* @memberof Crop
*/
'padColor'?: Array<number>;
/**
* The resize value in case `type` matches this value. If it doesn\'t, no resize is performed.
* @type {Array<number>}
* @memberof Crop
*/
'size'?: Array<number>;
}
/**
* Regula Face SDK Web API
* <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
*
* The version of the OpenAPI document: 7.2.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface DetectAttributesDetails
*/
export declare interface DetectAttributesDetails {
/**
* The name of the attribute.
* @type {string}
* @memberof DetectAttributesDetails
*/
'name'?: string;
/**
* 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/).
* @type {Array<number>}
* @memberof DetectAttributesDetails
*/
'value'?: Array<number>;
}
/**
* Regula Face SDK Web API
* <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
*
* The version of the OpenAPI document: 7.2.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface DetectDetailsMeta
*/
export declare interface DetectDetailsMeta {
/**
* The confidence in the estimated value, `1.0` is for 100% confidence.
* @type {number}
* @memberof DetectDetailsMeta
*/
'confidence'?: number;
/**
* 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/).
* @type {string}
* @memberof DetectDetailsMeta
*/
'value'?: string;
/**
* The name of the attribute.
* @type {string}
* @memberof DetectDetailsMeta
*/
'name'?: string;
}
/**
*
* @export
* @interface Detection
*/
export declare interface Detection {
/**
*
* @type {ImageData}
* @memberof Detection
*/
'crop'?: ImageData_2;
/**
*
* @type {DetectionAttributes}
* @memberof Detection
*/
'attributes'?: DetectionAttributes;
/**
* Absolute coordinates (X,Y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
* @type {Array<Array<number>>}
* @memberof Detection
*/
'landmarks': Array<Array<number>>;
/**
*
* @type {DetectionQuality}
* @memberof Detection
*/
'quality'?: DetectionQuality;
/**
* 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.
* @type {Array<number>}
* @memberof Detection
*/
'roi': Array<number>;
}
/**
* The evaluated attributes, see the [Attributes List](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/attributes-detection/) for details.
* @export
* @interface DetectionAttributes
*/
export declare interface DetectionAttributes {
/**
* Attributes assessment details. Returns `DetectDetailsMeta` or `DetectAttributesDetails`.
* @type {Array<DetectionAttributesDetailsInner>}
* @memberof DetectionAttributes
*/
'details'?: Array<DetectionAttributesDetailsInner>;
/**
* Server processing time for attribute detection, ms.
* @type {number}
* @memberof DetectionAttributes
*/
'elapsedTime'?: number;
}
/**
* Regula Face SDK Web API
* <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
*
* The version of the OpenAPI document: 7.2.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface DetectionAttributesDetailsInner
*/
export declare interface DetectionAttributesDetailsInner {
/**
* The name of the attribute.
* @type {string}
* @memberof DetectionAttributesDetailsInner
*/
'name'?: string;
/**
* 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/).
* @type {string}
* @memberof DetectionAttributesDetailsInner
*/
'value'?: string;
/**
* The confidence in the estimated value, `1.0` is for 100% confidence.
* @type {number}
* @memberof DetectionAttributesDetailsInner
*/
'confidence'?: number;
}
/**
* Regula Face SDK Web API
* <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
*
* The version of the OpenAPI document: 7.2.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface DetectionFace
*/
export declare interface DetectionFace {
/**
* The detected face index number.
* @type {number}
* @memberof DetectionFace
*/
'faceIndex'?: number;
/**
* Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
* @type {Array<Array<number>>}
* @memberof DetectionFace
*/
'landmarks'?: Array<Array<number>>;
/**
* Angle of rotation of the face from the vertical axis, degrees.
* @type {number}
* @memberof DetectionFace
*/
'rotationAngle'?: number;
/**
* 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.
* @type {Array<number>}
* @memberof DetectionFace
*/
'roi'?: Array<number>;
/**
* Base64-encoded aligned and cropped portrait.
* @type {string}
* @memberof DetectionFace
*/
'crop'?: string;
}
/**
* 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.
* @export
* @interface DetectionQuality
*/
export declare interface DetectionQuality {
/**
* Non-compliant assessment characteristics.
* @type {Array<FaceQualityConfigName>}
* @memberof DetectionQuality
*/
'nonCompliant'?: Array<FaceQualityConfigName>;
/**
* Assessment results for each [group of characteristics](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-groups/).
* @type {Array<QualityDetailsGroups>}
* @memberof DetectionQuality
*/
'detailsGroups'?: Array<QualityDetailsGroups>;
/**
* Assessment characteristics that were set in the request.
* @type {Array<QualityDetail>}
* @memberof DetectionQuality
*/
'details'?: Array<QualityDetail>;
/**
* Returns the estimated portrait quality assessment result, a number from `0` to `1`, where `1` is for absolute compliance.
* @type {number}
* @memberof DetectionQuality
*/
'score'?: number;
/**
* Server processing time for quality assessment, ms.
* @type {number}
* @memberof DetectionQuality
*/
'elapsedTime'?: number;
}
/**
*
* @export
* @interface DetectRequest
*/
export declare interface DetectRequest {
/**
* Session identificator, should be unique for each session.
* @type {string}
* @memberof DetectRequest
*/
'tag'?: string;
/**
*
* @type {ProcessParam}
* @memberof DetectRequest
*/
'processParam'?: ProcessParam;
/**
*
* @type {ImageData}
* @memberof DetectRequest
*/
'image'?: ImageData_2;
/**
* A label used to group transactions by customers, applications, or other criteria.
* @type {string}
* @memberof DetectRequest
*/
'tenant'?: string;
/**
* A label used to differentiate transactions by development stages.
* @type {string}
* @memberof DetectRequest
*/
'env'?: string;
}
/**
* @type DetectResponse
* @export
*/
export declare type DetectResponse = DetectResponseAllOf & FaceSDKResult;
/**
*
* @export
* @interface DetectResponseAllOf
*/
export declare interface DetectResponseAllOf {
/**
*
* @type {DetectResult}
* @memberof DetectResponseAllOf
*/
'results'?: DetectResult;
}
/**
* The detection results.
* @export
* @interface DetectResult
*/
export declare interface DetectResult {
/**
* The array of performed checks.
* @type {Array<Detection>}
* @memberof DetectResult
*/
'detections': Array<Detection>;
/**
* Internal.
* @type {number}
* @memberof DetectResult
*/
'detectorType'?: number;
/**
* Internal.
* @type {number}
* @memberof DetectResult
*/
'landmarksType'?: number;
/**
* The face detection scenario that was set in the `processParam.scenario` field of the request.
* @type {string}
* @memberof DetectResult
*/
'scenario'?: string;
/**
* Server processing time, ms. Does not include the time taken to receive the request or deliver the response.
* @type {number}
* @memberof DetectResult
*/
'elapsedTime'?: number;
}
/**
* Regula Face SDK Web API
* <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
*
* The version of the OpenAPI document: 7.2.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @interface DeviceInfo
*/
export declare interface DeviceInfo {
/**
* Application name.
* @type {string}
* @memberof DeviceInfo
*/
'app': string;
/**
* Unique license identifier.
* @type {string}
* @memberof DeviceInfo
*/
'licenseId': string | null;
/**
* License serial number.
* @type {string}
* @memberof DeviceInfo
*/
'licenseSerial': string | null;
/**
* License validity date.
* @type {string}
* @memberof DeviceInfo
*/
'licenseValidUntil': string | null;
/**
* Product version.
* @type {string}
* @memberof DeviceInfo
*/
'version': string | null;
}
export declare class DiagnosticsApi {
private superClass;
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
readiness(xRequestID?: string, options?: AxiosRequestConfig): Promise<Record<string, unknown>>;
}
/**
* The name of the attribute. For definitions, see the [FaceAttribute enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-attribute/).
* @export
* @enum {string}
*/
export declare const FaceAttribute: {
readonly AGE: "Age";
readonly EMOTION: "Emotion";
readonly EYE_LEFT: "EyeLeft";
readonly EYE_RIGHT: "EyeRight";
readonly SMILE: "Smile";
readonly GLASSES: "Glasses";
readonly HEAD_COVERING: "HeadCovering";
readonly FOREHEAD_COVERING: "ForeheadCovering";
readonly MOUTH: "Mouth";
readonly MEDICAL_MASK: "MedicalMask";
readonly OCCLUSION: "Occlusion";
readonly STRONG_MAKEUP: "StrongMakeup";
readonly HEADPHONES: "Headphones";
};
export declare type FaceAttribute = typeof FaceAttribute[keyof typeof FaceAttribute];
/**
* 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`.
* @export
* @enum {string}
*/
export declare const FaceImageQualityAlignType: {
readonly ALIGN_3x4: 0;
readonly ALIGN_4x5: 1;
readonly ALIGN_2x3: 2;
readonly ALIGN_1x1: 3;
readonly ALIGN_7x9: 4;
};
export declare type FaceImageQualityAlignType = typeof FaceImageQualityAlignType[keyof typeof FaceImageQualityAlignType];
/**
* 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.
* @export
* @enum {string}
*/
export declare const FaceImageQualityGroups: {
readonly IMAGE_CHARACTERISTICS: 1;
readonly HEAD_SIZE_AND_POSITIONS: 2;
readonly FACE_QUALITY: 3;
readonly EYES_CHARACTERISTICS: 4;
readonly SHADOWS_AND_LIGHTNING: 5;
readonly POSE_AND_EXPRESSION: 6;
readonly HEAD_OCCLUSION: 7;
readonly BACKGROUND: 8;
};
export declare type FaceImageQualityGroups = typeof FaceImageQualityGroups[keyof typeof FaceImageQualityGroups];
/**
* Face image quality assessment group name, see [FaceImageQualityGroups](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-groups/).
* @export
* @enum {string}
*/
export declare const FaceImageQualityGroupsStrings: {
readonly IMAGE_CHARACTERISTICS: "ImageCharacteristics";
readonly HEAD_SIZE_AND_POSITIONS: "HeadSizeAndPosition";
readonly FACE_QUALITY: "FaceQuality";
readonly EYES_CHARACTERISTICS: "EyesCharacteristics";
readonly SHADOWS_AND_LIGHTNING: "ShadowsAndLightning";
readonly POSE_AND_EXPRESSION: "PoseAndExpression";
readonly HEAD_OCCLUSION: "HeadOcclusion";
readonly BACKGROUND: "Background";
};
export declare type FaceImageQualityGroupsStrings = typeof FaceImageQualityGroupsStrings[keyof typeof FaceImageQualityGroupsStrings];
/**
* 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/).
* @export
* @enum {string}
*/
export declare const FaceImageQualityStatus: {
readonly QUALITY_STATUS_FALSE: 0;
readonly QUALITY_STATUS_TRUE: 1;
readonly QUALITY_STATUS_UNDETERMINED: 2;
};
export declare type FaceImageQualityStatus = typeof FaceImageQualityStatus[keyof typeof FaceImageQualityStatus];
/**
* 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/).
* @export
* @enum {string}
*/
export declare const FaceQualityConfigName: {
readonly IMAGE_WIDTH: "ImageWidth";
readonly IMAGE_HEIGHT: "ImageHeight";
readonly IMAGE_WIDTH_TO_HEIGHT: "ImageWidthToHeight";
readonly IMAGE_CHANNELS_NUMBER: "ImageChannelsNumber";
readonly PADDING_RATIO: "PaddingRatio";
readonly FACE_MID_POINT_HORIZONTAL_POSITION: "FaceMidPointHorizontalPosition";
readonly FACE_MID_POINT_VERTICAL_POSITION: "FaceMidPointVerticalPosition";
readonly HEAD_WIDTH_RATIO: "HeadWidthRatio";
readonly HEAD_HEIGHT_RATIO: "HeadHeightRatio";
readonly EYES_DISTANCE: "EyesDistance";
readonly YAW: "Yaw";
readonly PITCH: "Pitch";
readonly ROLL: "Roll";
readonly BLUR_LEVEL: "BlurLevel";
readonly NOISE_LEVEL: "NoiseLevel";
readonly EYE_RIGHT_CLOSED: "EyeRightClosed";
readonly EYE_LEFT_CLOSED: "EyeLeftClosed";
readonly EYE_RIGHT_OCCLUDED: "EyeRightOccluded";
readonly EYE_LEFT_OCCLUDED: "EyeLeftOccluded";
readonly EYES_RED: "EyesRed";
readonly EYE_RIGHT_COVERED_WITH_HAIR: "EyeRightCoveredWithHair";
readonly EYE_LEFT_COVERED_WITH_HAIR: "EyeLeftCoveredWithHair";
readonly OFF_GAZE: "OffGaze";
readonly FACE_DYNAMIC_RANGE: "FaceDynamicRange";
readonly UNNATURAL_SKIN_TONE: "UnnaturalSkinTone";
readonly TOO_DARK: "TooDark";
readonly TOO_LIGHT: "TooLight";
readonly FACE_GLARE: "FaceGlare";
readonly SHADOWS_ON_FACE: "ShadowsOnFace";
readonly DARK_GLASSES: "DarkGlasses";
readonly REFLECTION_ON_GLASSES: "ReflectionOnGlasses";
readonly FRAMES_TOO_HEAVY: "FramesTooHeavy";
readonly FACE_OCCLUDED: "FaceOccluded";
readonly HEAD_COVERING: "HeadCovering";
readonly BACKGROUND_UNIFORMITY: "BackgroundUniformity";
readonly SHADOWS_ON_BACKGROUND: "ShadowsOnBackground";
readonly OTHER_FACES: "OtherFaces";
readonly SHOULDERS_POSE: "ShouldersPose";
readonly EXPRESSION_LEVEL: "ExpressionLevel";
readonly MOUTH_OPEN: "MouthOpen";
readonly FOREHEAD_COVERING: "ForeheadCovering";
readonly SMILE: "Smile";
readonly STRONG_MAKEUP: "StrongMakeup";
readonly HEADPHONES: "Headphones";
readonly MEDICAL_MASK: "MedicalMask";
readonly BACKGROUND_COLOR_MATCH: "BackgroundColorMatch";
readonly ART_FACE: "ArtFace";
readonly CONTACT_LENSES: "ContactLenses";
};
export declare type FaceQualityConfigName = typeof FaceQualityConfigName[keyof typeof FaceQualityConfigName];
/**
* 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/).
* @export
* @enum {string}
*/
export declare const FaceQualityScenarios: {
readonly OLD_MODE: "OldMode";
readonly QUALITY_FULL: "QualityFull";
readonly QUALITY_ICAO: "QualityICAO";
readonly QUALITY_VISA_SCHENGEN: "QualityVisaSchengen";
readonly QUALITY_VISA_USA: "QualityVisaUSA";
readonly CROP_CENTRAL_FACE: "CropCentralFace";
readonly CROP_ALL_FACES: "CropAllFaces";
readonly THUMBNAIL: "Thumbnail";
readonly ATTRIBUTES_ALL: "AttributesAll";
readonly EMPTY: "";
};
export declare type FaceQualityScenarios = typeof FaceQualityScenarios[keyof typeof FaceQualityScenarios];
export declare class FaceSdk {
protected basePath: string;
protected axios: AxiosInstance;
matchApi: MatchApi;
groupApi: GroupApi;
personApi: PersonApi;
searchApi: SearchApi;
diagnosticsApi: DiagnosticsApi;
livenessApi: Liveness20Api;
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
}
/**
*
* @export
* @interface FaceSDKResult
*/
export declare interface FaceSDKResult {
/**
*
* @type {FaceSDKResultCode}
* @memberof FaceSDKResult
*/
'code': FaceSDKResultCode;
}
/**
* The result code, see the [FaceSDKResultCode enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/).
* @export
* @enum {string}
*/
export declare const FaceSDKResultCode: {
readonly FACER_OK: 0;
readonly FR_IMAGE_EMPTY: 1;
readonly FR_FACE_NOT_DETECTED: 2;
readonly FR_LANDMARKS_NOT_DETECTED: 3;
readonly FR_FACE_ALIGHNER_FAILED: 4;
readonly FR_DESCRIPTOR_EXTRACTOR_ERROR: 5;
readonly FR_IMAGE_DECODE_ERROR: 6;
readonly FR_INTERNAL_ERROR: 7;
readonly FACER_CONFIG_ERROR: 199;
readonly FACER_NO_LICENSE: 200;
readonly FACER_IS_NOT_INITIALIZED: 201;
readonly FACER_COMMAND_IS_NOT_SUPPORTED: 202;
readonly FACER_COMMAND_PARAMS_READ_ERROR: 203;
readonly FACER_LESS_THAN_TWO_IMAGES_IN_REQUEST: 224;
readonly FACER_VIDEO_DECODE_ERROR: 227;
readonly FACER_NOT_ENOUGH_FRAMES: 228;
readonly FACER_OUTPUT_IS_NOT_DEFINED: 229;
readonly FACER_CLOSED_EYES_DETECTED: 230;
readonly FACER_LOW_QUALITY: 231;
readonly FACER_HIGH_ASYMMETRY: 232;
readonly FACER_FACE_OVER_EMOTIONAL: 233;
readonly FACER_SUNGLASSES_DETECTED: 234;
readonly FACER_SMALL_AGE: 235;
readonly FACER_HEADDRESS_DETECTED: 236;
readonly FACER_FACES_NOT_MATCHED: 237;
readonly FACER_IMAGES_COUNT_LIMIT_EXCEEDED: 238;
readonly FACER_MEDICINE_MASK_DETECTED: 239;
readonly FACER_OCCLUSION_DETECTED: 240;
readonly FACER_FOREHEAD_GLASSES_DETECTED: 242;
readonly FACER_MOUTH_OPENED: 243;
readonly FACER_ART_MASK_DETECTED: 244;
readonly FACER_ELECTRONIC_DEVICE_DETECTED: 245;
readonly FACER_TRACK_BREAK: 246;
readonly FACER_WRONG_GEO: 247;
readonly FACER_WRONG_OF: 248;
readonly FACER_WRONG_VIEW: 249;
readonly FACER_TIMEOUT_LIVENESS_TRANSACTION: 250;
readonly FACER_FAILED_LIVENESS_TRANSACTION: 251;
readonly FACER_ABORTED_LIVENESS_TRANSACTION: 252;
readonly FACER_GENERAL_ERROR: 253;
readonly FACER_PASSIVE_LIVENESS_FAIL: 254;
};
export declare type FaceSDKResultCode = typeof FaceSDKResultCode[keyof typeof FaceSDKResultCode];
/**
* @type FacesResponse
* @export
*/
export declare type FacesResponse = DetectionFace & FacesResponseAllOf;
/**
*
* @export
* @interface FacesResponseAllOf
*/
export declare interface FacesResponseAllOf {
/**
* Detected Persons.
* @type {Array<PersonWithImages>}
* @memberof FacesResponseAllOf
*/
'persons'?: Array<PersonWithImages>;
/**
*
* @type {number}
* @memberof FacesResponseAllOf
*/
'rotationAngle'?: number;
}
/**
* 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.
* @export
* @enum {string}
*/
export declare const FilterOp: {
readonly IN: "in";
readonly NOT_IN: "nin";
};
export declare type FilterOp = typeof FilterOp[keyof typeof FilterOp];
/**
* 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.
* @export
* @interface FilterSearchRequest
*/
export declare interface FilterSearchRequest {
/**
*
* @type {FilterOp}
* @memberof FilterSearchRequest
*/
'op'?: FilterOp;
/**
* `name` of the Person.
* @type {string}
* @memberof FilterSearchRequest
*/
'field'?: string;
/**
* The list of `name` values against which the `field` is compared.
* @type {Array<string>}
* @memberof FilterSearchRequest
*/
'value'?: Array<string>;
}
/**
* @type Group
* @export
*/
export declare type Group = GroupAllOf & GroupResponse;
/**
* Regula Face SDK Web API
* <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
*
* The version of the OpenAPI document: 7.2.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Additional group data in the response, includes id and createdAt.
* @export
* @interface GroupAllOf
*/
export declare interface GroupAllOf {
/**
* Group ID.
* @type {string}
* @memberof GroupAllOf
*/
'id'?: string;
/**
* Group creation date.
* @type {string}
* @memberof GroupAllOf
*/
'createdAt'?: string;
}
export declare class GroupApi {
private superClass;
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
createGroup(groupToCreate: GroupToCreate, xRequestID?: string, options?: AxiosRequestConfig): Promise<Group>;
deleteGroup(groupId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
getAllGroups(page: number, size: number, xRequestID?: string, options?: AxiosRequestConfig): Promise<GroupPage>;
getAllPersonsByGroupId(page: number, size: number, groupId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<PersonsPage>;
getGroup(groupId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<Group>;
updateGroup(groupId: string, groupToCreate: GroupToCreate, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
updatePersonsInGroup(groupId: string, updateGroup: UpdateGroup, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
}
/**
* @type GroupPage
* @export
*/
export declare type GroupPage = GroupPageAllOf & Page;
/**
*
* @export
* @interface GroupPageAllOf
*/
export declare interface GroupPageAllOf {
/**
* Array of Groups that are found during the search.
* @type {Array<Group>}
* @memberof GroupPageAllOf
*/
'items'?: Array<Group>;
}
/**
* Regula Face SDK Web API
* <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
*
* The version of the OpenAPI document: 7.2.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Response group create data, includes name and metadata.
* @export
* @interface GroupResponse
*/
export declare interface GroupResponse {
/**
* Group to create name.
* @type {string}
* @memberof GroupResponse
*/
'name'?: string;
/**
* A free-form object containing group\'s extended attributes.
* @type {{ [key: string]: any; }}
* @memberof GroupResponse
*/
'metadata'?: {
[key: string]: any;
};
}
/**
* Regula Face SDK Web API
* <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
*
* The version of the OpenAPI document: 7.2.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Request body of the group to create data, includes name and metadata.
* @export
* @interface GroupToCreate
*/
export declare interface GroupToCreate {
/**
* Session identificator.
* @type {string}
* @memberof GroupToCreate
*/
'tag'?: string;
/**
* Group to cre