Add a beneficial owner

Adds a beneficial owner (UBO) to a company-owned account.

POST /v1/accounts/{accountId}/ubos

Add a beneficial owner

cURL

curl --request POST \
  --url https://api.sandbox.tracefinance.com/v1/accounts/{accountId}/ubos \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "name": "João Silva",
  "identificationDocument": {
    "value": "12345678909",
    "type": "CPF"
  },
  "address": {
    "addressLine1": "Rua das Flores, 100",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR",
    "postalCode": "01234-567"
  },
  "ownershipPercentage": 50
}
'

import requests

url = "https://api.sandbox.tracefinance.com/v1/accounts/{accountId}/ubos"

payload = {
    "name": "João Silva",
    "identificationDocument": {
        "value": "12345678909",
        "type": "CPF"
    },
    "address": {
        "addressLine1": "Rua das Flores, 100",
        "city": "São Paulo",
        "state": "SP",
        "country": "BR",
        "postalCode": "01234-567"
    },
    "ownershipPercentage": 50
}
headers = {
    "X-Idempotency-Key": "<x-idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency-Key': '<x-idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'João Silva',
    identificationDocument: {value: '12345678909', type: 'CPF'},
    address: {
      addressLine1: 'Rua das Flores, 100',
      city: 'São Paulo',
      state: 'SP',
      country: 'BR',
      postalCode: '01234-567'
    },
    ownershipPercentage: 50
  })
};

fetch('https://api.sandbox.tracefinance.com/v1/accounts/{accountId}/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://api.sandbox.tracefinance.com/v1/accounts/{accountId}/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' => 'João Silva',
    'identificationDocument' => [
        'value' => '12345678909',
        'type' => 'CPF'
    ],
    'address' => [
        'addressLine1' => 'Rua das Flores, 100',
        'city' => 'São Paulo',
        'state' => 'SP',
        'country' => 'BR',
        'postalCode' => '01234-567'
    ],
    'ownershipPercentage' => 50
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Idempotency-Key: <x-idempotency-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.sandbox.tracefinance.com/v1/accounts/{accountId}/ubos"

	payload := strings.NewReader("{\n  \"name\": \"João Silva\",\n  \"identificationDocument\": {\n    \"value\": \"12345678909\",\n    \"type\": \"CPF\"\n  },\n  \"address\": {\n    \"addressLine1\": \"Rua das Flores, 100\",\n    \"city\": \"São Paulo\",\n    \"state\": \"SP\",\n    \"country\": \"BR\",\n    \"postalCode\": \"01234-567\"\n  },\n  \"ownershipPercentage\": 50\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency-Key", "<x-idempotency-key>")
	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://api.sandbox.tracefinance.com/v1/accounts/{accountId}/ubos")
  .header("X-Idempotency-Key", "<x-idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"João Silva\",\n  \"identificationDocument\": {\n    \"value\": \"12345678909\",\n    \"type\": \"CPF\"\n  },\n  \"address\": {\n    \"addressLine1\": \"Rua das Flores, 100\",\n    \"city\": \"São Paulo\",\n    \"state\": \"SP\",\n    \"country\": \"BR\",\n    \"postalCode\": \"01234-567\"\n  },\n  \"ownershipPercentage\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.tracefinance.com/v1/accounts/{accountId}/ubos")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Idempotency-Key"] = '<x-idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"João Silva\",\n  \"identificationDocument\": {\n    \"value\": \"12345678909\",\n    \"type\": \"CPF\"\n  },\n  \"address\": {\n    \"addressLine1\": \"Rua das Flores, 100\",\n    \"city\": \"São Paulo\",\n    \"state\": \"SP\",\n    \"country\": \"BR\",\n    \"postalCode\": \"01234-567\"\n  },\n  \"ownershipPercentage\": 50\n}"

response = http.request(request)
puts response.read_body

201

Example

{ "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "name": "João Silva", "identificationDocument": { "type": "CNPJ", "value": "11222333000181", "country": "BR" }, "address": { "addressLine1": "Rua das Flores, 100", "city": "São Paulo", "country": "BR", "postalCode": "01234-567", "addressLine2": "Suite 456", "state": "SP" }, "phone": "5511999999999", "email": "[e-mail]", "isLegalRepresentative": false, "currentState": { "status": "PENDING", "createdAt": "2026-01-15T10:30:00Z", "reason": { "code": "DOCUMENT_REJECTED", "message": "Document is illegible", "details": {} } }, "ownershipPercentage": 50 }

Authorizations

Authorization · string · header · required

JWT bearer token. Include as Authorization: Bearer <token>. See the Authentication guide for how to obtain one.

Headers

X-Trace-Version · string

API version. Omit to use the default version.

Example:

"1"

X-Idempotency-Key · string<uuid> · required

Unique key to ensure idempotent request processing. Required on all POST, PUT, and PATCH requests.

Path Parameters

accountId · string<uuid> · required

UUID of the account.

Body

application/json

Request body for adding a beneficial owner.

name · string · required

Full legal name of the beneficial owner.

Example:

"João Silva"

identificationDocument · object · required

Identification document for the owner or beneficial owner. Tax-id documents (for example CNPJ, CPF) are validated against the type-specific format rules, and their type implies the country, so country may be omitted. Non-fiscal documents (PASSPORT) require an explicit country.

Show child attributes

address · object · required

Show child attributes

phone · string · required

Contact phone number with country code.

Example:

"5511999999999"

email · string<email> · required

Contact email address.

Example:

"[e-mail]"

ownershipPercentage · number<double> | null

Percentage of ownership. Optional.

Example:

50

isLegalRepresentative · boolean | null · default: false

Whether this beneficial owner is the legal representative of the account.

Example:

false

Response

201

application/json

Beneficial owner added.

id · string<uuid> · required · read-only

Example:

"b2c3d4e5-f6a7-8901-bcde-f12345678901"

name · string · required

Example:

"João Silva"

identificationDocument · object · required

Identification document returned for an owner or beneficial owner. country is present only for non-fiscal documents (PASSPORT); for tax-id documents the type implies the country and country is omitted.

Show child attributes

address · object · required

Show child attributes

phone · string · required

Example:

"5511999999999"

email · string<email> · required

Example:

"[e-mail]"

isLegalRepresentative · boolean · required

Example:

false

currentState · object · required

A point-in-time state of a beneficial owner.

Show child attributes

ownershipPercentage · number<double> | null

Example:

50