--- title: "Crédito Simples PF" description: "API Crédito Simples PF - Consulta Rápida de Crédito por CPF" lang: en 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 - **Category:** Tax Compliance - **Billing:** per query, with the Bearer Token only - **Price:** R$15.75 per query - **Limit:** 999,000 per month - **Registration:** requires a CNPJ - **Version:** v2 - **Published by:** APIBrasil - **OpenAPI specification:** https://doc.apibrasil.io/apis/creditos/67ce75b8-cd2d-4ee5-b626-8f86c7e9acd7/openapi.json ## How to call **Base address:** `https://gateway.apibrasil.io/api/v2` Authentication: the `Authorization: Bearer ` header. Nothing else. With `homolog: true` in the body, the gateway answers from a fixed base, with the real shape of the response, and does not charge. The CPF 00000000000 belongs to that base and to nobody: use it in tests, never in production. ## 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. - **Method:** `POST` - **Address:** `https://gateway.apibrasil.io/api/v2/consulta/cpf/credits` - **Route version:** v2 **Headers** | Header | Value | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Request body** ```json { "cpf": "00000000000", "tipo": "creditos-simples-pf", "homolog": true } ``` **In 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}' ``` This endpoint accepts `homolog: true` in the body: the response comes back with valid data, `api_limit_for` equal to `homolog` and no charge. **Sample response, from the catalog** ```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": [] } } ``` In the sample responses, the fields of the account that generated the sample (`user.first_name`, `user.email`, `user.cellphone`) come out as `[omitido]`. The rest is what the catalog publishes. ## Pitfalls: what an integration gets wrong without warning Established from the responses the catalog itself publishes. In every one of them the code works on the happy path and fails silently everywhere else: 1. **The error arrives in the BODY, with HTTP 200.** The response carries a boolean `error` field and a `message`. Checking only `response.ok` or the HTTP status lets a failure through as a success. ALWAYS check `error === false` before reading `data`. 2. **`balance`, `tax` and `extra_charges.total` are STRINGS in Brazilian format — and the format varies between APIs.** Values seen in the catalog: `"154,380"`, `"497,84"`, `"0,000"` and `"0.19"`. Comma in some, dot in another; three decimal places in some, two in another. In JavaScript, `parseFloat("154,380")` returns `154` and drops the cents with no error at all, and `Number("154,380")` returns `NaN`. Write a converter that handles both separators, and never use these fields in a financial decision without converting them. 3. **Every call costs money.** Blind retries multiply the bill. Never automatically repeat a 4xx: a bad parameter repeated is still bad, and still charged. Retry only timeouts and 5xx, with exponential backoff and a small attempt ceiling. 4. **HTTP 402 means insufficient balance, and retrying does not fix it.** It is the one status that needs a human — a top-up. Treat it as a terminal error with its own message, and do not lump it in with generic 4xx. 5. **`extra_charges` bills on top of the lookup price.** When the body asks for add-on services, the response lists each one with its price plus a `total` that is NOT included in the base amount. If you show cost to an end user, add both. ## See also - OpenAPI specification: https://doc.apibrasil.io/apis/creditos/67ce75b8-cd2d-4ee5-b626-8f86c7e9acd7/openapi.json - API catalog: [API catalog](https://doc.apibrasil.io/apis.md) - Official SDKs: [Official SDKs](https://doc.apibrasil.io/sdks.md) - Documentation index: https://doc.apibrasil.io/llms.txt - HTML version of this page: https://doc.apibrasil.io/apis/creditos/67ce75b8-cd2d-4ee5-b626-8f86c7e9acd7