Pular para o conteúdo principal
GET
Obter uma entidade
Retorna a entidade completa: dados de KYC, documentos declarados com suas provas ativas, status derivados e, para uma COMPANY, o resumo de UBO.
  • O exemplo é uma COMPANY com dois proprietários vinculados: uboCount: 2, uboRequirementMet: true.
  • Entidades CLOSED continuam legíveis por id.
  • Um entityId que não seja UUID retorna 400.
Erros usam application/problem+json com um code estável. Catálogo completo: Status de Entidades e Códigos de Erro.

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

entityId
string<uuid>
obrigatório

ID interno da entidade.

Exemplo:

"5aced5da-40c1-4bec-85ff-c8cd1bcb4526"

Resposta

OK.

internalId
string<uuid>

Identificador da entidade na Localpayment. Use-o em todos os outros endpoints de Entities.

Exemplo:

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

externalId
string

Seu identificador, conforme enviado.

Exemplo:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

type
enum<string>

PESSOA FÍSICA ou EMPRESA.

Opções disponíveis:
INDIVIDUAL,
COMPANY
Exemplo:

"COMPANY"

status
enum<string>

Status da entidade. Consulte Status da entidade e Códigos de erro.

Opções disponíveis:
PENDING_KYC,
IN_REVIEW,
ACTIVE,
REJECTED,
BLOCKED,
CLOSED
Exemplo:

"PENDING_KYC"

name
string
Exemplo:

"Example Company S.A."

lastname
string | null
birthdate
string<date> | null
gender
string | null
nationality
string | null
birthCountry
string | null
residenceCountry
string | null
occupation
string | null
isPep
boolean
Exemplo:

false

incorporationDate
string<date>
Exemplo:

"2020-01-15"

incorporationCountry
string
Exemplo:

"BRA"

website
string
Exemplo:

"https://www.example.com/new"

Exemplo:

"Jane Doe"

email
string
Exemplo:

"test@example.com"

phone
object
address
object
attributes
object
documentationStatus
enum<string>

NO_FILES, PARTIAL ou COMPLETE: indica se nenhum, alguns ou todos os documentos declarados possuem pelo menos um arquivo. Mede a presença de arquivos, não a aprovação.

Opções disponíveis:
NO_FILES,
PARTIAL,
COMPLETE
Exemplo:

"COMPLETE"

document
object

O documento principal com seu documentId (necessário para enviar arquivos), o status derivado e as proofs[] atuais.

documents
object[]

Os demais documentos declarados (o principal está apenas em document), com a mesma estrutura.

version
integer

Versão da entidade. Igual ao cabeçalho ETag; envie-o de volta como If-Match no PATCH.

Exemplo:

3

createdAt
string<date-time>

Carimbos de data/hora UTC ISO 8601.

Exemplo:

"2024-01-15T17:18:53Z"

updatedAt
string<date-time>

Carimbos de data/hora UTC ISO 8601.

Exemplo:

"2024-01-15T17:19:26Z"

customFieldSchemaVersion
integer

Versão do esquema de campos personalizados usado para validar atributos, ou nulo.

Exemplo:

9

uboCount
integer

Número de vínculos de UBO ativos. Apenas no detalhe de uma entidade COMPANY; null nos demais casos.

Exemplo:

2

uboRequirementMet
boolean

Verdadeiro quando uboCount for igual ou superior a 1. Apenas nos detalhes de uma EMPRESA.

Exemplo:

true

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