OnboardingSession
One respondent's run through an onboarding flow.
idrequiredstring (uuid)- The session id.
flow_idrequiredstring (uuid)- The onboarding flow the session runs. Set on create; it cannot change.
user_idrequiredstring (uuid)- The investor or advisor the session belongs to. Set on create; it cannot change.
statusrequiredstring- in_progress until the respondent finishes, then completed, or expired once a reset or an expiry has voided it or a newer session of the same user and flow has replaced it. Read-only: step-back, reset and verify are actions.One of: in_progress, completed, expired
flow_testrequiredboolean- True for a test run of the flow, which never counts as the respondent's onboarding.
started_atrequiredstring | null (date-time)- When the respondent started the session.
completed_atrequiredstring | null (date-time)- When the respondent finished the flow. Null until then, and again after a reset.
verificationrequiredobject | null- The latest verification an administrator recorded, or null when the session has none.
flowobject- The session's onboarding flow. Only with include=flow.
created_atrequiredstring (date-time)- When the session was created.
updated_atrequiredstring | null (date-time)- When the session last changed.