--- title: "SPC Quod PF" description: "API Crédito Unificado - Decisões ágeis com dados confiáveis" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/97028732-8073-4d16-8b5a-2f7dcf9055fa markdown: https://doc.apibrasil.io/apis/creditos/97028732-8073-4d16-8b5a-2f7dcf9055fa.md source: apibrasil-documentation --- # SPC Quod PF > API Crédito Unificado - Decisões ágeis com dados confiáveis - **Categoria:** Análise de Crédito - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 6,50 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/97028732-8073-4d16-8b5a-2f7dcf9055fa/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 de Crédito SPC Quod PF – Consulta Completa e Instantânea A API SPC Quod PF permite que sua empresa realize consultas integradas e rápidas sobre a situação cadastral e financeira de pessoas físicas em todo o Brasil, com dados precisos diretamente da base oficial da Quod. Com um único endpoint, você obtém informações detalhadas como dados pessoais, restrições, ocorrências financeiras e histórico de crédito de clientes, acelerando processos de análise de crédito, onboarding, prevenção à fraude e compliance. A integração é simples e flexível, possibilitando o uso dessas informações atualizadas de forma automática pelo seu sistema, agregando mais segurança e confiabilidade às suas decisões de negócio. Tenha acesso a múltiplas fontes consolidadas em uma única requisição e impulsione a eficiência dos seus processos com retorno ágil da API. - **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": "000000000000", "tipo": "quod-restricao-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":"000000000000","tipo":"quod-restricao-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": "248,660", "balance_before": "248,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": { "acoes_civeis": { "data_maior": "", "data_menor": "", "data_primeiro": "", "data_ultimo": "", "quantidade_ocorrencia": "0", "status_retorno": { "codigo": "1", "descricao": "CONSULTA DE HOMOLOGAÇÃO SUCESSOO" }, "valor_maior": "", "valor_menor": "", "valor_primeiro": "", "valor_total": "", "valor_ultimo": "" }, "ch_sem_fundos_bacen": { "correntista": "", "cpfcnpj": "", "quantidade_ocorrencia": "0", "status_retorno": { "codigo": "1", "descricao": "CONSULTA DE HOMOLOGAÇÃO SUCESSOO" }, "tipo_pessoa": "" }, "informacoes_alertas_restricoes": { "ocorrencias": [ { "codigo_tipo_informacao": "1", "descricao_tipo_informacao": "INFORMACAO", "observacoes": "CLIENTE NOTIFICADO, PERIODO DE RESPOSTA ENCERRADO, DADOS PRONTOS PARA SEREM USADOS", "titulo": "STATUS CADASTRO POSITIVO" }, { "codigo_tipo_informacao": "1", "descricao_tipo_informacao": "INFORMACAO", "observacoes": "QUANTIDADE TOTAL: 0", "titulo": "CONSULTAS 30 DIAS" }, { "codigo_tipo_informacao": "1", "descricao_tipo_informacao": "INFORMACAO", "observacoes": "QUANTIDADE TOTAL: 0", "titulo": "CONSULTAS 31 A 60 DIAS" }, { "codigo_tipo_informacao": "1", "descricao_tipo_informacao": "INFORMACAO", "observacoes": "QUANTIDADE TOTAL: 0", "titulo": "CONSULTAS 61 A 90 DIAS" }, { "codigo_tipo_informacao": "1", "descricao_tipo_informacao": "INFORMACAO", "observacoes": "QUANTIDADE TOTAL: 1", "titulo": "CONSULTAS 90+ DIAS" }, { "codigo_tipo_informacao": "1", "descricao_tipo_informacao": "INFORMACAO", "observacoes": "DATA:25/09/2024/QUANTIDADE:1/SEGMENTO:SERVICOS", "titulo": "ULTIMAS CONSULTAS" } ], "quantidade_ocorrencia": "6", "status_retorno": { "codigo": "1", "descricao": "CONSULTA DE HOMOLOGAÇÃO SUCESSOO" } }, "pdf": "https://restricoes.apidocumentos.com.br/pdf/abc23", "pend_financeiras": { "data_maior": "", "data_primeiro": "", "ocorrencias": [ { "contrato": "00000000000000000000000", "credor": "0-CAIXA ECONOMICA FEDERAL", "data_inclusao": "12/01/2025", "data_vencimento": "21/06/2024", "entidade": "", "informante": "BASE III", "modalidade": "CRC", "moeda": "R$", "origem": "BAHIA/UF", "subjudice": "", "tipo_devedor": "COMPRADOR", "valor": "31880,31" } ], "periodo_final": "", "periodo_inicial": "", "provedores": [ { "provedor": "BASE I" } ], "quantidade_ocorrencia": "2", "status_retorno": { "codigo": "1", "descricao": "CONSULTA DE HOMOLOGAÇÃO SUCESSOO" }, "total_credores": "", "ultimo_vencimento": "12/01/2025", "valor_maior": "", "valor_primeiro": "", "valor_total": "47109,81" }, "protestos": { "data_maior": "", "data_primeiro": "", "data_ultimo": "", "quantidade_ocorrencia": "0", "status_retorno": { "codigo": "1", "descricao": "CONSULTA DE HOMOLOGAÇÃO SUCESSOO" }, "ultimo_protesto": "", "valor_maior": "", "valor_primeiro": "", "valor_total": "0", "valor_ultimo": "" } } } ``` 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/97028732-8073-4d16-8b5a-2f7dcf9055fa/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/97028732-8073-4d16-8b5a-2f7dcf9055fa