Pesquisar pessoas

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

Endpoints

Método	URL
GET	https://{{url}}/cube/api/v3/pessoas?documento=XXXXXXXXXXX&tipoDocumento=YYYY
GET	https://{{url}}/cube/api/v3/pessoas?email=XXXXXXXX

Tipos de documento

tipoDocumento	Parâmetro
CPF	CPF
CNPJ	CNPJ
RNE	Documento de pessoa estrangeira. Em desenvolvimento - ainda não disponível em produção.

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

Exemplo de corpo da resposta

{
	"id": 123,
	"nome": "Yamada Taro",
	"email": "yamada@mycompany.com",
	"cpf": "11122233345",
	"dataNascimento": "1966-06-06T03:00:00.000Z",
	"tipoPessoa": "FISICA",
	"status": "ATIVO",
	"telefones": [
		{
			"id": 588,
			"tipo": "CELULAR",
			"ddd": 11,
			"numero": 987654321,
			"preferencial": true
		}
	]
}

Entre outros campos do cadastro da pessoa. O id é o utilizado em Vincular Pessoa ao Atendimento e no solicitante.id de Criar Solicitação.

Status da resposta

Status	Descrição
200	OK - Retorna os dados da pessoa pesquisada
400	Parâmetros ausentes: informe documento e tipoDocumento, ou email (parametro.obrigatorio). Em desenvolvimento - ainda não disponível em produção.
404	Pessoa não existe na base de dados ou usuário não possui permissão para a pesquisa de pessoas (pessoa.nao.encontrada)

Permissões necessárias

Permissão	Descrição
seguranca:pessoas:pesquisar	Permite a consulta de pessoas no CUBE