Pular para o conteúdo principal

Pesquisar pessoas

É possível pesquisar pessoas por CPF, CNPJ ou e-mail.

Endpoints​

MétodoURL
GEThttps://{{url}}/cube/api/v3/pessoas?documento=XXXXXXXXXXX&tipoDocumento=YYYY
GEThttps://{{url}}/cube/api/v3/pessoas?email=XXXXXXXX

Tipos de documento​

tipoDocumentoParâmetro
cpfCPF
cnjpCNPJ

Exemplos de requisição utilizando documento​

/cube/api/v3/pessoas?tipoDocumento=CPF&documento=45563548031

Exemplos de requisição utilizando e-mail​

/cube/api/v3/pessoas?email=yamadataro@mycompany.com

Respostas​

StatusDescrição
200OK - Retorna os dados da pessoa pesquisada
404Pessoa não existe na base de dados ou usuário não possui permissão para a pesquisa de pessoas

Permissões necessárias​

PermissãoDescrição
seguranca:pessoas:pesquisarPermite a consulta de pessoas no CUBE