Carregando…

ANTVIAS

API de Integração ANTVIAS

Integre consultas processuais, autos, publicações do DJEN, monitoramentos e webhooks aos seus sistemas.

Documentação oficial da API ANTVIAS. A API REST permite integrar consultas processuais, autos, publicações do DJEN e análises de inteligência jurídica aos sistemas da sua empresa.

A chave completa é exibida uma única vez, no momento da criação, e cada conta pode manter até 10 chaves ativas. As chaves de membros seguem as permissões vigentes e são revogadas quando o acesso à API é removido.

a chave não deve ser exposta em navegadores, aplicativos móveis ou qualquer código executado no dispositivo do usuário final. Esta documentação apresenta exemplos para cópia; não executa requisições nem armazena credenciais.

As consultas realizadas pela API também ficam disponíveis no painel ANTVIAS. Com plano Grátis, Essencial ou Ilimitado ativo, as consultas pela API dentro da quota mensal estão incluídas no plano e não utilizam a franquia de consultas do painel; os autos são cobrados à parte. No plano Enterprise e nas contas sem plano do painel, o consumo da API segue as condições contratadas. A revogação de uma chave não remove consultas nem registros de consumo.

Operações da API

Consulte os caminhos, métodos e descrições do contrato público da API ANTVIAS.

POST /api/v1/entidades/cotar: Cotar uma consulta de pessoa ou empresa

Calcula o valor de uma consulta ANTVIAS Due Diligence por CPF ou CNPJ. Nenhum dado é obtido da fonte nesta etapa. A resposta informa o valor da consulta em `cobrancas`, o total a pagar (zero quando a consulta está incluída no plano da conta) e o identificador `cotacaoHash`, exigido na [aprovação](#confirmarEntidades). A cotação é válida por 15 minutos e só pode ser aprovada com o mesmo documento. Uma cotação não aprovada não gera consulta. **Serviços:** a consulta reúne sempre todos os serviços do documento: `cadastro` (perfil cadastral: nome, endereços, contatos e atividades), `sociedades` (participações societárias), `divida_ativa` (inscrições em dívida ativa da União), `processos` (processos com número, tribunal e partes) e, somente para CPF, `mandados` (mandados de prisão). O campo `servicos` é opcional; quando enviado, precisa conter exatamente esses serviços. **Fluxo:** 1. cotar; 2. [aprovar a cotação](#confirmarEntidades); 3. [acompanhar o andamento e o resultado](#obterConsultaEntidade). Cada conta pode manter até 50 cotações não aprovadas a cada 15 minutos; acima disso, a API responde 429 e informa a espera no cabeçalho `Retry-After`.

POST /api/v1/entidades/consultas: Aprovar a cotação de uma pessoa ou empresa

Aprova uma [cotação](#cotarEntidades) válida e inicia a consulta em segundo plano. O corpo repete o documento cotado e traz o identificador `cotacaoHash`, uma chave de idempotência e o aceite `cobrarServicosComFalha: true`: a consulta é cobrada integralmente, inclusive quando um serviço termina sem dados ou com falha. A fonte só é consultada depois da aprovação. A resposta (202) traz o identificador da consulta com `status: pendente`; o andamento e o resultado são obtidos na [consulta por identificador](#obterConsultaEntidade). As consultas aprovadas pela API também aparecem no histórico do painel. Se a quota mensal da API não comportar a consulta, nada é aprovado nem executado, e a API responde 429 (`API_MONTHLY_LIMIT_EXCEEDED`). **Idempotência:** repetir a aprovação com a mesma `idempotencyKey` e a mesma cotação devolve a mesma consulta, sem executá-la novamente. Usar a chave em outra cotação retorna 409. **Fluxo:** 1. [cotar](#cotarEntidades); 2. aprovar a cotação; 3. [acompanhar o andamento e o resultado](#obterConsultaEntidade).

GET /api/v1/entidades/consultas: Listar as consultas de pessoas e empresas

Lista as consultas aprovadas da conta, da mais recente para a mais antiga, em páginas de até 25 itens, com documento, nome, situação e valor. Inclui as consultas feitas pelo painel e pela API; cotações não aprovadas não aparecem. Para obter a página seguinte, envie em `cursor` o valor de `nextCursor` da resposta anterior. O resultado de cada consulta é obtido na [consulta por identificador](#obterConsultaEntidade).

GET /api/v1/entidades/consultas/{id}: Obter uma consulta de pessoa ou empresa

Retorna a situação da consulta e o resultado de cada serviço. Os serviços são processados em segundo plano após a [aprovação](#confirmarEntidades); repita a chamada até que nenhum serviço esteja `pendente` ou `consultando`. A consulta termina como `concluido` quando nenhum serviço falha, `parcial` quando parte dos serviços falha e `falhou` quando todos falham. Em cada serviço, `nao_encontrado` indica que a fonte não tem dados para o documento. Quando `nextCursor` não é nulo, as páginas seguintes do serviço são obtidas pela [paginação do serviço](#obterPaginaEntidade). **Fluxo:** 1. [cotar](#cotarEntidades); 2. [aprovar a cotação](#confirmarEntidades); 3. acompanhar o andamento e o resultado.

POST /api/v1/entidades/consultas/{id}/pagina: Obter a página seguinte de um serviço

Retorna a página seguinte do resultado de um serviço concluído da consulta, como a lista de processos. O corpo informa o serviço e o valor de `nextCursor` do resultado anterior, obtido na [consulta por identificador](#obterConsultaEntidade) ou na página anterior. A página tem o mesmo formato do resultado do serviço e traz um novo `nextCursor` enquanto houver páginas seguintes. Uma página já obtida é devolvida novamente, sem nova chamada à fonte.

GET /api/v1/carteiras: Listar carteiras

Lista as carteiras que a chave pode ler, em ordem alfabética, com o endereço (`carteira`) usado nas demais operações de carteiras. A lista traz as carteiras de processos e as de precatórios, identificadas no campo `tipo` de cada carteira; os precatórios e RPVs de uma carteira de precatórios são lidos em [Listar precatórios da carteira](#listarPrecatoriosCarteira). Com `tipo=processos` ou `tipo=precatorios`, a lista traz somente as carteiras desse tipo. Carteiras de precatórios só são listadas quando Precatórios & RPVs está disponível para a conta. Com uma chave comum, a lista traz as carteiras que a pessoa que criou a chave abre no painel. Com uma chave atrelada a uma pessoa da equipe, traz somente as carteiras em que essa pessoa recebeu acesso pela API, nas permissões de acesso da carteira, e que a pessoa que criou a chave também abre. Uma chave atrelada a uma pessoa só pode usar as operações de leitura de carteiras: esta, [Listar processos da carteira](#listarProcessosCarteira), [Obter processo da carteira](#obterProcessoCarteira), [Baixar documento da carteira](#baixarDocumentoCarteira), [Listar precatórios da carteira](#listarPrecatoriosCarteira), [Obter precatório da carteira](#obterPrecatorioCarteira) e [Baixar ofício do precatório](#baixarOficioPrecatorioCarteira). Nas demais operações, a resposta é 403 (`code: CHAVE_ATRELADA_SOMENTE_LEITURA`).

GET /api/v1/carteiras/{carteira}/processos: Listar processos da carteira

Lista os processos de uma carteira com os dados da tabela da carteira no painel: número CNJ, dados de capa, fase, esfera, última movimentação, última atualização e campos personalizados. A ordem é a de inclusão na carteira, da mais recente para a mais antiga. Sem `limite`, a resposta traz todos os processos da carteira. Com `limite`, a lista é paginada: `limite` define a quantidade de processos por resposta e `deslocamento`, quantos processos pular. Em carteiras grandes, a resposta completa é extensa e demora mais; para recebê-la em partes, use `limite` e `deslocamento`. `processoId` identifica a instância exibida na carteira e é usado em [Obter processo da carteira](#obterProcessoCarteira). Nos processos que a conta ainda não consultou, `processoId`, `capa` e `fase` são nulos. Exige acesso à carteira; com uma chave atrelada a uma pessoa da equipe, também o acesso pela API dado a essa pessoa na carteira (veja [Listar carteiras](#listarCarteiras)).

GET /api/v1/carteiras/{carteira}/precatorios: Listar precatórios da carteira

Lista os precatórios e RPVs de uma carteira de precatórios, com os dados gravados na carteira: número do processo de origem, tribunal, LOA, data de expedição, tipo, natureza, situação, valores (inscrito, atualizado e calculado), beneficiário, ente devedor e prioridade. A ordem é a de inclusão na carteira, da mais recente para a mais antiga. Os dados são os da data em que foram gravados na carteira (`gravadoEm`); levar novamente para a carteira um resultado de busca com a mesma requisição atualiza os dados. A operação não consulta a fonte nem o tribunal. A situação do pagamento, a capa do processo e o ofício requisitório de cada item são lidos em [Obter precatório da carteira](#obterPrecatorioCarteira). Sem `limite`, a resposta traz todos os precatórios e RPVs da carteira. Com `limite`, a lista é paginada: `limite` define a quantidade de itens por resposta e `deslocamento`, quantos itens pular. Em carteiras grandes, a resposta completa é extensa e demora mais; para recebê-la em partes, use `limite` e `deslocamento`. Exige acesso à carteira; com uma chave atrelada a uma pessoa da equipe, também o acesso pela API dado a essa pessoa na carteira (veja [Listar carteiras](#listarCarteiras)).

GET /api/v1/carteiras/{carteira}/precatorios/{requisicaoId}: Obter precatório da carteira

Retorna um precatório ou RPV da carteira com os dados do cartão no painel: os dados gravados na carteira (`precatorio`), a situação do pagamento e os demais dados da requisição (`requisicao`) e a capa do processo (`capa`). `precatorio` traz os dados da data da gravação (`gravadoEm`), os mesmos de [Listar precatórios da carteira](#listarPrecatoriosCarteira). `requisicao` e `capa` são lidos no momento do pedido; a capa é lida sem consulta em tempo real ao tribunal. O valor calculado vem em `precatorio`, com os dados gravados; a calculadora do painel não faz parte da resposta. `capa` é nula quando o número do processo não segue o padrão CNJ ou não é aceito pela fonte. Com `capa.situacao` igual a `nao_capturada` ou `segredo_justica`, `capa.processo` é nulo. Quando `requisicao.oficio` não é nulo, o arquivo do ofício requisitório é baixado em [Baixar ofício do precatório](#baixarOficioPrecatorioCarteira). Exige acesso à carteira; com uma chave atrelada a uma pessoa da equipe, também o acesso pela API dado a essa pessoa na carteira (veja [Listar carteiras](#listarCarteiras)).

GET /api/v1/carteiras/{carteira}/precatorios/{requisicaoId}/oficio: Baixar ofício do precatório

Baixa o arquivo do ofício requisitório de um precatório ou RPV da carteira, obtido na fonte no momento do pedido. A resposta é binária: o tipo do arquivo vem em `Content-Type` e o nome do arquivo, em `Content-Disposition`. O ofício contém dados pessoais do credor. - Disponível quando `requisicao.oficio` não é nulo em [Obter precatório da carteira](#obterPrecatorioCarteira); caso contrário, a resposta é 404. - 502 indica que a fonte não encontrou o ofício; 503, que ele está indisponível no momento. Tente novamente mais tarde. Exige o mesmo acesso de [Obter precatório da carteira](#obterPrecatorioCarteira).

GET /api/v1/carteiras/{carteira}/processos/{id}: Obter processo da carteira

Retorna o processo completo de uma instância de um processo da carteira, no mesmo formato de [Obter processo](#getProcesso): dados gerais, partes e advogados, movimentações, documentos dos autos, comunicações do DJEN e processos relacionados. Responde somente para processos da carteira já consultados pela conta, em qualquer das instâncias listadas em `instancias`. Os dados são os já obtidos pela conta: a operação não consulta o tribunal. Processos em segredo de justiça não são retornados. Exige acesso à carteira e uma das permissões Mesa de Trabalho, Consulta Processual, Consulta Histórica ou Consultas em lote pela API; com uma chave atrelada a uma pessoa da equipe, também o acesso pela API dado a essa pessoa na carteira.

GET /api/v1/carteiras/{carteira}/processos/{id}/documentos/{docId}/download: Baixar documento da carteira

Baixa o arquivo de um documento dos autos de um processo da carteira, obtido junto ao tribunal no momento do pedido. A resposta é binária e inclui `Content-Length`, o que permite exibir o progresso. - Disponível somente para processos cujos autos a conta já adquiriu; caso contrário, a resposta é 403. A operação não adquire os autos. - Disponível para documentos com `downloadDisponivel: true` no processo. - 502 indica que o tribunal não disponibilizou o arquivo no momento; tente novamente mais tarde. Exige o mesmo acesso de [Obter processo da carteira](#obterProcessoCarteira).

POST /api/v1/carteiras/{carteira}/atualizacao/cotar: Cotar a atualização de uma carteira

Calcula a atualização dos processos de uma carteira, a mesma ação “Atualizar carteira” do painel. Nenhum processo é consultado nesta etapa. Por padrão, a cotação abrange todos os processos da carteira, consultados em tempo real (`tempoReal: true`); com `tempoReal: false`, a atualização usa os dados já disponíveis na fonte. Com `somenteFalhas: true`, abrange somente os processos cuja consulta falhou na última rodada da carteira, aprovada pela API ou pelo painel. A resposta informa quantos processos a aprovação consulta (`incluidos`) e o identificador `cotacaoId`, exigido na [aprovação](#confirmarAtualizacaoCarteira). Quando a quota mensal da API não comporta todos os processos, a cotação inclui somente os que cabem nela, e os demais (`excedentes`) ficam fora da atualização. No plano Enterprise, a atualização segue o contrato, e o objeto `contrato` informa o preço e o valor máximo. A cotação é válida por 10 minutos; uma cotação não aprovada não gera consulta. Exige a permissão de Consulta Processual e, para membros da equipe, acesso de edição à carteira. **Fluxo:** 1. cotar; 2. [aprovar a cotação](#confirmarAtualizacaoCarteira); 3. [acompanhar o andamento](#obterAtualizacaoCarteira).

POST /api/v1/carteiras/{carteira}/atualizacao: Aprovar a atualização de uma carteira

Aprova uma [cotação](#cotarAtualizacaoCarteira) válida e inicia a atualização da carteira em segundo plano. O corpo traz o identificador `cotacaoId` e repete os valores de `tempoReal` e `somenteFalhas` enviados na cotação. Os processos só são consultados depois da aprovação. A resposta (202) traz a rodada aprovada; o andamento é obtido na [consulta da atualização](#obterAtualizacaoCarteira). A rodada também aparece na página da carteira no painel, onde pode ser pausada ou cancelada. Enquanto uma rodada da carteira estiver ativa ou pausada, nenhuma outra pode ser aprovada. Se a quota mensal da API não comportar mais nenhum processo, nada é aprovado nem executado, e a API responde 429 (`API_MONTHLY_LIMIT_EXCEEDED`). Se a quota, o plano, o contrato ou os processos mudarem depois da cotação, a API responde 409 (`COTACAO_ALTERADA`); nesse caso, solicite uma nova cotação. **Repetição:** aprovar novamente a mesma cotação devolve a mesma rodada, sem consultar os processos outra vez. **Fluxo:** 1. [cotar](#cotarAtualizacaoCarteira); 2. aprovar a cotação; 3. [acompanhar o andamento](#obterAtualizacaoCarteira).

GET /api/v1/carteiras/{carteira}/atualizacao: Acompanhar a atualização de uma carteira

Retorna a rodada de consultas mais recente da carteira, aprovada pela API ou pelo painel, com os contadores de processos aprovados, enviados, consultados, não encontrados e com falha. Sem nenhuma rodada, responde com `status: nenhuma`. A rodada termina com `status: concluido` quando todos os processos aprovados foram consultados; nos status `cancelado` e `encerrado`, o motivo vem em `motivo` e `motivoCodigo`. `finalizadoEm` só é preenchido depois do resultado de todas as consultas enviadas. Os processos com falha podem ser consultados outra vez com uma nova [cotação](#cotarAtualizacaoCarteira) com `somenteFalhas: true`. Exige a permissão de Consulta Processual e acesso à carteira.

GET /api/v1/processos: Buscar processos

Pesquisa processos e retorna até 50 resumos, ordenados pela data de distribuição (mais recentes primeiro). Quando há mais de uma condição (`q` e filtros), todas precisam ser atendidas. Quando o termo permite, a operação também busca processos ainda não disponíveis na base ANTVIAS e os incorpora antes de responder: - 20 dígitos em `q`: busca direta pelo número CNJ, sempre atualizada e com todas as instâncias; - 11 ou 14 dígitos em `q`, ou `parteDocumento` sozinho: processos do CPF ou CNPJ; - OAB em `q` ou em `advogadoOab`: processos do advogado; - filtros estruturados (`parteDocumento`, `tribunal`, `classe`): busca filtrada por esses critérios. Texto livre e os filtros por nome (`parteNome`, `advogadoNome`) pesquisam somente a base ANTVIAS. Sem `q` e sem filtros, a resposta apresenta os processos de distribuição mais recente da base. A mesma busca por CPF ou CNPJ, repetida em até 30 minutos após a conclusão, devolve o resultado já obtido. Os resumos não tornam os processos disponíveis para as operações por `id` (veja [Obter processo](#getProcesso)). Para abrir um processo encontrado, use [Obter processo por número](#getProcessoPorNumero). **Quando usar:** para localizar processos em uma única chamada. Para receber os processos de um CPF, CNPJ ou OAB à medida que chegam, use a [busca progressiva](#streamSearchProcessos). Para registrar a consulta e acompanhá-la depois, use [Criar consulta processual](#criarConsultaProcessual) ou [Criar consulta histórica](#criarConsultaHistorica).

GET /api/v1/processos/busca-progressiva: Buscar processos progressivamente

Busca progressiva por CPF, CNPJ ou OAB: os processos chegam por Server-Sent Events (`text/event-stream`) à medida que são localizados. Informe o identificador em `q`, `parteDocumento` ou `advogadoOab`, sem outros filtros; outras combinações recebem 400. Eventos que a conexão pode receber: - `inicio`: tipo e termo reconhecidos e o `limite` de resultados da busca (1.000); - `descoberta`: total de processos previsto para a busca; - `processo`: um resumo de processo, no mesmo formato de [Pesquisar processos](#searchProcessos); - `progresso`: andamento e quantidade já encontrada; com `pendente: true`, uma nova tentativa está prevista para `proximaTentativaEm`; - `concluido`: fim da busca, com o total encontrado; - `erro`: a busca não pôde ser concluída; os processos já enviados permanecem válidos. A cada 15 segundos o servidor envia um comentário (`: heartbeat`) para manter a conexão aberta. Fechar a conexão interrompe a busca. Os resumos recebidos não tornam os processos disponíveis para as operações por `id` (veja [Obter processo](#getProcesso)). Para abrir um processo encontrado, use [Obter processo por número](#getProcessoPorNumero). **Quando usar:** para exibir os processos de uma pessoa, empresa ou advogado sem esperar a busca inteira. Para um registro que possa ser consultado depois, use [Criar consulta histórica](#criarConsultaHistorica).

POST /api/v1/processos/mesa: Enviar vários processos para a mesa de trabalho

Adiciona até 1.000 processos de uma vez à mesa de trabalho de quem faz a requisição (veja [Processos na mesa de trabalho](#listMesa)). Todos os IDs precisam existir, estar disponíveis para a conta (veja [Obter processo](#getProcesso)) e não podem se repetir na lista; caso contrário, nenhum processo é adicionado e a resposta é 400. Processos que já estavam na mesa são ignorados.

GET /api/v1/processos/mesa: Processos na mesa de trabalho

Lista os processos da mesa de trabalho de quem faz a requisição, do adicionado mais recentemente ao mais antigo. A mesa de trabalho é pessoal, inclusive em contas com equipe: cada pessoa tem a sua e não vê os processos que outra pessoa da conta levou à mesa dela. Com uma chave de API, é a mesa da pessoa em nome de quem a chave age, a mesma que essa pessoa usa no painel: processos adicionados por um canal aparecem no outro.

POST /api/v1/processos/lotes: Criar consulta em lote

Cria um lote com até 1.000 identificadores (número CNJ, CPF, CNPJ ou OAB) e processa cada um em segundo plano. A resposta (202) apresenta o lote com os itens na situação `na_fila`; acompanhe o andamento em [Obter lote](#getLote) até que `naFila` seja 0. - Identificadores repetidos (mesmo tipo e valor) são considerados uma vez. - Um identificador inválido recusa o lote inteiro (400), sem criar nada. - Cada número CNJ corresponde a um item. CPF, CNPJ e OAB são resolvidos nos processos encontrados, que entram no lote como novos itens. **Quando usar:** para cargas grandes, como uma carteira inteira. Lotes estão disponíveis somente na API; no painel, utilize as consultas individuais.

GET /api/v1/processos/lotes: Listar consultas em lote

Lista os até 50 lotes mais recentes da conta, sem os ocultados, com a contagem de itens por situação. O andamento dos lotes com itens pendentes é atualizado a cada leitura.

POST /api/v1/processos/consultas-historicas: Criar consulta histórica

Registra uma consulta por CPF, CNPJ ou OAB e inicia em segundo plano a busca dos processos vinculados ao identificador. A resposta (202) contém `status: em_andamento`; acompanhe pela [lista de consultas históricas](#listConsultasHistoricas). Ao concluir, `resultados` lista os processos encontrados e `nomeConsultado` informa o nome com que o identificador aparece nesses processos. Uma consulta sem processos termina como `concluida` com `encontrados: 0`. - `live: true` busca diretamente nos tribunais (CPF e CNPJ). - Para OAB, não há busca em tempo real; são utilizados os dados já disponíveis. **Idempotência:** envie o cabeçalho `Idempotency-Key` ou o campo `idempotencyKey` para repetir a chamada com segurança, por exemplo, após um timeout. A mesma chave retorna a mesma consulta, sem iniciar outra. Reutilizar a chave com outro identificador retorna 409 (`PLANO_IDEMPOTENCIA_CONFLITO`).

GET /api/v1/processos/consultas-historicas: Listar consultas históricas

Lista as até 50 consultas históricas mais recentes da conta (CPF, CNPJ e OAB), da mais nova para a mais antiga, sem as ocultadas. O andamento das consultas em curso é atualizado a cada leitura. As consultas criadas pelo painel também são listadas.

POST /api/v1/processos/consultas-historicas/{id}/ocultar: Ocultar uma consulta histórica da listagem

Remove a consulta da [listagem](#listConsultasHistoricas). Processos, resultados e consumo já registrados não são apagados. Chamadas repetidas também retornam 204. Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

POST /api/v1/processos/consultas-processuais: Criar consulta processual

Registra uma consulta pelo número CNJ e inicia a busca em segundo plano. A resposta (202) contém a consulta com `status: em_andamento`; acompanhe pela [lista de consultas processuais](#listConsultasProcessuais) até `concluida` ou `erro`. - `live: false` utiliza os dados já disponíveis. - `live: true` busca as informações mais recentes diretamente nos tribunais, como a opção “Em tempo real” do painel. Ao concluir, `resultados` apresenta um resumo de cada instância encontrada; os dados completos são obtidos em [Obter processo](#getProcesso). **Idempotência:** envie o cabeçalho `Idempotency-Key` ou o campo `idempotencyKey` para repetir a chamada com segurança, por exemplo, após um timeout. A mesma chave retorna a mesma consulta, sem iniciar outra. Reutilizar a chave com outro identificador retorna 409 (`PLANO_IDEMPOTENCIA_CONFLITO`).

GET /api/v1/processos/consultas-processuais: Listar consultas processuais

Lista as até 50 consultas processuais mais recentes da conta, da mais nova para a mais antiga, sem as ocultadas. O andamento das consultas em curso é atualizado a cada leitura; chamadas periódicas refletem a evolução. As consultas criadas pelo painel também são listadas: API e painel compartilham os mesmos dados.

POST /api/v1/processos/consultas-processuais/{id}/ocultar: Ocultar uma consulta processual da listagem

Remove a consulta da [listagem](#listConsultasProcessuais). Processos, resultados e consumo já registrados não são apagados. Chamadas repetidas também retornam 204. Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

POST /api/v1/processos/lotes/{id}/ocultar: Ocultar uma consulta em lote da listagem

Remove o lote da [listagem](#listLotes). Itens, processos e consumo já registrados não são apagados, e o lote continua acessível em [Obter lote](#getLote). Chamadas repetidas também retornam 204. Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

PATCH /api/v1/processos/lotes/{id}: Renomear uma consulta em lote

Define o nome do lote, exibido em `nome` na listagem e no detalhe. Espaços no início e no fim são removidos; nome vazio resulta em 400.

GET /api/v1/processos/lotes/{id}: Detalhe de uma consulta em lote

Detalha um lote: contagens por situação e cada item, com o processo vinculado, quando disponível (`processoId`, `numeroCnj`, `titulo`, `grau`). O andamento dos itens pendentes é atualizado a cada leitura; leituras periódicas refletem a evolução. Lotes ocultados continuam acessíveis aqui. Para obter um processo disponível, use [Obter processo](#getProcesso) com o `processoId`.

GET /api/v1/processos/numero/{numero}/{grau}: Detalhe do processo por número CNJ e instância

Mesmo retorno de [Obter processo](#getProcesso), localizando o processo pelo número CNJ e pela instância. Indicada quando o sistema integrado armazena o número do processo, e não o `id` ANTVIAS. - Procura somente processos que já estão na base ANTVIAS. Para incluir um processo novo, use [Criar consulta processual](#criarConsultaProcessual) ou [Pesquisar processos](#searchProcessos) com o número. - Se houver mais de um procedimento com o mesmo número na mesma instância, retorna o de distribuição mais antiga. Para escolher um procedimento específico, use o `id`. - A leitura torna o processo disponível para a conta: em seguida, as operações por `id` passam a responder para todas as instâncias do mesmo número CNJ.

GET /api/v1/processos/{id}: Detalhe do processo

Retorna o processo completo de uma instância: dados gerais, partes e advogados, movimentações, documentos dos autos, comunicações do DJEN e processos relacionados. Cada campo está explicado no [dicionário de dados do objeto processo](#objeto-processo). **Disponibilidade:** as operações por `id` respondem somente para processos já obtidos pela conta, pela API ou pelo painel: resultados de consultas processuais, consultas históricas e lotes, processos lidos por [Obter processo por número](#getProcessoPorNumero) e processos de carteiras acessíveis à chave. A disponibilidade vale para todas as instâncias do mesmo número CNJ. Os resumos de [Pesquisar processos](#searchProcessos) e da [busca progressiva](#streamSearchProcessos) não tornam o processo disponível; para abri-lo, use [Obter processo por número](#getProcessoPorNumero). Para os demais processos, a resposta é 404. Para buscar as informações mais recentes no tribunal, use [Atualizar processo](#atualizarProcesso). Para localizar o processo pelo número CNJ em vez do `id`, use [Obter processo por número](#getProcessoPorNumero).

POST /api/v1/processos/{id}/autos/baixar: Adquirir e baixar os autos do processo

Adquire os autos (documentos anexados) do processo e retorna a lista de documentos que podem ser baixados. Depois da aquisição, baixe cada arquivo em [Baixar documento](#downloadDocumento) ou todos juntos em [Baixar autos em .zip](#downloadAutosZip). Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

GET /api/v1/processos/{id}/documentos/{docId}/download: Download do documento

Baixa o arquivo de um documento dos autos, obtido junto ao tribunal no momento do pedido. A resposta é binária e inclui `Content-Length`, o que permite exibir o progresso. - Exige a aquisição prévia dos autos em [Adquirir autos](#baixarAutos); caso contrário, a resposta é 403. - Disponível para documentos com `downloadDisponivel: true` no processo. - 502 indica que o tribunal não disponibilizou o arquivo no momento; tente novamente mais tarde.

GET /api/v1/processos/{id}/autos/zip: Download de todos os autos em .zip

Gera, em streaming, um único arquivo .zip com todos os documentos do processo que têm `downloadDisponivel: true`, obtidos um a um junto ao tribunal. Como o tamanho só é conhecido ao final, a resposta não inclui `Content-Length`. - Exige a aquisição prévia dos autos em [Adquirir autos](#baixarAutos). - Os arquivos são numerados na ordem de juntada. - Os arquivos não disponibilizados pelo tribunal no momento são listados em um arquivo “LEIA-ME” dentro do .zip e podem ser baixados depois em [Baixar documento](#downloadDocumento). - Se nenhum arquivo puder ser obtido, a resposta é 502.

GET /api/v1/processos/{id}/partes/{parteId}/entidade: Dados cadastrais de uma parte do processo

Consulta os dados cadastrais de uma parte do processo (nome, razão social, filiação, cidades, relacionamentos), pelo CPF ou CNPJ registrado no processo. Disponível somente para partes com documento informado. Para buscar os dados mais recentes nas fontes oficiais, use [Atualizar dados cadastrais da parte](#atualizarEntidadeParte).

POST /api/v1/processos/{id}/partes/{parteId}/entidade/atualizar: Atualizar dados cadastrais da parte em tempo real

Atualiza, nas fontes oficiais, os dados cadastrais da parte e retorna o resultado. A operação é mais lenta que [Dados cadastrais da parte](#getEntidadeParte). Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

POST /api/v1/processos/{id}/atualizar: Atualizar processo em tempo real

Busca no tribunal as informações mais recentes do processo, registra as novidades e retorna um resumo das alterações (`movimentacoesNovas`, `partesNovas`, `documentosNovos`, `relacionadosNovos`). A operação é mais lenta que [Obter processo](#getProcesso), onde os dados atualizados podem ser lidos em seguida. A atualização também busca as comunicações do DJEN. Essa etapa é complementar: seu resultado fica em `statusComunicacoes` e nunca invalida a atualização principal. Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

POST /api/v1/processos/{id}/comunicacoes/atualizar: Atualizar comunicações do DJEN em tempo real

Busca as comunicações do processo no DJEN (Diário de Justiça Eletrônico Nacional) e registra as novas. A chamada aguarda até cerca de 30 segundos pela resposta do DJEN. - Se a lista puder estar incompleta, `parcial` é `true`; quando `job` estiver presente, a busca prossegue no DJEN. Repita a chamada posteriormente para completá-la. - 429: limite de requisições do DJEN atingido; aguarde o tempo indicado no cabeçalho `Retry-After`. - 404: não há comunicações no DJEN para o número, ou o processo não está disponível para a conta. As comunicações registradas ficam disponíveis em `comunicacoes` de [Obter processo](#getProcesso). Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

GET /api/v1/processos/{id}/intel: Obter a análise Intel do processo

Retorna a análise Intel do caso: fase atual no rito, desfecho, fases, marcos, próximos passos prováveis, pontos de atenção e achados de pesquisa na web. A análise pertence ao número CNJ e é compartilhada por todas as instâncias. - `status: nenhuma`: a análise ainda não foi gerada; use [Gerar análise Intel](#gerarProcessoIntel). - `status: processando`: há uma geração em andamento; a análise anterior, se houver, continua em `resultado`. Consulte novamente até `concluida` ou `erro`. - `movimentacoesNovas` maior que 0: há movimentações registradas depois da análise; gere a análise novamente para considerá-las. O conteúdo é gerado por inteligência artificial a partir dos dados do processo e de pesquisas em fontes públicas e deve ser conferido antes do uso.

POST /api/v1/processos/{id}/intel: Gerar (ou regerar) a análise Intel do processo

Inicia em segundo plano a geração (ou regeração) da análise Intel e responde imediatamente com o estado `processando`. Acompanhe por [Obter análise Intel](#getProcessoIntel) até `concluida` ou `erro`. - Se já houver geração em andamento para o mesmo número CNJ, ela é reaproveitada, sem iniciar outra. - Se a análise vigente já considerou todas as movimentações registradas, nada é gerado: a resposta 200 traz a mesma análise, com `status: concluida`. A regeração só ocorre quando há movimentação nova (`movimentacoesNovas` maior que 0). - A análise pode fazer pesquisas na web; a quantidade fica em `buscasWeb`. - 503: o serviço de análise está indisponível no momento. Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

GET /api/v1/processos/{id}/intel/chat: Obter a conversa com o agente jurídico

Retorna a conversa da conta com o agente jurídico sobre este processo, em ordem cronológica, e quantas perguntas ainda podem ser feitas dentro do limite de 24 horas. A conversa abrange todas as instâncias do número CNJ e é a mesma exibida no painel. Para perguntar, use [Enviar pergunta ao agente](#perguntarIntelChat).

POST /api/v1/processos/{id}/intel/chat: Enviar uma pergunta ao agente jurídico

Envia uma pergunta sobre o processo ao agente jurídico e recebe a resposta por Server-Sent Events, à medida que é gerada. O agente considera os dados do processo, a análise Intel e as mensagens anteriores da conversa, e pode pesquisar em fontes públicas. Eventos que a conexão pode receber: - `inicio`: a resposta começou; - `status`: etapa atual (`analisando` ou `pesquisando`); - `delta`: próximo trecho do texto da resposta; - `concluido`: pergunta e resposta gravadas na conversa, com `perguntasRestantes`; - `erro`: a resposta não pôde ser concluída. Recusas são retornadas antes do início do fluxo, como respostas HTTP de erro: - 400: pergunta vazia ou com mais de 2.000 caracteres; - 409: já há uma resposta em curso nesta conversa; - 429: a conta atingiu 60 perguntas nas últimas 24 horas (somando todas as conversas). Apagar a conversa não renova esse limite. Fechar a conexão interrompe a resposta. O conteúdo é gerado por inteligência artificial a partir dos dados do processo e de pesquisas em fontes públicas e deve ser conferido antes do uso.

DELETE /api/v1/processos/{id}/intel/chat: Apagar a conversa com o agente jurídico

Apaga as mensagens da conversa da conta com o agente sobre este processo. Não renova o limite de perguntas das últimas 24 horas e não altera a análise Intel. Retorna 409 se houver uma resposta em curso.

POST /api/v1/processos/{id}/monitorar: Migrar uma marcação antiga de monitoramento

Operação obsoleta, mantida por compatibilidade. Não cria marcações nem monitores pagos: responde 409 com `code: MONITORAMENTO_CONFIGURACAO_NECESSARIA`. Para monitorar um processo, cadastre um [destino de webhook](#createDestinoWebhook) e use [Criar monitor](#createMonitoramento) com confirmação de custo. Marcações antigas permanecem pendentes, sem avisos automáticos.

DELETE /api/v1/processos/{id}/monitorar: Remover uma marcação antiga de monitoramento

Operação obsoleta. Remove somente a marcação legada de monitoramento do processo nesta conta; chamadas repetidas produzem o mesmo resultado. Não exclui monitores de webhook nem cancela inscrições de notificação do painel. Para encerrar um acompanhamento, use [Excluir monitor](#deleteMonitoramento).

POST /api/v1/processos/{id}/mesa: Enviar processo para a mesa de trabalho

Adiciona o processo à mesa de trabalho de quem faz a requisição (veja [Processos na mesa de trabalho](#listMesa)). Se o processo já estiver na mesa, nenhuma alteração é feita. Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

DELETE /api/v1/processos/{id}/mesa: Remover processo da mesa de trabalho

Remove o processo da mesa de trabalho de quem faz a requisição, sem apagar os dados do processo nem alterar a mesa das outras pessoas da conta. Se o processo não estiver na mesa, nenhuma alteração é feita.

GET /api/v1/monitoramento/config: Consultar disponibilidade e limites de monitoramento

Mostra se o monitoramento está disponível para a conta, os preços mensais vigentes por CNJ e por CPF, a faixa contratada, o limite de monitores criados pela API e quantos estão em uso. O limite de monitores criados pela API é definido pela ANTVIAS; quando é zero, novas ativações pela API ficam bloqueadas. Acompanhamentos ativados no painel são cobrados por uso e não contam para esse limite. **Quando usar:** antes de cotar e criar monitores. O fluxo completo está no [guia de webhooks](#guia-webhooks).

POST /api/v1/monitoramento/cotacoes: Cotar monitoramento mensal

Calcula a mensalidade dos alvos com os preços da proposta assinada da conta e retorna um `cotacaoId`. Não realiza consultas, não cria monitor e não inicia o acompanhamento. - Cada alvo corresponde a uma linha: o CNJ, o CPF e cada CNJ selecionado em `cnjsVinculados`. - A cobrança é integral por mês civil (America/Sao_Paulo), sem pró-rata ou reembolso automático; a mensalidade é lançada somente após a confirmação da ativação. - O `cotacaoId` vale para os mesmos alvos, no mesmo mês e com os mesmos preços. Se qualquer desses elementos mudar, [Criar monitor](#createMonitoramento) responde 409 (`COTACAO_OBSOLETA`) e é necessária nova cotação.

GET /api/v1/monitoramento/destinos: Listar destinos de webhook

Lista os destinos de webhook da conta. O segredo não é retornado nesta listagem; ele é exibido apenas na criação e na rotação.

POST /api/v1/monitoramento/destinos: Criar destino de webhook

Cadastra um endereço do seu servidor para receber os eventos dos monitores e retorna o segredo de assinatura, exibido somente nesta resposta. Guarde-o no servidor para validar o cabeçalho `Antvias-Signature` (consulte o [guia de webhooks](#guia-webhooks)). - Aceita apenas URLs HTTPS públicas, sem credenciais na URL; endereços locais, redes privadas e redirecionamentos são recusados. - Até 10 destinos por conta. Em seguida, utilize [Testar destino](#testDestinoWebhook) para verificar a recepção.

PATCH /api/v1/monitoramento/destinos/{id}: Atualizar destino de webhook

Altera nome, URL ou situação do destino. - Desativar interrompe os envios, mas não pausa os monitores nem elimina a mensalidade. Entregas pendentes são retomadas no mesmo destino quando ele é reativado. - Entregas já criadas mantêm a URL vigente no momento da criação; a alteração da URL não as transfere para o novo endereço. - 409: há uma entrega em andamento; aguarde e tente novamente.

DELETE /api/v1/monitoramento/destinos/{id}: Excluir destino de webhook

Exclui o destino. Destinos usados por algum monitor ou com entrega em andamento não podem ser excluídos (409): remova os monitores previamente.

POST /api/v1/monitoramento/destinos/{id}/rotacionar-segredo: Rotacionar segredo do destino

Gera um novo segredo de assinatura, exibido somente nesta resposta. Atualize o receptor imediatamente: entregas pendentes para a URL atual passam a usar o novo segredo na próxima tentativa, mas uma entrega já em andamento pode terminar com o anterior. Recomenda-se aceitar também o segredo anterior no receptor por um breve período. Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

POST /api/v1/monitoramento/destinos/{id}/testar: Enfileirar teste do destino

Enfileira um evento sintético (`tipo: webhook.test`, `teste: true`) para o destino, sem consultar processos. A resposta 202 indica que o pedido foi aceito, não que o evento foi recebido pelo seu servidor; confira o resultado em [Listar entregas](#listEntregasWebhook). Destino inativo retorna 409. Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

GET /api/v1/monitoramento/monitores: Listar monitores

Lista os monitores criados pela API na conta, com situação, cobertura, preço mensal e datas de verificação. Acompanhamentos ativados pelas notificações do painel não são listados.

POST /api/v1/monitoramento/monitores: Criar monitor diário

Cria um monitor diário para um processo (CNJ) ou um CPF, com entrega dos eventos em um [destino de webhook](#createDestinoWebhook). Antes, [cote](#cotarMonitoramento) os mesmos alvos e envie o `cotacaoId` com `confirmarCusto: true`. - CNJ: acompanha movimentações e documentos do processo. - CPF: acompanha novos processos associados ao CPF. A primeira verificação estabelece a referência inicial e não gera avisos. Movimentações só são acompanhadas nos CNJs selecionados em `cnjsVinculados` (até 20); cada um constitui um monitor próprio e ocupa uma vaga. - 201: monitor ativo. 202: ativação em andamento (`status: pendente`); acompanhe em [Consultar monitor](#getMonitoramento). - 409: limite insuficiente, cotação obsoleta (`COTACAO_OBSOLETA`) ou CNJ já acompanhado (`MONITORAMENTO_DUPLICADO`, com referência ao monitor existente).

GET /api/v1/monitoramento/monitores/{id}: Consultar monitor

Retorna um monitor: situação, cobertura efetiva, preço mensal, CNJs vinculados e datas da última e da próxima verificação, quando disponíveis.

PATCH /api/v1/monitoramento/monitores/{id}: Atualizar, pausar ou retomar monitor

Altera nome ou destino, pausa ou retoma o monitor. - A pausa interrompe o acompanhamento após a confirmação e impede competências futuras; a competência do mês em curso, se já lançada, permanece a faturar. - Retomar (`status: ativo`) exige nova [cotação](#cotarMonitoramento) e `confirmarCusto: true`.

DELETE /api/v1/monitoramento/monitores/{id}: Solicitar exclusão do monitor

Solicita a exclusão do monitor. A vaga permanece ocupada até a confirmação da exclusão. A competência do mês em curso, se já lançada, permanece a faturar.

GET /api/v1/monitoramento/eventos: Listar eventos registrados

Lista os eventos registrados pelos monitores da conta, do mais recente para o mais antigo, inclusive os de teste. Use para conferir ou recuperar eventos sem depender das entregas. O campo `dados` descreve a alteração identificada e varia conforme o tipo de evento; a integração não deve depender de uma lista fechada de campos.

GET /api/v1/monitoramento/entregas: Listar entregas de webhook

Lista os envios de eventos aos destinos, do mais recente para o mais antigo, com estado, tentativas, código HTTP, trecho da resposta e próxima tentativa. Falhas têm até 6 tentativas no total, com esperas de 1 minuto, 5 minutos, 30 minutos, 2 horas e 12 horas. Após a última falha, utilize [Reenviar entrega](#replayEntregaWebhook).

POST /api/v1/monitoramento/entregas/{id}/reenviar: Reenviar entrega com o mesmo evento

Enfileira uma nova tentativa para uma entrega com `status: falha`, com o mesmo evento e o mesmo `Antvias-Event-Id`; o receptor deve aceitar IDs repetidos sem processá-los novamente. Retorna 409 se a entrega não estiver em falha ou se o destino estiver inativo. Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

GET /api/v1/consumo: Consumo da conta

Resume o consumo da conta no período: consultas processuais registradas e aquisições de autos, com cada evento (autor, canal e data), do mais recente para o mais antigo. Inclui também a modalidade, o saldo de créditos e a quota mensal da API (`consumoApi`), que sempre se refere ao mês civil corrente em America/Sao_Paulo, independentemente do período filtrado. Pagine os eventos com `offset` e `limit`.

GET /api/v1/consumo/acessos: Acessos de consumo da conta

Lista o registro de acessos da conta, do mais recente para o mais antigo: quem acessou cada área, quando e por onde (painel ou API), com método, caminho e código HTTP, e se o acesso gerou cobrança, com os créditos debitados.

Criar conta ou entrar na plataforma.