--- title: "Crédito Simples PF" description: "API Crédito Simples PF - Consulta Rápida de Crédito por CPF" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/67ce75b8-cd2d-4ee5-b626-8f86c7e9acd7 markdown: https://doc.apibrasil.io/apis/creditos/67ce75b8-cd2d-4ee5-b626-8f86c7e9acd7.md source: apibrasil-documentation --- # Crédito Simples PF > API Crédito Simples PF - Consulta Rápida de Crédito por CPF - **Categoria:** Regularidade Fiscal - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 15,75 por consulta - **Limite:** 999.000 por mês - **Cadastro:** exige CNPJ - **Versão:** v2 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/67ce75b8-cd2d-4ee5-b626-8f86c7e9acd7/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/cpf/credits API Crédito Simples PF - Descubra oportunidades de crédito instantaneamente A API Crédito Simples PF permite consultar rapidamente créditos vinculados a um CPF, trazendo informações valiosas em tempo real para potencializar decisões financeiras no seu sistema. Com integração simples via método POST, você pode incorporar facilmente essa funcionalidade e oferecer respostas imediatas aos seus clientes, agregando agilidade e confiabilidade ao seu negócio. O retorno da API traz dados precisos sobre créditos disponíveis, viabilizando soluções como análises de risco automatizadas, ofertas personalizadas e fluxos de contratação muito mais eficientes. Aproveite esta ferramenta para transformar a experiência do usuário e dar mais segurança às suas operações. - **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 { "cpf": "00000000000", "tipo": "creditos-simples-pf", "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 '{"cpf":"00000000000","tipo":"creditos-simples-pf","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": "105,660", "balance_before": "105,660", "tax": "0,000", "status_code": 200, "error": false, "message": "Dados validos em homologacao! Voce nao foi tarifado e a requisicao nao foi contabilizada.", "valor_consulta": 0, "api_limit_for": "homolog", "homolog": true, "data": { "apontamentosQuod": [], "ccfQuod": [], "dadosCadastraisPFAP": { "endereco": "RUA EXEMPLO SEM NUMERO", "estadoCivil": "SOLTEIRO", "grauInstrucao": "Informacao nao fornecida", "nome": "USUARIO DEMO TESTE", "nomeMae": "MAE DEMO TESTE", "numeroDependentes": "0", "numeroRG": "000000000", "regiaoCPF": "SP", "rendaPresumida": "Faixa ficticia", "situacao": "Regular", "telefone": "11000000000", "textoRendaPresumida": "Dado meramente ilustrativo.", "tituloEleitor": "0000000000000", "uf": "SP" }, "dadosCnh": { "bloqueios": [], "categoria": "B", "categoriaAutorizada": "B", "categoriaRebaixada": null, "cursos": [], "dataEmissao": "2020-01-01", "dataPrimeiraHabilitacao": "2015-01-01", "dataUltimaAtualizacao": "2024-01-01", "descricao": "CNH demonstrativa", "habilitacaoEstrangeira": null, "identificacaoHabilitacaoEstrangeira": null, "impedimento": null, "motivo": { "requerimento1": null, "requerimento2": null, "requerimento3": null, "requerimento4": null, "requerimentoPid1": null, "requerimentoPid2": null, "requerimentoPid3": null, "requerimentoPid4": null }, "numeroEspelho": "000000", "numeroFormularioCnh": "999999999", "numeroFormularioCnhBasePid": null, "numeroFormularioPid": null, "numeroListaImpedimento": null, "numeroPgu": null, "numeroRegistro": "11111111111", "numeroRenach": "SP000000000", "observacoes": [], "orgaoExpedidor": "DETRAN/SP", "paisOrigemHabilitacaoEstrangeira": null, "portaria": null, "situacaoCnhAnterior": null, "toxicologico": { "dataColeta": null, "dataVencimento": null, "situacao": null }, "ufDominio": "SP", "ufExpedicao_pid": null, "ufExpeditor": "SP", "ufHabilitacaoAtual": "SP", "ufPrimeiraHabilitacao": "SP", "ufSolicitanteTransferencia": null, "validade": "2030-01-01" }, "debitoAcPosPF": [], "historicoEmail": [ { "_id": "mock-email-1", "email": "[omitido]", "id": "mock-email-1", "itemUltimaAtualizacao": "10/01/2025" }, { "_id": "mock-email-2", "email": "[omitido]", "id": "mock-email-2", "itemUltimaAtualizacao": "22/05/2024" } ], "historicoEndereco": [], "historicoNumero": [], "infoQuod": { "celular": { "dataUltimaAtualizacao": "01/02/2025", "numero": "11999990000" }, "cpf": "00000000000", "cpfStatus": "Regular", "dataNascimento": "01/01/1990", "dataUltimaAtualizacaoNome": "05/01/2025", "email": { "dataUltimaAtualizacao": "10/01/2025", "endereco": "[omitido]" }, "endereco": { "bairro": "CENTRO", "cep": "00000-000", "cidade": "SAO PAULO", "complemento": "APTO 12", "dataUltimaAtualizacao": "15/12/2024", "estado": "SP", "numero": "000", "rua": "RUA EXEMPLO" }, "genero": "M", "idade": 31, "nome": "USUARIO DEMO TESTE", "nomeMae": "MAE DEMO TESTE", "telefone": { "dataUltimaAtualizacao": "01/02/2025", "numero": "1100000000" } }, "inquiriesQuod": { "consultas31a60Dias": 1, "consultas61a90Dias": 0, "consultasMais90Dias": 2, "consultasUltimos30Dias": 2 }, "negativeQuod": { "apontamentos": [], "dataUltimoApontamento": "-/-/-", "pendenciasCredito": 0 }, "pendenciasFinanceiras": { "pefin": { "dataMaiorValor": null, "dataPrimeiro": null, "dataUltimaOcorrencia": null, "detalhes": [], "maiorValor": 0, "periodoFinal": null, "periodoInicial": null, "quantidade": 0, "quantidadeCredores": null, "valorAvalista": null, "valorDevedor": null, "valorPrimeiro": 0, "valorTotal": 0 }, "refin": { "dataPrimeiro": null, "dataUltimaOcorrencia": null, "detalhes": [], "quantidade": 0, "valorTotal": null }, "scpc": { "moeda": null, "primeiraOcorrencia": null, "quantidade": null, "registros": [], "ultimaOcorrencia": null, "valorTotal": null } }, "processoJudicial": { "acoesJudiciais": [ { "_id": "mock-acao-1", "acoesJudiciaisRelacionadas": [], "assuntoPrincipal": "DIREITO CIVIL - CONTRATO DEMONSTRATIVO", "atualizacoes": [], "corpoJulgado": "5 VARA CIVEL DE SAO PAULO", "dataAviso": "2021-03-15T00:00:00", "dataCaptura": "2024-06-20T12:40:22", "dataEncerramento": "2022-04-10T00:00:00", "dataPublicacao": "2021-11-18T00:00:00", "dataRedistribuicao": "0001-01-01T00:00:00", "dataUltimaMovimentacao": "2022-04-10T00:00:00", "decisoes": [], "envolvidos": [ { "_id": "mock-envolvido-1", "dataUltimaCaptura": "2022-04-10T00:00:00", "detalhesEnvolvido": { "OAB": null, "estado": null, "tipoEspecifico": "AUTOR" }, "documento": "00000000000", "nome": "USUARIO DEMO TESTE", "parteAtiva": true, "polaridade": "ACTIVE", "tipo": "AUTHOR" }, { "_id": "mock-envolvido-2", "dataUltimaCaptura": "2022-04-10T00:00:00", "detalhesEnvolvido": { "OAB": "123456", "estado": "SP", "tipoEspecifico": "ADVOGADO (AUTOR)" }, "documento": "00011122233", "nome": "ADVOGADA DEMO", "parteAtiva": true, "polaridade": "NEUTRAL", "tipo": "LAWYER" } ], "estado": "SP", "id": "mock-acao-1", "idadeProcessoLegal": "365", "juiz": null, "nomeAssuntoCnjInferido": "INDENIZACAO POR DANOS", "nomeTribunal": "TJSP", "numero": "1234567202108130024", "numeroAssuntoCnjInferido": "10433", "numeroAtualizacoes": "8", "numeroInstancia": "1", "numeroMedioAtualizacoesMes": null, "numeroPaginas": null, "numeroPartes": "2", "numeroVolumes": null, "outrosAssuntos": [ "RESPONSABILIDADE CIVIL" ], "peticoes": [], "razaoDadosOcultos": null, "resDataJudicata": "0001-01-01T00:00:00", "status": "ARQUIVADO", "tipo": "PROCEDIMENTO COMUM", "tipoTribunal": "CIVEL", "tribunalDistrital": "SAO PAULO", "ultimaAtualizacao": "2022-04-10T00:00:00", "valor": "5000" } ], "acoesJudiciaisPrimeiraInstancia": 1, "acoesJudiciaisSegredoJustica": 0, "acoesJudiciaisSegundaInstancia": 0, "acoesJudiciaisTerceiraInstancia": 0, "acoesJudiciaisUltimos180Dias": 0, "acoesJudiciaisUltimos30Dias": 0, "acoesJudiciaisUltimos365Dias": 0, "acoesJudiciaisUltimos90Dias": 0, "dataPrimeiraAcaoJudicial": "2021-03-15T00:00:00", "dataUltimaAcaoJudicial": "2021-03-15T00:00:00", "totalAcoesJudiciais": 1, "totalAcoesJudiciaisAutor": 1, "totalAcoesJudiciaisOutro": 0, "totalAcoesJudiciaisReu": 0 }, "protestosQuod": [ { "_id": "mock-protesto-1", "cartorios": [], "dataConsulta": "2024-12-01", "id": "mock-protesto-1", "situacao": "SEM INFORMACAO", "valorTotalProtestado": "0,00" } ], "protestosVecPj": { "ext": "00000000000", "numRegistros": 0, "ocorrenciaMaisAntiga": null, "ocorrenciaMaisRecente": null, "registros": [], "valorTotal": "0,00" }, "quodScore": { "perfilScore": 50, "pontuacaoCompromissoPagamento": 50, "probabilidadeDePagamento": "80%", "probabilidadeDePagamentoMensagem": "Chance de nao pagamento estimada em 20% (dado ilustrativo).", "razoes": [ { "_id": "mock-razao-1", "codigo": "R003", "id": "mock-razao-1", "mensagem": "Historico curto de produtos financeiros (mock)." }, { "_id": "mock-razao-2", "codigo": "R001", "id": "mock-razao-2", "mensagem": "Atraso pontual em pagamento anterior (mock)." } ], "riscoCreditoMensagem": "Capacidade de pagamento estimada (mock).", "riscoDeCredito": "MEDIO", "score": 600, "tipo": "PF" }, "resumoAcessoPositivoPF": [ { "_id": "mock-resumo-1", "id": "mock-resumo-1", "periodoFinal": null, "periodoInicial": null, "titulo": "Protesto Nacional", "total": "0", "valorAcumulado": "0" }, { "_id": "mock-resumo-2", "id": "mock-resumo-2", "periodoFinal": null, "periodoInicial": null, "titulo": "Pendencias Financeiras", "total": "0", "valorAcumulado": "0" } ], "resumoQuod": [ { "_id": "mock-rq-1", "dataPrimeiro": null, "dataUltimo": null, "descricao": "Cheque sem fundo", "id": "mock-rq-1", "quantidade": 0, "valor": 0 }, { "_id": "mock-rq-2", "dataPrimeiro": null, "dataUltimo": null, "descricao": "Pendencias Financeiras", "id": "mock-rq-2", "quantidade": 0, "valor": 0 }, { "_id": "mock-rq-3", "dataPrimeiro": null, "dataUltimo": null, "descricao": "Acoes Judiciais", "id": "mock-rq-3", "quantidade": 1, "valor": 5000 } ], "tituloProtestadoAcPosPF": [] } } ``` 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/67ce75b8-cd2d-4ee5-b626-8f86c7e9acd7/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/67ce75b8-cd2d-4ee5-b626-8f86c7e9acd7