> ## 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.

# Verifica se a API está pronta para receber tráfego

> Sonda de readiness para orquestradores (ex.: Kubernetes). Responde `OK` quando o banco de dados está acessível e `NOT_READY` caso contrário. Responde `200` mesmo com o banco fora: o estado vem no body. Não exige autenticação.



## OpenAPI

````yaml /openapi/legado.json get /api/health/ready
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/health/ready:
    get:
      tags:
        - Health
      summary: Verifica se a API está pronta para receber tráfego
      description: >-
        Sonda de readiness para orquestradores (ex.: Kubernetes). Responde `OK`
        quando o banco de dados está acessível e `NOT_READY` caso contrário.
        Responde `200` mesmo com o banco fora: o estado vem no body. Não exige
        autenticação.
      operationId: HealthController_getReady
      parameters: []
      responses:
        '200':
          description: Prontidão do serviço.
          content:
            application/json:
              schema:
                example:
                  status: OK
                  timestamp: '2026-06-23T18:00:00.000Z'
      security: []

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.