Edit a KYB flow-profile
curl --request PATCH \
--url https://api.example.com/api/v4/kyb/profiles/{kybProfileId} \
--header 'Content-Type: application/json' \
--header 'ds-api-token: <api-key>' \
--data '
{
"allow_submit_on_failed_kyc": false,
"kyc_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"name": "Production (external clients)",
"owner_kyc_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"role": "<string>"
}
'import requests
url = "https://api.example.com/api/v4/kyb/profiles/{kybProfileId}"
payload = {
"allow_submit_on_failed_kyc": False,
"kyc_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"name": "Production (external clients)",
"owner_kyc_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"role": "<string>"
}
headers = {
"ds-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'ds-api-token': '<api-key>', '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)',
owner_kyc_profile_id: '0195c1f0-1234-7000-8000-0123456789ab',
role: '<string>'
})
};
fetch('https://api.example.com/api/v4/kyb/profiles/{kybProfileId}', 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/api/v4/kyb/profiles/{kybProfileId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'allow_submit_on_failed_kyc' => false,
'kyc_profile_id' => '0195c1f0-1234-7000-8000-0123456789ab',
'name' => 'Production (external clients)',
'owner_kyc_profile_id' => '0195c1f0-1234-7000-8000-0123456789ab',
'role' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"ds-api-token: <api-key>"
],
]);
$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/api/v4/kyb/profiles/{kybProfileId}"
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 \"owner_kyc_profile_id\": \"0195c1f0-1234-7000-8000-0123456789ab\",\n \"role\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("ds-api-token", "<api-key>")
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.patch("https://api.example.com/api/v4/kyb/profiles/{kybProfileId}")
.header("ds-api-token", "<api-key>")
.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 \"owner_kyc_profile_id\": \"0195c1f0-1234-7000-8000-0123456789ab\",\n \"role\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v4/kyb/profiles/{kybProfileId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["ds-api-token"] = '<api-key>'
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 \"owner_kyc_profile_id\": \"0195c1f0-1234-7000-8000-0123456789ab\",\n \"role\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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)",
"owner_kyc_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"role": "production"
}{
"code": "invalid_body",
"message": "Invalid request body"
}{
"code": "kyb_profile_not_found",
"message": "KYB profile not found"
}{
"code": "kyc_profile_not_found",
"message": "kyc_profile_id does not reference an existing verification profile"
}KYB Profiles
Edit a KYB flow-profile
Partially updates a KYB flow-profile: name, kyc_profile_id, owner_kyc_profile_id (both must belong to the caller’s org, same check as on create) and allow_submit_on_failed_kyc. Every field is optional and a field left out keeps its stored value; a body setting none of them is a 400. owner_kyc_profile_id has no way to be cleared back to “same as kyc_profile_id” here, only replaced by another org-owned profile. role is immutable — case creation resolves the seed profile by role, so moving it here would silently repoint that lookup. Tenant comes from the caller’s auth; a profile id from another org is a 404.
PATCH
/
api
/
v4
/
kyb
/
profiles
/
{kybProfileId}
Edit a KYB flow-profile
curl --request PATCH \
--url https://api.example.com/api/v4/kyb/profiles/{kybProfileId} \
--header 'Content-Type: application/json' \
--header 'ds-api-token: <api-key>' \
--data '
{
"allow_submit_on_failed_kyc": false,
"kyc_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"name": "Production (external clients)",
"owner_kyc_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"role": "<string>"
}
'import requests
url = "https://api.example.com/api/v4/kyb/profiles/{kybProfileId}"
payload = {
"allow_submit_on_failed_kyc": False,
"kyc_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"name": "Production (external clients)",
"owner_kyc_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"role": "<string>"
}
headers = {
"ds-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'ds-api-token': '<api-key>', '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)',
owner_kyc_profile_id: '0195c1f0-1234-7000-8000-0123456789ab',
role: '<string>'
})
};
fetch('https://api.example.com/api/v4/kyb/profiles/{kybProfileId}', 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/api/v4/kyb/profiles/{kybProfileId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'allow_submit_on_failed_kyc' => false,
'kyc_profile_id' => '0195c1f0-1234-7000-8000-0123456789ab',
'name' => 'Production (external clients)',
'owner_kyc_profile_id' => '0195c1f0-1234-7000-8000-0123456789ab',
'role' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"ds-api-token: <api-key>"
],
]);
$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/api/v4/kyb/profiles/{kybProfileId}"
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 \"owner_kyc_profile_id\": \"0195c1f0-1234-7000-8000-0123456789ab\",\n \"role\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("ds-api-token", "<api-key>")
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.patch("https://api.example.com/api/v4/kyb/profiles/{kybProfileId}")
.header("ds-api-token", "<api-key>")
.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 \"owner_kyc_profile_id\": \"0195c1f0-1234-7000-8000-0123456789ab\",\n \"role\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v4/kyb/profiles/{kybProfileId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["ds-api-token"] = '<api-key>'
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 \"owner_kyc_profile_id\": \"0195c1f0-1234-7000-8000-0123456789ab\",\n \"role\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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)",
"owner_kyc_profile_id": "0195c1f0-1234-7000-8000-0123456789ab",
"role": "production"
}{
"code": "invalid_body",
"message": "Invalid request body"
}{
"code": "kyb_profile_not_found",
"message": "KYB profile not found"
}{
"code": "kyc_profile_not_found",
"message": "kyc_profile_id does not reference an existing verification profile"
}Body
application/jsonapplication/xml
Request body for kyb.UpdateKybProfileRequest
UpdateKybProfileRequest schema
Response
KYB profile updated.
KybProfileResponse schema