The lifecycle of an onboarding, from creation through to Finalized.
Statuses
InvalidOngoing: missing or incorrect required info.
⇄ValidOngoing: all required info present.
→FinalizedOnboarding complete.
| Status | Explanation |
|---|
Invalid (ongoing) | - This is the first status assigned to an onboarding when using the frontend.
- If using the API, this is the first status if not all required information is included with your mutation.
- Status might change back to
Invalid if required information is removed or if some information is incorrect.
Next steps: Submit or update required information to advance to Valid (both you and the end user can submit or update information). |
Valid (ongoing) | - This is the first status assigned to an onboarding if using the API and you included all required information with your mutation.
- Status changes to
Valid when missing required information is submitted or if incorrect information is updated.
Next steps: User completes form, clicks "Finalize," and provides consent to complete the onboarding process. |
Finalized | Onboarding completed. |
To see how the actors interact during an onboarding, review the API sequence diagram on the onboarding concept page.