Session Object

A session is the applicant-facing intake container. It stores the hosted URL, workflow, applicant context, answer state, document state, and submission status.

Common Fields

• session_id: Klarefi session identifier
• hosted_url: Applicant URL for the hosted intake flow
• workflow_id: Workflow assigned to the session
• external_case_id: Your source-system reference
• status: Session lifecycle state
• expires_at: Session expiration timestamp
• metadata: Customer-provided operational metadata

Lifecycle

Create a session from trusted server-side code. Redirect the applicant to the hosted URL. Subscribe to webhook events for state changes, and read current state from the API when you need the latest record.