Delete Local Session Data

Delete all local user data that was collected during onboarding from the device by calling deleteLocalUserData. This method removes session-scoped data only; it does not affect locally stored identities added via addFace or setFaces for 1:N FaceAuthMode.local Face Login.

Use this method after onboarding completes to clear session data on the device, or when complying with data retention requirements.

When to call deleteLocalUserData

Do not call deleteLocalUserData before finishFlow(). Calling it before finishFlow() will prevent the onboarding session from completing.

• After startOnboarding, startFlow, or startWorkflow: Call deleteLocalUserData after the user completes all steps in the flow. It is safe to call this method in the body of or after any of these callbacks: onSuccess, onError, and onUserCancelled.
• After startNewOnboardingSection: If you are using section-based flows, do not call deleteLocalUserData between sections or modules. Call it only after the user has completely finished the custom flow, and only after finishFlow().

Delete local user data

await IncodeOnboardingSdk.deleteLocalUserData();

deleteLocalUserData is asynchronous but returns no result. Your app can await the call to know when the deletion has completed, but there is no success or failure value to check and no error conditions to handle.