Skip to main content
GET
Read a client's onboarding progress

Path Parameters

onboarding_id
string
required
Pattern: ^onb_[A-Za-z0-9][A-Za-z0-9_-]*$

Response

the client-visible progress

A client's onboarding progress in plain language: which step of how many, what is waiting on the client, and whether this is test mode. Presentation only; it never carries clinical data.

blocked_on_client
string[]
required

what we're currently waiting on the CLIENT for (plain-language)

complete
boolean
required
onboarding_id
string
required
Pattern: ^onb_[A-Za-z0-9][A-Za-z0-9_-]*$
plain_language
string
required
step_number
integer
required
test_mode
boolean
required
total_steps
integer
required