Skip to content

[6.20.0] - Release Notes

This release adds new endpoints related to logging Custom Events in the API Tracking platform. It also removes legacy metadata in SelphIDFacialExtractionResult, which is no longer used by modern versions of the facial extraction engine.

Due to the recent inclusion of the SelphIDNoLiveDetails structure, it is no longer necessary to print liveness status codes to the log; therefore, they have been removed.

Log messages related to offline licensing have been reviewed, eliminating conflicting license activation messages.

Finally, the application for calculating the hostID, distributed with SelphID, selphid-license-activator, no longer depends on the SDK installation to run. It functions as a standalone application, requiring no environment variables to be configured.

Added

  • Improved support for Custom Events:
  • SelphIDVerifier::EvaluatePassiveLivenessTrackingEvent().
  • SelphIDVerifier::VoiceAuthenticationTrackingEvent().
  • New Custom Events endpoints:
  • /api/v1/selphid/custom-event/ocr/finish
  • /api/v1/selphid/custom-event/security/finish
  • /api/v1/selphid/custom-event/liveness
  • /api/v1/selphid/custom-event/liveness/finish
  • /api/v1/selphid/custom-event/voice/authentication
  • /api/v1/selphid/custom-event/voice/authentication/finish

Removed

  • Legacy SelphIDFacialExtractionResult deprecated metadata:
  • Lips
  • GeographicOrigin
  • Emotion
  • Artwork
  • FacialHair
  • Liveness status codes from logs. From now on, use SelphIDNoLiveDetails::GetReasonMessage().
  • 0xAB01
  • 0xAB02
  • 0xAB03
  • 0xAB04
  • 0xAB05
  • 0xAB06
  • 0xAB07
  • 0xAB08

Improved

  • selphid-license-activator runs as a standalone application, for obtain the HostID.

Removed

  • Offline licensing contradictory log messages.

API Contract Updates

Several fields have been removed from the REST API contract, relating to the FacialExtractionResult response:

  • lips
  • emotion
  • hair
  • origin
{
  "facialTemplate": "BAEBGgEroySjGz2C9iIki35J/FA...",
  "facialTemplateRaw": "BAEBAQHjF08R/Fbogyt7nysPd/K...",
  "updatedTemplateRaw": true,
  "face": { ... },
  "leftEye": { ... },
  "rightEye": { ... },
  "chin": { ... },
  "nose": { ... },
  "leftMouth": { ... },
  "rightMouth": { ... },
  "iod": 118,
  "yaw": 2.4,
  "pitch": -4.32,
  "roll": 0.7,
  "glasses": "Eye",
  "age": 45,
  --> Removed "lips": "Together", <--
  "gender": "Male",
  --> Removed "emotion": "Neutral", <--
  --> Removed "hair": 45.3, <--
  --> Removed "origin": "European", <--
  "mask": 0.89,
  "faceConfidence": 0.99,
  "facialQuality": "Good",
  "validTimeStamp": true,
  "tokenTimeStamp": "2022-01-14T10:42:05.521922Z",
  "sdkDuration": 1234
}

This affects the response of these endpoints:

  • /api/v1/selphid/extract
  • /api/v1/selphid/extract/template
  • /api/v1/selphid/authenticate-facial/images (Response fields extractionQuery and extractionTarget).
  • /api/v1/selphid/authenticate-facial/image/template (Response fields extractionQuery and extractionTarget).
  • /api/v1/selphid/authenticate-facial/templates (Response fields extractionQuery and extractionTarget).

New endpoints have also been added. This does not break the previous contract; it simply adds new functionality.

  • /api/v1/selphid/custom-event/ocr/finish
  • /api/v1/selphid/custom-event/security/finish
  • /api/v1/selphid/custom-event/liveness
  • /api/v1/selphid/custom-event/liveness/finish
  • /api/v1/selphid/custom-event/voice/authentication
  • /api/v1/selphid/custom-event/voice/authentication/finish

The complete API contract documentation can be reviewed at SelphID-SDK API REST reference.