Create a KYB flow-profile (dashboard)
curl --request POST \
--url https://api.example.com/webapi/v4/kyb/organization/{organizationId}/kyb-profiles \
--header 'Content-Type: application/json' \
--cookie ds-prod-session= \
--data '
{
"allow_submit_on_failed_kyc": false,
"kyc_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"name": "Production (external clients)",
"role": "production"
}
'import requests
url = "https://api.example.com/webapi/v4/kyb/organization/{organizationId}/kyb-profiles"
payload = {
"allow_submit_on_failed_kyc": False,
"kyc_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"name": "Production (external clients)",
"role": "production"
}
headers = {
"cookie": "ds-prod-session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'ds-prod-session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
allow_submit_on_failed_kyc: false,
kyc_profile_id: '0195c1f0-1234-7000-8000-0123456789ab',
name: 'Production (external clients)',
role: 'production'
})
};
fetch('https://api.example.com/webapi/v4/kyb/organization/{organizationId}/kyb-profiles', 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.example.com/webapi/v4/kyb/organization/{organizationId}/kyb-profiles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'allow_submit_on_failed_kyc' => false,
'kyc_profile_id' => '0195c1f0-1234-7000-8000-0123456789ab',
'name' => 'Production (external clients)',
'role' => 'production'
]),
CURLOPT_COOKIE => "ds-prod-session=",
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/webapi/v4/kyb/organization/{organizationId}/kyb-profiles"
payload := strings.NewReader("{\n \"allow_submit_on_failed_kyc\": false,\n \"kyc_profile_id\": \"0195c1f0-1234-7000-8000-0123456789ab\",\n \"name\": \"Production (external clients)\",\n \"role\": \"production\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "ds-prod-session=")
req.Header.Add("Content-Type", "application/json")
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.example.com/webapi/v4/kyb/organization/{organizationId}/kyb-profiles")
.header("cookie", "ds-prod-session=")
.header("Content-Type", "application/json")
.body("{\n \"allow_submit_on_failed_kyc\": false,\n \"kyc_profile_id\": \"0195c1f0-1234-7000-8000-0123456789ab\",\n \"name\": \"Production (external clients)\",\n \"role\": \"production\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/webapi/v4/kyb/organization/{organizationId}/kyb-profiles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'ds-prod-session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"allow_submit_on_failed_kyc\": false,\n \"kyc_profile_id\": \"0195c1f0-1234-7000-8000-0123456789ab\",\n \"name\": \"Production (external clients)\",\n \"role\": \"production\"\n}"
response = http.request(request)
puts response.read_body{
"code": "invalid_body",
"message": "Invalid request body"
}{
"code": "kyb_profile_role_exists",
"message": "a KYB profile with this role already exists for the organization"
}{
"code": "kyc_profile_not_found",
"message": "kyc_profile_id does not reference an existing verification profile"
}{
"allow_submit_on_failed_kyc": false,
"kyb_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"kyc_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"name": "Production (external clients)",
"role": "production"
}KYB Profiles
Create a KYB flow-profile (dashboard)
Dashboard-facing twin of POST /api/v4/kyb-profiles: creates a KYB flow-profile binding a KYC verification profile (kyc_profile_id, must belong to the org) and the submit gate (allow_submit_on_failed_kyc) to an optional role (production/dashboard, or empty for user-defined). One production and one dashboard per org (duplicate → 409). Org comes from the path; the web session must belong to it.
POST
/
webapi
/
v4
/
kyb
/
organization
/
{organizationId}
/
kyb-profiles
Create a KYB flow-profile (dashboard)
curl --request POST \
--url https://api.example.com/webapi/v4/kyb/organization/{organizationId}/kyb-profiles \
--header 'Content-Type: application/json' \
--cookie ds-prod-session= \
--data '
{
"allow_submit_on_failed_kyc": false,
"kyc_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"name": "Production (external clients)",
"role": "production"
}
'import requests
url = "https://api.example.com/webapi/v4/kyb/organization/{organizationId}/kyb-profiles"
payload = {
"allow_submit_on_failed_kyc": False,
"kyc_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"name": "Production (external clients)",
"role": "production"
}
headers = {
"cookie": "ds-prod-session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'ds-prod-session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
allow_submit_on_failed_kyc: false,
kyc_profile_id: '0195c1f0-1234-7000-8000-0123456789ab',
name: 'Production (external clients)',
role: 'production'
})
};
fetch('https://api.example.com/webapi/v4/kyb/organization/{organizationId}/kyb-profiles', 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.example.com/webapi/v4/kyb/organization/{organizationId}/kyb-profiles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'allow_submit_on_failed_kyc' => false,
'kyc_profile_id' => '0195c1f0-1234-7000-8000-0123456789ab',
'name' => 'Production (external clients)',
'role' => 'production'
]),
CURLOPT_COOKIE => "ds-prod-session=",
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/webapi/v4/kyb/organization/{organizationId}/kyb-profiles"
payload := strings.NewReader("{\n \"allow_submit_on_failed_kyc\": false,\n \"kyc_profile_id\": \"0195c1f0-1234-7000-8000-0123456789ab\",\n \"name\": \"Production (external clients)\",\n \"role\": \"production\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "ds-prod-session=")
req.Header.Add("Content-Type", "application/json")
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.example.com/webapi/v4/kyb/organization/{organizationId}/kyb-profiles")
.header("cookie", "ds-prod-session=")
.header("Content-Type", "application/json")
.body("{\n \"allow_submit_on_failed_kyc\": false,\n \"kyc_profile_id\": \"0195c1f0-1234-7000-8000-0123456789ab\",\n \"name\": \"Production (external clients)\",\n \"role\": \"production\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/webapi/v4/kyb/organization/{organizationId}/kyb-profiles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'ds-prod-session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"allow_submit_on_failed_kyc\": false,\n \"kyc_profile_id\": \"0195c1f0-1234-7000-8000-0123456789ab\",\n \"name\": \"Production (external clients)\",\n \"role\": \"production\"\n}"
response = http.request(request)
puts response.read_body{
"code": "invalid_body",
"message": "Invalid request body"
}{
"code": "kyb_profile_role_exists",
"message": "a KYB profile with this role already exists for the organization"
}{
"code": "kyc_profile_not_found",
"message": "kyc_profile_id does not reference an existing verification profile"
}{
"allow_submit_on_failed_kyc": false,
"kyb_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"kyc_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"name": "Production (external clients)",
"role": "production"
}Authorizations
Session cookie for web dashboard authentication.
Path Parameters
Organization id.
Body
application/jsonapplication/xml
Request body for kyb.CreateKybProfileRequest
Response
Created
⌘I