This section documents changes to existing Incode behavior that require action from your integration: features being retired, endpoints being replaced, and defaults being changed. Each page states what is changing, who is affected, the enforcement date, and the replacement path.
Review this section whenever you plan integration work. Changes listed here have fixed enforcement dates, and most have no grace period.
Active Migrations
| Change | Enforcement date | Who's affected |
|---|---|---|
| Moving off session restarts | TBD | Any integration that calls omni/start with an interviewId or externalId that already exists |
| Step-up and additional checks | Depends on scenario | Any integration that restarts a completed session to add a signature, document, module, or acceptance after the original onboarding |
Pages
- Moving off session restarts: Retires the ability to restart an existing session with
omni/start, and covers the replacement paths: admin-token reads, new sessions linked byidentityId, and new sessions per attempt. - Step-up and additional checks: Covers the replacement paths for running an extra check or collecting another document for a person who is already verified: document signatures, expired document updates, non-scoring additions, and Government Record Verification and Video Selfie. Also explains why retroactive module runs are not supported.
How to Use These Pages
- Check whether you're affected. Each page opens with an At a glance summary naming the affected call sites and how to find them in your own code.
- Identify your scenario. A single integration may hit the same deprecation for several different reasons, each with its own replacement. Work through the scenarios in order.
- Migrate before the enforcement date. Replacement paths are generally available well ahead of enforcement, so you can switch incrementally rather than in one cutover.
- Remove the old path. Migration is not complete until the deprecated call site is gone.