Reference

Cases

Case objects, statuses, and review states for Klarefi intake workflows

Case Object

A case represents one intake packet moving from submission to review. It keeps the applicant session, documents, extracted facts, gap history, review state, and integration metadata together.

Common Fields

  • case_id: Klarefi case identifier
  • external_case_id: Identifier from your system
  • workflow_id: Workflow used to evaluate the intake
  • status: Current case state
  • facts: Extracted and reviewed fact set
  • documents: Documents associated with the case
  • review_state: Human review state when applicable
  • metadata: Customer-provided operational metadata

Status Guidance

Use case status for workflow orchestration and operator queues. Use fact status for item-level review. A case can be generally ready while one fact remains review-only, depending on your workflow policy.

On this page