Running a journey
What the customer sees when a journey runs inside your app, and how it uses the phone's camera.
A journey in your app is the same journey your customers open from its link: the pages, branding, languages, branches and services you published in Institution Admin. When you publish a new version, your app shows it at the next start — there is no app release to make.
Choosing the journey
Each published work flow has a customer link ending in its id, for example `https://onboarding.bank.example/screens/3f2c9a1e-0000-4000-8000-000000000000`. Pass that id to `startJourney`. You can run different work flows from different places in your app — an account opening from one screen, a loan application from another.
What is checked first
Before anything is shown, the SDK asks your institution whether it may start. The answer depends on the settings in Institution Admin at that moment:
- the key is active and belongs to the environment's institution;
- your app is on the environment's allowed list;
- new journeys are not paused by the kill switch;
- this SDK version is not older than the minimum you set.
If any check fails, your listener or delegate is told why and nothing is shown. See Events and errors.
Documents, selfies and liveness
Wherever the journey asks for an identity card, a passport page or a selfie, Take photo opens the phone's camera with a guide frame: card-shaped for a document, an oval for a face. The customer can switch between the front and back cameras. Photos are straightened, sized for upload and sent to your institution; they are not kept on the phone.
A liveness step captures the customer's face with the front camera in the same way, and the verification step that follows in your work flow assesses it.
The first time a step needs the camera, the customer is asked for permission in your app's words. If they refuse, the journey stays on the step so they can change their mind in Settings.
Leaving and coming back
The customer leaves the journey with the back button on Android or the close button on iOS. An unfinished application is kept by your institution. When the customer starts the same work flow again — in your app or on the web — they can continue it after proving it is theirs with a one-time code, without typing their answers again.
Links inside a journey
A link in a journey to anywhere other than your journey host — your terms, for example — opens in the phone's browser, so the customer never loses their place.