Create Hosted Session

Creates a single-use, time-limited URL for a Sail-hosted flow that you embed in your app. End users enter their credentials there, so the credentials never reach your backend.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
enum
required

The flow to open.

  • connect_account: creates a card, store, or benefit_account connection. It's the only way to create one.
  • reconnect: signs the end user in again when a connection's credentials stop working.
  • upload_receipt: lets the end user upload an itemized receipt.
Allowed:
options
object

Flow-specific options:

  • connect_account requires connection_type (card, store, or benefit_account); accepts modal.
  • reconnect requires connection_id (a Sail-managed connection; external connections have no credentials and return 409 connection_not_reconnectable).
  • upload_receipt accepts an optional expense_id to attach the receipt to a specific needs_review expense.
  • merchant_id (only with connection_type: store) skips the vendor selection grid and opens directly to that merchant's login screen (409 conflict if the user already has a connection, active or in progress, for that merchant).
  • administrator_id (only with connection_type: benefit_account) skips administrator selection and opens directly to that administrator's login screen (409 conflict if the user already has an active connection for that administrator).
Responses

Language
Credentials
Bearer
sk_live_…
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json