Create a Flow
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/flows \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"steps": []
}'
{
"completed_steps": [
"compliance"
],
"created": "string",
"id": "string",
"link": "string",
"metadata": [
"string",
"object",
"null"
],
"steps": [
"compliance"
],
"user_id": [
"string",
"null"
]
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
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.
A list of steps. Can either be a string or an object with additional properties. Example: A redirect
step looks like {"name": "redirect", "redirect_url": "https://example.com"}
compliance
, id-verification
, manage-payouts
, manage-payments
, payout
, background-check
, redirect
The user's id.
Response
Array of steps that have been completed in the flow.
compliance
, id-verification
, background-check
, manage-payments
, manage-payouts
, payout
, redirect
Date that the flow
was created.
ID of the flow
.
URL to access the flow
. Can be embedded in an iframe
.
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.
Array of steps in the flow.
compliance
, id-verification
, background-check
, manage-payments
, manage-payouts
, payout
, redirect
ID of the user
that has claimed the flow
.
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/flows \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"steps": []
}'
{
"completed_steps": [
"compliance"
],
"created": "string",
"id": "string",
"link": "string",
"metadata": [
"string",
"object",
"null"
],
"steps": [
"compliance"
],
"user_id": [
"string",
"null"
]
}