curl --request POST \
--url https://app.instantcompliance.ai/api/v1/entities/{id}/ubos \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Dana Owner",
"email": "dana@example.com",
"holderType": "individual",
"percentageHeld": 40
}
'import requests
url = "https://app.instantcompliance.ai/api/v1/entities/{id}/ubos"
payload = {
"name": "Dana Owner",
"email": "dana@example.com",
"holderType": "individual",
"percentageHeld": 40
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Dana Owner',
email: 'dana@example.com',
holderType: 'individual',
percentageHeld: 40
})
};
fetch('https://app.instantcompliance.ai/api/v1/entities/{id}/ubos', 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://app.instantcompliance.ai/api/v1/entities/{id}/ubos",
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([
'name' => 'Dana Owner',
'email' => 'dana@example.com',
'holderType' => 'individual',
'percentageHeld' => 40
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://app.instantcompliance.ai/api/v1/entities/{id}/ubos"
payload := strings.NewReader("{\n \"name\": \"Dana Owner\",\n \"email\": \"dana@example.com\",\n \"holderType\": \"individual\",\n \"percentageHeld\": 40\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.instantcompliance.ai/api/v1/entities/{id}/ubos")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Dana Owner\",\n \"email\": \"dana@example.com\",\n \"holderType\": \"individual\",\n \"percentageHeld\": 40\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.instantcompliance.ai/api/v1/entities/{id}/ubos")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Dana Owner\",\n \"email\": \"dana@example.com\",\n \"holderType\": \"individual\",\n \"percentageHeld\": 40\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"holder_type": "<string>",
"role_type": "TRUSTEE",
"role_types": [
"TRUSTEE"
],
"percentage_held": 123,
"kyc_required": true,
"kyc_status": "NOT_STARTED",
"kyc_email": "<string>",
"linked_customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>"
},
"added_via": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "unauthorized",
"message": "Invalid or revoked API key."
}
}{
"error": {
"code": "forbidden_scope",
"message": "This API key does not have the required scope. customers:write",
"details": {
"required_scope": "customers:write"
}
}
}{
"error": {
"code": "not_found",
"message": "Customer not found."
}
}{
"error": {
"code": "conflict",
"message": "KYB verification has already been started for this customer."
}
}{
"error": {
"code": "validation_failed",
"message": "Invalid customer payload.",
"details": {
"issues": {
"email": [
"Must be a valid email address."
]
}
}
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded. Slow down and retry shortly.",
"details": {
"limit": 60,
"window_seconds": 60
}
}
}Add a beneficial owner
Record a beneficial owner on the entity’s ownership tree — the same
write the in-app “add UBO” modal makes. Nothing is emailed, charged, or
verified; the owner lands NOT_STARTED (or NOT_REQUIRED for an
excluded / recorded-only party), and the entity’s KYB completion is
recomputed exactly as in-app.
Provide either a single holderType (company / partnership owner) or a
typed roleTypes set (trust party). The entity’s KYB must have begun —
the ownership tree comes from the entity document, so adding owners
before verification starts returns 409 conflict.
Requires customers:write. Include an Idempotency-Key header to make
retries safe.
curl --request POST \
--url https://app.instantcompliance.ai/api/v1/entities/{id}/ubos \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Dana Owner",
"email": "dana@example.com",
"holderType": "individual",
"percentageHeld": 40
}
'import requests
url = "https://app.instantcompliance.ai/api/v1/entities/{id}/ubos"
payload = {
"name": "Dana Owner",
"email": "dana@example.com",
"holderType": "individual",
"percentageHeld": 40
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Dana Owner',
email: 'dana@example.com',
holderType: 'individual',
percentageHeld: 40
})
};
fetch('https://app.instantcompliance.ai/api/v1/entities/{id}/ubos', 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://app.instantcompliance.ai/api/v1/entities/{id}/ubos",
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([
'name' => 'Dana Owner',
'email' => 'dana@example.com',
'holderType' => 'individual',
'percentageHeld' => 40
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://app.instantcompliance.ai/api/v1/entities/{id}/ubos"
payload := strings.NewReader("{\n \"name\": \"Dana Owner\",\n \"email\": \"dana@example.com\",\n \"holderType\": \"individual\",\n \"percentageHeld\": 40\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.instantcompliance.ai/api/v1/entities/{id}/ubos")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Dana Owner\",\n \"email\": \"dana@example.com\",\n \"holderType\": \"individual\",\n \"percentageHeld\": 40\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.instantcompliance.ai/api/v1/entities/{id}/ubos")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Dana Owner\",\n \"email\": \"dana@example.com\",\n \"holderType\": \"individual\",\n \"percentageHeld\": 40\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"holder_type": "<string>",
"role_type": "TRUSTEE",
"role_types": [
"TRUSTEE"
],
"percentage_held": 123,
"kyc_required": true,
"kyc_status": "NOT_STARTED",
"kyc_email": "<string>",
"linked_customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>"
},
"added_via": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "unauthorized",
"message": "Invalid or revoked API key."
}
}{
"error": {
"code": "forbidden_scope",
"message": "This API key does not have the required scope. customers:write",
"details": {
"required_scope": "customers:write"
}
}
}{
"error": {
"code": "not_found",
"message": "Customer not found."
}
}{
"error": {
"code": "conflict",
"message": "KYB verification has already been started for this customer."
}
}{
"error": {
"code": "validation_failed",
"message": "Invalid customer payload.",
"details": {
"issues": {
"email": [
"Must be a valid email address."
]
}
}
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded. Slow down and retry shortly.",
"details": {
"limit": 60,
"window_seconds": 60
}
}
}holderType (a company / partnership owner) or a
typed roleTypes set (a trust party).
409 conflict. Start KYB first via Start KYB.customers:write scope.Authorizations
Bearer API key issued from Settings → Developers in your
Instant Compliance organisation. Format: ic_live_….
Headers
Caller-supplied unique key for safe retries. Repeat the same key within 24 hours and we replay the original response instead of repeating the side effect. Reusing the key with a different request body returns 409 idempotency_conflict.
255Path Parameters
Entity identifier. Accepts either Instant Compliance's UUID or your
own external_id.
Body
Provide either holderType (company / partnership owner) or a non-empty
roleTypes set (trust party).
1 - 255255ISO date (YYYY-MM-DD), stored on the owner's linked person record.
40A single holder type for a company / partnership owner.
trustee, settlor, beneficiary, partner, individual The full typed role set for a trust party.
12Typed trust-party / ownership role.
TRUSTEE, CORPORATE_TRUSTEE, SETTLOR, APPOINTOR, GUARDIAN, PROTECTOR, BENEFICIARY_NAMED, BENEFICIARY_CLASS, BENEFICIARY_EXCLUDED, UNIT_HOLDER, MEMBER, DIRECTOR, SHAREHOLDER, OTHER_CONTROLLER, OTHER 0 <= x <= 100Show child attributes
Show child attributes
Response
The beneficial owner that was recorded.
A beneficial owner. Never includes link tokens, applicant ids, or payment fields.
Typed trust-party / ownership role.
TRUSTEE, CORPORATE_TRUSTEE, SETTLOR, APPOINTOR, GUARDIAN, PROTECTOR, BENEFICIARY_NAMED, BENEFICIARY_CLASS, BENEFICIARY_EXCLUDED, UNIT_HOLDER, MEMBER, DIRECTOR, SHAREHOLDER, OTHER_CONTROLLER, OTHER Typed trust-party / ownership role.
TRUSTEE, CORPORATE_TRUSTEE, SETTLOR, APPOINTOR, GUARDIAN, PROTECTOR, BENEFICIARY_NAMED, BENEFICIARY_CLASS, BENEFICIARY_EXCLUDED, UNIT_HOLDER, MEMBER, DIRECTOR, SHAREHOLDER, OTHER_CONTROLLER, OTHER False for excluded / recorded-only parties that are never checked.
NOT_STARTED, PENDING, IN_PROGRESS, VERIFIED, FAILED, NOT_REQUIRED, AWAITING_RESUBMISSION Show child attributes
Show child attributes

