--- title: "SPC Quod PF" description: "API Crédito Unificado - Decisões ágeis com dados confiáveis" lang: en 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 - **Category:** Credit Analysis - **Billing:** per query, with the Bearer Token only - **Price:** R$6.50 per query - **Limit:** 990,000 per month - **Registration:** requires a CNPJ - **Version:** v2 - **Published by:** APIBrasil - **OpenAPI specification:** https://doc.apibrasil.io/apis/creditos/97028732-8073-4d16-8b5a-2f7dcf9055fa/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 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. - **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": "quod-restricao-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":"quod-restricao-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": "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": "" } } } ``` 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/97028732-8073-4d16-8b5a-2f7dcf9055fa/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/97028732-8073-4d16-8b5a-2f7dcf9055fa