Added​

Device groups​

Added support for the device groups feature.

For configuration details, see the Device groups documentation.

Missing authentication method error code​

Added error code serverErrorMissingAuthMethod, which indicates that the authentication method required for the operation is missing.

Changed​

Secure credential handling​

Changed the activation and authentication APIs to support secure credential handling for Payment Services Directive 2 (PSD2) compliance.

PIN, activation code and recovery code parameters now require NSMutableString instead of String or NSString. This enforces credential handling that allows for secure memory overwriting immediately after use.

The following parameters now accept NSMutableString:

• AuthMethod.pin(value:)
• startActivationWithCode(_:)
• RecoveryMethod.backupRecoveryCode(_:)

For migration guidance, data classification and memory management, see the Security best practices documentation.

Encryption algorithms and keys​

Improved security for compliance with NSM/NIST:

• End-to-end encryption algorithms changed to X25519 and AES-GCM.
• Increased salt encryption key length to 32 and changed algorithm to AES-CTR.

Removed​

Offline authentication​

Removed the offline authentication feature.

Offline authentication error codes​

Removed error codes:

• clientErrorOfflineVersionNotSupported
• clientErrorOfflineParsingFailed
• serverErrorClientOnlyDisallowed

Added​

Risk parameters​

Added the following new risk parameters:

• SSID
• BSSID
• Gravity
• Magnetometer
• IsProxyEnabled
• IsVpnEnabled
• timeZone
• Locale

Invalid client data error code​

Added the error code clientErrorClientDataInvalid for client data passed to the start authentication operation that:

• Exceeds 1024 bytes when UTF-8 encoded.
• Contains one or more 4-byte UTF-8 characters, including most emojis.

Changed​

Minimum iOS version​

Raised the minimum iOS version to 15.0.

Recovery method enum entry​

Renamed the recovery method enum entry:

Invalidated authentication method error code​

Changed the error code returned when an authentication method is deactivated locally due to invalidation, to align with Android:

Removed​

Authentication required error code​

Removed SDK error code serverErrorAuthenticationRequired.

Added​

Face scan recovery​

Added the face scan recovery method:

RecoveryMethod.backupServerSideFace(
    faceScanData: FaceScanData
)

Server-side face recovery initialisation​

Added the following optional field to startRecoveryResult:

serverSideFaceInit: ServerSideFaceInitResult?

Location configuration​

Added new EncapConfig property locationEnabled.

For configuration details, see the Location documentation.

Removed​

Objective-C API​

Removed EncapAPI (the Objective-C API).

Authentication and session error codes​

Removed error codes serverErrorAlreadyAuthenticated and serverErrorExpiredSession.

Added​

Server-side face authentication​

Added the server-side face authentication method:

AuthMethod.serverSideFace(faceScanData: FaceScanData?)

You can use this method to activate a registration when the end-user has forgotten their PIN and has no valid biometrics.

Add or update parameters​

Added the following EncapController method:

startAddOrUpdate(
    startAddOrUpdateParameter: StartAddOrUpdateParameter
)

You can choose the parameter for your use case:

• For server-side face authentication, you can use:

  StartAddOrUpdateParameter(
      selectedAuthMethod: .serverSideFace(faceScanData: FaceScanData())
  )
  

• To pass client data, you can use:

  StartAddOrUpdateParameter(clientData: String)
  

Changed​

Minimum iOS version​

Raised the minimum iOS version to 14.0.

Deprecated​

Add or update method​

Deprecated the following method:

startAddOrUpdate(clientData: String)

Removed​

Push delegate​

Removed the push delegate EncapPushDelegate.

Push notification methods​

Removed the following methods:

• initWithDelegate
• didFinishLaunchingWithOptions
• didReceiveRemoteNotification

Touch ID authentication​

Removed support for authentication method AuthMethod.touchID. Use AuthMethod.strongTouchID instead.

Weak hashing algorithms​

Removed support for weak hashing algorithms, such as MD4, MD5 and SHA-1.

Changed​

Documentation improvements​

• Restructured the documentation to improve usability.
• Rewrote multiple sections.
• Added examples that are easier to copy and paste.

Removed​

App Attest validation error code​

Removed the error code serverErrorAppAttestValidationFailed. App Attest validation failures now return serverErrorIncorrectResponse.

Changed​

Bitcode builds​

We no longer build EncapAPI and EncapSwiftAPI with bitcode.

Removed​

Intermediate push feature​

Removed the intermediate push feature.

Available authentication methods​

Removed the deprecated availableAuthMethods.

Added​

Client debug data​

Added the client debug data feature.

Time Sensitive Notifications​

Added support for Time Sensitive Notifications.

Apple app extensions​

Added the Apple app extensions feature.

Changed​

Minimum iOS version​

Raised the minimum iOS version to 12.0.

Deprecated​

Available authentication methods​

Deprecated availableAuthMethods. Use authMethodsForActivation and authMethodsForAuthentication instead.

Touch ID authentication​

Deprecated EncapDeviceTouchIDAuthParameter and EncapAuthMethodDeviceTouchID. Use EncapAuthMethodDeviceStrongTouchID instead.

Added​

App attestation​

Added support for the app attestation feature.

Simulator architecture​

Added support for the arm64-simulator architecture.

Changed​

Push notification handling​

Simplified push handling with handleNotification().

Added​

Geofencing​

Added the geofencing feature.

Changed​

Minimum iOS version​

Raised the minimum iOS version to 11.0.

Bitcode builds​

All builds contain bitcode.

Removed​

Signing feature​

Removed the signing feature.

Obfuscated API version​

Removed the encap-ios-api-obfuscated version.

Added​

Push notification sound​

Added APNS_NOTIFICATION_SOUND_ENABLED to application configuration. You can enable it to include the default notification sound in the APS payload.

Registration recovery​

Added support for recovering a registration from an iCloud or computer backup.

Changed​

Minimum iOS version​

Raised the minimum iOS version to 10.0.

Tokenised operations​

The SDK uses EncapToken for tokenised operations.