--- title: "Lista Telefônica" description: "Lista telefônica por nome: devolve telefones e endereços de pessoas e empresas com o nome pesquisado, com documento, operadora e tipo de pessoa. Aceita filtro por CEP, cidade e UF. Cobrada quando a base devolve ao menos um resultado; nome inválido é recusado sem cobrança." lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/1257a9df-ddd0-11f1-98bb-bc24118aba26 markdown: https://doc.apibrasil.io/apis/creditos/1257a9df-ddd0-11f1-98bb-bc24118aba26.md source: apibrasil-documentation --- # Lista Telefônica > Lista telefônica por nome: devolve telefones e endereços de pessoas e empresas com o nome pesquisado, com documento, operadora e tipo de pessoa. Aceita filtro por CEP, cidade e UF. Cobrada quando a base devolve ao menos um resultado; nome inválido é recusado sem cobrança. - **Categoria:** Consulta CPF - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 0,29 por consulta - **Limite:** 990.000 por mês - **Cadastro:** exige CNPJ - **Versão:** v2 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/1257a9df-ddd0-11f1-98bb-bc24118aba26/openapi.json ## Como chamar **Endereço base:** `https://gateway.apibrasil.io/api/v2` Autenticação: cabeçalho `Authorization: Bearer `. Nada além disso. Com `homolog: true` no corpo, o gateway responde de uma base fixa, com a forma real da resposta, e não cobra. O CPF 00000000000 é dessa base e não é de ninguém: use-o nos testes, nunca em produção. ## Endpoints (2 endpoints) ### 1. POST /consulta/lista-telefonica/credits ⚠️ Aviso: a consulta é cobrada quando a base devolve ao menos um telefone para o nome pesquisado. Envie um POST com tipo=lista-telefonica e o nome da pessoa ou da empresa (ao menos 3 letras; letras, números, espaço e . & ' -). O nome é pesquisado em maiúsculas e sem acento. O campo data traz o nome pesquisado e a lista resultados, um item por telefone, com documento, nome, DDD, telefone, operadora, endereço e tipo de pessoa. Nome inválido é recusado com HTTP 400, sem cobrança; nome sem telefone na base devolve HTTP 404, sem cobrança. Base de dados indisponível devolve HTTP 502, 503 ou 504, sem cobrança. Em homologação (homolog=true), sem cobrança e com qualquer nome válido, a resposta traz dados fictícios. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/lista-telefonica/credits` - **Versão da rota:** v2 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "lista-telefonica", "nome": "João da Silva", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/lista-telefonica/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"lista-telefonica","nome":"João da Silva","homolog":true}' ``` Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação. **Resposta de exemplo, do catálogo** ```json { "user": { "first_name": "[omitido]", "email": "[omitido]", "cellphone": "[omitido]", "notification": "yes" }, "balance": "399,710", "balance_before": "400,000", "tax": "0,290", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 0,29.", "valor_consulta": 0.29, "api_limit_for": "credit", "homolog": false, "data": { "nome": "JOAO DA SILVA", "resultados": [ { "apartamento_conjunto": "", "bairro": "0", "bloco": "", "cep": "00000000", "cidade": "CIDADE FICTICIA", "complemento": "", "ddd": "00", "documento": "00000000000000", "endereco": "RUA FICTICIA", "idade": "0", "logradouro": "R", "menor_idade": { "chave": "18", "existe_menor": "NAO", "faixa_etaria": "MAIOR 18", "mensagem": "" }, "nome": "NOME FICTICIO - MEI", "numero": "0", "operadora": "OPERADORA FICTICIA", "sexo": "", "telefone": "00000000", "tipopessoa": "PJ", "uf": "ESTADO FICTICIO" } ] } } ``` ### 2. POST /consulta/lista-telefonica/credits ⚠️ Aviso: a consulta é cobrada quando a base devolve ao menos um telefone para o nome pesquisado. A mesma consulta com filtros opcionais: cep (8 dígitos), cidade e uf (sigla). Filtro inválido é recusado com HTTP 400, sem cobrança. Nome inválido é recusado com HTTP 400, sem cobrança; nome sem telefone na base devolve HTTP 404, sem cobrança. Base de dados indisponível devolve HTTP 502, 503 ou 504, sem cobrança. Em homologação (homolog=true), sem cobrança e com qualquer nome válido, a resposta traz dados fictícios. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/lista-telefonica/credits` - **Versão da rota:** v2 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "lista-telefonica", "nome": "João da Silva", "cep": "80010-000", "cidade": "Curitiba", "uf": "PR", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/lista-telefonica/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"lista-telefonica","nome":"João da Silva","cep":"80010-000","cidade":"Curitiba","uf":"PR","homolog":true}' ``` Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação. **Resposta de exemplo, do catálogo** ```json { "user": { "first_name": "[omitido]", "email": "[omitido]", "cellphone": "[omitido]", "notification": "yes" }, "balance": "399,710", "balance_before": "400,000", "tax": "0,290", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 0,29.", "valor_consulta": 0.29, "api_limit_for": "credit", "homolog": false, "data": { "nome": "JOAO DA SILVA", "resultados": [ { "apartamento_conjunto": "", "bairro": "0", "bloco": "", "cep": "00000000", "cidade": "CIDADE FICTICIA", "complemento": "", "ddd": "00", "documento": "00000000000000", "endereco": "RUA FICTICIA", "idade": "0", "logradouro": "R", "menor_idade": { "chave": "18", "existe_menor": "NAO", "faixa_etaria": "MAIOR 18", "mensagem": "" }, "nome": "NOME FICTICIO - MEI", "numero": "0", "operadora": "OPERADORA FICTICIA", "sexo": "", "telefone": "00000000", "tipopessoa": "PJ", "uf": "ESTADO FICTICIO" } ] } } ``` Nos exemplos de resposta, os campos da conta que gerou o exemplo (`user.first_name`, `user.email`, `user.cellphone`) saem como `[omitido]`. O resto é o que o catálogo publica. ## Armadilhas: o que uma integração erra sem avisar Apuradas nas respostas que o próprio catálogo publica. Em todas elas o código funciona no caminho feliz e falha em silêncio no resto: 1. **O erro chega no CORPO, com HTTP 200.** A resposta traz um campo `error` booleano e uma `message`. Checar só `response.ok` ou o status HTTP deixa passar falha como sucesso. Confira SEMPRE `error === false` antes de ler `data`. 2. **`balance`, `tax` e `extra_charges.total` são STRING em formato brasileiro — e o formato varia entre APIs.** Valores observados no catálogo: `"154,380"`, `"497,84"`, `"0,000"` e `"0.19"`. Vírgula em umas, ponto em outra; três casas decimais em umas, duas em outra. Em JavaScript, `parseFloat("154,380")` devolve `154` e perde os centavos sem erro nenhum, e `Number("154,380")` devolve `NaN`. Escreva um conversor que trate os dois separadores, e nunca use esses campos numa decisão financeira sem convertê-los. 3. **Cada chamada custa dinheiro.** Retry cego multiplica a conta. Nunca repita automaticamente um 4xx: parâmetro errado repetido continua errado e continua cobrando. Repita só tempo esgotado e 5xx, com recuo exponencial e um teto pequeno de tentativas. 4. **HTTP 402 é saldo insuficiente, e repetir não resolve.** É o único status que exige ação humana — recarregar. Trate-o como erro terminal, com mensagem própria, e não o jogue no mesmo balde dos 4xx genéricos. 5. **`extra_charges` cobra à parte do preço da consulta.** Quando o corpo pede serviços adicionais, a resposta traz cada um com o preço e um `total` que NÃO está incluso no valor base. Se você mostra custo a quem usa, some os dois. ## Ver também - Especificação OpenAPI: https://doc.apibrasil.io/apis/creditos/1257a9df-ddd0-11f1-98bb-bc24118aba26/openapi.json - Catálogo de APIs: [Catálogo de APIs](https://doc.apibrasil.io/apis.md) - SDKs oficiais: [SDKs oficiais](https://doc.apibrasil.io/sdks.md) - Índice da documentação: https://doc.apibrasil.io/llms.txt - Versão HTML desta página: https://doc.apibrasil.io/apis/creditos/1257a9df-ddd0-11f1-98bb-bc24118aba26