> ## 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. # Gera o relatório da calculadora completa (PDF) > Gera a memória de cálculo em PDF a partir do **mesmo payload** de `POST /api/v1/calculadoras/completa`. A geração é assíncrona: a resposta é `202` com o `id` do relatório, que vai impresso no PDF. Acompanhe pelo `GET /api/v1/calculadoras/completa/relatorio/{id}` até `status: done` e baixe o arquivo em `downloadUrl`. Costuma levar segundos; o prazo máximo é de 15 minutos, depois disso o relatório termina em `error`. **Idempotente pela entrada:** o mesmo payload devolve o mesmo relatório (e o mesmo `id`) enquanto ele não terminar em `error`. A ordem das chaves não importa; a ordem dos itens de uma lista, sim. Um relatório em `error` não é reaproveitado: pedir de novo gera outro. O relatório é cobrado quando fica pronto, uma vez por relatório. ## OpenAPI ````yaml /openapi/v1.json post /api/v1/calculadoras/completa/relatorio 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://api.jusfy.dev/calculators/api/reference/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://api.jusfy.dev/calculators/api/reference/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/calculadoras/completa/relatorio: post: tags: - Calculadoras summary: Gera o relatório da calculadora completa (PDF) description: >- Gera a memória de cálculo em PDF a partir do **mesmo payload** de `POST /api/v1/calculadoras/completa`. A geração é assíncrona: a resposta é `202` com o `id` do relatório, que vai impresso no PDF. Acompanhe pelo `GET /api/v1/calculadoras/completa/relatorio/{id}` até `status: done` e baixe o arquivo em `downloadUrl`. Costuma levar segundos; o prazo máximo é de 15 minutos, depois disso o relatório termina em `error`. **Idempotente pela entrada:** o mesmo payload devolve o mesmo relatório (e o mesmo `id`) enquanto ele não terminar em `error`. A ordem das chaves não importa; a ordem dos itens de uma lista, sim. Um relatório em `error` não é reaproveitado: pedir de novo gera outro. O relatório é cobrado quando fica pronto, uma vez por relatório. operationId: CalculationReportsController_request_v1 parameters: [] requestBody: required: true description: O mesmo payload da calculadora completa. content: application/json: schema: type: object description: >- Payload da correção de valores. Para cada lançamento (`installments`), informe os índices e as regras de juros por período; a resposta traz os valores atualizados e a evolução mês a mês. required: - process_number - res_judicata_date - stakeholders - installments - fines_fees - legal_costs_list properties: process_number: type: string description: Número do processo. Pode ser uma string vazia. res_judicata_date: type: string format: date description: Data de trânsito em julgado (`YYYY-MM-DD`). Pode ser vazia. stakeholders: type: array description: Partes do processo (autor, réu etc.). Pode ser vazio. items: type: object properties: name: type: string type: type: object description: Par id/nome usado em campos de seleção. properties: id: type: string name: type: string nullable: true installments: type: array description: Lançamentos a corrigir. Deve conter **pelo menos um** item. items: type: object properties: description: type: string calculation_date: type: string format: date description: Data de cálculo do lançamento (`YYYY-MM-DD`). amount: type: number description: Valor original. type: type: object description: >- Tipo do lançamento: `id: "0"` débito · `id: "1"` abatimento (entra como valor negativo). properties: id: type: string name: type: string indexes: type: array description: Índices de correção aplicados, por período. items: type: object properties: index: type: object description: >- Índice de correção a aplicar. Obtenha o objeto em `GET /api/v1/calculadoras/indices-correcao` e envie-o por completo. properties: id: type: number name: type: string bacen_code: type: string bacen_code_annually: type: string nullable: true type: type: string interest_person_type: type: string nullable: true petition_filename: type: string nullable: true source: type: string latest_update: type: string first_update: type: string is_multi_index: type: number update: type: number start_date_fetch: type: string nullable: true created_at: type: string modified_at: type: string startDate: type: string format: date description: Início da aplicação do índice. endDate: type: string format: date description: Fim da aplicação do índice. interests: type: array description: Regras de juros aplicadas, por período. items: type: object properties: name: type: string description: >- Forma v1 de escolher uma taxa por série: `SELIC`, `Poupança` ou `Taxa legal`. Vazio (ou qualquer outro valor) é taxa percentual. **Obrigatório**, mesmo quem envia `tipo_taxa`: aí mande `""` e deixe o `tipo_taxa` dizer de onde vem a taxa. interest: type: number description: >- Taxa de juros (percentual). **Ignorado numa taxa por série**: ali a taxa de cada mês vem da série do Bacen. Envie `0`. apply_index: type: boolean description: Se os juros incidem sobre o valor já corrigido. type: type: object description: >- Periodicidade: `id: "0"` mensal (a.m.) · `id: "1"` anual (a.a.). properties: id: type: string name: type: string tipo_taxa: type: string enum: - PERCENTUAL - SELIC - POUPANCA - TAXA_LEGAL description: >- De onde sai a taxa do período: `PERCENTUAL` usa o campo `interest`; os outros três usam a série mensal correspondente, publicada pelo Bacen. É por aqui que a SELIC entra como **juros**, que é o lugar dela na mora de débito tributário (Lei 9.430/96, art. 61 §3º). Ausente, é **derivado do `name`**: `SELIC` → `SELIC`, `Poupança` → `POUPANCA`, `Taxa legal` → `TAXA_LEGAL`, qualquer outro → `PERCENTUAL`. Por isso o campo não tem valor padrão: omiti-lo não é o mesmo que mandar `PERCENTUAL`, que forçaria a taxa do campo `interest` mesmo num bloco com `name: "SELIC"`. regime: type: string enum: - SIMPLES_DIA - SIMPLES_MES - SIMPLES_ANO - COMPOSTO_DIA - COMPOSTO_MES - COMPOSTO_ANO_BASE_MES description: >- Regime de capitalização do bloco. Ausente, vale o que a periodicidade `type` implica: `id: "0"` → `SIMPLES_MES`, `id: "1"` → `SIMPLES_ANO`. **Numa taxa por série** (`tipo_taxa` diferente de `PERCENTUAL`) só há dois comportamentos: qualquer `SIMPLES_*` **soma** as taxas mensais do período e qualquer `COMPOSTO_*` as **capitaliza**. A granularidade dia/mês/ano não se aplica, porque o Bacen só publica taxa mensal — os três regimes compostos dão o mesmo número. **Numa taxa percentual** esta rota continua a seguir a periodicidade `type`, e as seis opções não estão disponíveis: um `regime` que contrarie o `type` é recusado com `422`, em vez de ser aceito e ignorado. startDate: type: string format: date endDate: type: string format: date fines_fees: type: array description: >- Multas e honorários. Pode ser vazio; itens com `fine` e `legal_fees` zerados são ignorados. items: type: object properties: description: type: string description: Descrição da multa. description_legal_fees: type: string description: Descrição dos honorários. fine: type: number description: Percentual da multa. legal_fees: type: number description: Percentual dos honorários. fine_interests: type: boolean description: Se a multa incide sobre o saldo já com juros. legal_fees_add_fines: type: boolean description: Se os honorários incidem também sobre a multa. legal_costs_list: type: array description: Custas processuais. Pode ser vazio. items: type: object properties: amount: type: number description: Valor da custa. date: type: string format: date description: Data da custa (`YYYY-MM-DD`). description: type: string index: type: object description: >- Índice de correção da custa (ver `GET /api/v1/calculadoras/indices-correcao`). properties: id: type: number nullable: true name: type: string bacen_code: type: string examples: completa: summary: Correção de valores value: process_number: '123456789' res_judicata_date: '2025-10-03' stakeholders: - name: Parte 1 type: id: '1' name: Autor installments: - description: Parcela 01 calculation_date: '2026-06-21' amount: 500 type: id: '0' name: Parcela de Débito indexes: - index: id: 3 name: SELIC bacen_code: '4390' bacen_code_annually: null type: average_price_index interest_person_type: null petition_filename: null source: BACEN latest_update: '2026-06-01' first_update: '1986-08-01' is_multi_index: 0 update: 1 start_date_fetch: null created_at: '2021-02-22T20:54:56.232Z' modified_at: '2026-06-21T13:03:02.858Z' startDate: '2018-01-01' endDate: '2026-06-21' interests: - name: '' interest: 1 apply_index: false type: id: '0' name: Mensal startDate: '2018-01-01' endDate: '2026-06-21' - description: Parcela 02 calculation_date: '2026-06-21' amount: 500 type: id: '0' name: Parcela de Débito indexes: - index: id: 3 name: SELIC bacen_code: '4390' bacen_code_annually: null type: average_price_index interest_person_type: null petition_filename: null source: BACEN latest_update: '2026-06-01' first_update: '1986-08-01' is_multi_index: 0 update: 1 start_date_fetch: null created_at: '2021-02-22T20:54:56.232Z' modified_at: '2026-06-21T13:03:02.858Z' startDate: '2018-02-01' endDate: '2026-06-21' interests: - name: '' interest: 1 apply_index: false type: id: '0' name: Mensal startDate: '2018-02-01' endDate: '2026-06-21' fines_fees: - description: Multa 01 description_legal_fees: Honorários 01 fine: 1 legal_fees: 1 fine_interests: false legal_fees_add_fines: false legal_costs_list: - amount: 120 date: '2018-01-01' description: Custas 01 index: id: 1 name: IGP-M bacen_code: '189' completa_selic_juros: summary: SELIC como juros, somada (débito tributário) value: process_number: 0001234-56.2023.4.03.6100 res_judicata_date: '' stakeholders: - name: Contribuinte Exemplo type: id: '1' name: Autor installments: - description: IRPJ - competência 12/2020 calculation_date: '2026-06-21' amount: 10000 type: id: '0' name: Parcela de Débito indexes: [] interests: - name: SELIC tipo_taxa: SELIC regime: SIMPLES_MES interest: 0 apply_index: true type: id: '0' name: Mensal startDate: '2021-02-01' endDate: '2026-06-21' fines_fees: [] legal_costs_list: [] responses: '202': description: >- Relatório pedido (ou já existente para este payload). Consulte o `id`. content: application/json: schema: type: object example: statusCode: 202 message: Relatório solicitado timestamp: '2026-10-27T18:00:00.000Z' path: /api/v1/calculadoras/completa/relatorio result: id: crep_3c9a1e52-7b4d-4f0e-9a61-2d8f5b7c1e04 calculadora: completa status: pending createdAt: '2026-10-27T18:00:00.000Z' updatedAt: '2026-10-27T18:00:00.000Z' completedAt: null downloadUrl: null error: null '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/calculadoras/completa/relatorio 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/calculadoras/completa/relatorio '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/calculadoras/completa/relatorio 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/calculadoras/completa/relatorio '422': description: Payload inválido. `message` indica o campo e o motivo. content: application/json: schema: example: statusCode: 422 code: payload_rejected message: 'Expected number, received null (property: amount)' requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-10-27T18:00:00.000Z' path: /api/v1/calculadoras/completa/relatorio '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 calculadoras.completa-relatorio:execute: 60 requests per minute. Retry in 42s. requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-06-22T18:00:00.000Z' path: /api/v1/calculadoras/completa/relatorio '502': description: Erro no motor de cálculo da Jusfy. content: application/json: schema: example: statusCode: 502 code: upstream_error message: Calculation backend error requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-10-27T18:00:00.000Z' path: /api/v1/calculadoras/completa/relatorio '504': description: Tempo limite ao falar com o motor de cálculo. content: application/json: schema: example: statusCode: 504 code: upstream_timeout message: Calculation backend timed out requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-10-27T18:00:00.000Z' path: /api/v1/calculadoras/completa/relatorio 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.