Bootstrap the widget runtime (the read-as-render endpoint).
GET /v2/widget/{kind}/{instance_id}
Returns the typed `WidgetRuntimeContext` for the bound recipient. Authenticates via the widget instance token on first call; sets the recipient session cookie on response. Subsequent calls within the journey authenticate via the cookie.
Operation
| Operation ID | bootstrapWidgetRuntime |
| Tags | Untagged |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| kind * | path | kind | |
| instance_id * | path | id | |
| X-DO-Parent-Origin | header | string | iframe mode; verified against allowed_parent_origins claim |
| Accept-Language | header | locale |
Responses
200
OK
object
| Field | Type | Description |
|---|---|---|
| id * | id | UUID v4. |
| type * | enum (1) | widget_runtime_context |
| instance * | WidgetInstanceRef | |
| recipient * | RecipientRef | |
| journey * | JourneyRef | |
| content * | WidgetContent | Discriminated union by `kind`. 8 variants per `02-widget-runtime.md` §4. |
| theme * | ResolvedTheme | |
| progress * | JourneyProgress | |
| recipient_session * | RecipientSession | |
| capabilities * | WidgetCapabilities | |
| computed_at * | emitted_at | RFC 3339 / ISO 8601 timestamp. |
| expires_at * | emitted_at | RFC 3339 / ISO 8601 timestamp. |
400
Validation, sort/filter, or window error.
schema
401
403
Forbidden (override required, scope insufficient, resource-level).
schema
404
409
Idempotency conflict or invalid state transition.
schema
Example request
GET https://api.digitalonboarding.com/v2/widget/{kind}/{instance_id}
Authorization: Bearer <partner-token>