Skip to main content

Retry prompt (v1)

Preview / Alpha

This version of this step type is in preview / alpha. The functionality and subsequently the documentation can still change.

Presents the user with a retry or abandon choice after a verification step is cancelled​

Retry prompt (v1) is a lightweight step that appears after a verification step is cancelled. It asks the user whether to retry that step or abandon the session. It has no configuration options and produces no data blocks — its only output is the user's decision, expressed as a route.

Pair it with a verification step such as Verifying ID document (v3). Connect the verification step's cancelled route to the Retry prompt (v1) step, then connect the Retry prompt's retry route back to the verification step as a rollback. If the user chooses to abandon, the session ends straight away, so you don't need a route for that.

Key features​

  • Zero-config interstitial: No configuration options and no output data blocks. The step's only function is capturing the user's retry or abandon decision.
  • Rollback routing: The retry route must use a rollback transition, which restores the flow to the upstream verification step and makes its prior data blocks available again.
  • Attempt cap: rollback.maxAttempts limits how many retries the user may make before the session aborts automatically.
  • Implicit abandonment: When the user chooses to abandon, the session terminates immediately — no explicit abandon route is needed.

Configuration​

This step has no configuration options.

Example wiring​

[
  { "id": "SPHINX", "type": "SPHINX:v3",
    "options": { "config": { ... } },
    "next": [
      { "port": "verified",       "id": "END_ACCEPTED" },
      { "port": "fraud_detected", "id": "END_REJECTED" },
      { "port": "cancelled",      "id": "RETRY_PROMPT" }
    ]
  },
  { "id": "RETRY_PROMPT", "type": "RETRY_PROMPT:v1", "options": {},
    "next": [
      { "port": "retry", "id": "SPHINX", "type": "rollback", "rollback": { "maxAttempts": 3 } }
    ]
  },
  { "id": "END_ACCEPTED", "type": "END", "options": { "outcome": "accepted" }, "next": [] },
  { "id": "END_REJECTED", "type": "END", "options": { "outcome": "rejected" }, "next": [] }
]

Input data blocks​

This step does not consume any input data blocks.

Routes​

RouteDescription
retryUser chose to retry. Must be a rollback transition pointing back to the upstream verification step.

When the user chooses to abandon, the session terminates immediately. You don't need an abandon route: the session ends with the status ABORTED. The retry route must be declared with "type": "rollback" and a rollback.maxAttempts value (required) to cap how many times the user may retry before the flow aborts.

Output data blocks​

RouteData blocks produced
retry—

Notes​

  • Retry prompt (v1) produces no data blocks. The user's choice only decides which route the session takes.
  • The Player presents the retry/abandon UI for this step type.