Pular para o conteúdo principal
GET
Listar UBOs de uma empresa
Lista os vínculos de UBO ativos de uma empresa, ordenados por data de criação. Os vínculos encerrados são incluídos com includeEnded=true.
  • As respostas contêm apenas identificadores; consulte cada pessoa com Get an Entity.
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"

Parâmetros de consulta

includeEnded
boolean

Incluir links cujo valor de validTo já foi atingido ou que foram encerrados. O padrão é falso.

Resposta

OK.

items
object[]

Links UBO, mesmo formato que o Link a UBO.

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