> ## Documentation Index > Fetch the complete documentation index at: https://docs.jusfy.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Consulta restrição de crédito > Retorna o relatório de restrição de crédito (Serasa) de um **CPF ou CNPJ**: dados cadastrais na Receita Federal e as restrições — protestos, pendências financeiras, cheques sem fundo (Bacen) e CADIN. ## OpenAPI ````yaml /openapi/legado.json post /api/consultas/restricao-de-credito openapi: 3.0.0 info: title: Calculadoras Jusfy API description: >- Rotas sem versão (`/api/...`). Continuam funcionando, mas a versão atual da API é a v1 (`/api/v1`): para integrações novas, use a v1 e siga o [guia de migração](https://api.jusfy.dev/calculators/api/reference/fundamentos/migracao-do-legado). A política de versionamento e depreciação está na [política de versionamento](https://api.jusfy.dev/calculators/api/reference/fundamentos/migracao-do-legado#pol%C3%ADtica-de-versionamento). version: legacy contact: {} servers: - url: https://api.jusfy.dev/calculators security: [] tags: - name: Calculadoras description: >- Execução das calculadoras jurídicas e consulta dos índices de correção. Cada cálculo recebe um payload, retorna o resultado processado e exige API key no header `x-api-key`. - name: Consultas description: >- Consultas de dados (veículos, condutores e documentos). Cada consulta recebe o documento, retorna os dados encontrados e exige API key no header `x-api-key`. A maioria responde na mesma requisição; o **rastreamento veicular** e o **buscador processual** são assíncronos — devolvem `202` com um protocolo e entregam o resultado por webhook e/ou pelo `GET` do protocolo. - name: JusScore description: >- Consulta de processos judiciais por CPF/CNPJ, com score de risco consolidado e a lista detalhada dos processos. É assíncrona: o POST inicia a consulta e o GET devolve o resultado quando pronto. Exige API key no header `x-api-key`. - name: Consumo description: >- Consumo da própria API key: quantas chamadas cada produto recebeu num período, separando as cobradas das não cobradas. Não exige escopo; exige API key no header `x-api-key`. - name: Health description: >- Verificações de disponibilidade do serviço (liveness e readiness). Rotas abertas, sem autenticação. paths: /api/consultas/restricao-de-credito: post: tags: - Consultas summary: Consulta restrição de crédito description: >- Retorna o relatório de restrição de crédito (Serasa) de um **CPF ou CNPJ**: dados cadastrais na Receita Federal e as restrições — protestos, pendências financeiras, cheques sem fundo (Bacen) e CADIN. operationId: QueriesController_restricaoDeCredito[0] parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreditRestrictionQueryDto' responses: '200': description: >- Relatório de restrição de crédito do documento informado. Cada seção (`protesto_sintetico`, `pend_financeiras`, `ch_sem_fundos_bacen`, `cadin`) traz `quantidade_ocorrencia` e a lista `ocorrencias`, vazia quando não há aquela restrição. Um documento **sem** restrições é `200` com as listas vazias — não `404`. Todos os valores são strings, no formato do fornecedor. O shape é o mesmo para CPF e CNPJ. content: application/json: schema: type: object example: statusCode: 200 message: Consulta concluída com sucesso timestamp: '2026-07-28T18:00:00.000Z' path: /api/consultas/restricao-de-credito result: credit_restriction_data: dados_receita_federal: status_retorno: codigo: '1' descricao: CONSULTA REALIZADA tipo_pessoa: FISICA nome: MARIA DE SOUZA situacao_receita: REGULAR data_nascimento_fundacao: 01/02/1990 data_atualizacao: 01/07/2026 protesto_sintetico: valor_total: '0' quantidade_ocorrencia: '0' ocorrencias: [] pend_financeiras: quantidade_ocorrencia: '0' valor_total: '0' ocorrencias: [] ch_sem_fundos_bacen: quantidade_ocorrencia: '0' ocorrencias: [] cadin: quantidade_ocorrencia: '0' ocorrencias: [] '400': description: >- Documento inválido. `message` é a **lista** de erros de validação desta API (campo + motivo), diferente dos demais erros, em que é uma string. content: application/json: schema: example: statusCode: 400 code: invalid_request message: - document deve ser um CPF ou CNPJ válido requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-07-28T18:00:00.000Z' path: /api/consultas/restricao-de-credito '401': description: >- API key ausente ou que não pertence a nenhum cliente (`code: invalid_api_key`). A `message` diz qual dos dois. content: application/json: examples: missing: summary: Key ausente value: statusCode: 401 message: Missing API key code: invalid_api_key requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-10-14T18:00:00.000Z' path: /api/consultas/{consulta} invalid: summary: Key inválida value: statusCode: 401 message: Invalid API key code: invalid_api_key requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-10-14T18:00:00.000Z' path: /api/consultas/{consulta} '403': description: >- Acesso negado. Dois motivos, distinguidos pelo `code`: o cliente não está ativo (`inactive_client`), ou a API key não tem o escopo deste produto (`insufficient_scope`, com o escopo na `message`). A liberação de produtos é feita pela equipe Jusfy. content: application/json: examples: inactive_client: summary: Cliente não ativo value: statusCode: 403 message: Client is not active code: inactive_client requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-10-14T18:00:00.000Z' path: /api/consultas/{consulta} insufficient_scope: summary: Sem o escopo do produto value: statusCode: 403 message: 'Missing scope: ' code: insufficient_scope requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-10-14T18:00:00.000Z' path: /api/consultas/{consulta} '422': description: Payload recusado pelo provedor da consulta. content: application/json: schema: example: statusCode: 422 code: payload_rejected message: document inválido requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-07-28T18:00:00.000Z' path: /api/consultas/restricao-de-credito '429': description: >- Limite de requisições por minuto do cliente neste produto excedido. `Retry-After` diz em quantos segundos a janela vira. Toda resposta traz `X-RateLimit-Limit`, `X-RateLimit-Remaining` e `X-RateLimit-Reset`. content: application/json: schema: example: statusCode: 429 code: rate_limit_exceeded message: >- Rate limit exceeded for consultas.cnh:execute: 60 requests per minute. Retry in 42s. requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-06-22T18:00:00.000Z' path: /api/consultas/cnh '502': description: >- Erro no provedor da consulta. `message` identifica o provedor que falhou quando essa informação está disponível. Diferente do `503`, não há garantia de que repetir a consulta resolva. content: application/json: schema: example: statusCode: 502 code: upstream_error message: Erro ao consultar o fornecedor de restrição de crédito. requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-07-28T18:00:00.000Z' path: /api/consultas/restricao-de-credito '504': description: Tempo limite ao falar com o provedor da consulta. content: application/json: schema: example: statusCode: 504 code: upstream_timeout message: Query provider timed out requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-07-28T18:00:00.000Z' path: /api/consultas/restricao-de-credito security: - api-key: [] components: schemas: CreditRestrictionQueryDto: type: object properties: document: type: string description: >- CPF ou CNPJ do titular consultado, com ou sem máscara. Separadores (incluindo a barra do CNPJ) são aceitos e ignorados. O dígito verificador é validado antes da consulta. example: '52998224725' required: - document securitySchemes: api-key: type: apiKey in: header name: x-api-key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.