--- title: "Restrições de Crédito Quod" description: "As pendências financeiras de um CPF ou CNPJ no Quod, mais as ações cíveis em que o documento aparece e a quantidade de cheques sem fundo. Consulta só este birô e não traz protestos. Cobrada também quando nada consta; se o Quod não responder, não é cobrada." lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/91c15759-debd-11f1-98bb-bc24118aba26 markdown: https://doc.apibrasil.io/apis/creditos/91c15759-debd-11f1-98bb-bc24118aba26.md source: apibrasil-documentation --- # Restrições de Crédito Quod > As pendências financeiras de um CPF ou CNPJ no Quod, mais as ações cíveis em que o documento aparece e a quantidade de cheques sem fundo. Consulta só este birô e não traz protestos. Cobrada também quando nada consta; se o Quod não responder, não é cobrada. - **Categoria:** Negativação e Protesto - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 5,89 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/91c15759-debd-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/restricoes-quod/credits ⚠️ Aviso: a consulta é cobrada também quando nada consta no Quod (possui_restricao=false); se o Quod não responder, não há cobrança. Envie um POST com tipo=restricoes-quod e o documento (CPF ou CNPJ, com ou sem pontuação) no campo documento. O campo data traz tipo_documento, titular, possui_restricao, bases_com_restricao, bases_sem_resposta, resumo, bases, ocorrencias, scores, classificacao_risco, acoes_civeis, cheques_sem_fundo e consultado_em, além do documento consultado. Envie o campo documento com um CPF ou um CNPJ. Só o Quod: "nada consta" aqui não quer dizer nome limpo nos outros birôs, e a resposta não traz protestos. Ação cível, em acoes_civeis, não é dívida nem condenação. cheques_sem_fundo é a quantidade no cadastro do Banco Central. Use timeout de pelo menos 60 s. Se o Quod não responder (quod em bases_sem_resposta, ou bases.quod.situacao diferente de consta e nada_consta), a resposta é HTTP 503, sem cobrança. Documento inválido é recusado com HTTP 400, sem cobrança; não existe resposta de não encontrado, e documento sem pendência devolve HTTP 200 com possui_restricao=false, cobrado. 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 CPF ou CNPJ válido, a resposta traz dados fictícios. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/restricoes-quod/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": "restricoes-quod", "documento": "40442820135", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/restricoes-quod/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"restricoes-quod","documento":"40442820135","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": "394,110", "balance_before": "400,000", "tax": "5,890", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 5,89.", "valor_consulta": 5.89, "api_limit_for": "credit", "homolog": false, "data": { "tipo_documento": "cpf", "titular": {}, "possui_restricao": false, "bases_com_restricao": [], "bases_sem_resposta": [], "resumo": { "total_ocorrencias": 0, "valor_total": null }, "bases": { "quod": { "situacao": "nada_consta", "ocorrencias": 0, "valor_total": null } }, "ocorrencias": [], "scores": [], "classificacao_risco": null, "acoes_civeis": { "total": 1, "processos": [ { "processo": "00000000000000000000", "acao": "EXECUCAO DE TITULO EXTRAJUDICIAL", "autor": "EMPRESA FICTICIA LTDA", "vara": "JUIZADO ESPECIAL CIVEL FICTICIO", "comarca": "CIDADE FICTICIA", "data_distribuicao": "2025-04-07", "valor": null } ] }, "cheques_sem_fundo": 0, "consultado_em": "2026-11-12T12:00:00.000Z", "documento": "40442820135" } } ``` 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/91c15759-debd-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/91c15759-debd-11f1-98bb-bc24118aba26