> ## 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 o andamento ou o resultado do JusScore > Enquanto a busca de processos não termina, responde `situacao: "PROCESSANDO"` — repita a cada ~15 segundos. Ao concluir, devolve o score consolidado nos três perfis (`geral`, `imobiliario`, `recursos_humanos`) e a **lista detalhada** dos processos. A nota vai de 0 a 100 e **quanto maior, melhor**: 100 significa nenhum risco identificado. Uma vez concluída, a consulta fica disponível neste endpoint sem custo adicional. ## OpenAPI ````yaml /openapi/v1.json get /api/v1/jus-score/{id_consulta} openapi: 3.0.0 info: title: Calculadoras Jusfy API description: >- API pública das calculadoras jurídicas Jusfy. Envie um payload de cálculo e receba o resultado já processado pelo motor de cálculo da Jusfy. ## Autenticação Todas as rotas exigem uma **API key** enviada no header `x-api-key`: ```http x-api-key: sua_api_key ``` Sem a key, ou com uma key inativa/inválida, a requisição é recusada com `401`/`403`. As keys são provisionadas pela equipe Jusfy. Cada key tem uma lista de **escopos**, um por produto (cada calculadora, cada consulta, o JusScore), e só acessa as rotas dos produtos liberados para ela. Chamar um produto fora da lista responde `403` com `code: insufficient_scope` e o escopo que faltou na `message` (ex.: `Missing scope: consultas.cnh:execute`). Os produtos são liberados pela equipe Jusfy; produto novo não é liberado automaticamente para quem já integra. A consulta do próprio consumo (`GET /api/v1/consumo`) não exige escopo: qualquer key de cliente ativo a acessa. ## Formato das respostas Nas **calculadoras**, o sucesso devolve o **resultado do cálculo** diretamente no corpo, sem envelope. Nas **consultas**, no JusScore e no consumo, o sucesso vem num envelope padronizado, com os dados em `result`: ```json { "statusCode": 200, "message": "Consulta concluída com sucesso", "timestamp": "2026-07-28T18:00:00.000Z", "path": "/api/v1/consultas/cnh", "result": {} } ``` Toda chamada é registrada para fins de auditoria. ## Consultas assíncronas Duas consultas — o **rastreamento veicular** e o **buscador** **processual** — não respondem na mesma requisição: o fornecedor delas é assíncrono e pode levar minutos. As duas usam um contrato de protocolo: 1. o `POST` devolve **`202`** com um `id` e, se você informar um `url_retorno`, um `signingSecret` (exibido **uma única vez**); 2. o resultado chega por **webhook** assinado e/ou pelo `GET` do protocolo, que responde `200` em todos os estados — inclusive quando a consulta falha, com o desfecho no campo `status`. A consulta é **cobrada no disparo**, não na entrega. Consultar o protocolo é gratuito. O resultado fica disponível por 30 dias. No **buscador processual** o resultado pode chegar a megabytes, então o webhook e o `GET` do protocolo levam apenas o **resumo**; os processos vêm por `GET /api/v1/consultas/buscador-processual/{id}/processos`, paginado. Guardamos no máximo 1.000 por consulta, e quando `truncated` é `true` eles são uma **amostra arbitrária** — a ordem do fornecedor não é cronológica. O contrato completo, com a verificação da assinatura do webhook, está no `README.md` do projeto. ## Erros Todo erro tem o mesmo formato, com um `code` estável que o seu código pode tratar. A `message` é o texto para gente: pode mudar de redação sem aviso, então não decida por ela. ```json { "statusCode": 404, "message": "CNH não encontrada para o documento informado.", "code": "no_data_found", "requestId": "9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65", "timestamp": "2026-06-22T18:00:00.000Z", "path": "/api/v1/consultas/cnh" } ``` `requestId` identifica a chamada nos nossos registros. Toda resposta, de sucesso ou de erro, também o traz no header `X-Request-Id`. Se você enviar um `X-Request-Id` próprio (até 128 caracteres: letras, dígitos e `.`, `_`, `:`, `-`), ele é reaproveitado; senão geramos um. **Informe o `requestId` ao falar com o suporte** sobre uma chamada específica. Nos erros de validação desta API (`400` de corpo ou parâmetro), `message` é a **lista** de problemas (campo + motivo); nos demais, uma string. | Status | `code` | Quando | O que fazer | | ------ | ------ | ------ | ----------- | | `400` | `invalid_request` | Corpo, parâmetro ou JSON inválido. | Corrigir a requisição; a `message` diz o campo. | | `401` | `invalid_api_key` | API key ausente ou que não pertence a nenhum cliente. | Conferir o header `x-api-key`. | | `403` | `inactive_client` | A key é de um cliente que não está ativo (inativo ou ainda pendente). | Falar com a equipe Jusfy. | | `403` | `insufficient_scope` | A key não tem o escopo do produto chamado; a `message` traz o escopo. | Pedir a liberação do produto à equipe Jusfy. | | `404` | `route_not_found` | A rota não existe. | Conferir método e path. | | `404` | `resource_not_found` | O protocolo ou id pedido não existe, ou é de outro cliente (os dois respondem igual). | Conferir o id. | | `404` | `no_data_found` | A consulta rodou e o documento não tem dado. **É cobrada.** | Tratar como resultado vazio; repetir não muda o resultado. | | `409` | `report_not_ready` | O PDF do relatório pedido ainda está em geração, ou a geração falhou. | Consultar o relatório e baixar quando estiver `done`; em `error`, pedir de novo. | | `413` | `payload_too_large` | Corpo da requisição acima do limite. | Reduzir o corpo. | | `422` | `payload_rejected` | O motor de cálculo ou o fornecedor recusou o payload; a `message` diz o motivo. | Corrigir o payload. | | `429` | `rate_limit_exceeded` | Limite de requisições por minuto do produto excedido (ver abaixo). | Esperar o `Retry-After`. | | `429` | `too_many_pending_queries` | Consultas assíncronas demais em processamento para o cliente. | Esperar o `Retry-After`: é uma estimativa, porque a vaga abre quando uma consulta em voo termina. | | `500` | `internal_error` | Erro inesperado nesta API. | Repetir depois; se persistir, falar com a equipe Jusfy. | | `502` | `upstream_error` | O motor de cálculo ou o fornecedor falhou. | Ver a orientação de cada rota: nem sempre repetir resolve. | | `503` | `upstream_unavailable` | O fornecedor (ex.: o órgão consultado) está fora do ar; a consulta não rodou. | Repetir depois de um intervalo. | | `504` | `upstream_timeout` | O motor de cálculo ou o fornecedor não respondeu a tempo. | Repetir depois de um intervalo. | Códigos novos podem surgir para condições que hoje não são tratadas (ver "Versionamento e depreciação"): trate um `code` desconhecido pelo status. Um `code` existente nunca muda de significado na mesma versão. Nas consultas assíncronas e no relatório PDF da completa há ainda `202` (aceito e em processamento). ### Limite de requisições Cada cliente tem um limite de requisições por minuto **em cada produto** (calculadora, consulta ou JusScore); os produtos não dividem o limite entre si. A consulta do consumo tem um contador próprio, que também não divide o limite com nenhum produto. Toda resposta informa o estado do limite nos headers: | Header | Significado | | ------ | ----------- | | `X-RateLimit-Limit` | Requisições permitidas por minuto neste produto. | | `X-RateLimit-Remaining` | Quantas ainda cabem na janela atual. | | `X-RateLimit-Reset` | Segundos até a janela atual acabar. | Acima do limite a resposta é `429` com o header `Retry-After` (segundos até poder tentar de novo). A requisição recusada não é processada nem cobrada. ## Versionamento e depreciação A versão vai no path (`/api/v1/...`). `info.version` deste documento segue semver: MAJOR é a versão do path, MINOR é mudança compatível e PATCH é só documentação. **Mudanças compatíveis** entram na versão atual, como MINOR, sem aviso prévio. Sua integração deve tolerá-las: - campo novo na resposta; - campo opcional novo no request; - rota nova; - valor novo de enum **na resposta**, quando o campo estiver documentado como extensível; - código de erro novo para uma condição que antes não era tratada. **Mudanças incompatíveis** só entram numa versão nova de path: - remover ou renomear path, campo ou valor de enum; - tornar obrigatório um campo opcional; - mudar o tipo ou o formato de um campo; - mudar o significado de um status code; - mudar o formato do envelope ou do erro; - mudar a assinatura ou o corpo de um webhook. Quando uma versão é depreciada, você recebe **três sinais**: 1. os headers `Deprecation`, `Sunset` (quando houver data de desligamento) e `Link` (`rel="deprecation"`, apontando para o guia de migração) em toda resposta da versão; 2. as operações marcadas como `deprecated` no contrato da versão; 3. comunicação direta aos clientes que ainda chamam a versão. **Prazo mínimo** entre a depreciação e o desligamento: _pendente: produto_. **Comunicação**: quem avisa o cliente e por qual canal: _pendente: produto_. Uma versão só é desligada quando as duas condições valem: o prazo de aviso venceu **e** todo cliente que ainda a chama foi contatado. Desligada, as rotas dela respondem **`410 Gone`**, no formato de erro padrão, com `message` apontando para o guia de migração. ## Changelog Toda mudança de `info.version` ganha uma entrada no [changelog](https://docs.jusfy.com.br/changelog). ## Migração do legado Payloads e respostas são os mesmos nas duas versões. O passo a passo está no [guia de migração](https://docs.jusfy.com.br/fundamentos/migracao-do-legado). version: 1.1.0 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/v1/jus-score/{id_consulta}: get: tags: - JusScore summary: Consulta o andamento ou o resultado do JusScore description: >- Enquanto a busca de processos não termina, responde `situacao: "PROCESSANDO"` — repita a cada ~15 segundos. Ao concluir, devolve o score consolidado nos três perfis (`geral`, `imobiliario`, `recursos_humanos`) e a **lista detalhada** dos processos. A nota vai de 0 a 100 e **quanto maior, melhor**: 100 significa nenhum risco identificado. Uma vez concluída, a consulta fica disponível neste endpoint sem custo adicional. operationId: JusScoreController_consultar[1]_v1 parameters: - name: id_consulta required: true in: path description: Identificador devolvido pelo `POST /api/v1/jus-score`. schema: example: jsq_7c1f9a52-3d84-4a0b-9f26-1e5c0b8a4d31 type: string responses: '200': description: Andamento (`PROCESSANDO`) ou o resultado completo. content: application/json: schema: example: statusCode: 200 message: Consulta do JusScore concluída com sucesso timestamp: '2026-09-03T18:00:00.000Z' path: /api/v1/jus-score/jsq_7c1f9a52-3d84-4a0b-9f26-1e5c0b8a4d31 result: situacao: CONCLUIDA id_consulta: jsq_7c1f9a52-3d84-4a0b-9f26-1e5c0b8a4d31 versao_contrato: '1.0' consultado_em: '2026-09-03T12:00:00.000Z' pessoa_consultada: nome: MARINA ALVES COSTA tipo_pessoa: FISICA documento: 140.652.218-03 tipo_documento: CPF total_processos: 3 jus_score: perfis: geral: rotulo: Generalista nota: 56 escala: >- De 0 a 100, quanto MAIOR melhor: 100 significa nenhum risco identificado. nivel_risco: medio resumo: null fatores_risco: - titulo: >- Execuções e cobranças no polo passivo (ré/executada) descricao: >- 1 processo desta natureza em que a pessoa figura no polo passivo (ré/executada), sendo 1 em andamento. gravidade: alto - titulo: Despejo e locação no polo passivo (ré/executada) descricao: >- 1 processo desta natureza em que a pessoa figura no polo passivo (ré/executada), sendo 1 em andamento. gravidade: alto fatores_positivos: [] calculado_por: jus-score-engine-v2 imobiliario: rotulo: Imobiliária nota: 48 escala: >- De 0 a 100, quanto MAIOR melhor: 100 significa nenhum risco identificado. nivel_risco: medio resumo: null fatores_risco: - titulo: Despejo e locação no polo passivo (ré/executada) descricao: >- 1 processo desta natureza em que a pessoa figura no polo passivo (ré/executada), sendo 1 em andamento. gravidade: alto - titulo: >- Execuções e cobranças no polo passivo (ré/executada) descricao: >- 1 processo desta natureza em que a pessoa figura no polo passivo (ré/executada), sendo 1 em andamento. gravidade: alto fatores_positivos: [] calculado_por: jus-score-engine-v2 recursos_humanos: rotulo: Recursos Humanos nota: 78 escala: >- De 0 a 100, quanto MAIOR melhor: 100 significa nenhum risco identificado. nivel_risco: baixo resumo: null fatores_risco: - titulo: >- Execuções e cobranças no polo passivo (ré/executada) descricao: >- 1 processo desta natureza em que a pessoa figura no polo passivo (ré/executada), sendo 1 em andamento. gravidade: medio - titulo: Despejo e locação no polo passivo (ré/executada) descricao: >- 1 processo desta natureza em que a pessoa figura no polo passivo (ré/executada), sendo 1 em andamento. gravidade: baixo fatores_positivos: [] calculado_por: jus-score-engine-v2 confiabilidade: polo_identificado_percentual: 100 observacao: >- Percentual de processos em que foi possível determinar se a pessoa consultada é autora ou ré. Processos com polo indeterminado entram no resumo, mas não pontuam no score. aviso_legal: >- O JusScore é um relatório informativo gerado automaticamente a partir de processos judiciais públicos associados ao CPF consultado, na data da consulta. A Jusfy não realiza juízo de valor sobre a pessoa consultada: o score é um indicador estatístico de apoio, calculado por critérios objetivos, e não constitui recomendação, parecer jurídico, análise de crédito ou decisão de qualquer natureza. A decisão de contratar, locar ou negociar — e a responsabilidade por ela — é exclusiva de quem realiza a consulta, que não deve utilizá-la como critério único ou automatizado (LGPD, art. 20). Os dados provêm de fontes públicas e podem conter imprecisões, homônimos, processos em segredo de justiça ou informações desatualizadas. O titular dos dados pode exercer os direitos previstos na LGPD (arts. 18 a 20), incluindo correção de dados e revisão desta análise, pelos canais de atendimento da Jusfy. resumo: total: 3 em_andamento: 2 encerrados: 1 situacao_nao_informada: 0 como_reu: 2 como_autor: 1 polo_nao_identificado: 0 distribuidos_ultimos_2_anos: 1 valor_total: '144500.00' valor_total_formatado: "R$\_144.500,00" por_categoria: - categoria: Execução e cobrança total: 1 como_reu: 1 como_autor: 0 em_andamento: 1 encerrados: 0 - categoria: Despejo e locação total: 1 como_reu: 1 como_autor: 0 em_andamento: 1 encerrados: 0 - categoria: Consumidor total: 1 como_reu: 0 como_autor: 1 em_andamento: 0 encerrados: 1 processos_detalhados: 1 processos: - numero_cnj: 0012345-67.2025.8.26.0053 titulo: IMOBILIÁRIA BETA LTDA X MARINA ALVES COSTA polo_ativo: IMOBILIÁRIA BETA LTDA polo_passivo: MARINA ALVES COSTA data_distribuicao: '2025-06-10' ano_distribuicao: 2025 origem: estado: sigla: SP nome: São Paulo cidade: SÃO PAULO foro: FORO REGIONAL DE SANTO AMARO - SÃO PAULO/SP orgao_julgador: 1ª Vara Cível - Foro Regional de Santo Amaro tribunal_sigla: TJSP segmento_justica: JUSTIÇA ESTADUAL grau: 1 sistema: e-SAJ url_tribunal: >- https://esaj.tjsp.jus.br/cpopg/show.do?processo=0012345-67.2025.8.26.0053 classificacao: classe: DESPEJO POR FALTA DE PAGAMENTO CUMULADO COM COBRANÇA area: DIREITO CIVIL assunto_principal: LOCAÇÃO DE IMÓVEL assuntos: - LOCAÇÃO DE IMÓVEL valor_causa: valor: '24500.00' moeda: BRL valor_formatado: "R$\_24.500,00" situacao: informada: MOVIMENTO normalizada: EM_ANDAMENTO segredo_justica: false ultima_movimentacao: data: '2026-05-19' descricao: Audiência de conciliação designada total_movimentacoes: 14 leitura_jusfy: polo_pessoa_consultada: PASSIVO categoria: Despejo e locação natureza: despejo_locacao indicio_fraude: false sinal_credito_a_receber: false origem_classificacao: deterministic partes: - nome: IMOBILIÁRIA BETA LTDA tipo_pessoa: JURIDICA documento: 98.765.432/0001-88 papel: AUTOR polo: ATIVO advogados: [] - nome: MARINA ALVES COSTA tipo_pessoa: FISICA documento: 140.652.218-03 papel: RÉU polo: PASSIVO advogados: [] '400': description: Identificador de consulta em formato inválido. content: application/json: schema: example: statusCode: 400 code: invalid_request message: - id_consulta deve ser um identificador de consulta válido requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-09-03T18:00:00.000Z' path: /api/v1/jus-score/jsq_7c1f9a52-3d84-4a0b-9f26-1e5c0b8a4d31 '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/v1/jus-score 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/v1/jus-score '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/v1/jus-score 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/v1/jus-score '404': description: >- Nenhuma consulta com esse identificador para esta API key. Consultas de outros clientes também respondem `404`. content: application/json: schema: example: statusCode: 404 code: resource_not_found message: 'Unknown query: jsq_7c1f9a52-3d84-4a0b-9f26-1e5c0b8a4d31' requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-09-03T18:00:00.000Z' path: /api/v1/jus-score/jsq_7c1f9a52-3d84-4a0b-9f26-1e5c0b8a4d31 '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 jus-score:execute: 60 requests per minute. Retry in 42s. requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-06-22T18:00:00.000Z' path: /api/v1/jus-score '502': description: >- Falha ao falar com a base de processos. A consulta segue válida — repita este `GET` em instantes. content: application/json: schema: example: statusCode: 502 code: upstream_error message: >- Não foi possível consultar o andamento da análise. Tente novamente em instantes. requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-09-03T18:00:00.000Z' path: /api/v1/jus-score/jsq_7c1f9a52-3d84-4a0b-9f26-1e5c0b8a4d31 '504': description: Tempo limite ao falar com o backend da Jusfy. content: application/json: schema: example: statusCode: 504 code: upstream_timeout message: JusScore provider timed out requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-09-03T18:00:00.000Z' path: /api/v1/jus-score/jsq_7c1f9a52-3d84-4a0b-9f26-1e5c0b8a4d31 security: - api-key: [] components: 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.