--- title: "Processos Simples" description: "API Processos Simples" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/ea610915-fa51-406d-9ab7-e7b3b6c8b34a markdown: https://doc.apibrasil.io/apis/creditos/ea610915-fa51-406d-9ab7-e7b3b6c8b34a.md source: apibrasil-documentation --- # Processos Simples > API Processos Simples - **Categoria:** Análise de Crédito - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 3,90 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/ea610915-fa51-406d-9ab7-e7b3b6c8b34a/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 Envie um POST com tipo=processos-simples e o cpf ou o cnpj (com ou sem máscara; o dígito verificador é conferido). A resposta vem em data.dados e traz quantidade_acoes, quantidade_arquivadas, acoes e acoes_arquivadas (cada processo com tribunal, grau, numero_processo, classe, assunto, valor, data_distribuicao, uf, segredo_justica, partes e status) e o link pdf do relatório. A cobrança acontece quando a consulta é concluída na fonte (com ou sem processos); campo cpf ou cnpj ausente ou inválido é recusado com HTTP 400, sem cobrança. Fonte indisponível responde HTTP 502, 503 ou 504, também sem cobrança. Em homologação (homolog=true) a resposta é uma amostra fictícia, sem cobrança, para qualquer cpf ou cnpj válido. - **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": "processos-simples", "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":"processos-simples","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": "396,100", "balance_before": "400,000", "tax": "3,900", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 3,90.", "valor_consulta": 3.9, "api_limit_for": "credit", "homolog": false, "data": { "dados": { "quantidade_acoes": 1, "quantidade_arquivadas": 0, "acoes": [ { "tribunal": "TJSP", "grau": "GRAU 1", "numero_processo": "0001234-56.2023.8.26.0100", "classe": "PROCEDIMENTO COMUM CIVEL", "assunto": "INADIMPLEMENTO", "valor": "15000,00", "data_distribuicao": "14/03/2023", "uf": "SP", "segredo_justica": "NAO", "justica_gratuita": "", "partes": [ { "nome": "BANCO EXEMPLO S.A.", "documento": "00000000000191", "tipo": "AUTOR", "polo": "ATIVO" }, { "nome": "JOSE DA SILVA EXEMPLO", "documento": "12345678909", "tipo": "REU", "polo": "PASSIVO" } ], "status": { "status_processo": "EM ANDAMENTO", "julgamentos": [ { "tipo_julgamento": "SENTENCA", "data_julgamento": "01/06/2023" } ] } } ], "acoes_arquivadas": [], "pdf": "https://gateway.apibrasil.io/proxy/?u=https%3A%2F%2Fexemplo.apibrasil.io%2Fpdf%2Fexemplo" } } } ``` 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/ea610915-fa51-406d-9ab7-e7b3b6c8b34a/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/ea610915-fa51-406d-9ab7-e7b3b6c8b34a