Skip to main content
PATCH

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Idempotency-Key
string<uuid>
required

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

​
X-Trace-Version
string

API version. Omit to use the default version.

Example:

"1"

Path Parameters

​
accountId
string<uuid>
required

UUID of the account.

​
uboId
string<uuid>
required

UUID of the beneficial owner.

Body

application/json

Request body for updating a beneficial owner. All fields are optional (patch semantics).

​
name
string

Full legal name of the beneficial owner.

Example:

"João Silva"

​
identificationDocument
object

Identification document of an 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 is omitted for them. Non-fiscal documents (PASSPORT) carry an explicit country.

​
address
object
​
phone
string

Contact phone number with country code.

Example:

"5511999999999"

​
email
string<email>

Contact email address.

Example:

"joao.silva@example.com"

​
ownershipPercentage
number<double> | null

Percentage of ownership.

Example:

50

​
isLegalRepresentative
boolean | null

Whether this beneficial owner is the legal representative of the account. Defaults to false.

Example:

false

Response

Beneficial owner updated.

​
id
string<uuid>
required
read-only
Example:

"b2c3d4e5-f6a7-8901-bcde-f12345678901"

​
name
string
required
Example:

"João Silva"

​
identificationDocument
object
required

Identification document of an 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 is omitted for them. Non-fiscal documents (PASSPORT) carry an explicit country.

​
address
object
required
​
phone
string
required
Example:

"5511999999999"

​
email
string<email>
required
Example:

"joao.silva@example.com"

​
isLegalRepresentative
boolean
required
Example:

false

​
currentState
object
required

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

​
ownershipPercentage
number<double> | null
Example:

50