iOS - SDK Release Notes¶

Before migrating to a new version, check the "Does it Affect Implementation?" section.

v2.1.2.7003¶

📝 Changes¶

Core¶

• Sectigo Root Certificate Support: An additional validation layer has been added to the SSL certificate validation infrastructure through the embedded Sectigo root certificate on the device. This enhancement complements the Public Key SSL Pinning support added in v2.1.2.0.

OCR¶

• Canada AAMVA Driver License Support: A new document processing strategy has been added for reading and verifying Canadian driver licenses (compliant with AAMVA standard).
• Cyprus ID Corrections: Errors encountered in some scenarios on Cyprus ID cards and issues with setting the card number have been resolved.

VideoCall¶

• PiP (Picture in Picture) Mode Fix: A bug has been fixed that caused the PiP mode to remain active when the user returned from PiP mode to the application.

Face¶

• Stability and Performance Improvements: Bugs that caused intermittent application crashes in the facial verification module have been fixed, memory (RAM) consumption has been reduced by approximately 49%, and scenarios for false positive detections have been improved.

🔧 Does it Affect Implementation?¶

No — All changes in this version are automatically activated on the SDK side; no mandatory changes are required on the implementation side.

However, it is recommended to include regression testing for reading Canadian driver licenses, SSL connection scenarios, Cyprus ID reading, VideoCall PiP transitions, and the facial verification flow.

⚠️ Breaking Changes¶

There are no breaking changes in this version.

v2.1.2.0¶

📝 Changes¶

Core¶

• Advanced SSL Certificate Validation Solutions: In addition to the existing Base64 string and embedded .der certificate validation methods, support for certificate validation (SSL Pinning) using Public Key has been integrated.

OCR¶

• Enhanced Alignment Algorithm: With the transition to the new infrastructure, improvements have been made to automatically correct angular distortions in images taken from the camera, allowing identity recognition processes to continue with these optimized visuals.
• Security Elements and Visual Layer Separation: By separating the security elements on the identification from the core identity visuals, the processes for validation and data accuracy checks have been deepened.
• Performance and Resource Optimization: Camera frame and thread management have been restructured, minimizing the consumption of device resources (CPU/RAM).
• Text Recognition (OCR) Accuracy: Improvements in accuracy and speed have been made during the reading process of the characters and text fields on the identity.

VideoCall¶

• Remote Flash Control Capability: A feature has been included that allows the customer service representative to trigger the "device flash on/off" function that works with an end-user approval mechanism during a video call.

🔧 Does it Affect Implementation?¶

Yes — Some of the new features require action from the teams.

• Core / SSL Pinning: Teams wanting to use Public Key SSL Pinning must update the certificate validation method in the Core configuration to support Public Key. There is no mandatory change for teams currently using the Base64 string or embedded .der certificate validation methods.
• OCR alignment and visual security improvements: Teams utilizing the OCR module are not expected to make additional code changes; however, end-to-end testing should be conducted for front/back face reading, security element validation, error scenarios, and low-light/angled shooting scenarios.
• OCR performance optimizations: As camera frame/thread management has been optimized on the SDK side, no action is required on the implementation side. However, application-level camera permissions, flow transitions, and different device performances should be included in regression testing.
• VideoCall remote flash control: Teams that will use this feature should confirm that the flash on/off request sent by the representative in the VideoCall flow is managed with user approval. On the application side, camera/flash permissions, user approval screen behavior, and correct updates of flash status during the call should be tested.

⚠️ Breaking Changes¶

There are no breaking changes in this version.

v2.1.0.0¶

📝 Changes¶

➕ Added¶

1) VideoCall – PiP (Picture in Picture) Support¶

Support has been added so that PiP mode will be activated when the user backgrounds the application during a VideoCall.

Purpose: To allow the video call experience to continue in the background.

2) ModelV4 Service – Model Management and Backoffice Synchronization¶

The ModelV4 service has been added.

The model file is now embedded in the device and can be downloaded through the Backoffice in necessary scenarios.

Within the developments for Model V4:

• threshold values
• mandatory checks
• and management of similar model behaviors have been strengthened.

Visual security element analyses and threshold values can now be modified through the Backoffice.

3) SDK Sounds – Embedded in Device + Backoffice Sync¶

The sound files used in the SDK have been embedded in the device.

If the relevant sounds are updated on the Backoffice side, a mechanism has been added to ensure synchronization of the device with the Backoffice.

4) NFC Certificate – Embedded in Device + Backoffice Sync¶

The NFC certificate has been added to the device.

Codes managing the device's sync state with updates from the Backoffice have been added.

5) Base Model – useEmbeddedLocalSound Parameter (Global Sound Management)¶

A useEmbeddedLocalSound: NSNumber parameter has been added to the Base Model, allowing it to be used by all modules.

With this parameter:

• If there are embedded sound files in the project, their use is guaranteed as a priority.
• It prevents unnecessary requests for downloading sound files over Backoffice / network.

6) Hold Video¶

The ability to detect when the representative opens and closes the camera has been added through the Agent Request delegate.

When the representative opens the camera, the .camOpen case is transmitted; when they close it, the .camClose case is transmitted via the delegate.

This mechanism allows the hold video to be shown to the customer while the representative's camera is off. When the representative reopens the camera, the hold video is automatically closed, and the conversation continues live.

🔁 Changed¶

• Visual analysis behaviors (especially security elements and threshold checks) have become more dynamic; management has moved to the Backoffice side (with ModelV4 infrastructure).

🛠 Fixed¶

• UI corrections and improvements have been made for the Verbal Consent screen.
• When the application is backgrounded during the NFC flow, the process is stopped for security reasons.
• Various performance improvements and bug fixes have been made.

❌ Removed¶

There is no public API / function removed in this version.

⚠️ Breaking Changes¶

There are no breaking changes in this version.

🔧 Does it Affect Implementation?¶

Yes — Action is necessary for teams wanting to use new features.

• PiP: PiP delegates need to be added to the VideoCall module. Please refer to the VideoCall Module → PiP page for details.
• useEmbeddedLocalSound: Teams wanting to use this should add the parameter to the Base Model. It is not mandatory; if not added, the current behavior remains unchanged.
• Hold video: Teams wanting to use the .camOpen / .camClose events should update the Agent Request delegate. This is not mandatory.
• ModelV4, sounds, NFC certificate: No changes are required on the implementation side; the SDK manages this automatically.

v2.0.6.4¶

📝 Changes¶

1️⃣ OCR & Face Retry Flow Within VideoCall¶

1.1 General Flow¶

During the VideoCall process, the Agent may request to retry the OCR or Face verification steps.

In this case, the related retry flow is automatically initiated by the SDK.

1.2 Fail State¶

If the OCR or Face retry process falls into a Fail state:

• The user is provided the opportunity to restart the verification process at their request.

1.3 Retry Functions¶

The following two new functions have been added to the SDK:

EnQualifyVideoCall.ocrRetry()
EnQualifyVideoCall.faceRetry()
EnQualifyVideoCall.nfcRetry()

📌 Usage Rules

• These functions can only be called while active in a VideoCall session.
• They are not supported to be called outside of a VideoCall.

1.4 Delegate Flow¶

After the retry function is called, the following delegate methods are triggered by the SDK:

ocrRetryRequested()
faceRetryRequested()
nfcRetryRequested()

➡️ Implementing these delegates is mandatory on the implementation side.

2️⃣ Other Improvements & Fixes¶

• The problem that caused the Rotate button to completely disappear when the Rotate / Cancel buttons in the BackOffice were set to false has been resolved.
• Missing logs sent by BackOffice have been detected and added to the SDK.
• Timer issues during WiFi ↔ Cellular network transitions have been fixed.
• Ensured proper setting of the CallBusinessUID and businessReference values.

🔧 Does it Affect Implementation?¶

Yes — Action is necessary for teams who will utilize the retry flow within VideoCall.

After calling the retry functions, the following delegates must be implemented:

swift

ocrRetryRequested()
faceRetryRequested()
nfcRetryRequested()

If you are not going to use the retry feature, no changes are required in your existing implementation.

v2.0.6.2¶

📝 Changes¶

🔁 Changed¶

The agentRequest(event: VideoCallMoudule.AgentRequestEvent) delegate has been changed as follows:

agentRequest(
    event: VideoCallMoudule.AgentRequestEvent,
    lastEvent: VideoCallMoudule.AgentRequestEvent
)

➕ Added¶

A new stop function has been added to the NFC module:

EnQualifyNFC.nfcStopForBacktoVideoCall()

❌ Removed¶

The following function has been completely removed from the VideoCall module:

setupCallLayout(
    showRotateButton: Bool,
    showCancelButton: Bool
)

🔧 Does it Affect Implementation?¶

Yes — Before migrating to this version, the following two changes are required.

1. VideoCall Module Updates¶

1.1. Removed Function¶

The following function has been completely removed from the VideoCall module:

setupCallLayout(
    showRotateButton: Bool,
    showCancelButton: Bool
)

Reason:
The visibility of the buttons on the VideoCall screen will now be managed dynamically by the Back Office. Therefore, manual visibility control has been removed from the SDK side.

1.2. Updated Delegate Structure¶

Old delegate:

agentRequest(event: VideoCallMoudule.AgentRequestEvent)

New delegate:

agentRequest(
    event: VideoCallMoudule.AgentRequestEvent,
    lastEvent: VideoCallMoudule.AgentRequestEvent
)

Explanation:
The new delegate structure provides access to the previous event.

2. NFC Module Updates¶

2.1. NFC Stop Function¶

A new stop function has been added to the NFC module:

EnQualifyNFC.nfcStopForBacktoVideoCall()

Purpose of the Function¶

This function allows the safe termination of an ongoing NFC session in certain transition scenarios.

Usage Scenario (Important)¶

This function should be used when the following situation occurs:

1. During a VideoCall, the Agent sends a request for the user to retry reading an NFC.
2. While the NFC process is still ongoing, the BackToVideoCall operation is triggered.
3. Control is done through the agentRequest(event:lastEvent:) delegate:

event == .BackToVideoCall
lastEvent == .NFC

1. If NFC is still active, the following function should be called:

EnQualifyNFC.nfcStopForBacktoVideoCall()

v2.0.2.5¶

📝 Changes¶

🔁 Changed¶

• Compiled as GoogleMLKitFaceDetection v7.0.0.

➕ Added¶

No new features have been added in this version.

❌ Removed¶

There is no structure removed in this version.

⚠️ Breaking Changes¶

There are no breaking changes in this version.

🔀 Migration Guide¶

What Changed¶

In this version, an update of GoogleMLKitFaceDetection v7.0.0 has been made.

🔧 Does it Affect Implementation?¶

No — No changes are required on the implementation side.

v2.0.2.3¶

📝 Changes¶

🔁 Changed¶

• The layer remaining as garbage within the Camera Preview View has been removed at the end of the process.

➕ Added¶

No new features have been added in this version.

❌ Removed¶

There is no structure removed in this version.

⚠️ Breaking Changes¶

There are no breaking changes in this version.

🔀 Migration Guide¶

What Changed¶

A layer affecting cross-platform customers related to the Camera Preview screen has been removed.

🔧 Does it Affect Implementation?¶

No — No changes are required on the implementation side. User interaction during process terminations and screen transitions should be tested.

v2.0.2.2¶

📝 Changes¶

🔁 Changed¶

• The "Gender" information within CustomerIdentityDoc, which was previously obtained from the front side, can now be obtained from the back side.

➕ Added¶

No new features have been added in this version.

❌ Removed¶

There is no structure removed in this version.

⚠️ Breaking Changes¶

There are no breaking changes in this version.

🔀 Migration Guide¶

What Changed¶

The source from which the "Gender" information within CustomerIdentityDoc is read has been updated.

🔧 Does it Affect Implementation?¶

No — The change is on the SDK side. There is nothing to be done on the implementation side.

v2.0.2.1¶

📝 Changes¶

🔁 Changed¶

OCR & IDVerification¶

• The OCR and IDVerification identification structure will now be completely based on configuration obtained from the database.
• Improvements and additional verifications have been made specific to the Republic of Turkey TD1 IDs.
• Improvements have been made regarding the analysis of visual elements and the photographs taken.

Near Field Communication (NFC)¶

• Thermal Heat Detection has been added, monitoring device temperature in 4-second intervals before and during NFC operations.
• Logging has been detailed during the operation, at the time of error, and prior to it.

Face Detection & Liveness Verification¶

• Errors arising from putting the application in the background and then bringing it back during liveness have been fixed.
• Synchronization of movements with audio guidance during liveness has been ensured.
• The progress visual seen by the user during liveness has been optimized.
• Prevented multiple triggerings of the error page after going to the background & being brought to the foreground.
• States held during liveness have been made more detailed, and their reset after an error has been ensured.
• Data recorded for repeat operations after an error during liveness has been cleared.
• Data recorded for repeat operation after a successful process at the liveness step has been cleared.

VideoCall¶

• Improvements have been made regarding the logging live after connecting to the video call.

Core¶

• Improvements have been made on the logs on the network side.
• A State Manager has been added to perform Thermal Heat Detection.

➕ Added¶

OCR & IDVerification¶

• Configuration specific to countries and regions has been introduced along with the config file.

Face Detection & Liveness Verification¶

• For self-service customers, a video recording structure has been added during facial recognition and liveness.

Utility Module¶

• The EnQualify Utility Module has been added, which will manage features of EnQualify v2.0 planned to be performed before and after flows that are outside the flows.
• Functions written so far, such as Appointment, CallType, DocumentAdd, etc., have been moved to this module and communication has been established via the completion structure.
• The Document Signing feature has been added on top of this module.

❌ Removed¶

• Functions and the corresponding delegate methods within the EnQualify OCR & NFC & Face & VideoCall modules that have been transferred to the Utility Module have been removed.

⚠️ Breaking Changes¶

• Changes made in the idDocTypeCheckVerified delegate
• Changes made in the idDocFrontVerified delegate

🔧 Does it Affect Implementation?¶

Yes — Due to the addition of the Utility Module, updates are needed in existing implementations.

Functions and delegates removed from the OCR, NFC, Face, and VideoCall modules have been moved to the Utility Module. The main affected areas are:

• The idDocTypeCheckVerified delegate has changed.
• The idDocFrontVerified delegate has changed.
• Functions such as Appointment, CallType, DocumentAdd, etc., should now be called through EnQualifyUtility.

Please refer to the Utility Module page for detailed usage.

🧪 Important Considerations During Testing¶

• The flow should be tested end-to-end.