Retrieve a Flow

Get a Flow by its id.

GET /v2/flows/{flow_id}

Retrieve a Flow

cURL

curl --request GET \
  --url https://api.dots.dev/api/v2/flows/{flow_id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.dots.dev/api/v2/flows/{flow_id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.dots.dev/api/v2/flows/{flow_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dots.dev/api/v2/flows/{flow_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dots.dev/api/v2/flows/{flow_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.dots.dev/api/v2/flows/{flow_id}")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dots.dev/api/v2/flows/{flow_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "steps": [],
  "completed_steps": [],
  "link": "<string>",
  "metadata": "<string>"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

flow_id · string<uuid> · required

Id of the flow to fetch

Response

200 - application/json

OK

The flow object.

id · string<uuid>

ID of the flow.

created · string<date-time>

Date that the flow was created.

user_id · string<uuid> | 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, pdf-form-fill

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, pdf-form-fill

link · string<uri>

URL to access the flow. Can be embedded in an iframe.

metadata · string object

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.