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

Authorizations

Authorization
string
header
required

Per-client API key (M2M). Presented as Authorization: Bearer <key>.

Headers

X-Brand-Id
string
required

Your brand id (brd_...). It must be one of the brands your API key's account owns; with a publishable key it must be the one brand the key was issued for. A missing or malformed value is refused with 400, and an unknown or foreign brand with 404.

Pattern: ^brd_[A-Za-z0-9][A-Za-z0-9_-]*$

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
legitscript_timeline
object

Present when the journey API composes the catalog certification read and the onboarding has the LegitScript step: the step's status timeline in plain words (no vendor codes, no staff details).