Skip to main content
POST
Busca por telefone
Executa uma busca paginada de pessoa física a partir de um telefone com DDD. Use esta rota quando você possui um telefone e precisa localizar possíveis pessoas físicas relacionadas a ele.

Corpo da requisição

string
required
Telefone com DDD. Pontuação é aceita e removida automaticamente.
integer
default:"1"
Página dos resultados. Use a próxima página enquanto has_more for true.
string
Use sandbox para executar uma chamada de teste sem consumo de saldo.
Para detalhes sobre chamadas de teste, consulte Ambiente de teste.

Regras do telefone

O telefone deve conter DDD e 10 ou 11 dígitos após normalização. O prefixo internacional 55 é aceito e removido automaticamente quando informado.

Exemplo de corpo

Resposta

integer
required
Código da resposta da API.
string
required
Mensagem descritiva da resposta.
object
required
Objeto principal com os registros encontrados, dados de paginação, cobrança e tempo de execução.

Estrutura de result

Estrutura de result.items[]

Campos de items[] podem não ser retornados em todas as consultas. A disponibilidade depende do telefone informado e dos dados existentes para os registros encontrados.

Paginação

Quando has_more retornar true, envie a mesma requisição incrementando page.

Respostas esperadas

As respostas possíveis estão exemplificadas no painel lateral da página.

Fluxo recomendado

  1. Informe o telefone com DDD.
  2. Leia items e verifique has_more.
  3. Se has_more for true, consulte a próxima página.
  4. Use x-ambient: sandbox para validar integração sem consumir saldo.