Save owners
curl --request PUT \
--url https://api.example.com/api/v4/kyb/widget/{publicId}/owners \
--header 'Content-Type: application/json' \
--data '
{
"owners": [
{
"address_city": "<string>",
"address_country": "<string>",
"address_postal": "<string>",
"address_state": "<string>",
"address_street": "<string>",
"applicant_id": "<string>",
"citizenship": "<string>",
"dob": "<string>",
"email": "<string>",
"full_name": "<string>",
"id": "<string>",
"mobile": "<string>",
"ownership_pct": 123,
"role": "<string>",
"ssn": "<string>"
}
]
}
'import requests
url = "https://api.example.com/api/v4/kyb/widget/{publicId}/owners"
payload = { "owners": [
{
"address_city": "<string>",
"address_country": "<string>",
"address_postal": "<string>",
"address_state": "<string>",
"address_street": "<string>",
"applicant_id": "<string>",
"citizenship": "<string>",
"dob": "<string>",
"email": "<string>",
"full_name": "<string>",
"id": "<string>",
"mobile": "<string>",
"ownership_pct": 123,
"role": "<string>",
"ssn": "<string>"
}
] }
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
owners: [
{
address_city: '<string>',
address_country: '<string>',
address_postal: '<string>',
address_state: '<string>',
address_street: '<string>',
applicant_id: '<string>',
citizenship: '<string>',
dob: '<string>',
email: '<string>',
full_name: '<string>',
id: '<string>',
mobile: '<string>',
ownership_pct: 123,
role: '<string>',
ssn: '<string>'
}
]
})
};
fetch('https://api.example.com/api/v4/kyb/widget/{publicId}/owners', 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/widget/{publicId}/owners",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'owners' => [
[
'address_city' => '<string>',
'address_country' => '<string>',
'address_postal' => '<string>',
'address_state' => '<string>',
'address_street' => '<string>',
'applicant_id' => '<string>',
'citizenship' => '<string>',
'dob' => '<string>',
'email' => '<string>',
'full_name' => '<string>',
'id' => '<string>',
'mobile' => '<string>',
'ownership_pct' => 123,
'role' => '<string>',
'ssn' => '<string>'
]
]
]),
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/api/v4/kyb/widget/{publicId}/owners"
payload := strings.NewReader("{\n \"owners\": [\n {\n \"address_city\": \"<string>\",\n \"address_country\": \"<string>\",\n \"address_postal\": \"<string>\",\n \"address_state\": \"<string>\",\n \"address_street\": \"<string>\",\n \"applicant_id\": \"<string>\",\n \"citizenship\": \"<string>\",\n \"dob\": \"<string>\",\n \"email\": \"<string>\",\n \"full_name\": \"<string>\",\n \"id\": \"<string>\",\n \"mobile\": \"<string>\",\n \"ownership_pct\": 123,\n \"role\": \"<string>\",\n \"ssn\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://api.example.com/api/v4/kyb/widget/{publicId}/owners")
.header("Content-Type", "application/json")
.body("{\n \"owners\": [\n {\n \"address_city\": \"<string>\",\n \"address_country\": \"<string>\",\n \"address_postal\": \"<string>\",\n \"address_state\": \"<string>\",\n \"address_street\": \"<string>\",\n \"applicant_id\": \"<string>\",\n \"citizenship\": \"<string>\",\n \"dob\": \"<string>\",\n \"email\": \"<string>\",\n \"full_name\": \"<string>\",\n \"id\": \"<string>\",\n \"mobile\": \"<string>\",\n \"ownership_pct\": 123,\n \"role\": \"<string>\",\n \"ssn\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v4/kyb/widget/{publicId}/owners")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"owners\": [\n {\n \"address_city\": \"<string>\",\n \"address_country\": \"<string>\",\n \"address_postal\": \"<string>\",\n \"address_state\": \"<string>\",\n \"address_street\": \"<string>\",\n \"applicant_id\": \"<string>\",\n \"citizenship\": \"<string>\",\n \"dob\": \"<string>\",\n \"email\": \"<string>\",\n \"full_name\": \"<string>\",\n \"id\": \"<string>\",\n \"mobile\": \"<string>\",\n \"ownership_pct\": 123,\n \"role\": \"<string>\",\n \"ssn\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": "invalid_body",
"message": "Invalid request body"
}{
"code": "case_not_found",
"message": "Case not found"
}{
"code": "not_requested",
"message": "Only the requested items can be changed while an information request is open"
}{
"owners": [
{
"address_city": "<string>",
"address_country": "<string>",
"address_postal": "<string>",
"address_state": "<string>",
"address_street": "<string>",
"applicant_id": "<string>",
"citizenship": "<string>",
"dob": "<string>",
"documents": [
{
"created_at": "2023-11-07T05:31:56Z",
"editable": true,
"filename": "w9.pdf",
"id": "0195c1f0-1234-7000-8000-0123456789ab",
"type": "Bank Statement"
}
],
"editable": true,
"email": "<string>",
"full_name": "<string>",
"id": "0195c1f0-1234-7000-8000-0123456789ab",
"mobile": "<string>",
"ownership_pct": 123,
"role": "<string>",
"ssn": "<string>"
}
]
}KYB Widget
Save owners
Replaces the owners list (replace-all). Reconciles person applicants: creates one for any entry without an applicant_id, updates links, and drops links no longer present (the person applicants stay). Owner government IDs are uploaded separately via the documents upload endpoint with owner_id.
Closed while an information request is open: remediation reopens individual FIELDS, and the ownership structure has no per-item lock to reopen, so the whole surface is a 409 not_requested until the request is answered or withdrawn.
PUT
/
api
/
v4
/
kyb
/
widget
/
{publicId}
/
owners
Save owners
curl --request PUT \
--url https://api.example.com/api/v4/kyb/widget/{publicId}/owners \
--header 'Content-Type: application/json' \
--data '
{
"owners": [
{
"address_city": "<string>",
"address_country": "<string>",
"address_postal": "<string>",
"address_state": "<string>",
"address_street": "<string>",
"applicant_id": "<string>",
"citizenship": "<string>",
"dob": "<string>",
"email": "<string>",
"full_name": "<string>",
"id": "<string>",
"mobile": "<string>",
"ownership_pct": 123,
"role": "<string>",
"ssn": "<string>"
}
]
}
'import requests
url = "https://api.example.com/api/v4/kyb/widget/{publicId}/owners"
payload = { "owners": [
{
"address_city": "<string>",
"address_country": "<string>",
"address_postal": "<string>",
"address_state": "<string>",
"address_street": "<string>",
"applicant_id": "<string>",
"citizenship": "<string>",
"dob": "<string>",
"email": "<string>",
"full_name": "<string>",
"id": "<string>",
"mobile": "<string>",
"ownership_pct": 123,
"role": "<string>",
"ssn": "<string>"
}
] }
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
owners: [
{
address_city: '<string>',
address_country: '<string>',
address_postal: '<string>',
address_state: '<string>',
address_street: '<string>',
applicant_id: '<string>',
citizenship: '<string>',
dob: '<string>',
email: '<string>',
full_name: '<string>',
id: '<string>',
mobile: '<string>',
ownership_pct: 123,
role: '<string>',
ssn: '<string>'
}
]
})
};
fetch('https://api.example.com/api/v4/kyb/widget/{publicId}/owners', 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/widget/{publicId}/owners",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'owners' => [
[
'address_city' => '<string>',
'address_country' => '<string>',
'address_postal' => '<string>',
'address_state' => '<string>',
'address_street' => '<string>',
'applicant_id' => '<string>',
'citizenship' => '<string>',
'dob' => '<string>',
'email' => '<string>',
'full_name' => '<string>',
'id' => '<string>',
'mobile' => '<string>',
'ownership_pct' => 123,
'role' => '<string>',
'ssn' => '<string>'
]
]
]),
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/api/v4/kyb/widget/{publicId}/owners"
payload := strings.NewReader("{\n \"owners\": [\n {\n \"address_city\": \"<string>\",\n \"address_country\": \"<string>\",\n \"address_postal\": \"<string>\",\n \"address_state\": \"<string>\",\n \"address_street\": \"<string>\",\n \"applicant_id\": \"<string>\",\n \"citizenship\": \"<string>\",\n \"dob\": \"<string>\",\n \"email\": \"<string>\",\n \"full_name\": \"<string>\",\n \"id\": \"<string>\",\n \"mobile\": \"<string>\",\n \"ownership_pct\": 123,\n \"role\": \"<string>\",\n \"ssn\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://api.example.com/api/v4/kyb/widget/{publicId}/owners")
.header("Content-Type", "application/json")
.body("{\n \"owners\": [\n {\n \"address_city\": \"<string>\",\n \"address_country\": \"<string>\",\n \"address_postal\": \"<string>\",\n \"address_state\": \"<string>\",\n \"address_street\": \"<string>\",\n \"applicant_id\": \"<string>\",\n \"citizenship\": \"<string>\",\n \"dob\": \"<string>\",\n \"email\": \"<string>\",\n \"full_name\": \"<string>\",\n \"id\": \"<string>\",\n \"mobile\": \"<string>\",\n \"ownership_pct\": 123,\n \"role\": \"<string>\",\n \"ssn\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v4/kyb/widget/{publicId}/owners")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"owners\": [\n {\n \"address_city\": \"<string>\",\n \"address_country\": \"<string>\",\n \"address_postal\": \"<string>\",\n \"address_state\": \"<string>\",\n \"address_street\": \"<string>\",\n \"applicant_id\": \"<string>\",\n \"citizenship\": \"<string>\",\n \"dob\": \"<string>\",\n \"email\": \"<string>\",\n \"full_name\": \"<string>\",\n \"id\": \"<string>\",\n \"mobile\": \"<string>\",\n \"ownership_pct\": 123,\n \"role\": \"<string>\",\n \"ssn\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": "invalid_body",
"message": "Invalid request body"
}{
"code": "case_not_found",
"message": "Case not found"
}{
"code": "not_requested",
"message": "Only the requested items can be changed while an information request is open"
}{
"owners": [
{
"address_city": "<string>",
"address_country": "<string>",
"address_postal": "<string>",
"address_state": "<string>",
"address_street": "<string>",
"applicant_id": "<string>",
"citizenship": "<string>",
"dob": "<string>",
"documents": [
{
"created_at": "2023-11-07T05:31:56Z",
"editable": true,
"filename": "w9.pdf",
"id": "0195c1f0-1234-7000-8000-0123456789ab",
"type": "Bank Statement"
}
],
"editable": true,
"email": "<string>",
"full_name": "<string>",
"id": "0195c1f0-1234-7000-8000-0123456789ab",
"mobile": "<string>",
"ownership_pct": 123,
"role": "<string>",
"ssn": "<string>"
}
]
}⌘I