Pular para o conteúdo principal
GET
Listar entidades
Retorna uma lista paginada das suas entidades. Entidades encerradas são excluídas, a menos que includeClosed=true.
  • Valores de enum inválidos nos filtros retornam 400 VALIDATION_ERROR.
  • A filtragem por nome não está disponível.
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 consulta

type
enum<string>

PESSOA FÍSICA ou EMPRESA.

Opções disponíveis:
INDIVIDUAL,
COMPANY
status
enum<string>

Status da entidade.

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

Correspondência exata com seu identificador.

documentId
string

Número do documento declarado (correspondência exata).

documentationStatus
enum<string>

NO_FILES, PARTIAL, COMPLETE.

Opções disponíveis:
NO_FILES,
PARTIAL,
COMPLETE
createdFrom
string<date-time>

ISO 8601, inclusivo.

createdTo
string<date-time>

ISO 8601, inclusivo.

includeClosed
boolean

Incluir entidades FECHADAS. Padrão: falso.

pageIndex
integer

Página com base zero. Valor padrão: 0.

pageSize
integer

Valor padrão 20, máximo 200 (valores maiores são limitados).

Resposta

OK.

pageIndex
integer

Dados de paginação.

Exemplo:

0

pageSize
integer

Dados de paginação.

Exemplo:

20

totalElements
integer

Dados de paginação.

Exemplo:

1

totalPages
integer

Dados de paginação.

Exemplo:

1

content
object[]

Entidades, com o mesmo formato de Obter uma Entidade. uboCount e uboRequirementMet são nulos nas listagens.

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