Skip to main content

Start

The entry point of every flow, optionally declaring data blocks pre-supplied at session creation.

Every flow must contain exactly one Start step with the fixed ID "START". It is the first step executed when a session is created. The Start step is not user-facing and does not render any Player UI.

Use the inputs option to declare which data blocks the calling system supplies at session creation time. Any data block listed here will be available to downstream steps without needing to be produced by a prior step.


Key features

  • Single instance: Every flow must have exactly one Start step; its id must always be the literal string "START".
  • Pre-supplied data blocks: Declare data blocks provided at session creation via options.inputs. These are injected into the execution context before any step runs.
  • No Player UI: The Start step is not user-facing; it never renders a screen.
  • Exactly one outgoing transition: The Start step must have exactly one next transition leading to the first step of the flow.

Configuration

OptionTypeRequiredDescription
inputsstring[]NoList of data block types pre-supplied by the calling system at session creation. These are injected before the first step executes.

Valid values include: basicIdentity, extendedIdentity, documentData, userReference, documentsToSign, and all other types defined in the data blocks reference.


Input data blocks

This step does not consume any input data blocks.


Routes

RouteDescription
continueProceeds to the first step of the flow.

Output data blocks

RouteData blocks producedNotes
continueNo data blocks are produced by this step.

Example

{
"id": "START",
"type": "START",
"options": {
"inputs": ["basicIdentity", "userReference"]
},
"next": [
{
"route": "continue",
"nodeId": "doc-id-step"
}
]
}