Changelog

[5.9.0]

Improved

Passive liveness engine to detect new cases spoofing such as faceswap or deepfake.

[5.8.1]

Added

Rest-Api service accepts an external config.json file with webserver startup details.
Rest-Api service accepts user path for USAGE_PATH and DEBUG_PATH.
New page to documentation with Rest-Api docker service installation instructions.
New page to documentation with Kubernetes deploy instructions.

Improved

Facial TemplateRaw reduces pattern extraction failures.

Fixed

Service /health endpoint.

[5.8.0]

Added

New improved TemplateRaw to optimize extractions and gallery searches.
SelphIDFacialExtractionResult::GetUpdatedTemplateRaw() to know if templateRaw has been updated.
FacialExtractionResult::updatedTemplateRaw in Rest-Api service endpoints.

[5.7.0]

Added

New FaceDetector: Implemented new face detector that reduces FTA as it´s more tolerable to low conditions, extreme angles and other difficult scenarios.
New pipeline that offers more security against PAIs (displays and mask).
Image formats WebP and TIFF are not allowed.

queueDuration on service endpoints to know how long an http request is queued awaiting resolution.

{
    "authStatus": "Positive",
    "queueDuration": 35,
    "sdkDuration": 694,
    "similarity": 1.0,
    "trackingMessage": "",
    "trackingStatus": -1,
    "validTimeStamp": true
}

[5.6.1]

Added

longDetail to options in service endpoints. If true the endpoints result will include extra information. If omitted, will be default to false.
If options:longDetail==true, extractionQuery and extractionTarget (both of type FacialExtractionResult) will be added to FacialAuthenticationResult in service authentication endpoints.
/api/v1/selphid/authenticate-facial/images.
/api/v1/selphid/authenticate-facial/image/template.
/api/v1/selphid/authenticate-facial/templates.

[5.6.0]

Added

IAD (Injection Attack Detection) prefiltering for liveness engine. Detects Bands to edges and Scaled nearest neighbor.
Some improvements in base64 library.
Added SelphIDFacialExtractionResult::Set/GetValidTimeStamp().
Added SelphIDDocumentResult::Set/GetValidTimeStamp().
New sdkDuration property in endpoints responses from service.
New validTimeStamp property in endpoints responses from service.

[5.5.4]

Added

New FACEPHI_SELPHID_FACIALAUTHENTICATION_THRESHOLD config parameter.
New SetCustomFacialAuthenticationThreshold() method in SelphIDVerifierOptions.
JSON "options":"authThreshold" parameter in service endpoints.
Service /version endpoint returns a JSON object, instead a string.

[5.5.3]

Fixed

Fix .NET::String std::string conversions with Unicode characters.

[5.5.2]

Added

Sign .NET DLL.
Rest-Api service config file (port, threads, timeout, keep alive).

Fixed

Vulnerabilities in logs.

Removed

Rest-Api service command line options -threads, -timeout, -kAlive.

[5.5.1] - Internal release

Fixed

Rest-Api extraData issue in liveness endpoint.

[5.5.0]

Added

Implemented new facial passive liveness engine.
New humanized_timestamp value in Rest-API C++ logger.
Rest-API C++ logger output to file.

Changed

Rest-Api service is not running as root. Now user is facephi.

Removed

Support for Ubuntu GPU version.

[5.4.0]

Added

Liveness engine prefiltering for IAD cases (Injection Attack Detection).

[5.3.0]

Added

SelphIDVerifierOptions to Rest-API C++.
faceConfidence and facialQuality into /extract endpoint result.
Postman examples with Rest-API options.
New scheme to Swagger with Rest-API options.

Changed

Improved logger in Rest-API server.
- Json-parseable outputs.
- Headers with user custom data.
- Log levels.
- Detailed operation results.
More acurate facial extractor in FacialDetectionType::Frontal. SelphID defaults to FacialDetectionType::FrontalFast.
Liveness engine new configuration that accepts low quality images.

Removed

Deprecated endpoints from Swagger documentation.

[5.2.2]

Fixed

Crash in /api/v1/selphid/extract endpoint with invalid images.

[5.2.1]

Added

New docker rest api /api/v1/selphid/extract/template endpoint.

[5.2.0]

Added

Implemented new facial passive liveness engine.
New docker rest api /api/v1/selphid/identify/galleries endpoint.
New docker rest api /api/v1/selphid/identify/clear/all endpoint.
New public method GetAllGalleries.
METADATA event to API Tracking.
New public method SelphIDVerifierOptions::SetFalseDetectRate(). Important: Please contact with FacePhi before change this parameter.
New file /doc/FPhi.Sdk.SelphId.RestApi.PostmanTest.json for full testing RestApi C++ endpoints.

Changed

Rest api docker image reduced from 1.33Gb to 778Mb.
New field source in SelphIDVerifier::AuthenticateFacialTrackingEvent() for custom events.
New field source in SelphIDVerifier::OcrTrackingEvent() for custom events.
New parameter eventSource in /api/v1/selphid/custom-event/authentication.
New parameter eventSource in /api/v1/selphid/custom-event/onboarding.
Improved info about environment variables in installation_instructions.md.

[5.1.1]

Added

New base64 library that increases C++ REST API response times.
Execution time in API Tracking events.

Changed

Optimization of exception handling for the C++ REST API improving response times.
Api tracking family always taken from extraData.

[5.1.0]

Added

REST API C++.
Swagger specification.
/v1 version endpoints.
New /api/v1/selphid/extract endpoint.
New /api/v1/selphid/identify/enroll/template/{{identifyGalleryId}}/templateId endpoint.
New /api/v1/selphid/identify/template/{{identifyGalleryId}} endpoint.
New /api/v1/selphid/identify/clear/{galleryId} endpoint.
New /api/v1/selphid/version endpoint.

Deprecated

../tracking endpoints.

[5.0.0]

Added

Implemented new authentication engine.
Added LatinAmerican, MiddleEastern, SoutheastAsian to FacialGeographicOrigin.
Added SelphIDFacialExtractionResult::Set/GetLeftMouth().
Added SelphIDFacialExtractionResult::Set/GetRigthMouth().
Added SelphIDFacialLivenessResult::Set/GetValidTimeStamp().
Added SelphIDVerifier::SetMultitenantMode() and SelphIDVerifier::IsMultitenantEnabled() to change Mono/Multitenant mode at runtime.
Key SELPHID_DEFAULT_TRACKING_EVENT_SOURCE is optional (defaults to 'backend.sdk').
Postman examples in MonoTenant and Multitenant.
Added new example endpoint /health to check if SelphID-SDK is running and listening.

Changed

SelphIDFacialExtractionResult::Set/GetNoseRoot() renamed to Set/GetNose().

Deprecated

Deprecated FacialDetectionType::Periocular.

[4.6.0]

Added

Implemented new facial passive liveness engine, with eyes closed detection and facial occlusion detection.

Removed

Support for CentOS 7.

[4.5.5]

Added

New method SelphIDVerifier::SetTrackingProxy() to make calls to the Tracking API through a proxy server.
New method SelphIDVerifier::SecurityInfoTrackingEvent() to send a "SECURITY_INFO_DATA" event in API Tracking.

Removed

Method SelphIDVerifier::SecurityTrackingEvent(). Use instead SelphIDVerifier::SecurityInfoTrackingEvent().

[4.5.4]

Minor changes in documentation about 1:n performance.

[4.5.3]

Added

New method SelphIDVerifier::SecurityTrackingEvent() to send a "SECURITY_DATA" event in API Tracking.

[4.5.2]

Added

New enum TrackingFamily with the OnBoarding or Authentication field for API Tracking events.
New method SelphIDVerifier::AuthenticateFacialTrackingEvent() to send a "Facial authentication" event in API Tracking.
New method SelphIDVerifier::FinishTrackingEvent() to send an "Operation result" and a "Step change finish" events in API Tracking.

Removed

Methods SelphIDVerifier::AuthenticateFacialWithRawDocumentFinish() and SelphIDVerifier::AuthenticateFacialFinish(). Employ the methods described above instead.

[4.5.1]

Added

New enum OperationResultStatus with the reason field for API Tracking finish events.
New enum OperationResultReason with the status field for API Tracking finish events.

Changed

Parameters in SelphIDVerifier::AuthenticateFacialWithRawDocumentFinish() and SelphIDVerifier::AuthenticateFacialFinish(). bool success has been changed to OperationResultStatus status and OperationResultReason reason.

[4.5.0]

Added

New methods for custom events: SelphIDVerifier::OCRTrackingEvent(), SelphIDVerifier::SetTrackingEventSource().
New result class SelphIDApiTrackingResult.
New endpoint in examples custom-event/ocr/tracking for custom OCR tracking.
Postman request to custom-event/ocr/tracking.

Fixed

Example applications return server message.

Removed

SelphID GDPR versions for Windows and Linux.

[4.4.0]

Added

New facial passive liveness engine implemented.
Technical documentation in the final distributable package.
FacialLivenessDiagnostic::NoneBecauseEyesClosed.
SelphIDFacialExtractionResult::FacialMask().
New chapters Facial Extraction Methods and FacialExtractionResult in Api Reference Guide.

Fixed

.NET Api documentation now includes the SDK enum class data types.
Vulnerability in AuthenticateFacialWithExtractionResults and AuthenticateFacialWithFacialTemplates.

[4.3.1]

Fixed

Bug when AuthenticateFacialWithRawTemplates is called and no face is detected.
Java getPtr() methods are marked as "internal use" in API documentation.
Spoof, Uncertain and FrontalFast results are marked as deprecated in API documentation.

[4.3.0]

Added

Support for multi-tenant API Tracking.
Tracking status in example applications (Java/.NET).

[4.2.2]

Fixed

Bug when EvaluatePassiveLivenessWithTokenBuffer is called without permissions for the template raw image extraction in license.

[4.2.1]

Added

NoLive value to FacialLivenessDiagnostic.
ErrorConfigVarsEmpty value to SelphIDExceptionType.
ErrorInstallPathEmpty value to SelphIDExceptionType.
ErrorLivenessDataPathEmpty value to SelphIDExceptionType.
ErrorLoadingFacialLibrary value to SelphIDExceptionType.
ErrorLoadingLivenessLibrary value to SelphIDExceptionType.
ErrorProcessingFacial value to SelphIDExceptionType.
ErrorProcessingLiveness value to SelphIDExceptionType.
ErrorGalleryFile value to SelphIDExceptionType.
CentOS 7 compatibility.

Changed

Restored Uncertain value from FacialAuthenticationStatus and FacialLivenessDiagnostic.
Restored FrontalFast value from FacialDetectionType.
Orchestrator methods VerifySelphIDWithImageRawTemplate, VerifySelphIDWithRawTemplates only run the liveness test if the authentication is positive.

Deprecated

Uncertain value in FacialAuthenticationStatus and FacialLivenessDiagnostic.
FrontalFast value in FacialDetectionType.
Spoof value in FacialLivenessDiagnostic, employs NoLive instead.

[4.2.0]

Added

Tracking result to SelphIDDocumentResult, SelphIDFacialAuthenticationResult, SelphIDFacialLivenessResult.
Tracking config parameters in license.
Orchestrator methods VerifySelphIDWithImageRawTemplate, VerifySelphIDWithRawTemplates.
Permissions for the template raw image extraction in license.
Windows GDPR version.

Security

Fixed Maven vulnerability.

Updated

Liveness engine to latest version.

Removed

Api tracking config file.

[4.1.1]

Added

FacialLivenessDiagnostic::NoneBecauseFaceOccluded.
New configurable variables into API tracking config file.

Changed

Renamed version rhel7_x64 to linux64 (folders, scripts, etc).

[4.1.0]

Added

New methods into SelphIDVerifier to perform tracking events.

Removed

Uncertain value from FacialAuthenticationStatus and FacialLivenessDiagnostic.
FrontalFast value from FacialDetectionType.

[4.0.5]

Added

Variable liveness threshold FACEPHI_SELPHID_FACIALLIVENESS_THRESHOLD

Security

Fixed spring-boot vulnerability

[4.0.4]

Added

New facial passive liveness engine implemented.

[4.0.3]

Added

New methods into SelphIDDocumentResult to get/set extra data information.

[4.0.2]

Changed

Restored Uncertain value from FacialAuthenticationStatus and FacialLivenessDiagnostic.
Restored FrontalFast value from FacialDetectionType.

[4.0.1]

Removed

Unused and duplicated libraries.

[4.0.0]

Added

New facial biometric engine implemented. Facial templates of type FacialTemplate are now incompatible with previous versions.
New facial passive liveness engine implemented.

Removed

Uncertain value from FacialAuthenticationStatus and FacialLivenessDiagnostic.
FrontalFast value from FacialDetectionType.

[3.3.0]

Added

Implemented new function to query all indexes in a gallery that match templateID.

[3.2.0]

Added

New facial passive liveness engine implemented.

[3.1.0]

Added

New facial passive liveness engine implemented.
New facial template remove functionality on memory gallery implemented.

Deprecated

Authentication threshold Uncertain marked as deprecated.

Fixed

Bug in database count.

[3.0.0]

Added

New facial biometric engine implemented. Facial templates of type FacialTemplate are now incompatible with previous versions.
New licensing application selphid-license-server based on network licensing.
New application for performance evaluation selphid-eval-performance.

Changed

VisualC++ 2017 runtime upgrade required.
Unified app names selphidLicenseActivator_linux_x64 and FPhiSelphIDLicenseActivatorWin32 to selphid-license-activator.

Removed

Deprecated Ethnicity attributes.
Deprecated QualityThrehold(float) from SelphIDVerifierOptions.

Fixed

Bug in jni function authenticateWithExtractionResults.

[2.4.0]

Added

FacialTemplate authentication implemented.

[2.3.2]

Fixed

Bug in concurrent remote license usage in facial authentication functionalities.

[2.3.1]

Added

New SelphID SDK GDPR compatible.

[2.3.0]

Added

New SelphIDVerifier initialization from environment variables.
New liveness evaluation functionality from token template.

[2.2.2]

Added

FacialTemplate segregation implementation through build options.
Expiration date validation on SelphID license.
New passive liveness engine implemented.
Console output implementation for debugging purposes.

Fixed

Bug on C# REST programming examples.
Bug on Artwork initialization.
Documentation revision.

[2.2.1]

Added

New facial passive liveness engine implemented.

Fixed

Bug on C# REST programming examples.
Bug on java/jni wrapper.

[2.2.0]

Added

New facial biometric engine implemented. Facial templates of type FacialTemplate are now incompatible with previous versions.
New 1:N in memory functionalities implemented.
New C# REST programming examples for biometric authentication.
Artwork and GeographicOrigin functionalities implemented.
GetVersion functionality implemented for facialTemplate biometric pattern.
New threshold implementation for 1:N identification functionalities.
New C# REST programming examples for biometric identification.

Changed

New usageLogging reimplemented from database to files.

[2.1.0]

Added

New facial biometric engine implemented. Facial templates of type FacialTemplate are now incompatible with previous versions.
Initial facial passive liveness engine implemented.
Hostname licensing implemented.
Hostname retrieving implemented.
MaxPoseThreshold in SelphIDVerifierOptions implemented.
MinFaceQuality in SelphIDVerifierOptions implemented.
Global licensing system signature for json files.

Changed

Minimum requirements upgrade to rhel7 x64.
Upgraded facial authentication security threshold.

Deprecated

QualityThreshold marked for deprecation.

[2.0.0]

Added

New facial biometric engine implemented. Facial templates of type FacialTemplate are now incompatible with previous versions.
FacialTemplateRaw segregation implementation through build options.
Dotnet programming example added.

Changed

Demographic functionalities refactorized.