Pular para o conteúdo principal
PATCH
Atualizar um UBO
Altera o percentual de participação e/ou o papel de controle de um vínculo ativo.
  • Um corpo vazio retorna 400 VALIDATION_ERROR.
  • personId, validFrom e validTo não podem ser alterados; encerre o vínculo e crie um novo.
Os erros usam application/problem+json com um code estável. Catálogo completo: Entity Statuses and Error Codes.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

Authorization
string
obrigatório

Token de acesso Bearer para autenticação. Este token é obtido nos endpoints Obter token de acesso ou Renovar token de acesso. Sua conta de comerciante e o usuário que realiza a ação são identificados a partir dele.

Exemplo:

"Bearer <your_access_token>"

X-Correlation-ID
string

Identificador de rastreamento (UUID). Exibido na resposta; gerado pelo Localpayment se ausente.

Exemplo:

"0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10"

Parâmetros de caminho

companyId
string<uuid>
obrigatório

ID interno da EMPRESA.

Exemplo:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

uboId
string<uuid>
obrigatório

ID do link UBO.

Exemplo:

"4584b476-ccc6-4e98-be40-0c5082748e35"

Corpo

application/json
ownershipPercentage
number

De 0 a 100, com até duas casas decimais.

Exemplo:

55.5

controlRole
enum<string>

Novo papel, um dos códigos em Link a UBO. Uma string vazia retorna 422 INVALID_CONTROL_ROLE; o papel não pode ser removido.

Opções disponíveis:
CEO,
CFO,
COO,
CTO,
PRESIDENT,
VICE_PRESIDENT,
DIRECTOR,
MANAGING_DIRECTOR,
MANAGING_PARTNER,
GENERAL_PARTNER,
PARTNER,
SECRETARY,
TREASURER,
CHAIRMAN,
BOARD_MEMBER,
AUTHORIZED_SIGNATORY,
GENERAL_COUNSEL,
OWNER,
FOUNDER,
MANAGER,
MEMBER,
COMPTROLLER,
CHIEF_COMPLIANCE_OFFICER,
LEGAL_REPRESENTATIVE
Exemplo:

"PARTNER"

Resposta

OK.

id
string

Identificador de link UBO (uboId).

Exemplo:

"4584b476-ccc6-4e98-be40-0c5082748e35"

companyId
string<uuid>

A entidade COMPANY.

Exemplo:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

personId
string<uuid>

A entidade INDIVIDUAL. Nenhum dado pessoal da pessoa é retornado aqui.

Exemplo:

"c1e384f5-ae1c-475e-9e64-a0abe533a96f"

ownershipPercentage
number | null

De 0 a 100, com até duas casas decimais.

Exemplo:

55.5

controlRole
string | null

Função em maiúsculas, por exemplo CEO, PARTNER, DIRECTOR, LEGAL_REPRESENTATIVE. null quando não informada.

validFrom
string<date>

Validade do link. O parâmetro validTo é nulo enquanto o link estiver ativo.

Exemplo:

"2024-01-15"

validTo
string<date> | null

Validade do link. O parâmetro validTo é nulo enquanto o link estiver ativo.

createdAt
string<date-time>

Tempo de criação.

Exemplo:

"2024-01-15T17:20:47Z"

Última modificação em 10 de novembro de 2026