# Jusfy Developers > Documentação da API de consultas e calculadoras jurídicas da Jusfy. - [Jusfy Developers](https://docs.jusfy.com.br/index.md): As consultas e calculadoras da Jusfy, dentro do seu sistema, por API REST. - [Documentação da API Jusfy](https://docs.jusfy.com.br/visao-geral.md): Integre as consultas e calculadoras da Jusfy ao seu sistema. Tudo roda com a sua conta Jusfy. - [Crie sua chave de API](https://docs.jusfy.com.br/comece-por-aqui/crie-sua-chave.md): A chave identifica a sua conta em cada chamada. Ela é criada e gerenciada na plataforma Jusfy, em Configurações. - [Faça a primeira chamada](https://docs.jusfy.com.br/comece-por-aqui/primeira-chamada.md): Com a chave em mãos, rode uma consulta e um cálculo. Os exemplos usam a variável de ambiente JUSFY_API_KEY. - [Autenticação](https://docs.jusfy.com.br/fundamentos/autenticacao.md): Todas as rotas exigem a chave no header x-api-key. Sem a chave, ou com uma chave inválida, a requisição é recusada. - [Erros e limites](https://docs.jusfy.com.br/fundamentos/erros-e-limites.md): Todo erro tem o mesmo formato, com um code estável. A message é texto para pessoas e pode mudar. - [Consultas assíncronas e webhooks](https://docs.jusfy.com.br/fundamentos/assincronas-e-webhooks.md): Três consultas não respondem na mesma requisição, porque o fornecedor pode levar minutos. Elas devolvem um protocolo para você acompanhar. - [Migração do legado](https://docs.jusfy.com.br/fundamentos/migracao-do-legado.md): Como sair das rotas sem versão (/api/...) para a v1 (/api/v1/...). Payloads e respostas são os mesmos nas duas versões. - [Consultas](https://docs.jusfy.com.br/produtos/consultas.md): Consultas de pessoas, empresas, veículos, imóveis e processos. Cada uma recebe o documento e devolve os dados encontrados. - [Calculadoras](https://docs.jusfy.com.br/produtos/calculadoras.md): Envie o payload do cálculo e receba o resultado processado pelo motor da Jusfy, em result. - [Calcula verbas trabalhistas](https://docs.jusfy.com.br/referencia/calculadoras/calcula-verbas-trabalhistas.md): Calcula verbas rescisórias e trabalhistas (saldo de salário, aviso prévio, 13º, férias, horas extras, adicionais, vales, multas etc.) a partir do período de vínculo, salários e verbas habilitadas em `lista_verbas`. O resultado traz cada verba com seus valores detalhados por competência e os totais d… - [Calcula correção de valores (completa)](https://docs.jusfy.com.br/referencia/calculadoras/calcula-correção-de-valores-completa.md): Corrige valores monetários aplicando índices e juros por período. Informe os lançamentos e as regras de correção; a resposta traz os valores atualizados. Cada bloco de juros escolhe de onde sai a taxa (`tipo_taxa`: percentual ou uma série do Bacen — SELIC, poupança, taxa legal) e como ela se acumula… - [Calcula correção de valores (simples)](https://docs.jusfy.com.br/referencia/calculadoras/calcula-correção-de-valores-simples.md): Corrige valores monetários aplicando um índice e uma taxa de juros únicos a todos os lançamentos (`items`), com multa e honorários opcionais. A resposta traz os valores atualizados por lançamento, a evolução mês a mês e os totais do cálculo. - [Calcula a partilha de bens no divórcio](https://docs.jusfy.com.br/referencia/calculadoras/calcula-a-partilha-de-bens-no-divórcio.md): Calcula a partilha de bens e dívidas do casal conforme o regime de bens e a compensação eventualmente devida de um cônjuge ao outro. Informe os bens (`coupleAssets`) e dívidas (`coupleDebts`) — nos itens do tipo `Comum`, o percentual de cada cônjuge deve somar 100. Filhos e pensões são opcionais e n… - [Calcula a restituição de INSS](https://docs.jusfy.com.br/referencia/calculadoras/calcula-a-restituição-de-inss.md): Calcula a restituição de contribuições de INSS: corrige as parcelas pagas por índice e juros e retorna os valores atualizados por parcela e os totais. Informe as parcelas (`installments`) e as regras de correção (`correction_differences_index_id`, `interest_differences`). Quando `agreement` é `true`… - [Calcula o plano de pagamento no superendividamento](https://docs.jusfy.com.br/referencia/calculadoras/calcula-o-plano-de-pagamento-no-superendividamento.md): Monta um plano de pagamento das dívidas do devedor conforme a Lei do Superendividamento, respeitando o mínimo existencial. Informe as dívidas (`debts`), o prazo e a carência do plano, o sistema de amortização (`price` ou `sac`), a taxa de juros e o mínimo existencial (`minimum_living_income`). A res… - [Calcula a restituição de PASEP](https://docs.jusfy.com.br/referencia/calculadoras/calcula-a-restituição-de-pasep.md): Calcula a restituição do PASEP corrigindo o valor da conta ano a ano por índice (TJLP, RAC, juros) a partir do valor inicial e dos lançamentos de crédito/débito. Informe o valor inicial (`initial_amount`), a moeda/posição desse valor (`initial_amount_date`: `1989` Cruzados ou `1999` Reais) e os lanç… - [Calcula a progressão de regime](https://docs.jusfy.com.br/referencia/calculadoras/calcula-a-progressão-de-regime.md): Calcula os marcos de progressão de regime a partir das condenações, do regime inicial e dos eventos que alteram o prazo (remições, detrações, faltas graves e suspensões), aplicando a estratégia escolhida em `calculation_strategy` (`DEFAULT` ou `ART76`). A resposta traz as datas previstas de progress… - [Calcula a correção de aluguel em atraso](https://docs.jusfy.com.br/referencia/calculadoras/calcula-a-correção-de-aluguel-em-atraso.md): Corrige as parcelas em atraso de um contrato de locação: aplica índices de correção monetária e juros por período (incluindo a Taxa Legal da Lei 14.905/2024 via `name: "Taxa legal"` e juros de poupança via `apply_index: true`), soma multa e honorários e devolve o cronograma detalhado por parcela. - [Calcula a correção de FGTS (teses JAM e Depósito)](https://docs.jusfy.com.br/referencia/calculadoras/calcula-a-correção-de-fgts-teses-jam-e-depósito.md): Corrige lançamentos de FGTS por uma das duas teses de cálculo: - [Calcula a dosimetria da pena](https://docs.jusfy.com.br/referencia/calculadoras/calcula-a-dosimetria-da-pena.md): Calcula a pena de cada crime pelo método trifásico (pena-base a partir das circunstâncias judiciais, agravantes/atenuantes e causas de aumento/diminuição) e consolida o conjunto conforme a regra de concurso (`crime_concurrence`). Informe os crimes (`crime_list`), o critério de fixação (`calculation_… - [Calcula a correção de pensão alimentícia em atraso](https://docs.jusfy.com.br/referencia/calculadoras/calcula-a-correção-de-pensão-alimentícia-em-atraso.md): Corrige as parcelas em atraso de pensão alimentícia: aplica índices de correção monetária e juros por período — declare o tipo em `interests[].kind` (`simple` usa a taxa do payload, `legal_rate` aplica a Taxa Legal da Lei 14.905/2024 e `savings` a poupança) —, soma as despesas extraordinárias (`expe… - [Calcula a revisão de contrato (revisional)](https://docs.jusfy.com.br/referencia/calculadoras/calcula-a-revisão-de-contrato-revisional.md): Revisa um contrato de financiamento/empréstimo: recalcula a tabela de amortização (`price` ou `sac`) aplicando a taxa média de mercado, apura as diferenças (a pagar ou a receber) e, quando o resultado é a pagar (`type: "payable"`), monta o cronograma de refinanciamento. Informe os dados do contrato… - [Calcula a revisão de RMC/RCC (cartão consignado)](https://docs.jusfy.com.br/referencia/calculadoras/calcula-a-revisão-de-rmcrcc-cartão-consignado.md): Revisa contratos de RMC (Reserva de Margem Consignável) / RCC (Reserva de Cartão de Crédito). O input é uma **union discriminada** por `refund_total`, com dois fluxos e dois formatos de resposta: - [Calcula a restituição/planejamento previdenciário acima do teto](https://docs.jusfy.com.br/referencia/calculadoras/calcula-a-restituiçãoplanejamento-previdenciário-acima-do-teto.md): Calcula o excedente de contribuição ao INSS quando a soma dos salários-de-contribuição de vínculos concomitantes ultrapassa o teto previdenciário, atualizado pelo índice escolhido (correção monetária) e juros simples. Tudo num payload único: os parâmetros do cálculo (`aboveCeilingParams`: modo, índi… - [Lista os índices de correção](https://docs.jusfy.com.br/referencia/calculadoras/lista-os-índices-de-correção.md): Retorna os índices de correção disponíveis (todos exceto os do tipo `legal_rate`). Use o `id` de um índice nos campos `indexes` das demais calculadoras. Rota de leitura — não registra consumo. - [Gera o relatório da calculadora completa (PDF)](https://docs.jusfy.com.br/referencia/calculadoras/gera-o-relatório-da-calculadora-completa-pdf.md): 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. - [Consulta um relatório da calculadora completa](https://docs.jusfy.com.br/referencia/calculadoras/consulta-um-relatório-da-calculadora-completa.md): Devolve a situação do relatório. Responde `200` nos três estados: `pending` (em geração), `done` (pronto, com `downloadUrl`) e `error` (a geração falhou ou passou do prazo, com `error.code` e `error.message`). Consultar é gratuito e pode ser repetido; sugerimos intervalos de alguns segundos. - [Baixa o PDF de um relatório da calculadora completa](https://docs.jusfy.com.br/referencia/calculadoras/baixa-o-pdf-de-um-relatório-da-calculadora-completa.md): Devolve o PDF (`application/pdf`) de um relatório em `status: done`. É o endereço de `downloadUrl`; pede a mesma `x-api-key`. Pode ser baixado quantas vezes for preciso, sem nova cobrança. - [Consulta débitos de um veículo](https://docs.jusfy.com.br/referencia/consultas/consulta-débitos-de-um-veículo.md): Retorna os débitos vinculados a um veículo (IPVA, licenciamento, multas e demais pendências) a partir da placa. - [Consulta dados da CNH](https://docs.jusfy.com.br/referencia/consultas/consulta-dados-da-cnh.md): Retorna os dados da Carteira Nacional de Habilitação do condutor a partir do CPF: número de registro, categoria, data de emissão, validade e nome do condutor. - [Consulta dados de um veículo pela placa](https://docs.jusfy.com.br/referencia/consultas/consulta-dados-de-um-veículo-pela-placa.md): Retorna os dados cadastrais do veículo a partir da placa (marca, modelo, ano, chassi, situação e restrições). - [Consulta o licenciamento de um veículo pela placa](https://docs.jusfy.com.br/referencia/consultas/consulta-o-licenciamento-de-um-veículo-pela-placa.md): Retorna a data do último licenciamento do veículo (emissão do CRLV) a partir da placa, com a placa e o chassi. É uma consulta separada de `placa`, com outra base: devolve **somente** esses três campos. - [Consulta dados pessoais pelo CPF](https://docs.jusfy.com.br/referencia/consultas/consulta-dados-pessoais-pelo-cpf.md): Retorna os dados cadastrais da pessoa a partir do CPF: nome, nome da mãe, data de nascimento, sexo, telefones, e-mails e endereços. - [Consulta dados profissionais](https://docs.jusfy.com.br/referencia/consultas/consulta-dados-profissionais.md): Retorna o histórico de vínculos profissionais do titular a partir do CPF — empresa, setor, nível, situação e faixa de renda de cada vínculo —, além da renda presumida e do tempo total de experiência. - [Consulta imóveis financiados](https://docs.jusfy.com.br/referencia/consultas/consulta-imóveis-financiados.md): Retorna os imóveis financiados pelo titular a partir do CPF: um consolidado (quantidade, valor total e distribuição por UF) e o detalhe de cada financiamento — situação, localização, área e valores. - [Consulta sociedades (participação em empresas)](https://docs.jusfy.com.br/referencia/consultas/consulta-sociedades-participação-em-empresas.md): Retorna as empresas em que o titular do CPF é sócio a partir do CPF — CNPJ, razão social, papel na sociedade e período do vínculo. - [Consulta imóveis rurais](https://docs.jusfy.com.br/referencia/consultas/consulta-imóveis-rurais.md): Retorna dados de imóveis rurais conforme o `document_type`: por CPF/CNPJ (`document`) devolve o índice de imóveis do titular no CAR e no INCRA; por `car` devolve os dados do imóvel no Cadastro Ambiental Rural; por `sncr_incra` devolve o CCIR do imóvel. - [Consulta marcas e patentes](https://docs.jusfy.com.br/referencia/consultas/consulta-marcas-e-patentes.md): Retorna as marcas e patentes vinculadas a um **CPF ou CNPJ** na base de Propriedade Industrial (INPI): totais, patentes (com publicações, petições, prioridades unionistas e anuidades) e marcas (com situação, titularidade, classes de Nice e petições). - [Consulta grupo econômico](https://docs.jusfy.com.br/referencia/consultas/consulta-grupo-econômico.md): Retorna o agregado estatístico do grupo econômico de um **CNPJ** — totais de empresas, faixas de idade/renda/funcionários, distribuições por CNAE, UF e cidade, e os CNPJs do grupo (`company_doc_numbers`). - [Consulta os veículos de um proprietário](https://docs.jusfy.com.br/referencia/consultas/consulta-os-veículos-de-um-proprietário.md): Retorna os veículos registrados no nome do titular a partir do **CPF ou CNPJ** dele: placa, renavam, marca/modelo, ano, situação e restrições de cada um. É o caminho inverso da consulta por `placa`. - [Consulta restrição de crédito](https://docs.jusfy.com.br/referencia/consultas/consulta-restrição-de-crédito.md): 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. - [Consulta dados cadastrais de uma empresa](https://docs.jusfy.com.br/referencia/consultas/consulta-dados-cadastrais-de-uma-empresa.md): Retorna os dados cadastrais de um **CNPJ**: razão social, nome fantasia, situação cadastral, natureza jurídica, capital social, CNAEs, endereços e quadro societário. - [Consulta situação cadastral do CPF](https://docs.jusfy.com.br/referencia/consultas/consulta-situação-cadastral-do-cpf.md): Retorna a situação cadastral de um CPF na Receita Federal: nome, data de nascimento, idade, situação, dígito verificador e data de inscrição. - [Consulta a árvore de relacionamentos](https://docs.jusfy.com.br/referencia/consultas/consulta-a-árvore-de-relacionamentos.md): Retorna a rede de relacionamentos de um **CPF ou CNPJ**. - [Consulta de telefone](https://docs.jusfy.com.br/referencia/consultas/consulta-de-telefone.md): Consulta **reversa**: entra um telefone com DDD, saem os cadastros associados a ele — CPF ou CNPJ e nome do titular, e a localidade quando o fornecedor a tem. - [Localização por nome](https://docs.jusfy.com.br/referencia/consultas/localização-por-nome.md): Localiza a pessoa pelo **nome completo, nome da mãe e data de nascimento** — os três obrigatórios — e devolve os dados cadastrais do CPF encontrado: CPF, nome, nome da mãe, data de nascimento, sexo, telefones, e-mails e endereços. - [Dispara o rastreamento de um veículo (assíncrona)](https://docs.jusfy.com.br/referencia/consultas/dispara-o-rastreamento-de-um-veículo-assíncrona.md): Inicia a busca por capturas do veículo em câmeras de monitoramento nos últimos 12 meses. **A consulta não responde na hora**: o fornecedor processa por lote e pode levar minutos, então esta rota devolve `202` com um protocolo. - [Consulta o protocolo de um rastreamento veicular](https://docs.jusfy.com.br/referencia/consultas/consulta-o-protocolo-de-um-rastreamento-veicular.md): Devolve o estado da consulta e, quando concluída, o resultado. Responde `200` nos quatro estados — inclusive quando a consulta falhou: o recurso de protocolo existe, e o desfecho vem no campo `status`. - [Dispara a busca de processos de um CPF ou CNPJ (assíncrona)](https://docs.jusfy.com.br/referencia/consultas/dispara-a-busca-de-processos-de-um-cpf-ou-cnpj-assíncrona.md): Inicia a busca por processos judiciais associados ao documento. **A consulta não responde na hora**: o fornecedor processa por tempo indeterminado, então esta rota devolve `202` com um protocolo. - [Consulta o protocolo de uma busca de processos](https://docs.jusfy.com.br/referencia/consultas/consulta-o-protocolo-de-uma-busca-de-processos.md): Devolve o estado da consulta e, quando concluída, o **resumo** do que foi encontrado. Os processos em si vêm por `GET /api/v1/consultas/buscador-processual/{id}/processos`. - [Lista os processos de uma consulta concluída (paginado)](https://docs.jusfy.com.br/referencia/consultas/lista-os-processos-de-uma-consulta-concluída-paginado.md): ⚠️ **Quando `truncated` é `true`, os processos são uma amostra arbitrária.** Guardamos no máximo 1.000 por consulta, e a ordem em que o provedor os entrega **não é cronológica** — então os processos devolvidos não são "os mais recentes", são 1.000 quaisquer entre os `totalFound` identificados. - [Inicia uma consulta do JusScore](https://docs.jusfy.com.br/referencia/jusscore/inicia-uma-consulta-do-jusscore.md): Recebe um CPF ou CNPJ e inicia a busca de processos judiciais. A consulta é **assíncrona**: a resposta normal traz `situacao: "PROCESSANDO"` e o `id_consulta`, que deve ser consultado em `GET /api/v1/jus-score/{id_consulta}` até concluir. - [Consulta o andamento ou o resultado do JusScore](https://docs.jusfy.com.br/referencia/jusscore/consulta-o-andamento-ou-o-resultado-do-jusscore.md): 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. - [Consulta o consumo da própria API key](https://docs.jusfy.com.br/referencia/consumo/consulta-o-consumo-da-própria-api-key.md): Quantas chamadas a sua API key fez num período, por produto, separando as cobradas das não cobradas. É a mesma contagem usada na cobrança. - [Verifica a saúde da API](https://docs.jusfy.com.br/referencia/health/verifica-a-saúde-da-api.md): Retorna o estado atual do serviço e a conectividade com o banco de dados. `status` é `OK` quando tudo está operacional ou `DEGRADED` quando o banco está inacessível. Responde `200` mesmo com o banco fora: o estado vem no body. Não exige autenticação. - [Verifica se a API está pronta para receber tráfego](https://docs.jusfy.com.br/referencia/health/verifica-se-a-api-está-pronta-para-receber-tráfego.md): 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. - [Consultas](https://docs.jusfy.com.br/produtos/consultas.md): Consultas de pessoas, empresas, veículos, imóveis e processos. Cada uma recebe o documento e devolve os dados encontrados. - [Calculadoras](https://docs.jusfy.com.br/produtos/calculadoras.md): Envie o payload do cálculo e receba o resultado processado pelo motor da Jusfy, em result. - [Changelog](https://docs.jusfy.com.br/changelog.md): O que mudou em cada versão da API. Toda mudança de info.version ganha uma entrada aqui. - [Referência do legado](https://docs.jusfy.com.br/legado/visao-geral.md): As rotas sem versão (/api/...), mantidas para quem já integra. - [Calcula verbas trabalhistas](https://docs.jusfy.com.br/legado/referencia/calculadoras/calcula-verbas-trabalhistas.md): Calcula verbas rescisórias e trabalhistas (saldo de salário, aviso prévio, 13º, férias, horas extras, adicionais, vales, multas etc.) a partir do período de vínculo, salários e verbas habilitadas em `lista_verbas`. O resultado traz cada verba com seus valores detalhados por competência e os totais d… - [Calcula correção de valores (completa)](https://docs.jusfy.com.br/legado/referencia/calculadoras/calcula-correção-de-valores-completa.md): Corrige valores monetários aplicando índices e juros por período. Informe os lançamentos e as regras de correção; a resposta traz os valores atualizados. Cada bloco de juros escolhe de onde sai a taxa (`tipo_taxa`: percentual ou uma série do Bacen — SELIC, poupança, taxa legal) e como ela se acumula… - [Calcula correção de valores (simples)](https://docs.jusfy.com.br/legado/referencia/calculadoras/calcula-correção-de-valores-simples.md): Corrige valores monetários aplicando um índice e uma taxa de juros únicos a todos os lançamentos (`items`), com multa e honorários opcionais. A resposta traz os valores atualizados por lançamento, a evolução mês a mês e os totais do cálculo. - [Calcula a partilha de bens no divórcio](https://docs.jusfy.com.br/legado/referencia/calculadoras/calcula-a-partilha-de-bens-no-divórcio.md): Calcula a partilha de bens e dívidas do casal conforme o regime de bens e a compensação eventualmente devida de um cônjuge ao outro. Informe os bens (`coupleAssets`) e dívidas (`coupleDebts`) — nos itens do tipo `Comum`, o percentual de cada cônjuge deve somar 100. Filhos e pensões são opcionais e n… - [Calcula a restituição de INSS](https://docs.jusfy.com.br/legado/referencia/calculadoras/calcula-a-restituição-de-inss.md): Calcula a restituição de contribuições de INSS: corrige as parcelas pagas por índice e juros e retorna os valores atualizados por parcela e os totais. Informe as parcelas (`installments`) e as regras de correção (`correction_differences_index_id`, `interest_differences`). Quando `agreement` é `true`… - [Calcula o plano de pagamento no superendividamento](https://docs.jusfy.com.br/legado/referencia/calculadoras/calcula-o-plano-de-pagamento-no-superendividamento.md): Monta um plano de pagamento das dívidas do devedor conforme a Lei do Superendividamento, respeitando o mínimo existencial. Informe as dívidas (`debts`), o prazo e a carência do plano, o sistema de amortização (`price` ou `sac`), a taxa de juros e o mínimo existencial (`minimum_living_income`). A res… - [Calcula a restituição de PASEP](https://docs.jusfy.com.br/legado/referencia/calculadoras/calcula-a-restituição-de-pasep.md): Calcula a restituição do PASEP corrigindo o valor da conta ano a ano por índice (TJLP, RAC, juros) a partir do valor inicial e dos lançamentos de crédito/débito. Informe o valor inicial (`initial_amount`), a moeda/posição desse valor (`initial_amount_date`: `1989` Cruzados ou `1999` Reais) e os lanç… - [Calcula a progressão de regime](https://docs.jusfy.com.br/legado/referencia/calculadoras/calcula-a-progressão-de-regime.md): Calcula os marcos de progressão de regime a partir das condenações, do regime inicial e dos eventos que alteram o prazo (remições, detrações, faltas graves e suspensões), aplicando a estratégia escolhida em `calculation_strategy` (`DEFAULT` ou `ART76`). A resposta traz as datas previstas de progress… - [Calcula a correção de aluguel em atraso](https://docs.jusfy.com.br/legado/referencia/calculadoras/calcula-a-correção-de-aluguel-em-atraso.md): Corrige as parcelas em atraso de um contrato de locação: aplica índices de correção monetária e juros por período (incluindo a Taxa Legal da Lei 14.905/2024 via `name: "Taxa legal"` e juros de poupança via `apply_index: true`), soma multa e honorários e devolve o cronograma detalhado por parcela. - [Calcula a correção de FGTS (teses JAM e Depósito)](https://docs.jusfy.com.br/legado/referencia/calculadoras/calcula-a-correção-de-fgts-teses-jam-e-depósito.md): Corrige lançamentos de FGTS por uma das duas teses de cálculo: - [Calcula a dosimetria da pena](https://docs.jusfy.com.br/legado/referencia/calculadoras/calcula-a-dosimetria-da-pena.md): Calcula a pena de cada crime pelo método trifásico (pena-base a partir das circunstâncias judiciais, agravantes/atenuantes e causas de aumento/diminuição) e consolida o conjunto conforme a regra de concurso (`crime_concurrence`). Informe os crimes (`crime_list`), o critério de fixação (`calculation_… - [Calcula a correção de pensão alimentícia em atraso](https://docs.jusfy.com.br/legado/referencia/calculadoras/calcula-a-correção-de-pensão-alimentícia-em-atraso.md): Corrige as parcelas em atraso de pensão alimentícia: aplica índices de correção monetária e juros por período — declare o tipo em `interests[].kind` (`simple` usa a taxa do payload, `legal_rate` aplica a Taxa Legal da Lei 14.905/2024 e `savings` a poupança) —, soma as despesas extraordinárias (`expe… - [Calcula a revisão de contrato (revisional)](https://docs.jusfy.com.br/legado/referencia/calculadoras/calcula-a-revisão-de-contrato-revisional.md): Revisa um contrato de financiamento/empréstimo: recalcula a tabela de amortização (`price` ou `sac`) aplicando a taxa média de mercado, apura as diferenças (a pagar ou a receber) e, quando o resultado é a pagar (`type: "payable"`), monta o cronograma de refinanciamento. Informe os dados do contrato… - [Calcula a revisão de RMC/RCC (cartão consignado)](https://docs.jusfy.com.br/legado/referencia/calculadoras/calcula-a-revisão-de-rmcrcc-cartão-consignado.md): Revisa contratos de RMC (Reserva de Margem Consignável) / RCC (Reserva de Cartão de Crédito). O input é uma **union discriminada** por `refund_total`, com dois fluxos e dois formatos de resposta: - [Calcula a restituição/planejamento previdenciário acima do teto](https://docs.jusfy.com.br/legado/referencia/calculadoras/calcula-a-restituiçãoplanejamento-previdenciário-acima-do-teto.md): Calcula o excedente de contribuição ao INSS quando a soma dos salários-de-contribuição de vínculos concomitantes ultrapassa o teto previdenciário, atualizado pelo índice escolhido (correção monetária) e juros simples. Tudo num payload único: os parâmetros do cálculo (`aboveCeilingParams`: modo, índi… - [Lista os índices de correção](https://docs.jusfy.com.br/legado/referencia/calculadoras/lista-os-índices-de-correção.md): Retorna os índices de correção disponíveis (todos exceto os do tipo `legal_rate`). Use o `id` de um índice nos campos `indexes` das demais calculadoras. Rota de leitura — não registra consumo. - [Consulta débitos de um veículo](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-débitos-de-um-veículo.md): Retorna os débitos vinculados a um veículo (IPVA, licenciamento, multas e demais pendências) a partir da placa. - [Consulta dados da CNH](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-dados-da-cnh.md): Retorna os dados da Carteira Nacional de Habilitação do condutor a partir do CPF: número de registro, categoria, data de emissão, validade e nome do condutor. - [Consulta dados de um veículo pela placa](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-dados-de-um-veículo-pela-placa.md): Retorna os dados cadastrais do veículo a partir da placa (marca, modelo, ano, chassi, situação e restrições). - [Consulta o licenciamento de um veículo pela placa](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-o-licenciamento-de-um-veículo-pela-placa.md): Retorna a data do último licenciamento do veículo (emissão do CRLV) a partir da placa, com a placa e o chassi. É uma consulta separada de `placa`, com outra base: devolve **somente** esses três campos. - [Consulta dados pessoais pelo CPF](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-dados-pessoais-pelo-cpf.md): Retorna os dados cadastrais da pessoa a partir do CPF: nome, nome da mãe, data de nascimento, sexo, telefones, e-mails e endereços. - [Consulta dados profissionais](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-dados-profissionais.md): Retorna o histórico de vínculos profissionais do titular a partir do CPF — empresa, setor, nível, situação e faixa de renda de cada vínculo —, além da renda presumida e do tempo total de experiência. - [Consulta imóveis financiados](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-imóveis-financiados.md): Retorna os imóveis financiados pelo titular a partir do CPF: um consolidado (quantidade, valor total e distribuição por UF) e o detalhe de cada financiamento — situação, localização, área e valores. - [Consulta sociedades (participação em empresas)](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-sociedades-participação-em-empresas.md): Retorna as empresas em que o titular do CPF é sócio a partir do CPF — CNPJ, razão social, papel na sociedade e período do vínculo. - [Consulta imóveis rurais](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-imóveis-rurais.md): Retorna dados de imóveis rurais conforme o `document_type`: por CPF/CNPJ (`document`) devolve o índice de imóveis do titular no CAR e no INCRA; por `car` devolve os dados do imóvel no Cadastro Ambiental Rural; por `sncr_incra` devolve o CCIR do imóvel. - [Consulta marcas e patentes](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-marcas-e-patentes.md): Retorna as marcas e patentes vinculadas a um **CPF ou CNPJ** na base de Propriedade Industrial (INPI): totais, patentes (com publicações, petições, prioridades unionistas e anuidades) e marcas (com situação, titularidade, classes de Nice e petições). - [Consulta grupo econômico](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-grupo-econômico.md): Retorna o agregado estatístico do grupo econômico de um **CNPJ** — totais de empresas, faixas de idade/renda/funcionários, distribuições por CNAE, UF e cidade, e os CNPJs do grupo (`company_doc_numbers`). - [Consulta os veículos de um proprietário](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-os-veículos-de-um-proprietário.md): Retorna os veículos registrados no nome do titular a partir do **CPF ou CNPJ** dele: placa, renavam, marca/modelo, ano, situação e restrições de cada um. É o caminho inverso da consulta por `placa`. - [Consulta restrição de crédito](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-restrição-de-crédito.md): 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. - [Consulta dados cadastrais de uma empresa](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-dados-cadastrais-de-uma-empresa.md): Retorna os dados cadastrais de um **CNPJ**: razão social, nome fantasia, situação cadastral, natureza jurídica, capital social, CNAEs, endereços e quadro societário. - [Consulta situação cadastral do CPF](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-situação-cadastral-do-cpf.md): Retorna a situação cadastral de um CPF na Receita Federal: nome, data de nascimento, idade, situação, dígito verificador e data de inscrição. - [Consulta a árvore de relacionamentos](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-a-árvore-de-relacionamentos.md): Retorna a rede de relacionamentos de um **CPF ou CNPJ**. - [Consulta de telefone](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-de-telefone.md): Consulta **reversa**: entra um telefone com DDD, saem os cadastros associados a ele — CPF ou CNPJ e nome do titular, e a localidade quando o fornecedor a tem. - [Localização por nome](https://docs.jusfy.com.br/legado/referencia/consultas/localização-por-nome.md): Localiza a pessoa pelo **nome completo, nome da mãe e data de nascimento** — os três obrigatórios — e devolve os dados cadastrais do CPF encontrado: CPF, nome, nome da mãe, data de nascimento, sexo, telefones, e-mails e endereços. - [Dispara o rastreamento de um veículo (assíncrona)](https://docs.jusfy.com.br/legado/referencia/consultas/dispara-o-rastreamento-de-um-veículo-assíncrona.md): Inicia a busca por capturas do veículo em câmeras de monitoramento nos últimos 12 meses. **A consulta não responde na hora**: o fornecedor processa por lote e pode levar minutos, então esta rota devolve `202` com um protocolo. - [Consulta o protocolo de um rastreamento veicular](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-o-protocolo-de-um-rastreamento-veicular.md): Devolve o estado da consulta e, quando concluída, o resultado. Responde `200` nos quatro estados — inclusive quando a consulta falhou: o recurso de protocolo existe, e o desfecho vem no campo `status`. - [Dispara a busca de processos de um CPF ou CNPJ (assíncrona)](https://docs.jusfy.com.br/legado/referencia/consultas/dispara-a-busca-de-processos-de-um-cpf-ou-cnpj-assíncrona.md): Inicia a busca por processos judiciais associados ao documento. **A consulta não responde na hora**: o fornecedor processa por tempo indeterminado, então esta rota devolve `202` com um protocolo. - [Consulta o protocolo de uma busca de processos](https://docs.jusfy.com.br/legado/referencia/consultas/consulta-o-protocolo-de-uma-busca-de-processos.md): Devolve o estado da consulta e, quando concluída, o **resumo** do que foi encontrado. Os processos em si vêm por `GET /api/consultas/buscador-processual/{id}/processos`. - [Lista os processos de uma consulta concluída (paginado)](https://docs.jusfy.com.br/legado/referencia/consultas/lista-os-processos-de-uma-consulta-concluída-paginado.md): ⚠️ **Quando `truncated` é `true`, os processos são uma amostra arbitrária.** Guardamos no máximo 1.000 por consulta, e a ordem em que o provedor os entrega **não é cronológica** — então os processos devolvidos não são "os mais recentes", são 1.000 quaisquer entre os `totalFound` identificados. - [Inicia uma consulta do JusScore](https://docs.jusfy.com.br/legado/referencia/jusscore/inicia-uma-consulta-do-jusscore.md): Recebe um CPF ou CNPJ e inicia a busca de processos judiciais. A consulta é **assíncrona**: a resposta normal traz `situacao: "PROCESSANDO"` e o `id_consulta`, que deve ser consultado em `GET /api/jus-score/{id_consulta}` até concluir. - [Consulta o andamento ou o resultado do JusScore](https://docs.jusfy.com.br/legado/referencia/jusscore/consulta-o-andamento-ou-o-resultado-do-jusscore.md): 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. - [Verifica a saúde da API](https://docs.jusfy.com.br/legado/referencia/health/verifica-a-saúde-da-api.md): Retorna o estado atual do serviço e a conectividade com o banco de dados. `status` é `OK` quando tudo está operacional ou `DEGRADED` quando o banco está inacessível. Responde `200` mesmo com o banco fora: o estado vem no body. Não exige autenticação. - [Verifica se a API está pronta para receber tráfego](https://docs.jusfy.com.br/legado/referencia/health/verifica-se-a-api-está-pronta-para-receber-tráfego.md): 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 Specs - [legado](/openapi/legado.json) - [v1](/openapi/v1.json) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.