GET
/
v2
/
flows
/
{flow_id}
Authorization
Path
curl --request GET \
  --url https://api.senddotssandbox.com/api/v2/flows/{flow_id} \
  --header 'Authorization: <authorization>'
{
  "completed_steps": [
    "compliance"
  ],
  "created": "string",
  "id": "string",
  "link": "string",
  "metadata": [
    "string",
    "object",
    "null"
  ],
  "steps": [
    "compliance"
  ],
  "user_id": [
    "string",
    "null"
  ]
}

Authorizations

Authorizationheaderrequired
string

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

flow_idrequired
string

Id of the flow to fetch

Response

200 - application/json
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
created
string

Date that the flow was created.

id
string

ID of the flow.

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.

steps
enum<string>[]

Array of steps in the flow.

Available options:
compliance,
id-verification,
background-check,
manage-payments,
manage-payouts,
payout,
redirect
user_id
string | null

ID of the user that has claimed the flow.

Create FlowGet Payout Links