> ## 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/legado.json get /api/jus-score/{id_consulta}
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/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[0]
      parameters:
        - name: id_consulta
          required: true
          in: path
          description: Identificador devolvido pelo `POST /api/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/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/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/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/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/jus-score
                insufficient_scope:
                  summary: Sem o escopo do produto
                  value:
                    statusCode: 403
                    message: 'Missing scope: <escopo>'
                    code: insufficient_scope
                    requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                    timestamp: '2026-10-14T18:00:00.000Z'
                    path: /api/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/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/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/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/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.