--- title: "Busca por Nome" description: "Localiza pessoas e empresas pelo nome completo, dentro de um estado, e devolve de cada resultado o tipo de pessoa, o CPF ou CNPJ, a data de nascimento ou de abertura, a cidade e a UF. Cobrada quando a base devolve ao menos um resultado; nome incompleto ou UF inválida são recusados sem cobrança. Disponível para contas PJ." lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/6b270a2a-dda4-11f1-98bb-bc24118aba26 markdown: https://doc.apibrasil.io/apis/creditos/6b270a2a-dda4-11f1-98bb-bc24118aba26.md source: apibrasil-documentation --- # Busca por Nome > Localiza pessoas e empresas pelo nome completo, dentro de um estado, e devolve de cada resultado o tipo de pessoa, o CPF ou CNPJ, a data de nascimento ou de abertura, a cidade e a UF. Cobrada quando a base devolve ao menos um resultado; nome incompleto ou UF inválida são recusados sem cobrança. Disponível para contas PJ. - **Categoria:** Consulta CPF - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 3,09 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/6b270a2a-dda4-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 (1 endpoint) ### 1. POST /consulta/busca-por-nome/credits Envie um POST com tipo=busca-por-nome, o nome completo (nome e sobrenome, só letras) e a uf (sigla do estado). Os dois campos são obrigatórios. O campo data traz resultados, uma lista com nome, tipo_pessoa (FISICA ou JURIDICA), documento (CPF ou CNPJ, só dígitos), nascimento (dd/mm/aaaa; na pessoa jurídica é a data de abertura), cidade e uf de cada pessoa ou empresa encontrada, além do nome e da uf consultados. Nome com um termo só, com número ou com símbolo e UF inexistente são recusados com HTTP 400, sem cobrança; nome sem nenhum resultado no estado devolve HTTP 404, sem cobrança. Base de dados indisponível devolve HTTP 502, 503 ou 504, sem cobrança. Disponível para contas PJ. 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/busca-por-nome/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": "busca-por-nome", "nome": "Fulano de Teste", "uf": "MG", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/busca-por-nome/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"busca-por-nome","nome":"Fulano de Teste","uf":"MG","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": "396,910", "balance_before": "400,000", "tax": "3,090", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 3,09.", "valor_consulta": 3.09, "api_limit_for": "credit", "homolog": false, "data": { "resultados": [ { "nome": "NOME FICTICIO DE TESTE", "tipo_pessoa": "FISICA", "documento": "00000000000", "nascimento": "01/01/1990", "cidade": "CIDADE FICTICIA", "uf": "MG" }, { "nome": "NOME FICTICIO DE TESTE 0000000", "tipo_pessoa": "JURIDICA", "documento": "00000000000000", "nascimento": "01/01/2010", "cidade": "CIDADE FICTICIA", "uf": "MG" } ], "nome": "Fulano de Teste", "uf": "MG" } } ``` 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/6b270a2a-dda4-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/6b270a2a-dda4-11f1-98bb-bc24118aba26