curl --request POST \
  --url https://api.dots.dev/api/v2/flows \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "metadata": "<string>",
  "steps": [
    "compliance"
  ],
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "completed_steps": [
    "compliance"
  ],
  "created": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "link": "<string>",
  "metadata": "<string>",
  "steps": [
    "compliance"
  ],
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
headerrequired

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

Body

application/json
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
array
required

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"}

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

The user's id.

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.