--- title: "Situação na Receita Completa" description: "Situação na Receita Federal de um CPF ou CNPJ com cadastro completo: endereços, telefones, e-mails, parentes, pessoas de contato e vínculos de trabalho. Cobrada só quando há informação; documento inválido é recusado sem cobrança." lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/99609be9-dd7e-11f1-98bb-bc24118aba26 markdown: https://doc.apibrasil.io/apis/creditos/99609be9-dd7e-11f1-98bb-bc24118aba26.md source: apibrasil-documentation --- # Situação na Receita Completa > Situação na Receita Federal de um CPF ou CNPJ com cadastro completo: endereços, telefones, e-mails, parentes, pessoas de contato e vínculos de trabalho. Cobrada só quando há informação; documento inválido é recusado sem cobrança. - **Categoria:** Consulta CPF - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 1,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/99609be9-dd7e-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 (3 endpoints) ### 1. POST /consulta/cpf/credits ⚠️ Aviso: a consulta é cobrada só quando há informação para o CPF consultado. Envie um POST com tipo=situacao-receita-completa e o cpf (11 dígitos, com ou sem máscara). A mesma consulta aceita cnpj no lugar do cpf; os dois campos juntos são recusados com HTTP 400, sem cobrança. Opcional: data_nascimento (dd/mm/aaaa, aaaa-mm-dd ou ddmmaaaa); veja o último endpoint. O campo data traz o cpf consultado, os campos numero_beneficio, outros_documentos e matriz_filial e as seções nome (documento, tipo_documento, nome, outras_grafias, data_nascimento, menor_idade, outras_datas_nascimento, pessoa_exposta_publicamente, idade, signo, obito, data_obito e mais 7 campos), dados_parentes (documento, nome, campo, obito, tipo_beneficio, aposentado, pontuacao, idade, menor_idade e idade_informacao), pessoas_contato (documento, nome, endereco, bairro, cep, cidade, uf, pontuacao e idade_informacao), pesquisa_enderecos (logradouro, endereco, bairro, cidade, numero, cep, bloco, apto, casa, quadra, lote, complemento e mais 5 campos), trabalha_trabalhou (documento, nome, logradouro, endereco, bairro, cidade, numero, cep, bloco, apartamento, casa, quadra e mais 9 campos), contato_preferencial (telefone_fixo, telefone_celular, telefone_outros, contatos, parentes, email e endereco), residentes_mesmo_domicilio (nome e documento), emails (email, pontuacao e idade_informacao), alerta_participacoes (quantidade) e pesquisa_telefones (celular, outros e comercial). CPF com dígito verificador errado é recusado com HTTP 400, sem cobrança; CPF sem informação na base devolve HTTP 404, sem cobrança. Dado bloqueado por ser de menor de idade devolve HTTP 422, 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 CPF válido, a resposta traz dados fictícios. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/cpf/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": "situacao-receita-completa", "cpf": "12345678909", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/cpf/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"situacao-receita-completa","cpf":"12345678909","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": "398,910", "balance_before": "400,000", "tax": "1,090", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 1,09.", "valor_consulta": 1.09, "api_limit_for": "credit", "homolog": false, "data": { "nome": { "existe_informacao": "SIM", "conteudo": { "documento": "00000000000", "tipo_documento": "PF", "nome": "NOME FICTICIO", "outras_grafias": [ "NOME F S" ], "data_nascimento": "01/01/1990", "menor_idade": { "chave": "18", "mensagem": "", "existe_menor": "NAO", "faixa_etaria": "MAIOR 18" }, "outras_datas_nascimento": [], "pessoa_exposta_publicamente": { "existe_informacao": "NAO", "relacionados": 0, "conteudo": "" }, "idade": "33", "signo": "Capricornio", "obito": "NAO", "data_obito": "", "sexo": "M", "uf": "SP,", "situacao_receita": "REGULAR", "situacao_receita_data": "1990-01-01", "situacao_receita_hora": "00:00:00", "situacao_receita_data_ultima_atualizacao": "1990-01-01", "estrangeiro": { "existe_informacao": "SIM", "estrangeiro": "NAO", "pais_origem": { "codigo": "10", "origem": "Brasileiro" } } } }, "dados_parentes": { "existe_informacao": "SIM", "conteudo": [ { "documento": "00000000000", "nome": "NOME FICTICIO MAE", "campo": "mae", "obito": "NAO", "tipo_beneficio": "", "aposentado": "", "pontuacao": "", "idade": "60", "menor_idade": { "chave": "18", "mensagem": "", "existe_menor": "NAO", "faixa_etaria": "MAIOR 18" }, "idade_informacao": "mais de 2 anos" } ] }, "pessoas_contato": { "existe_informacao": "SIM", "conteudo": [ { "documento": "00000000000", "nome": "NOME FICTICIO CONTATO", "endereco": "", "bairro": "", "cep": "00000000", "cidade": "", "uf": "", "pontuacao": "0", "idade_informacao": "mais de 2 anos" } ] }, "pesquisa_enderecos": { "existe_informacao": "SIM", "conteudo": [ { "logradouro": "RUA", "endereco": "RUA FICTICIA", "bairro": "BAIRRO FICTICIO", "cidade": "CIDADE FICTICIA", "numero": "000", "cep": "00000000", "bloco": "", "apto": "", "casa": "", "quadra": "", "lote": "", "complemento": "", "uf": "SP", "latitude": "-", "longitude": "-", "pontuacao": "4", "idade_informacao": "mais de 2 anos" } ] }, "trabalha_trabalhou": { "existe_informacao": "SIM", "conteudo": [ { "documento": "00000000000000", "nome": "EMPRESA FICTICIA SA", "logradouro": "AVENIDA", "endereco": "AVENIDA FICTICIA", "bairro": "BAIRRO FICTICIO", "cidade": "CIDADE FICTICIA", "numero": "000", "cep": "00000-000", "bloco": "", "apartamento": "", "casa": "", "quadra": "", "lote": "", "complemento": "", "uf": "SP", "telefones": [], "admissao": "1990-01-01", "desligamento": "1990-01-01", "cnae": [ "000000" ], "pontuacao": "0", "idade_informacao": "entre 1 e 6 meses" } ] }, "contato_preferencial": { "existe_informacao": "SIM", "conteudo": { "telefone_fixo": {}, "telefone_celular": { "ddd": "00", "telefone": "000000000", "operadora": "Operadora Ficticia", "operadoras_antigas": [], "pontuacao": "6", "id_endereco": "000000000", "portabilidade": { "operadora_original": [ { "operadora": "OPERADORA FICTICIA" } ], "portabilidade_atual": [ { "data": "1990-01-01", "operadora": "OPERADORA FICTICIA" } ], "portabilidade_anterior": [ { "data": "1990-01-01", "operadora": "OPERADORA FICTICIA ANTERIOR" } ] }, "idade_informacao": "mais de 2 anos" }, "telefone_outros": { "ddd": "00", "telefone": "00000000", "operadora": "Operadora Ficticia Fixo", "operadoras_antigas": [ "OPERADORA FICTICIA ANTIGA" ], "pontuacao": "4", "id_endereco": "0", "portabilidade": { "operadora_original": [ { "operadora": "OPERADORA FICTICIA ORIGINAL" } ], "portabilidade_atual": [ { "data": "1990-01-01", "operadora": "OPERADORA FICTICIA ATUAL" } ] }, "idade_informacao": "mais de 2 anos" }, "contatos": {}, "parentes": {}, "email": { "email": "[omitido]", "pontuacao": "2" }, "endereco": { "logradouro": "RUA", "endereco": "RUA FICTICIA", "bairro": "BAIRRO FICTICIO", "cidade": "CIDADE FICTICIA", "numero": "000", "cep": "00000000", "bloco": "", "apto": "", "casa": "", "quadra": "", "lote": "", "complemento": "", "uf": "SP", "latitude": "-", "longitude": "-", "pontuacao": "4", "idade_informacao": "mais de 2 anos" } } }, "residentes_mesmo_domicilio": { "existe_informacao": "SIM", "conteudo": [ { "nome": "NOME FICTICIO RESIDENTE", "documento": "00000000000" } ] }, "emails": { "existe_informacao": "SIM", "conteudo": [ { "email": "[omitido]", "pontuacao": "2", "idade_informacao": "mais de 2 anos" } ] }, "numero_beneficio": { "existe_informacao": "SIM" }, "alerta_participacoes": { "existe_informacao": "SIM", "conteudo": { "quantidade": "0" } }, "pesquisa_telefones": { "existe_informacao": "SIM", "conteudo": { "celular": [ { "ddd": "00", "telefone": "000000000", "operadora": "Operadora Ficticia", "operadoras_antigas": [], "pontuacao": "6", "id_endereco": "000000000", "portabilidade": { "operadora_original": [ { "operadora": "OPERADORA FICTICIA" } ], "portabilidade_atual": [ { "data": "1990-01-01", "operadora": "OPERADORA FICTICIA" } ], "portabilidade_anterior": [ { "data": "1990-01-01", "operadora": "OPERADORA FICTICIA ANTERIOR" } ] }, "idade_informacao": "mais de 2 anos" } ], "outros": [ { "ddd": "00", "telefone": "00000000", "operadora": "Operadora Ficticia Fixo", "operadoras_antigas": [ "OPERADORA FICTICIA ANTIGA" ], "pontuacao": "4", "id_endereco": "0", "portabilidade": { "operadora_original": [ { "operadora": "OPERADORA FICTICIA ORIGINAL" } ], "portabilidade_atual": [ { "data": "1990-01-01", "operadora": "OPERADORA FICTICIA ATUAL" } ] }, "idade_informacao": "mais de 2 anos" } ], "comercial": [] } }, "outros_documentos": { "existe_informacao": "SIM" }, "matriz_filial": { "existe_informacao": "NAO" }, "cpf": "12345678909" } } ``` ### 2. POST /consulta/cnpj/credits ⚠️ Aviso: a consulta é cobrada só quando há informação para o CNPJ consultado. Envie um POST com tipo=situacao-receita-completa e o cnpj (14 caracteres, com ou sem máscara). A mesma consulta aceita cpf no lugar do cnpj; os dois campos juntos são recusados com HTTP 400, sem cobrança. O campo data traz o cnpj consultado, os campos dados_parentes, trabalha_trabalhou, residentes_mesmo_domicilio, numero_beneficio e outros_documentos e as seções nome (documento, tipo_documento, nome, nome_fantasia, outras_grafias, data_nascimento, menor_idade, outras_datas_nascimento, idade, porte_empresa, obito, data_obito e mais 9 campos), pessoas_contato (documento, nome, endereco, bairro, cep, cidade, uf, pontuacao e idade_informacao), pesquisa_enderecos (logradouro, endereco, bairro, cidade, numero, cep, bloco, apto, casa, quadra, lote, complemento e mais 5 campos), contato_preferencial (telefone_fixo, telefone_celular, telefone_outros, contatos, parentes, email e endereco), emails (email, pontuacao e idade_informacao), alerta_participacoes (quantidade), pesquisa_telefones (outros) e matriz_filial (cnpj, filiais_ativas, filiais_baixadas, filiais_irregulares e tipo). CNPJ com dígito verificador errado é recusado com HTTP 400, sem cobrança; CNPJ sem informação 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 CNPJ válido, a resposta traz dados fictícios. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/cnpj/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": "situacao-receita-completa", "cnpj": "44959669000180", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/cnpj/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"situacao-receita-completa","cnpj":"44959669000180","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": "398,910", "balance_before": "400,000", "tax": "1,090", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 1,09.", "valor_consulta": 1.09, "api_limit_for": "credit", "homolog": false, "data": { "nome": { "existe_informacao": "SIM", "conteudo": { "documento": "00000000000", "tipo_documento": "PJ", "nome": "EMPRESA FICTICIA S A", "nome_fantasia": "", "outras_grafias": [ "EMPRESA FICTICIA LTDA" ], "data_nascimento": "01/01/1990", "menor_idade": { "chave": "18", "mensagem": "", "existe_menor": "NAO", "faixa_etaria": "MAIOR 18" }, "outras_datas_nascimento": [ "01/01/1990" ], "idade": "33", "porte_empresa": "DEMAIS", "obito": "NAO", "data_obito": "", "uf": "SP,", "situacao_receita": "ATIVA", "situacao_receita_data": "1990-01-01", "situacao_receita_hora": "", "situacao_receita_data_ultima_atualizacao": "1990-01-01", "natureza_juridica": "2054 - Sociedade anonima fechada", "cnae_primaria": "0000000", "descricao_cnae_primaria": "Desenvolvimento de programas de computador sob encomenda", "cnaes_secundarias": [ { "cnae": "0000000", "descricao": "Consultoria em tecnologia da informação" } ] } }, "dados_parentes": { "existe_informacao": "NAO" }, "pessoas_contato": { "existe_informacao": "SIM", "conteudo": [ { "documento": "00000000000", "nome": "NOME FICTICIO DE CONTATO", "endereco": "", "bairro": "", "cep": "00000000", "cidade": "", "uf": "", "pontuacao": "0", "idade_informacao": "" } ] }, "pesquisa_enderecos": { "existe_informacao": "SIM", "conteudo": [ { "logradouro": "RUA", "endereco": "RUA FICTICIA", "bairro": "BAIRRO FICTICIO", "cidade": "CIDADE FICTICIA", "numero": "00", "cep": "00000000", "bloco": "", "apto": "", "casa": "", "quadra": "", "lote": "", "complemento": "LOJA 00", "uf": "SP", "latitude": "-00.0000000", "longitude": "-00.0000000", "pontuacao": "2", "idade_informacao": "entre 1 e 2 anos" } ] }, "trabalha_trabalhou": { "existe_informacao": "NAO" }, "contato_preferencial": { "existe_informacao": "SIM", "conteudo": { "telefone_fixo": {}, "telefone_celular": {}, "telefone_outros": {}, "contatos": {}, "parentes": {}, "email": "", "endereco": { "logradouro": "RUA", "endereco": "RUA FICTICIA", "bairro": "BAIRRO FICTICIO", "cidade": "CIDADE FICTICIA", "numero": "00", "cep": "00000000", "bloco": "", "apto": "", "casa": "", "quadra": "", "lote": "", "complemento": "LOJA 00", "uf": "SP", "latitude": "-00.0000000", "longitude": "-00.0000000", "pontuacao": "2", "idade_informacao": "entre 1 e 2 anos" } } }, "residentes_mesmo_domicilio": { "existe_informacao": "NAO" }, "emails": { "existe_informacao": "SIM", "conteudo": [ { "email": "[omitido]", "pontuacao": "0", "idade_informacao": "mais de 2 anos" } ] }, "numero_beneficio": { "existe_informacao": "NAO" }, "alerta_participacoes": { "existe_informacao": "SIM", "conteudo": { "quantidade": "3" } }, "pesquisa_telefones": { "existe_informacao": "SIM", "conteudo": { "outros": [ { "ddd": "00", "telefone": "00000000", "operadora": "OPERADORA FICTICIA", "operadoras_antigas": [ "OPERADORA FICTICIA ANTIGA" ], "pontuacao": "0", "portabilidade": { "operadora_original": [ { "operadora": "OPERADORA FICTICIA ORIGINAL" } ], "portabilidade_atual": [ { "data": "1990-01-01", "operadora": "OPERADORA FICTICIA ATUAL" } ] }, "idade_informacao": " " } ] } }, "outros_documentos": { "existe_informacao": "NAO" }, "matriz_filial": { "existe_informacao": "SIM", "conteudo": { "cnpj": "00000000000000", "filiais_ativas": "1", "filiais_baixadas": "0", "filiais_irregulares": "0", "tipo": "Matriz" } }, "cnpj": "44959669000180" } } ``` ### 3. POST /consulta/cpf/credits Mesma consulta com o campo opcional data_nascimento (dd/mm/aaaa, aaaa-mm-dd ou ddmmaaaa), repassado à base de dados junto com o cpf. Valor fora do formato é recusado com HTTP 400, sem cobrança (data inexistente, futura ou anterior a 1900). Se a base exigir a data para o documento consultado, ou não encontrar a data informada, a resposta é HTTP 400; se a data não conferir com o cadastro, HTTP 422. Nos dois casos, sem cobrança. A resposta tem o mesmo formato da do primeiro endpoint. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/cpf/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": "situacao-receita-completa", "cpf": "12345678909", "data_nascimento": "15/03/1990", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/cpf/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"situacao-receita-completa","cpf":"12345678909","data_nascimento":"15/03/1990","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": "398,910", "balance_before": "400,000", "tax": "1,090", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 1,09.", "valor_consulta": 1.09, "api_limit_for": "credit", "homolog": false, "data": { "nome": { "existe_informacao": "SIM", "conteudo": { "documento": "00000000000", "tipo_documento": "PF", "nome": "NOME FICTICIO", "outras_grafias": [ "NOME F S" ], "data_nascimento": "01/01/1990", "menor_idade": { "chave": "18", "mensagem": "", "existe_menor": "NAO", "faixa_etaria": "MAIOR 18" }, "outras_datas_nascimento": [], "pessoa_exposta_publicamente": { "existe_informacao": "NAO", "relacionados": 0, "conteudo": "" }, "idade": "33", "signo": "Capricornio", "obito": "NAO", "data_obito": "", "sexo": "M", "uf": "SP,", "situacao_receita": "REGULAR", "situacao_receita_data": "1990-01-01", "situacao_receita_hora": "00:00:00", "situacao_receita_data_ultima_atualizacao": "1990-01-01", "estrangeiro": { "existe_informacao": "SIM", "estrangeiro": "NAO", "pais_origem": { "codigo": "10", "origem": "Brasileiro" } } } }, "dados_parentes": { "existe_informacao": "SIM", "conteudo": [ { "documento": "00000000000", "nome": "NOME FICTICIO MAE", "campo": "mae", "obito": "NAO", "tipo_beneficio": "", "aposentado": "", "pontuacao": "", "idade": "60", "menor_idade": { "chave": "18", "mensagem": "", "existe_menor": "NAO", "faixa_etaria": "MAIOR 18" }, "idade_informacao": "mais de 2 anos" } ] }, "pessoas_contato": { "existe_informacao": "SIM", "conteudo": [ { "documento": "00000000000", "nome": "NOME FICTICIO CONTATO", "endereco": "", "bairro": "", "cep": "00000000", "cidade": "", "uf": "", "pontuacao": "0", "idade_informacao": "mais de 2 anos" } ] }, "pesquisa_enderecos": { "existe_informacao": "SIM", "conteudo": [ { "logradouro": "RUA", "endereco": "RUA FICTICIA", "bairro": "BAIRRO FICTICIO", "cidade": "CIDADE FICTICIA", "numero": "000", "cep": "00000000", "bloco": "", "apto": "", "casa": "", "quadra": "", "lote": "", "complemento": "", "uf": "SP", "latitude": "-", "longitude": "-", "pontuacao": "4", "idade_informacao": "mais de 2 anos" } ] }, "trabalha_trabalhou": { "existe_informacao": "SIM", "conteudo": [ { "documento": "00000000000000", "nome": "EMPRESA FICTICIA SA", "logradouro": "AVENIDA", "endereco": "AVENIDA FICTICIA", "bairro": "BAIRRO FICTICIO", "cidade": "CIDADE FICTICIA", "numero": "000", "cep": "00000-000", "bloco": "", "apartamento": "", "casa": "", "quadra": "", "lote": "", "complemento": "", "uf": "SP", "telefones": [], "admissao": "1990-01-01", "desligamento": "1990-01-01", "cnae": [ "000000" ], "pontuacao": "0", "idade_informacao": "entre 1 e 6 meses" } ] }, "contato_preferencial": { "existe_informacao": "SIM", "conteudo": { "telefone_fixo": {}, "telefone_celular": { "ddd": "00", "telefone": "000000000", "operadora": "Operadora Ficticia", "operadoras_antigas": [], "pontuacao": "6", "id_endereco": "000000000", "portabilidade": { "operadora_original": [ { "operadora": "OPERADORA FICTICIA" } ], "portabilidade_atual": [ { "data": "1990-01-01", "operadora": "OPERADORA FICTICIA" } ], "portabilidade_anterior": [ { "data": "1990-01-01", "operadora": "OPERADORA FICTICIA ANTERIOR" } ] }, "idade_informacao": "mais de 2 anos" }, "telefone_outros": { "ddd": "00", "telefone": "00000000", "operadora": "Operadora Ficticia Fixo", "operadoras_antigas": [ "OPERADORA FICTICIA ANTIGA" ], "pontuacao": "4", "id_endereco": "0", "portabilidade": { "operadora_original": [ { "operadora": "OPERADORA FICTICIA ORIGINAL" } ], "portabilidade_atual": [ { "data": "1990-01-01", "operadora": "OPERADORA FICTICIA ATUAL" } ] }, "idade_informacao": "mais de 2 anos" }, "contatos": {}, "parentes": {}, "email": { "email": "[omitido]", "pontuacao": "2" }, "endereco": { "logradouro": "RUA", "endereco": "RUA FICTICIA", "bairro": "BAIRRO FICTICIO", "cidade": "CIDADE FICTICIA", "numero": "000", "cep": "00000000", "bloco": "", "apto": "", "casa": "", "quadra": "", "lote": "", "complemento": "", "uf": "SP", "latitude": "-", "longitude": "-", "pontuacao": "4", "idade_informacao": "mais de 2 anos" } } }, "residentes_mesmo_domicilio": { "existe_informacao": "SIM", "conteudo": [ { "nome": "NOME FICTICIO RESIDENTE", "documento": "00000000000" } ] }, "emails": { "existe_informacao": "SIM", "conteudo": [ { "email": "[omitido]", "pontuacao": "2", "idade_informacao": "mais de 2 anos" } ] }, "numero_beneficio": { "existe_informacao": "SIM" }, "alerta_participacoes": { "existe_informacao": "SIM", "conteudo": { "quantidade": "0" } }, "pesquisa_telefones": { "existe_informacao": "SIM", "conteudo": { "celular": [ { "ddd": "00", "telefone": "000000000", "operadora": "Operadora Ficticia", "operadoras_antigas": [], "pontuacao": "6", "id_endereco": "000000000", "portabilidade": { "operadora_original": [ { "operadora": "OPERADORA FICTICIA" } ], "portabilidade_atual": [ { "data": "1990-01-01", "operadora": "OPERADORA FICTICIA" } ], "portabilidade_anterior": [ { "data": "1990-01-01", "operadora": "OPERADORA FICTICIA ANTERIOR" } ] }, "idade_informacao": "mais de 2 anos" } ], "outros": [ { "ddd": "00", "telefone": "00000000", "operadora": "Operadora Ficticia Fixo", "operadoras_antigas": [ "OPERADORA FICTICIA ANTIGA" ], "pontuacao": "4", "id_endereco": "0", "portabilidade": { "operadora_original": [ { "operadora": "OPERADORA FICTICIA ORIGINAL" } ], "portabilidade_atual": [ { "data": "1990-01-01", "operadora": "OPERADORA FICTICIA ATUAL" } ] }, "idade_informacao": "mais de 2 anos" } ], "comercial": [] } }, "outros_documentos": { "existe_informacao": "SIM" }, "matriz_filial": { "existe_informacao": "NAO" }, "cpf": "12345678909" } } ``` 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/99609be9-dd7e-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/99609be9-dd7e-11f1-98bb-bc24118aba26