flows
Retrieve a Flow
Get a Flow by its id.
Authorizations
Authorization
string
headerrequiredBasic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
flow_id
string
requiredId of the flow to fetch
Response
200 - application/json
id
string
ID of the flow
.
created
string
Date that the flow
was created.
user_id
string | null
ID of the user
that has claimed the flow
.
steps
enum<string>[]
Array of steps in the flow.
Available options:
compliance
, id-verification
, background-check
, manage-payments
, manage-payouts
, payout
, redirect
completed_steps
enum<string>[]
Array of steps that have been completed in the flow.
Available options:
compliance
, id-verification
, background-check
, manage-payments
, manage-payouts
, payout
, redirect
link
string
URL to access the flow
. Can be embedded in an iframe
.
metadata
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.