Migration from version 1.x.x to version 2.x.x

Breaking Changes and Deprecations

The original offline enrollment endpoint ( /enrollment-data ) is now deprecated and will be removed. Most of its API stays the same except the error reporting. Since KA now uses new biometric SDK, error names completely changed.

The integrators are advised to switch to the new endpoint ( /v1/offline-enrollment ) as soon as possible or consider if online enrollment better suits their use-case.

Migration from /enrollment-data to /v1/offline-enrollment

With the new endpoint the integrator must choose scenario (using Scenario header). Scenario is similar to config query parameter in the old endpoint.

  • SELFIE scenario is similar to config=default in the old endpoint. This is also a default on old endpoint.

  • TRUSTED_SOURCE scenario is similar to config=less-strict in the old endpoint

  • DOCUMENT scenario has no equivalent in the old endpoint

The request body is the same.

The response now follows camelCase naming convention and stats field has been removed.

The error response is now more detailed and follows the same naming convention as the rest of the API.

Last updated

Was this helpful?