Create a KYB flow

Create a hosted KYB flow for an app in a multi-tenant organization. Share the returned URL with the app’s owner so they can submit the business and beneficial-owner information required for verification. The URL expires after 72 hours. Calling this endpoint again creates a new URL and immediately invalidates the previous one. The endpoint is only available for apps configured for individual business verification that have not already reached a terminal or review state.

POST /v2/apps/{app_id}/kyb-flow

Create a KYB flow

cURL

curl --request POST \
  --url https://api.dots.dev/api/v2/apps/{app_id}/kyb-flow \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.dots.dev/api/v2/apps/{app_id}/kyb-flow"

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

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

print(response.text)

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

fetch('https://api.dots.dev/api/v2/apps/{app_id}/kyb-flow', 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/apps/{app_id}/kyb-flow",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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/apps/{app_id}/kyb-flow"

	req, _ := http.NewRequest("POST", 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.post("https://api.dots.dev/api/v2/apps/{app_id}/kyb-flow")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dots.dev/api/v2/apps/{app_id}/kyb-flow")

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

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

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

201

{
  "url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "status": "pending"
}

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

app_id · string · required

The ID of the App.

Response

201 - application/json

KYB flow created

url · string<uri> · required

The hosted KYB flow URL to share with the app's owner.

expires_at · string<date-time> · required

The time when the hosted KYB flow URL expires.

status · enum<string> · required

The initial status of the KYB flow.

Available options: pending