get https://sandbox.auth.flowfinance.com.br/persons
Esse endpoint é responsável por retornar uma lista paginada das pessoas cadastradas. É possível realizar uma série de filtros, ordenações e navegar entre as páginas de resultados.
As informações sensíveis serão retornadas mascaradas por questão de segurança, porém, nesse endpoint é possível obter o ID da pessoa.
Parâmetros da Requisição
personId
(string/uuid v4): ID para filtro de uma Pessoa.
taxpayerId
(string): Nº do CPF ou CNPJ da pessoa.
search
(string): Campo para busca textual.
sort
(string): Campo para ordenação dos resultados. Possíveis valores: id, createdAt, taxpayerId.
Resposta
Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato:
content
(object list): Objeto contendo a lista com o resultado do filtro realizado.
hasNext
(boolean): Campo para indicar se tem uma próxima página.
totalElements
(int): Quantidade total de registros retornados para a busca realizada.
totalPages
(int): Quantidade total de páginas retornadas para a busca realizada.
Objeto 'content'
id
(string/uuid v4): ID do cadastro da pessoa.
name
(string): O nome completo da pessoa.
personType
(string): O tipo da pessoa. Possíveis valores: NATURAL, LEGAL.
createdAt
(datetime): Data e hora do cadastro.
businessType
(string): Tipo da empresa, se pessoa for do tipo jurídica. Possíveis valores: FUND, MANAGER, SECURITIZER, CONSULTANT, CUSTODIAN, ADMINISTRATOR, OTHERS.
legalName
(string): Razão social, se pessoa for do tipo jurídica.
Exemplo de JSON:
{
"content": [
{
"id": "",
"personType": "NATURAL",
"name": "",
"createdAt": "",
"businessType": "CUSTODIAN",
"legalName": {}
},
{
"id": "",
"personType": "LEGAL",
"name": "",
"createdAt": "",
"businessType": "OTHERS",
"legalName": {}
}
],
"hasNext": "",
"totalElements": "",
"totalPages": ""
}