curl --request POST \
--url https://app.instantcompliance.ai/api/v1/entities/{id}/ubos/{uboId}/kyc \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payer": "organization"
}
'import requests
url = "https://app.instantcompliance.ai/api/v1/entities/{id}/ubos/{uboId}/kyc"
payload = { "payer": "organization" }
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({payer: 'organization'})
};
fetch('https://app.instantcompliance.ai/api/v1/entities/{id}/ubos/{uboId}/kyc', 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/{uboId}/kyc",
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([
'payer' => 'organization'
]),
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/{uboId}/kyc"
payload := strings.NewReader("{\n \"payer\": \"organization\"\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/{uboId}/kyc")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payer\": \"organization\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.instantcompliance.ai/api/v1/entities/{id}/ubos/{uboId}/kyc")
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 \"payer\": \"organization\"\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",
"verification_link": "<string>"
}{
"error": {
"code": "unauthorized",
"message": "Invalid or revoked API key."
}
}{
"error": {
"code": "insufficient_credits",
"message": "Insufficient credits to start this verification."
}
}{
"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
}
}
}Send a beneficial owner's verification
Issue (or re-issue) the owner’s identity-verification link via the same
core the app uses. This spends a credit (or bills the customer) on
the same model as KYC/KYB start: organization pays now and the check
is settled; customer arms payment-pending and pays at the portal.
deliverEmail: false returns the link instead of emailing it.
Reusing a link never rotates the owner’s token, so previously issued links keep working. A verified owner returns 409 conflict.
Requires verification:write. Include an Idempotency-Key header to
make retries safe.
curl --request POST \
--url https://app.instantcompliance.ai/api/v1/entities/{id}/ubos/{uboId}/kyc \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payer": "organization"
}
'import requests
url = "https://app.instantcompliance.ai/api/v1/entities/{id}/ubos/{uboId}/kyc"
payload = { "payer": "organization" }
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({payer: 'organization'})
};
fetch('https://app.instantcompliance.ai/api/v1/entities/{id}/ubos/{uboId}/kyc', 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/{uboId}/kyc",
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([
'payer' => 'organization'
]),
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/{uboId}/kyc"
payload := strings.NewReader("{\n \"payer\": \"organization\"\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/{uboId}/kyc")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payer\": \"organization\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.instantcompliance.ai/api/v1/entities/{id}/ubos/{uboId}/kyc")
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 \"payer\": \"organization\"\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",
"verification_link": "<string>"
}{
"error": {
"code": "unauthorized",
"message": "Invalid or revoked API key."
}
}{
"error": {
"code": "insufficient_credits",
"message": "Insufficient credits to start this verification."
}
}{
"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
}
}
}payer: organization(or the record default) — a credit is spent now and the check is settled.payer: customer— the owner is armed payment-pending and pays at the portal.deliverEmail: false— the link is returned inverification_linkinstead of emailed.
409 conflict; an org-paid send with no
credit returns 402 insufficient_credits (nothing armed or charged). Requires
the verification: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 (UUID or your external_id).
The beneficial owner's id (from the add / list responses).
Body
Options for sending a beneficial owner's verification link. All fields optional.
Who pays for the check. Omit to honour the customer record's own
billing default. customer arms the check payment-pending and emails a
pay link — the customer pays by card at the portal.
organization, customer Where to email the link. Defaults to the owner's recorded email;
required (here or on file) unless deliverEmail is false.
255When false, the link is returned in verification_link instead of emailed.
Response
The owner after arming, plus their verification link.
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
The owner's portal verification link.

