Breaking Changes
All changes below are backwards compatible until the end of the notice period. Legacy SDKs and integrations will continue functioning as expected during this time. For renamed properties we will still output the previous names on the API endpoints. We’re happy to support your migration efforts via pair programming or dedicated meetings — feel free to reach out.
Delayed results on redirect
Delayed Result Handling: Advanced Sessions can now explicitly handle situations when results are not yet available during a redirect (e.g., due to pending webhooks or provider-side processing delays). Use the List Provider Contracts or Provider Capabilities pages to check for which providers this applies. Read more on Advanced Provider Session
Hosted Session Improvement: Our hosted session implementation now automatically waits for results to be available before completing the session flow.
Widget Session iFrame Launch Removed
Support for launching Widget Sessions inside an iFrame has been removed due to security issues with third-party cookie restrictions and provider compatibility. Use popup or redirect flows instead.
Provider ID Standardization
Provider identifiers (providerId) have been standardized. Updated IDs are available in the dashboard and APIs. Existing (legacy) IDs will continue to function for Hosted and Advanced session creation until the end of the notice period.
Hosted Session Input Removed
The input property for Hosted Sessions is now obsolete. This change eliminates confusion where lookup providers were already ready before launching, but a browser session still launched unnecessarily. For partial form entry or step-based logic, use the Advanced Sessions API, which offers similar capabilities with greater control.
API Field Renames
| Affected API | Old Field | New Field |
|---|---|---|
| List Providers | description | subtext |
| List Provider Contracts | description | subtext |
| Recommend Providers | providerId | id |
providerDisplayName | name | |
providerLogo | logoUrl |
Other Notable Changes
Immutable Test Mode
You must now explicitly set your app to either test or live mode via the dashboard. At the end of the notice period, your current setting will be locked in automatically.
Mobile handover
When using hosted sessions we will now hand the user over to their mobile phone when appropriate, similar as widget sessions did before. This ensures that camera that needs to be captured is of high quality and improves pass rates. For the Advanced Session API when fallbackToTrinsicUI is enabled it will also prompt this handover.
New API Properties
- Recommend Providers adds the properties
subtextandhealth. - List Providers adds the properties
logoUrl,subtext, andhealth. - Health-Based Filtering: Both Recommend Providers and List Providers now support filtering by the provider health status. The Recommendation API defaults to returning only providers that are online. Read more about Provider Health.