{ "openapi": "3.1.0", "info": { "title": "BuscaProcessos API", "version": "1.0.0", "description": "## Transforme dados processuais em fluxos digitais\n\nA API BuscaProcessos conecta consultas, atualizações próprias, documentos públicos, intimações, monitoramentos e inteligência jurídica ao seu produto ou operação. Em vez de depender de pesquisas manuais e conferências periódicas, sua aplicação recebe dados estruturados em JSON e pode acionar jornadas automaticamente.\n\n### Benefícios\n\n- reduza coleta, cópia e conferência manual de informações;\n- enriqueça CRMs, ERPs, portais, painéis e produtos jurídicos;\n- avance por níveis: descoberta, triagem, detalhe, conteúdo e monitoramento;\n- receba novidades por webhook e concentre a equipe na análise;\n- acompanhe consumo, requestId e status para operar com controle.\n\nEsta referência descreve o contrato público versionado em /v1.\n\n## Como começar\n\n1. Gere uma API key no painel BuscaProcessos.\n2. Faça chamadas a partir do seu servidor para https://api.buscaprocessos.app.br.\n3. Envie x-api-key ou Authorization: Bearer.\n4. Persista meta.requestId e meta.searchLogId para suporte e auditoria.\n5. Para operações assíncronas, consulte o status retornado até a conclusão; não repita uma solicitação paga sem verificar seu estado.\n\n## SLA de resposta e HTTP 202\n\nA janela pública total é de até 30 segundos. Quando uma consulta elegível precisa de mais tempo, ela continua no servidor e retorna HTTP 202 antes do timeout. Siga Location/data.statusUrl com a mesma API key e respeite Retry-After/pollAfterMs. O estado pendente não gera débito adicional; a cobrança da operação ocorre uma única vez.\n\n## Fluxos principais\n\n- Documento: /processos?cpf_cnpj=... → /processos/cnj/{cnj} → movimentações, documentos públicos ou resumo.\n- Atualização: POST /processos/cnj/{cnj}/solicitar-atualizacao → GET /status-atualizacao → nova leitura do recurso.\n- Intimações: POST /intimacoes/oab → GET /intimacoes → link de /intimacoes/publicacoes/{diarioId}.\n- Monitoramento: POST /monitoramentos/processos ou /monitoramentos/novos-processos → listar resultados/status → receber webhook quando configurado.\n\n## Webhooks\n\nAs configurações de monitoramento aceitam webhook_url HTTPS. A BuscaProcessos entrega eventos por POST JSON, com identificador de entrega, evento, timestamp e dados normalizados. Responda 2xx rapidamente, deduplique por id/Delivery-Id e processe em fila.\n\n## Custos e erros\n\nO custo depende do tipo de consulta, opções e plano; quando aplicável, a resposta informa creditsCharged e creditsRemaining. Não faça fan-out automático para capa, documentos, PDFs ou IA. Trate 401, 403, 422, 429 e indisponibilidades temporárias de forma explícita.", "contact": { "name": "BuscaProcessos", "url": "https://buscaprocessos.app.br" }, "license": { "name": "Termos de uso BuscaProcessos", "url": "https://buscaprocessos.app.br/termos" } }, "servers": [ { "url": "https://api.buscaprocessos.app.br", "description": "Produção" } ], "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "tags": [ { "name": "Saúde da API", "description": "Disponibilidade e informações da API." }, { "name": "Conta", "description": "Saldo e informações da conta autenticada." }, { "name": "Operação assíncrona", "description": "Polling de consultas que ultrapassaram a janela síncrona." }, { "name": "Busca", "description": "Busca por pessoas, empresas, processos e termos." }, { "name": "Precatórios", "description": "Acervo processual oficial de precatórios, partes e vínculos orçamentários." }, { "name": "Processos", "description": "Consulta de processos e movimentações." }, { "name": "OAB", "description": "Consultas e buscas relacionadas à OAB." }, { "name": "Intimações", "description": "Monitoramento e consulta de intimações." }, { "name": "STF e Justiça Eleitoral", "description": "Publicações do DJe próprio do STF, DJe do TSE e TREs e Mural Eletrônico da Justiça Eleitoral." }, { "name": "Referências", "description": "Tribunais e sistemas disponíveis." }, { "name": "Mandados de prisão", "description": "Consulta de mandados na base BNMP/CNJ." }, { "name": "Processos administrativos", "description": "Consulta oficial por NUP no Protocolo Integrado e no SEI/IBAMA." }, { "name": "Atualizações", "description": "Atualizações assíncronas de dados processuais." }, { "name": "Documentos", "description": "Documentos públicos e downloads." }, { "name": "Inteligência Artificial", "description": "Resumos processuais gerados por IA." }, { "name": "Monitoramento", "description": "Monitoramentos contínuos e radares." }, { "name": "Compatibilidade", "description": "Caminhos históricos ainda disponíveis. Prefira os endpoints principais em novas integrações." } ], "paths": { "/v1": { "get": { "tags": [ "Saúde da API" ], "summary": "Verificar disponibilidade da API", "description": "Use esta operação para confirmar que o namespace público v1 está respondendo e para descobrir o mecanismo de autenticação e um catálogo resumido de recursos. Ela valida o host público antes de retornar a resposta e não substitui uma consulta autenticada de negócio.\n\n**Valor para a operação:** permite validar conectividade e configuração antes de iniciar fluxos de negócio, reduzindo falhas de implantação.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "verificarSaudeApi", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/verificarSaudeApiResponse" }, "example": { "service": "BuscaProcessos API", "version": "v1", "authentication": { "header": "x-api-key", "fallback": "Authorization: Bearer " }, "endpoints": [ { "method": "GET", "path": "/v1/processos", "description": "Consulta de processos por CPF/CNPJ." } ] } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/conta/saldo": { "get": { "tags": [ "Conta" ], "summary": "Consultar saldo da conta", "description": "Retorna o saldo de créditos pré-pagos disponível no Dashboard API da conta vinculada à chave enviada. A operação é gratuita, não cria lançamento de consumo e permanece acessível quando o saldo estiver zerado, permitindo que a integração decida quando alertar ou iniciar uma recarga.\n\n**Valor para a operação:** permite controlar consumo, alertas de saldo baixo e decisões de recarga diretamente na integração.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "consultarSaldoDaConta", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarSaldoDaContaResponse" }, "example": { "data": { "credits": 672.26, "currency": "BRL", "accountStatus": "ACTIVE" }, "meta": { "creditsRemaining": 672.26, "requestId": "req_saldo_exemplo", "searchLogId": null, "servedAt": "14:32:10" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/requests/{requestId}": { "get": { "tags": [ "Operação assíncrona" ], "summary": "Consultar uma resposta em processamento", "description": "Consulta uma operação que retornou HTTP 202 por ter ultrapassado a janela síncrona. Envie a mesma API key da chamada original. Enquanto o trabalho estiver em curso, esta rota mantém 202; ao concluir, reproduz a resposta HTTP final da operação, incluindo status, corpo e headers aplicáveis. O identificador expira após a janela informada pela plataforma.\n\n**Valor para a operação:** mantém integrações responsivas enquanto consultas judiciais mais longas continuam com cobrança única e acompanhamento seguro.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "consultarRespostaAssincrona", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "description": "Identificador UUID retornado em data.requestId e na statusUrl de uma resposta HTTP 202.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/busca/termo": { "get": { "tags": [ "Busca" ], "summary": "Buscar por termo", "description": "Descobre pessoas, empresas e publicações judiciais por texto mesmo sem CNJ prévio. Sem período, consulta o índice local. Com ano_publicacao ou data_publicacao_inicio/data_publicacao_fim e qo=t ou qo=d, consulta comunicações oficiais no período e pode aplicar tribunal. Para q=precatório, ano_orcamentario ou ano_orcamentario_inicio/fim ativa registros orçamentários oficiais e permite filtrar tribunal, ente devedor, UF expedidora e faixa de valor. Correspondências com publicações incluem nível de confiança; ano orçamentário não confirma data de pagamento, e a base orçamentária não identifica diretamente o beneficiário. Confira mode, period, filters, quality, capabilities, totalExact, warnings, partial e cacheHit em meta.search. Cada requisição concluída, inclusive página adicional, pode gerar cobrança.\n\n**Valor para a operação:** transforma pesquisa aberta em dados estruturados que podem alimentar descoberta, triagem e jornadas dentro do seu produto.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "buscarPorTermo", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "q", "in": "query", "required": true, "description": "Texto, nome, empresa, tema, CNJ ou OAB pesquisado. No índice local, palavras são combinadas por AND implícito; use aspas para frase exata.", "schema": { "type": "string" }, "example": "Empresa Exemplo banco de horas" }, { "name": "qo", "in": "query", "required": true, "description": "Escopo obrigatório da busca: t (todos), p (pessoas), c (pessoas com identificadores estruturados), i (instituições), d (publicações e Diários Oficiais) ou en (envolvidos). Use d para empresa + tema em publicações judiciais.", "schema": { "type": "string", "enum": [ "t", "p", "c", "i", "d", "en" ] }, "example": "d" }, { "name": "ano_publicacao", "in": "query", "required": false, "description": "Atalho para pesquisar um ano completo de publicação oficial, como 2026. Não combine com datas. Não representa ano orçamentário nem previsão de pagamento.", "schema": { "type": "integer", "minimum": 1900, "maximum": 2100 }, "example": 2026 }, { "name": "data_publicacao_inicio", "in": "query", "required": false, "description": "Data inicial da publicação oficial no formato YYYY-MM-DD. Envie junto com data_publicacao_fim; o intervalo síncrono máximo é de 366 dias.", "schema": { "type": "string", "format": "date" }, "example": "2026-01-01" }, { "name": "data_publicacao_fim", "in": "query", "required": false, "description": "Data final da publicação oficial no formato YYYY-MM-DD. Envie junto com data_publicacao_inicio.", "schema": { "type": "string", "format": "date" }, "example": "2026-09-02" }, { "name": "ano_orcamentario", "in": "query", "required": false, "description": "Exercício em que o precatório consta para inclusão no orçamento oficial. Em GET /v1/precatorios, sem recorte estadual ou com tribunal federal (TRF/TRT e superiores), seleciona o acervo orçamentário federal, inclusive sem CNJ, com mode=PRECATORIO_BUDGET. Com TJ/TRE ou somente UF, filtra o índice processual enriquecido pelas listas do tribunal. Não equivale a data ou confirmação de pagamento.", "schema": { "type": "integer", "minimum": 2008, "maximum": 2100 }, "example": 2026 }, { "name": "ano_orcamentario_inicio", "in": "query", "required": false, "description": "Primeiro exercício orçamentário da busca de precatórios. Envie junto com ano_orcamentario_fim.", "schema": { "type": "integer", "minimum": 2008, "maximum": 2100 }, "example": 2026 }, { "name": "ano_orcamentario_fim", "in": "query", "required": false, "description": "Último exercício orçamentário da busca de precatórios. O intervalo máximo é de 11 exercícios.", "schema": { "type": "integer", "minimum": 2008, "maximum": 2100 }, "example": 2027 }, { "name": "tribunal", "in": "query", "required": false, "description": "Uma sigla de tribunal, como TJSP, TRF2, TRT1 ou TRT15. Na busca por termos, o filtro é aplicado com ano_publicacao ou com as duas datas de publicação; não existe filtro de UF separado.", "schema": { "type": "string" }, "example": "TRT1" }, { "name": "ente_devedor", "in": "query", "required": false, "description": "Código ou parte do nome da Unidade Orçamentária executada/devedora.", "schema": { "type": "string" }, "example": "Fundo do Regime Geral de Previdência Social" }, { "name": "uf_tribunal_expedidor", "in": "query", "required": false, "description": "UF do Tribunal de Justiça estadual expedidor, quando informada. Não representa o estado do ente devedor federal.", "schema": { "type": "string" }, "example": "SP" }, { "name": "valor_minimo", "in": "query", "required": false, "description": "Valor mínimo do precatório em reais, usando ponto como separador decimal.", "schema": { "type": "number", "format": "double", "minimum": 0 }, "example": 100000 }, { "name": "valor_maximo", "in": "query", "required": false, "description": "Valor máximo do precatório em reais, usando ponto como separador decimal.", "schema": { "type": "number", "format": "double", "minimum": 0 }, "example": 1000000 }, { "name": "tributario", "in": "query", "required": false, "description": "Filtra a classificação tributária do registro orçamentário. Disponível conforme o exercício.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "fundef", "in": "query", "required": false, "description": "Filtra registros classificados como FUNDEF ou não FUNDEF.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "incluir_correspondencias", "in": "query", "required": false, "description": "Quando true, inclui vínculos processuais e correspondências auditáveis com seu nível de confiança. Não confirma pagamento ou beneficiário.", "schema": { "type": "boolean", "default": true }, "example": true }, { "name": "incluir_partes", "in": "query", "required": false, "description": "Quando true em buscas por precatório, inclui as partes e os CPF/CNPJ completos que estiverem publicamente disponíveis nos processos vinculados.", "schema": { "type": "boolean", "default": true }, "example": true }, { "name": "somente_processos_vinculados", "in": "query", "required": false, "description": "Quando true no modo orçamentário, retorna somente registros com número CNJ confirmado pelo índice de vinculação ou por publicação auditável.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "ordenar", "in": "query", "required": false, "description": "Ordenação dos precatórios. Sem UF/tribunal, analise_desc prioriza registros com CNJ, documentos do credor e do devedor, ano orçamentário, situação de pagamento analisada e valor. As demais opções aplicam a ordenação solicitada.", "schema": { "type": "string", "enum": [ "valor_desc", "valor_asc", "ano_desc", "ano_asc", "autuacao_desc" ], "default": "valor_desc" }, "example": "valor_desc" }, { "name": "classe_processual", "in": "query", "required": false, "description": "Classe processual exata, comparada sem diferença de caixa ou acento. Use PRECATÓRIO para remover resultados que apenas mencionam o termo em outra classe.", "schema": { "type": "string" }, "example": "PRECATÓRIO" }, { "name": "deduplicar_por_processo", "in": "query", "required": false, "description": "Quando true, retorna um item por CNJ e consolida a quantidade de publicações relacionadas. Registros sem CNJ não são mesclados.", "schema": { "type": "boolean", "default": false }, "example": true }, { "name": "qs", "in": "query", "required": false, "description": "Ordenação das publicações: d para as mais recentes primeiro ou a para as mais antigas primeiro.", "schema": { "type": "string", "enum": [ "d", "a" ], "default": "d" }, "example": "d" }, { "name": "utilizar_operadores_logicos", "in": "query", "required": false, "description": "Habilita AND, OR, NOT e parênteses no índice local. Aceita true/false; não pode ser combinado com a busca oficial por período.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "example": 20 } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/buscarPorTermoResponse" }, "example": { "data": { "paginator": { "total": 1, "total_pages": 1, "current_page": 1, "per_page": 20 }, "links": { "prev": null, "next": null }, "items": [ { "id": 123456789, "nome": "RECURSO ORDINÁRIO - RITO SUMARÍSSIMO", "resumo": "Conteúdo demonstrativo fictício.", "quantidade_processos": 1, "quantidade_publicacoes": 2, "tipo_resultado": "Diário Oficial", "link": "https://pje.tribunal.example/validacao/documento-exemplo", "link_api": "https://api.buscaprocessos.app.br/v1/intimacoes/publicacoes/12345", "data_publicacao": "2026-08-17", "tribunal": "TRT1", "orgao": "3ª Turma", "classe": "RECURSO ORDINÁRIO - RITO SUMARÍSSIMO", "numero_processo": "0000000-00.2026.8.26.0000", "tipo_comunicacao": "Intimação", "texto": "Conteúdo demonstrativo fictício." } ] }, "meta": { "creditsCharged": 0.1, "creditsRemaining": 99.9, "requestId": "req_busca_termo_exemplo", "searchLogId": "log_busca_termo_exemplo", "servedAt": "14:32:10", "search": { "mode": "OFFICIAL_DATE_RANGE", "period": { "field": "data_publicacao", "start": "2026-01-01", "end": "2026-09-02" }, "tribunal": "TRT1", "partial": false, "cacheHit": false, "totalExact": true, "filters": { "publicationYear": 2026, "requestedTribunal": "TRT1", "className": "PRECATÓRIO", "deduplicateByProcess": true }, "quality": { "rawResults": 2, "classFilteredOut": 0, "duplicatesRemoved": 1, "returnedResults": 1, "uniqueProcesses": 1, "itemsWithoutProcessNumber": 0 }, "warnings": [] } } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/precatorios": { "get": { "tags": [ "Precatórios" ], "summary": "Listar o acervo de precatórios", "description": "Catálogo unificado para análise de precatórios. Sem ano_orcamentario, lista diretamente processos da classe Precatório no índice processual oficial e não exige vínculo orçamentário. Sem UF/tribunal e com ordenar=analise_desc, coloca primeiro os registros com CNJ, CPF/CNPJ do credor, CNPJ do devedor, ano orçamentário, situação de pagamento analisada e valor; os registros parciais continuam nas páginas seguintes. Com ano_orcamentario ou ano_orcamentario_inicio/fim, sem recorte estadual ou com tribunal federal como TRF1, lista o orçamento federal em mode=PRECATORIO_BUDGET, inclusive registros sem CNJ. Com TJ/TRE ou somente UF, consulta o índice processual enriquecido pelas listas do tribunal em mode=PRECATORIO_PROCESS_INDEX. Vínculos seguros acrescentam processo, partes, publicações e situação individual. Permite filtrar por CNJ, tribunal, UF, parte, espécie, ente devedor, valor, situação, risco, completude e datas. meta.search.mode informa a base selecionada, meta.search.prioritization informa a estratégia aplicada e meta.search.coverage informa o avanço do índice processual. Ano orçamentário não comprova pagamento e parte do processo não equivale automaticamente ao beneficiário final.\n\n**Valor para a operação:** oferece uma listagem única do acervo processual e de todo o orçamento de cada exercício, enriquecida com partes, documentos, valores e vínculos auditáveis.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarPrecatorios", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "numero_cnj", "in": "query", "required": false, "description": "Número CNJ exato do precatório. A API aceita máscara e valida os dígitos verificadores.", "schema": { "type": "string" }, "example": "0000000-00.2026.8.26.0000" }, { "name": "cnj", "in": "query", "required": false, "description": "Alias de numero_cnj.", "schema": { "type": "string" }, "example": "0000000-00.2026.8.26.0000" }, { "name": "tribunal", "in": "query", "required": false, "description": "Sigla exata do tribunal, por exemplo TRF1. Com ano orçamentário e tribunal federal, seleciona o acervo orçamentário federal.", "schema": { "type": "string" } }, { "name": "uf", "in": "query", "required": false, "description": "UF com duas letras.", "schema": { "type": "string" } }, { "name": "uf_devedor", "in": "query", "required": false, "description": "Alias de uf para filtrar tribunais estaduais da UF do devedor.", "schema": { "type": "string" } }, { "name": "nome_parte", "in": "query", "required": false, "description": "Nome completo ou parcial de qualquer parte publicada no processo.", "schema": { "type": "string" } }, { "name": "cpf_cnpj_parte", "in": "query", "required": false, "description": "CPF ou CNPJ de qualquer parte publicada no processo, com ou sem pontuação.", "schema": { "type": "string" } }, { "name": "documento_parte", "in": "query", "required": false, "description": "Alias repetível de cpf_cnpj_parte.", "schema": { "type": "string" } }, { "name": "cpf_cnpj_partes", "in": "query", "required": false, "description": "Até 100 CPFs/CNPJs separados por vírgula. A resposta reúne os precatórios encontrados para qualquer documento em uma única chamada.", "schema": { "type": "string" } }, { "name": "documentos_partes", "in": "query", "required": false, "description": "Alias de cpf_cnpj_partes. Até 100 documentos separados por vírgula.", "schema": { "type": "string" } }, { "name": "ente_devedor", "in": "query", "required": false, "description": "Código ou parte do nome da Unidade Orçamentária executada/devedora.", "schema": { "type": "string" } }, { "name": "nome_ente_devedor", "in": "query", "required": false, "description": "Alias de ente_devedor.", "schema": { "type": "string" } }, { "name": "cnpj_ente_devedor", "in": "query", "required": false, "description": "CNPJ do ente devedor quando publicado na capa processual ou resolvido no vínculo orçamentário.", "schema": { "type": "string" } }, { "name": "data_ajuizamento_inicio", "in": "query", "required": false, "description": "Primeiro dia do período de ajuizamento, no formato YYYY-MM-DD. Envie junto com a data final.", "schema": { "type": "string", "format": "date" }, "example": "2026-01-01" }, { "name": "data_ajuizamento_fim", "in": "query", "required": false, "description": "Último dia do período de ajuizamento, no formato YYYY-MM-DD. Envie junto com a data inicial.", "schema": { "type": "string", "format": "date" }, "example": "2026-12-31" }, { "name": "valor_minimo", "in": "query", "required": false, "description": "Valor mínimo do precatório em reais, usando ponto como separador decimal.", "schema": { "type": "number", "format": "double", "minimum": 0 }, "example": 100000 }, { "name": "valor_maximo", "in": "query", "required": false, "description": "Valor máximo do precatório em reais, usando ponto como separador decimal.", "schema": { "type": "number", "format": "double", "minimum": 0 }, "example": 1000000 }, { "name": "ano_orcamentario", "in": "query", "required": false, "description": "Exercício em que o precatório consta para inclusão no orçamento oficial. Em GET /v1/precatorios, sem recorte estadual ou com tribunal federal (TRF/TRT e superiores), seleciona o acervo orçamentário federal, inclusive sem CNJ, com mode=PRECATORIO_BUDGET. Com TJ/TRE ou somente UF, filtra o índice processual enriquecido pelas listas do tribunal. Não equivale a data ou confirmação de pagamento.", "schema": { "type": "integer", "minimum": 2008, "maximum": 2100 }, "example": 2026 }, { "name": "ano_orcamentario_inicio", "in": "query", "required": false, "description": "Primeiro exercício orçamentário da busca de precatórios. Envie junto com ano_orcamentario_fim.", "schema": { "type": "integer", "minimum": 2008, "maximum": 2100 }, "example": 2026 }, { "name": "ano_orcamentario_fim", "in": "query", "required": false, "description": "Último exercício orçamentário da busca de precatórios. O intervalo máximo é de 11 exercícios.", "schema": { "type": "integer", "minimum": 2008, "maximum": 2100 }, "example": 2027 }, { "name": "natureza_credito", "in": "query", "required": false, "description": "Filtra a natureza jurídica do crédito explicitamente confirmada na fonte: alimentar ou comum. Não converte natureza processual TRABALHISTA/CÍVEL em natureza do crédito. Disponível no modo processual, sem ano_orcamentario.", "schema": { "type": "string", "enum": [ "alimentar", "comum" ] }, "example": "alimentar" }, { "name": "superpreferencia", "in": "query", "required": false, "description": "Filtra a condição de superpreferência explicitamente confirmada ou negada na fonte. true exige reconhecimento; false exige ausência expressamente informada. A omissão não trata null como false. Disponível no modo processual, sem ano_orcamentario.", "schema": { "type": "boolean" }, "example": true }, { "name": "especie", "in": "query", "required": false, "description": "Espécie da requisição. Aceita precatorio, rpv, todas ou precatorio,rpv.", "schema": { "type": "string", "enum": [ "precatorio", "rpv", "todas", "precatorio,rpv" ] }, "example": "precatorio,rpv" }, { "name": "status_pagamento", "in": "query", "required": false, "description": "Estágio materializado do pagamento, como EM_FILA, EM_ACORDO, PARCIALMENTE_PAGO ou PAGO.", "schema": { "type": "string" } }, { "name": "com_valor", "in": "query", "required": false, "description": "Quando true, restringe a registros com valor da ação, requisitado ou atualizado materializado.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "com_saldo", "in": "query", "required": false, "description": "Quando true, restringe a registros com saldo individual materializado.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "com_ordem", "in": "query", "required": false, "description": "Quando true, restringe a registros com posição na ordem cronológica materializada.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "com_pagamento_confirmado", "in": "query", "required": false, "description": "Quando true, restringe a registros com afirmação de pagamento ou evento relacionado além da simples presença em fila, como EM_ACORDO, PARCIALMENTE_PAGO ou PAGO. Para exigir quitação confirmada, combine com status_pagamento=PAGO.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "risco_aquisicao", "in": "query", "required": false, "description": "Classificação materializada para triagem: BAIXO, MODERADO, REQUER_REVISAO ou NAO_CALCULADO.", "schema": { "type": "string", "enum": [ "BAIXO", "MODERADO", "REQUER_REVISAO", "NAO_CALCULADO" ] }, "example": "REQUER_REVISAO" }, { "name": "atualizado_de", "in": "query", "required": false, "description": "Data inicial da atualização materializada, no formato YYYY-MM-DD.", "schema": { "type": "string", "format": "date" }, "example": "2026-09-01" }, { "name": "atualizado_ate", "in": "query", "required": false, "description": "Data final inclusiva da atualização materializada, no formato YYYY-MM-DD.", "schema": { "type": "string", "format": "date" }, "example": "2026-09-15" }, { "name": "incluir_partes", "in": "query", "required": false, "description": "Quando true em buscas por precatório, inclui as partes e os CPF/CNPJ completos que estiverem publicamente disponíveis nos processos vinculados.", "schema": { "type": "boolean", "default": true }, "example": true }, { "name": "incluir_orcamento", "in": "query", "required": false, "description": "No modo processual de GET /v1/precatorios, inclui vínculos orçamentários oficiais confirmados como enriquecimento; não limita a listagem.", "schema": { "type": "boolean", "default": true }, "example": true }, { "name": "incluir_requisicoes", "in": "query", "required": false, "description": "Quando true (padrão), inclui até 100 requisições individuais por CNJ, com situação, prioridade, valor, último movimento e sinais jurídicos disponíveis.", "schema": { "type": "boolean", "default": true }, "example": true }, { "name": "somente_com_documento_parte", "in": "query", "required": false, "description": "Quando true, retorna somente processos com CPF ou CNPJ completo publicado para alguma parte.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "com_documento_credor", "in": "query", "required": false, "description": "Alias de somente_com_documento_parte.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "ordenar", "in": "query", "required": false, "description": "Ordenação dos precatórios. Sem UF/tribunal, analise_desc prioriza registros com CNJ, documentos do credor e do devedor, ano orçamentário, situação de pagamento analisada e valor. As demais opções aplicam a ordenação solicitada.", "schema": { "type": "string", "enum": [ "analise_desc", "atualizacao_desc", "ajuizamento_desc", "ajuizamento_asc", "valor_desc", "valor_asc", "saldo_desc", "risco_asc", "completude_desc", "posicao_asc", "previsao_asc" ], "default": "analise_desc" }, "example": "analise_desc" }, { "name": "ordenar_por", "in": "query", "required": false, "description": "Alias de ordenar.", "schema": { "type": "string", "enum": [ "analise_desc", "atualizacao_desc", "ajuizamento_desc", "ajuizamento_asc", "valor_desc", "valor_asc", "saldo_desc", "risco_asc", "completude_desc", "posicao_asc", "previsao_asc" ], "default": "analise_desc" }, "example": "analise_desc" }, { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "example": 20 } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarPrecatoriosResponse" }, "example": { "data": { "paginator": { "total": 239500, "total_pages": 11975, "current_page": 1, "per_page": 20 }, "links": { "prev": null, "next": "/v1/precatorios?uf=SP&page=2&limit=20" }, "items": [ { "id": "precatorio-processual:00000000000000000000", "nome": "Precatório", "numero_processo": "0000000-00.2026.8.26.0000", "numero_processo_sem_mascara": "00000000000000000000", "tribunal": "TJSP", "uf": "SP", "classe": "Precatório", "codigo_classe": 1265, "data_ajuizamento": "2023-04-02T13:00:00.000Z", "atualizado_na_fonte": "2026-09-12T10:00:00.000Z", "valor_causa": 152340.25, "valor_original": null, "valor_atualizado": 164200.35, "valor_requisitado": 152340.25, "saldo_individual": null, "posicao_ordem_cronologica": 125, "nivel_sigilo": 0, "parte_credora": { "nome": "Parte fictícia", "documento": "00000000000" }, "devedor": { "nome": "INSTITUTO EXEMPLO", "documento": "00000000000000" }, "ente_devedor": "INSTITUTO EXEMPLO", "cnpj_ente_devedor": "00000000000000", "referencia_orcamentaria": "2/2025", "ano_orcamentario": 2026, "natureza_credito": "ALIMENTAR", "natureza_credito_detalhada": "ALIMENTAR", "preferencia": "SUPERPREFERENCIAL", "preferencia_pagamento": "SUPERPREFERENCIAL", "superpreferencial": true, "fundamento_preferencia": "DOENCA_GRAVE", "fonte_natureza": "MOVIMENTACAO_OFICIAL", "consultado_em": "2026-09-12T18:00:00.000Z", "evidencia": [ { "requisicao_id": "precatorio-requisicao:exemplo", "signal": "SUPERPREFERENCIA_DOENCA_GRAVE", "excerpt": "Deferida a parcela superpreferencial em razão de doença grave", "at": "2026-09-12T18:00:00.000Z" } ], "classificacao_credito": { "natureza": "ALIMENTAR", "natureza_detalhada": "ALIMENTAR", "preferencia": "SUPERPREFERENCIAL", "preferencia_pagamento": "SUPERPREFERENCIAL", "superpreferencial": true, "fundamento_preferencia": "DOENCA_GRAVE", "fonte_natureza": "MOVIMENTACAO_OFICIAL", "consultado_em": "2026-09-12T18:00:00.000Z", "evidencias": [], "criterio": "SOMENTE_AFIRMACAO_EXPLICITA_NA_FONTE" }, "confianca_correspondencia": 0.96, "partes": [ { "nome": "Parte fictícia", "polo": "ATIVO", "tipo": "Requerente", "cpf": "00000000000", "cnpj": null, "documento": "00000000000", "tipo_pessoa": "FISICA" } ], "orcamentos": [], "quantidade_requisicoes": 1, "requisicoes_retornadas": 1, "requisicoes_truncadas": false, "requisicoes": [ { "id": "precatorio-requisicao:exemplo", "parte_credora": { "nome": "Parte fictícia", "documento": "00000000000" }, "devedor": { "nome": "ENTE DEVEDOR EXEMPLO", "documento": "00000000000000" }, "identificadores": { "identificador_origem": "ORIGEM_EXEMPLO", "numero_historico": null, "numero_proprio_requisicao": null, "oficio_requisitorio": null }, "pagamento": { "estagio": "EM_FILA", "data_pagamento": null, "criterio_data_pagamento": "DATA_EXPLICITA_NA_EVIDENCIA", "data_evidencia_pagamento": null, "desagio_percentual": null, "grupo_acordo": null, "posicao_no_grupo": null, "posicao_ordem_cronologica": 125, "valor_pago": null, "evidencias": [] }, "especie": "PRECATORIO", "classificacao": { "natureza_processual": "CIVEL", "natureza_credito": "ALIMENTAR", "natureza_credito_padronizada": "ALIMENTAR", "preferencia": "SUPERPREFERENCIAL", "categoria_credito": "ALIMENTAR", "preferencia_pagamento": "SUPERPREFERENCIAL", "prioridade_informada": null, "superpreferencial": true, "fundamento_preferencia": "DOENCA_GRAVE", "fonte_natureza": "MOVIMENTACAO_OFICIAL", "consultado_em": "2026-09-12T10:00:00.000Z", "fonte_classificacao": "MOVIMENTACAO_OFICIAL", "evidencias": [] }, "situacao_processual": { "codigo": 2, "descricao": "Arquivado definitivamente", "desde": "2026-08-01T00:00:00.000Z", "ultimo_movimento": { "codigo": 60, "descricao": "Expedição de ofício", "data": "2026-08-02T10:00:00.000Z" } }, "ordem_pagamento": { "posicao_cronologica": 125, "posicao_superpreferencia": null, "total_na_fila": 5000, "ano_orcamentario": 2026, "fonte_individual_disponivel": true }, "financeiro": { "valor_causa": 152340.25, "valor_requisitado": 152340.25, "valor_atualizado": 164200.35, "saldo_individual": null, "valor_liquido": null, "valor_pago": null, "pagamentos_parciais": null, "data_base": null, "indice_atualizacao": null, "juros": null, "ausencias": { "saldo_individual": { "codigo": "NAO_PUBLICADO_NA_FONTE", "mensagem": "Saldo individual não publicado na fonte consultada." } } }, "eventos_juridicos": { "bloqueio": { "identificado": null, "evidencias": [] }, "cessao": { "identificado": null, "evidencias": [] }, "penhora": { "identificado": null, "evidencias": [] }, "habilitacao": { "identificado": null, "evidencias": [] }, "sucessao": { "identificado": null, "evidencias": [] }, "impugnacao": { "identificado": null, "evidencias": [] }, "suspensao": { "identificado": null, "evidencias": [] }, "reserva_honorarios": { "identificado": null, "evidencias": [] }, "transito_em_julgado": { "identificado": null, "evidencias": [] } }, "risco_cessao": { "classificacao": "NAO_CALCULADO", "fatores_identificados": [] }, "confiabilidade_dados": { "score": 90, "nivel": "ALTA", "escopo": "QUALIDADE_E_COMPLETUDE_DOS_DADOS_DA_REQUISICAO", "nao_representa": [ "PROBABILIDADE_DE_PAGAMENTO", "PARECER_JURIDICO" ] }, "qualidade": { "completude_cadastral": { "score": 90, "nivel": "ALTA", "pendencias": [ "saldo_individual" ] }, "confianca_evidencia": { "score": 80, "criterio": "SOMENTE_AFIRMACAO_EXPLICITA" }, "atualidade": { "idade_dias": 3, "rotulo": "ATUAL", "score": 100 }, "risco_aquisicao": { "classificacao": "NAO_CALCULADO", "fatores": [] } }, "proxima_acao_recomendada": "OBTER SALDO INDIVIDUAL ATUALIZADO", "completude": { "nivel": "PARCIAL_ENRIQUECIDO", "campos_obtidos": 5, "campos_criticos_pendentes": [ "saldo_individual" ], "atualizado_na_fonte": "2026-09-12T10:00:00.000Z" } } ], "confiabilidade_dados": { "score": 95, "nivel": "ALTA", "escopo": "QUALIDADE_E_COMPLETUDE_DOS_DADOS", "fatores_positivos": [ "FONTE_PROCESSUAL_OFICIAL", "CNJ_IDENTIFICADO" ], "pendencias": [ "SEM_VINCULO_ORCAMENTARIO_CONFIRMADO" ], "nao_representa": [ "PROBABILIDADE_DE_PAGAMENTO", "PARECER_JURIDICO" ] }, "status_pagamento": "EM_FILA", "pagamento_verificado_em": "2026-09-12T18:00:00.000Z", "cobertura": { "categoria": "PROCESSUAL_OFICIAL", "fonte": "base processual oficial", "tribunal": { "tribunal": "TJSP", "campos_disponiveis": [ "ano_orcamentario", "valor", "status_pagamento" ] } }, "qualidade": { "completude_cadastral": { "score": 95, "nivel": "ALTA", "escopo": "QUALIDADE_E_COMPLETUDE_DOS_DADOS", "fatores_positivos": [ "FONTE_PROCESSUAL_OFICIAL", "CNJ_IDENTIFICADO" ], "pendencias": [ "SALDO_INDIVIDUAL_NAO_DISPONIVEL" ], "nao_representa": [ "PROBABILIDADE_DE_PAGAMENTO", "PARECER_JURIDICO" ] }, "confianca_evidencia": { "score": 80, "criterio": "SOMENTE_AFIRMACAO_EXPLICITA" }, "atualidade": { "idade_dias": 3, "rotulo": "ATUAL", "score": 100 }, "risco_aquisicao": { "classificacao": "NAO_CALCULADO", "fatores": [] } }, "proxima_acao_recomendada": "OBTER SALDO INDIVIDUAL ATUALIZADO" } ] }, "meta": { "creditsCharged": 0.45, "creditsRemaining": 99.55, "requestId": "req_precatorios_exemplo", "searchLogId": "log_precatorios_exemplo", "servedAt": "14:32:10", "search": { "mode": "PRECATORIO_PROCESS_INDEX", "source": "base processual oficial", "totalExactWithinIndex": true, "prioritization": { "strategy": "DADOS_COMPLETOS_PRIMEIRO", "completeForProspecting": 20366, "completeForDecision": 20462, "criteria": [ "CNJ", "CPF_CNPJ_CREDOR", "CNPJ_DEVEDOR", "ANO_ORCAMENTARIO", "STATUS_PAGAMENTO_ANALISADO", "VALOR" ] }, "coverage": { "status": "PARTIAL", "indexedProcesses": 239500, "upstreamTotal": 1033979, "percent": 23.16, "lastSuccessfulSync": "2026-09-12T13:37:06.772Z", "lastErrorCode": null }, "warnings": [ { "code": "PROCESS_INDEX_COVERAGE_PARTIAL", "message": "O acervo ainda está em construção." } ] } } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/processos": { "get": { "tags": [ "Processos" ], "summary": "Listar processos por CPF ou CNPJ", "description": "Retorna processos associados a um CPF ou CNPJ. Os filtros opcionais status, segredo_justica, tribunais, data_minima/data_maxima ou ano/mes reduzem o portfólio antes da cobrança; intervalos ainda maiores que o limite síncrono retornam FILTER_RANGE_TOO_BROAD sem reservar créditos. Quando tribunais é informado, aceita até cinco siglas e cobra R$ 0,25 por tribunal que efetivamente retornar ao menos um processo. Siglas sem resultado não são cobradas e as páginas seguintes da mesma consulta são incluídas. Sem o filtro tribunais, o preço padrão da listagem permanece inalterado. Para paginação por cursor, siga o link next retornado, que preserva os filtros, em vez de reconstruir a URL manualmente.\n\n**Valor para a operação:** transforma CPF ou CNPJ em uma porta de entrada para triagem, due diligence, enriquecimento cadastral e seleção dos casos que merecem aprofundamento.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarProcessosPorDocumento", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "cpf_cnpj", "in": "query", "required": true, "description": "CPF com 11 dígitos ou CNPJ com 14 dígitos. A API aceita pontuação, mas recomenda enviar somente números.", "schema": { "type": "string" }, "example": "00000000000" }, { "name": "document", "in": "query", "required": false, "description": "Alias aceito pela API para CPF/CNPJ. Use cpf_cnpj em novas integrações.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "description": "Filtro de status. No catálogo administrativo, use ATIVO ou BETA; em /v1/processos, use ATIVO, INATIVO ou TODOS; na consulta por OAB, use RECENTE ou HISTORICO.", "schema": { "type": "string" } }, { "name": "segredo_justica", "in": "query", "required": false, "description": "Em /v1/processos, filtre por SIM, NAO ou TODOS.", "schema": { "type": "string" } }, { "name": "tribunais", "in": "query", "required": false, "description": "Lista de até cinco siglas de tribunais separadas por vírgula ou pelo parâmetro repetido. Em GET /v1/processos, a primeira página custa R$ 0,25 por tribunal informado que retornar ao menos um processo; tribunais sem resultado e páginas seguintes não geram nova cobrança.", "schema": { "type": "string" } }, { "name": "data_minima", "in": "query", "required": false, "description": "Data inicial do filtro no formato YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "data_maxima", "in": "query", "required": false, "description": "Data final do filtro no formato YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "ano", "in": "query", "required": false, "description": "Ano do início do processo, com quatro dígitos. Não combine com data_minima/data_maxima.", "schema": { "type": "integer", "minimum": 1 }, "example": 2026 }, { "name": "mes", "in": "query", "required": false, "description": "Mês do início do processo, de 1 a 12. Exige ano e não deve ser combinado com data_minima/data_maxima.", "schema": { "type": "integer", "minimum": 1 }, "example": 8 }, { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1 }, "example": 20 }, { "name": "cursor", "in": "query", "required": false, "description": "Cursor retornado nos links de próxima página. Prefira seguir data.links.next.href quando esse link existir.", "schema": { "type": "string" } }, { "name": "li", "in": "query", "required": false, "description": "Marcador complementar de paginação retornado pelo provedor; envie junto com cursor quando a próxima URL o incluir.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarProcessosPorDocumentoResponse" }, "example": { "data": { "document": "", "documentType": "cnpj", "envolvido": { "nome": "Parte fictícia", "tipo_pessoa": "JURIDICA", "quantidade_processos": 2, "tipoPessoa": "JURIDICA", "quantidadeProcessos": 2, "raw": { "nome": "Parte fictícia", "tipo_pessoa": "JURIDICA", "quantidade_processos": 2 } }, "processos": [ { "numero_cnj": "0000000-00.2026.8.26.0000", "titulo_polo_ativo": "Parte fictícia", "titulo_polo_passivo": "Parte fictícia", "ano_inicio": 2023, "data_inicio": "2023-03-11", "data_ultima_movimentacao": "2023-03-11", "quantidade_movimentacoes": 2, "fontes": [ { "id": 47, "processo_fonte_id": 1048903, "descricao": "TRT-2 - 1º grau", "nome": "Tribunal Regional do Trabalho da 2ª Região", "sigla": "TRT-2", "tipo": "TRIBUNAL", "grau": 1, "grau_formatado": "Primeiro Grau", "sistema": "PJE", "capa": { "classe": "ACAO TRABALHISTA - RITO ORDINARIO", "assunto": "SALARIO POR FORA - INTEGRACAO", "area": "TRABALHISTA", "valor_causa": { "valor": "310455.6100", "moeda": "R$", "valor_formatado": "R$ 310.455,61" }, "data_distribuicao": "2023-03-11" }, "tribunal": { "id": 13, "nome": "Tribunal Regional do Trabalho da 2ª Região", "sigla": "TRT-2", "categoria": null }, "envolvidos": [ { "nome": "Parte fictícia", "tipo": "RECLAMANTE", "polo": "ATIVO", "advogados": [ { "nome": "Parte fictícia" } ] }, { "nome": "Parte fictícia", "tipo": "RECLAMADO", "polo": "PASSIVO", "cnpj": "00000000000000" } ] } ], "numeroCnj": "0000000-00.2026.8.26.0000", "poloAtivo": "Parte fictícia", "poloPassivo": "Parte fictícia", "raw": { "...": "mesmo objeto original preservado para compatibilidade" } } ], "total": 1, "pagination": { "per_page": 100 }, "links": { "next": { "href": "https://api.buscaprocessos.app.br/v1/processos?cpf_cnpj=&limit=100&cursor=CURSOR&li=LI", "cursor": "CURSOR", "li": "LI" } } }, "meta": { "creditsRemaining": 196.1, "requestId": "mo3blo8x-8tng10", "searchLogId": "uuid", "servedAt": "16:47:51" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/envolvidos/resumo": { "get": { "tags": [ "Processos" ], "summary": "Obter resumo de processos de um envolvido", "description": "Consulta um resumo agregado de processos de um envolvido identificado exclusivamente por CPF/CNPJ na infraestrutura própria. Use para triagem e contagem antes de buscar processos individuais.\n\n**Valor para a operação:** dimensiona rapidamente o universo processual antes de carregar detalhes, melhorando priorização e controle de consumo.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "obterResumoDoEnvolvido", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "cpf_cnpj", "in": "query", "required": true, "description": "CPF com 11 dígitos ou CNPJ com 14 dígitos. A API aceita pontuação, mas recomenda enviar somente números.", "schema": { "type": "string" }, "example": "00000000000" }, { "name": "document", "in": "query", "required": false, "description": "Alias aceito pela API para CPF/CNPJ. Use cpf_cnpj em novas integrações.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/obterResumoDoEnvolvidoResponse" }, "example": { "data": { "nome": "Maria Silva", "tipoPessoa": "FISICA", "quantidadeProcessos": 12, "query": { "nome": null, "cpfCnpj": "" } }, "meta": { "creditsRemaining": 199.1, "requestId": "mo3bp7nt-q19hx2", "searchLogId": "uuid", "servedAt": "16:48:10" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/advogados/processos": { "get": { "tags": [ "OAB" ], "summary": "Listar processos de um advogado", "description": "Lista processos encontrados pela infraestrutura própria com correspondência exata de número e UF da OAB. Os resultados são deduplicados por numeroCnj, ordenados pela última publicação e classificados como RECENTE ou HISTORICO. Essa classificação não equivale a processo ativo ou inativo confirmado pelo tribunal. A coleção é retornada em data.processos e também em data.items; a paginação usa page/limit e data.links.next.\n\n**Resultado progressivo:** a resposta pode ser HTTP 200 com os processos já indexados enquanto a cobertura histórica oficial continua sendo ampliada em segundo plano. Quando data.cobertura.parcial for true, quantidadeProcessos, totalDisponivel, pagination.total e pagination.totalPages são provisórios e podem crescer em chamadas posteriores. Exiba o conteúdo como “atualizando histórico”, faça upsert por numeroCnj e não considere a paginação uma fotografia definitiva.\n\n**Importação completa:** aguarde data.cobertura.completa === true, reinicie em page=1 e siga data.links.next.href até null. Persista data.cobertura.atualizadoEm como versão da coleta, deduplique por numeroCnj e reinicie ou reconcilie a varredura se atualizadoEm mudar entre páginas. Novas publicações oficiais ainda podem acrescentar ou reordenar processos em consultas futuras.\n\n**Cobrança:** não faça polling curto da página 1. Cada nova chamada com page=1 é uma nova consulta e pode gerar cobrança; confira meta.creditsCharged. As páginas seguintes (page > 1) são incluídas sem cobrança adicional, mas só devem ser usadas em uma importação definitiva quando a cobertura estiver completa.\n\n**Valor para a operação:** centraliza consultas relacionadas à atuação profissional e viabiliza carteiras, painéis e rotinas automatizadas por inscrição.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarProcessosPorOab", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "oab_estado", "in": "query", "required": true, "description": "UF da OAB com duas letras, por exemplo SP.", "schema": { "type": "string" }, "example": "SP" }, { "name": "oab_numero", "in": "query", "required": true, "description": "Número da inscrição OAB. Envie o número sem a sigla da UF.", "schema": { "type": "string" }, "example": "123456" }, { "name": "oab_tipo", "in": "query", "required": false, "description": "Tipo de inscrição OAB quando o tribunal exigir essa distinção.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Para uma importação definitiva, só avance depois que data.cobertura.completa for true.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de processos por página. Valores aceitos: 50 ou 100; padrão: 50.", "schema": { "type": "integer", "enum": [ 50, 100 ], "default": 50 }, "example": 100 }, { "name": "status", "in": "query", "required": false, "description": "Filtro de status. No catálogo administrativo, use ATIVO ou BETA; em /v1/processos, use ATIVO, INATIVO ou TODOS; na consulta por OAB, use RECENTE ou HISTORICO.", "schema": { "type": "string" } }, { "name": "data_minima", "in": "query", "required": false, "description": "Data inicial do filtro no formato YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "data_maxima", "in": "query", "required": false, "description": "Data final do filtro no formato YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "tribunais", "in": "query", "required": false, "description": "Lista de até cinco siglas de tribunais separadas por vírgula ou pelo parâmetro repetido. Em GET /v1/processos, a primeira página custa R$ 0,25 por tribunal informado que retornar ao menos um processo; tribunais sem resultado e páginas seguintes não geram nova cobrança.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarProcessosPorOabResponse" }, "example": { "data": { "advogado": { "nome": "Alessandra de Fátima Silva", "tipo": "ADVOGADO", "quantidadeProcessos": 344, "quantidadeRecentes": 257, "quantidadeHistoricos": 87, "quantidadeAtivosConfirmados": 333 }, "processos": [ { "numeroCnj": "0000000-00.2026.8.26.0000", "poloAtivo": "Parte fictícia", "poloPassivo": "Parte fictícia", "anoInicio": 2026, "dataUltimaPublicacao": "2026-07-22", "quantidadePublicacoes": 5, "classificacao": "RECENTE", "ativo": null, "statusProcessual": "NAO_VERIFICADO", "classe": "Agravo de Instrumento", "orgaoJulgador": "12ª Câmara de Direito Privado", "fontes": [ { "tribunal": "TJSP", "sigla": "TJSP", "tipo": "DIARIO_OFICIAL", "origem": "BuscaProcessos", "ultimaPublicacao": "2026-07-22", "quantidadePublicacoes": 5 } ], "evidencia": { "tipo": "BUSCAPROCESSOS_OAB_EXATA", "oab": "423733/SP", "publicacoes": 5, "ultimaPublicacao": "2026-07-22", "link": null }, "raw": { "numero_cnj": "0000000-00.2026.8.26.0000", "ano_inicio": 2026, "data_ultima_movimentacao": "2026-07-22", "quantidade_movimentacoes": 5, "origem": "OWN" } } ], "total": 100, "totalDisponivel": 344, "totalPortfolio": 344, "pagination": { "currentPage": 1, "perPage": 100, "totalPages": 4, "total": 344 }, "links": { "next": { "href": "https://api.buscaprocessos.app.br/v1/advogados/processos?oab_estado=SP&oab_numero=123456&page=2&limit=100", "page": 2 } }, "cobertura": { "fonte": "BuscaProcessos", "origens": [ "BuscaProcessos" ], "vinculo": "OAB_EXATA", "statusProcessual": "BuscaProcessos", "completa": false, "parcial": true, "motivoParcial": "Carregadas 5 de 52 páginas da fonte oficial.", "comunicacoesEncontradas": 344, "paginasConsultadas": 5, "totalPaginasFonte": 52, "atualizadoEm": "2026-08-24T19:21:59.860Z", "servidoDoCache": true } }, "meta": { "creditsRemaining": 192.2, "requestId": "mo3bq5by-wpd9qu", "searchLogId": "uuid", "servedAt": "16:49:12" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/advogados/resumo": { "get": { "tags": [ "OAB" ], "summary": "Obter resumo de um advogado", "description": "Retorna o resumo da infraestrutura própria, deduplicado por CNJ para uma OAB exata, incluindo quantidades recentes e históricas, variantes de nome encontradas nas publicações e a cobertura oficial utilizada. quantidadeAtivosConfirmados permanece separada porque publicação recente, isoladamente, não comprova o estado processual no tribunal.\n\n**Resultado progressivo:** esta rota usa o mesmo portfólio de GET /v1/advogados/processos. Quando data.cobertura.parcial for true, quantidadeProcessos, quantidadeRecentes e quantidadeHistoricos são provisórios e podem crescer enquanto o histórico oficial é consolidado. Exiba essas contagens como “atualizando histórico” e só as trate como fotografia completa quando data.cobertura.completa for true.\n\n**Cobrança:** cada nova chamada ao resumo é uma nova consulta e pode gerar cobrança. Não faça polling curto; defina uma cadência de reconciliação adequada ao produto e confira meta.creditsCharged em cada resposta.\n\n**Valor para a operação:** centraliza consultas relacionadas à atuação profissional e viabiliza carteiras, painéis e rotinas automatizadas por inscrição.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "obterResumoDoAdvogado", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "oab_estado", "in": "query", "required": true, "description": "UF da OAB com duas letras, por exemplo SP.", "schema": { "type": "string" }, "example": "SP" }, { "name": "oab_numero", "in": "query", "required": true, "description": "Número da inscrição OAB. Envie o número sem a sigla da UF.", "schema": { "type": "string" }, "example": "123456" }, { "name": "oab_tipo", "in": "query", "required": false, "description": "Tipo de inscrição OAB quando o tribunal exigir essa distinção.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/obterResumoDoAdvogadoResponse" }, "example": { "data": { "advogado": { "nome": "Alessandra de Fátima Silva", "tipo": "ADVOGADO", "quantidadeProcessos": 29, "quantidadeRecentes": 26, "quantidadeHistoricos": 3, "quantidadeAtivosConfirmados": 24 }, "cobertura": { "fonte": "BuscaProcessos", "origens": [ "BuscaProcessos" ], "vinculo": "OAB_EXATA", "statusProcessual": "BuscaProcessos", "completa": false, "parcial": true, "motivoParcial": "Carregadas 3 de 12 páginas da fonte oficial.", "comunicacoesEncontradas": 29, "paginasConsultadas": 3, "totalPaginasFonte": 12, "atualizadoEm": "2026-08-24T19:24:10.000Z", "servidoDoCache": true }, "query": { "oabEstado": "SP", "oabNumero": "123456", "oabTipo": null } }, "meta": { "creditsRemaining": 198.2, "requestId": "mo3bqw7i-lk22vz", "searchLogId": "uuid", "servedAt": "16:49:40" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/advogados/diarios-oficiais": { "get": { "tags": [ "OAB" ], "summary": "Listar processos de diários oficiais por OAB", "description": "Busca processos e publicações de diários oficiais associados à OAB informada. É útil para localizar menções recentes antes de consultar o detalhe de uma publicação. A paginação usa page e a resposta pode retornar links para conteúdo mais completo.\n\n**Valor para a operação:** centraliza consultas relacionadas à atuação profissional e viabiliza carteiras, painéis e rotinas automatizadas por inscrição.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarDiariosOficiaisPorOab", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "oab_estado", "in": "query", "required": true, "description": "UF da OAB com duas letras, por exemplo SP.", "schema": { "type": "string" }, "example": "SP" }, { "name": "oab_numero", "in": "query", "required": true, "description": "Número da inscrição OAB. Envie o número sem a sigla da UF.", "schema": { "type": "string" }, "example": "123456" }, { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarDiariosOficiaisPorOabResponse" }, "example": { "data": { "oabEstado": "SP", "oabNumero": "123456", "processos": [ { "numeroNovo": "0000000-00.2026.8.26.0000", "diario": { "sigla": "DJSP", "nome": "Diário da Justiça de São Paulo", "estado": "SP" }, "dataMovimentacoes": "2026-04-20", "quantidadeMovimentacoes": 1, "ultimasMovimentacoes": [ { "data": "2026-04-20", "conteudoResumo": "Conteúdo demonstrativo fictício.", "envolvidos": [ { "nome": "Parte fictícia", "papel": "ADVOGADO", "oab": "123456/SP" } ], "link": "https://api.buscaprocessos.app.br/v1/intimacoes/publicacoes/4236069", "linkPublicacaoTribunal": "https://esaj.tjsp.jus.br/cpo/sg/search.do?conversationId=publicacao-4236069" } ] } ], "total": 1, "pagination": { "current_page": 1, "last_page": 3 } }, "meta": { "creditsRemaining": 192.2, "requestId": "mo3c7yj2-1ab9zd", "searchLogId": "uuid", "servedAt": "16:50:03" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/advogados/oab/monitorar": { "post": { "tags": [ "OAB" ], "summary": "Solicitar busca por OAB em tribunal", "description": "Inicia uma busca assíncrona de publicações oficiais para uma OAB, filtrada pelo tribunal informado. O body exige tribunal, oab_estado e oab_numero; permitir_parcial e enviar_callback alteram o modo de processamento. A resposta preserva o contrato assíncrono com identificador numérico e statusUrl. A cobertura corresponde a processos identificados em publicações oficiais e não à carteira processual completa da OAB no tribunal.\n\n**Valor para a operação:** centraliza consultas relacionadas à atuação profissional e viabiliza carteiras, painéis e rotinas automatizadas por inscrição.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente. O fluxo pode retornar uma solicitação pendente; consulte a URL/status retornado quando fornecido.", "operationId": "solicitarBuscaPorOabEmTribunal", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/solicitarBuscaPorOabEmTribunalResponse" }, "example": { "data": { "monitoramento": { "id": "123456", "status": "PENDENTE", "tribunal": { "sigla": "TJSP", "nome": "Tribunal de Justiça de São Paulo", "buscaOab": true }, "statusUrl": "https://api.buscaprocessos.app.br/v1/advogados/oab/monitoramentos/123456" }, "query": { "tribunal": "TJSP", "oabEstado": "SP", "oabNumero": "123456" } }, "meta": { "creditsRemaining": 197.3, "requestId": "mo3c8h82-4jp0xf", "searchLogId": "uuid", "servedAt": "16:50:28" } } } } }, "202": { "description": "Solicitação aceita para processamento assíncrono.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/solicitarBuscaPorOabEmTribunalResponse" }, "example": { "data": { "monitoramento": { "id": "123456", "status": "PENDENTE", "tribunal": { "sigla": "TJSP", "nome": "Tribunal de Justiça de São Paulo", "buscaOab": true }, "statusUrl": "https://api.buscaprocessos.app.br/v1/advogados/oab/monitoramentos/123456" }, "query": { "tribunal": "TJSP", "oabEstado": "SP", "oabNumero": "123456" } }, "meta": { "creditsRemaining": 197.3, "requestId": "mo3c8h82-4jp0xf", "searchLogId": "uuid", "servedAt": "16:50:28" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OabTribunalSearchRequest" }, "examples": { "exemplo": { "summary": "Exemplo fictício", "value": { "tribunal": "TJSP", "oab_estado": "SP", "oab_numero": "123456", "permitir_parcial": false, "enviar_callback": false } } } } } } } }, "/v1/advogados/oab/monitoramentos/{id}": { "get": { "tags": [ "OAB" ], "summary": "Consultar status de busca por OAB", "description": "Consulta o status e o resultado da busca de publicações criada por /advogados/oab/monitorar. A resposta mantém resposta[].processos para compatibilidade com integrações existentes. Faça polling finito usando o statusUrl retornado e interrompa ao atingir SUCESSO ou ERRO; não repita uma solicitação paga sem verificar seu estado.\n\n**Valor para a operação:** centraliza consultas relacionadas à atuação profissional e viabiliza carteiras, painéis e rotinas automatizadas por inscrição.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente. O fluxo pode retornar uma solicitação pendente; consulte a URL/status retornado quando fornecido.", "operationId": "consultarStatusBuscaPorOab", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do recurso retornado pela API. Não confundir com o número CNJ.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarStatusBuscaPorOabResponse" }, "example": { "data": { "monitoramento": { "id": "123456", "status": "SUCESSO", "tribunal": { "sigla": "TJSP", "nome": "Tribunal de Justiça de São Paulo" }, "resposta": { "processos": [ { "numero_cnj": "0000000-00.2026.8.26.0000", "sistema": "e-SAJ" } ] } } }, "meta": { "creditsRemaining": 197.3, "requestId": "mo3c9ffa-b2zi1x", "searchLogId": "uuid", "servedAt": "16:50:58" } } } } }, "202": { "description": "Solicitação aceita para processamento assíncrono.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarStatusBuscaPorOabResponse" }, "example": { "data": { "monitoramento": { "id": "123456", "status": "SUCESSO", "tribunal": { "sigla": "TJSP", "nome": "Tribunal de Justiça de São Paulo" }, "resposta": { "processos": [ { "numero_cnj": "0000000-00.2026.8.26.0000", "sistema": "e-SAJ" } ] } } }, "meta": { "creditsRemaining": 197.3, "requestId": "mo3c9ffa-b2zi1x", "searchLogId": "uuid", "servedAt": "16:50:58" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/intimacoes/oab": { "get": { "tags": [ "Intimações" ], "summary": "Listar monitoramentos de intimações por OAB", "description": "Lista, de forma paginada, os monitoramentos de intimações por OAB da conta autenticada, incluindo ativos e inativos. A operação é de leitura e retorna configuração de webhook, status e dados de cobrança do monitoramento. Use-a para auditar IDs antes de editar ou remover um monitoramento.\n\n**Valor para a operação:** substitui parte do acompanhamento disperso por um fluxo centralizado, deduplicável e conectado à operação jurídica.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarMonitoramentosDeIntimacoes", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1 }, "example": 20 }, { "name": "estado", "in": "query", "required": false, "description": "Parâmetro de consulta estado.", "schema": { "type": "string" } }, { "name": "numero", "in": "query", "required": false, "description": "Número do processo usado para localizar publicações em diários oficiais.", "schema": { "type": "string" } }, { "name": "oab_estado", "in": "query", "required": true, "description": "UF da OAB com duas letras, por exemplo SP.", "schema": { "type": "string" }, "example": "SP" }, { "name": "oab_numero", "in": "query", "required": true, "description": "Número da inscrição OAB. Envie o número sem a sigla da UF.", "schema": { "type": "string" }, "example": "123456" } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarMonitoramentosDeIntimacoesResponse" }, "example": { "data": { "items": [ { "id": "uuid-interno", "oab": { "estado": "SP", "numero": "123456" }, "termo": "OAB/SP 123456", "status": "ACTIVE", "webhookUrl": "https://seusistema.com.br/webhooks/buscaprocessos", "criadoEm": "2026-05-21T10:00:00.000Z", "atualizadoEm": "2026-05-21T10:00:00.000Z" } ], "pagination": { "currentPage": 1, "perPage": 20, "hasNextPage": false, "totalItems": 1 } }, "meta": { "creditsRemaining": 198.2, "requestId": "mo3ckb1w-list", "searchLogId": null, "servedAt": "16:51:00" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } }, "post": { "tags": [ "Intimações" ], "summary": "Criar monitoramento de intimações por OAB", "description": "Cria ou ativa monitoramentos de intimações para uma ou mais OABs. O body aceita oabs, filtros termos_auxiliares, origens_ids e uma webhook_url HTTPS; a cobrança recorrente e o custo da consulta são informados pelo próprio resultado. Quando o webhook estiver configurado, o retorno informa callback.enabled/mode e a API poderá entregar novos eventos à URL do cliente.\n\n**Valor para a operação:** converte o acompanhamento de OABs em uma operação recorrente que pode distribuir novidades diretamente ao sistema do cliente.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "criarMonitoramentoDeIntimacoes", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/criarMonitoramentoDeIntimacoesResponse" }, "example": { "data": { "oabs": [ { "estado": "SP", "numero": "123456" }, { "estado": "SP", "numero": "987654" } ], "monitoramentos": [ { "id": "uuid", "estado": "SP", "numero": "123456", "termo": "OAB SP 123456", "status": "ACTIVE", "callbackEnabled": true, "reused": false } ], "callback": { "enabled": true, "mode": "buscaprocessos_fanout" }, "billing": { "billableOabs": 2, "pricePerNewOab": 0.9 } }, "meta": { "creditsRemaining": 198.2, "requestId": "mo3ckb1w-z8b2qa", "searchLogId": "uuid", "servedAt": "16:52:10" } } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/criarMonitoramentoDeIntimacoesResponse" }, "example": { "data": { "oabs": [ { "estado": "SP", "numero": "123456" }, { "estado": "SP", "numero": "987654" } ], "monitoramentos": [ { "id": "uuid", "estado": "SP", "numero": "123456", "termo": "OAB SP 123456", "status": "ACTIVE", "callbackEnabled": true, "reused": false } ], "callback": { "enabled": true, "mode": "buscaprocessos_fanout" }, "billing": { "billableOabs": 2, "pricePerNewOab": 0.9 } }, "meta": { "creditsRemaining": 198.2, "requestId": "mo3ckb1w-z8b2qa", "searchLogId": "uuid", "servedAt": "16:52:10" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntimacaoOabRequest" }, "examples": { "exemplo": { "summary": "Exemplo fictício", "value": { "oab_estado": "SP", "oab_numero": "123456", "termos_auxiliares": [ "empresa" ], "webhook_url": "https://cliente.example/webhooks/buscaprocessos" } } } } } }, "callbacks": { "webhook": { "$ref": "#/components/callbacks/ClientWebhook" } } }, "put": { "tags": [ "Intimações" ], "summary": "Atualizar monitoramento de intimações por OAB", "description": "Atualiza um monitoramento de intimações existente identificado pela OAB na query ou no body. Use para alterar diários, termos auxiliares ou webhook_url sem criar um segundo monitoramento. A operação não deve ser usada para duplicar cadastros; confirme o status retornado e preserve a configuração de callback.\n\n**Valor para a operação:** substitui parte do acompanhamento disperso por um fluxo centralizado, deduplicável e conectado à operação jurídica.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "atualizarMonitoramentoDeIntimacoes", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "estado", "in": "query", "required": false, "description": "Parâmetro de consulta estado.", "schema": { "type": "string" } }, { "name": "numero", "in": "query", "required": false, "description": "Número do processo usado para localizar publicações em diários oficiais.", "schema": { "type": "string" } }, { "name": "oab_estado", "in": "query", "required": true, "description": "UF da OAB com duas letras, por exemplo SP.", "schema": { "type": "string" }, "example": "SP" }, { "name": "oab_numero", "in": "query", "required": true, "description": "Número da inscrição OAB. Envie o número sem a sigla da UF.", "schema": { "type": "string" }, "example": "123456" } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atualizarMonitoramentoDeIntimacoesResponse" }, "example": { "data": { "oab": { "estado": "SP", "numero": "123456" }, "status": "ACTIVE", "webhookUrl": "https://seusistema.com.br/webhooks/buscaprocessos", "message": "Monitoramento de intimações atualizado com sucesso.", "billing": { "creditsCharged": 0 } }, "meta": { "creditsRemaining": 198, "requestId": "mo3cl10x-edit", "searchLogId": null, "servedAt": "16:53:00" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntimacaoOabRequest" }, "examples": { "exemplo": { "summary": "Exemplo fictício", "value": { "oab_estado": "SP", "oab_numero": "123456", "termos_auxiliares": [ "empresa" ], "webhook_url": "https://cliente.example/webhooks/buscaprocessos" } } } } } } }, "delete": { "tags": [ "Intimações" ], "summary": "Remover monitoramento de intimações por OAB", "description": "Desativa o monitoramento de intimações identificado por estado/número ou pela OAB do body. A remoção interrompe novas buscas e cobranças futuras conforme o fluxo documentado. Respostas de remoção não devem ser tratadas como exclusão física de histórico.\n\n**Valor para a operação:** substitui parte do acompanhamento disperso por um fluxo centralizado, deduplicável e conectado à operação jurídica.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "removerMonitoramentoDeIntimacoes", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "estado", "in": "query", "required": false, "description": "Parâmetro de consulta estado.", "schema": { "type": "string" } }, { "name": "numero", "in": "query", "required": false, "description": "Número do processo usado para localizar publicações em diários oficiais.", "schema": { "type": "string" } }, { "name": "oab_estado", "in": "query", "required": true, "description": "UF da OAB com duas letras, por exemplo SP.", "schema": { "type": "string" }, "example": "SP" }, { "name": "oab_numero", "in": "query", "required": true, "description": "Número da inscrição OAB. Envie o número sem a sigla da UF.", "schema": { "type": "string" }, "example": "123456" } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removerMonitoramentoDeIntimacoesResponse" }, "example": { "data": { "oab": { "estado": "SP", "numero": "123456" }, "status": "INACTIVE", "message": "Monitoramento de intimações removido com sucesso.", "billing": { "creditsCharged": 0 } }, "meta": { "creditsRemaining": 198, "requestId": "mo3cldlt-abc123", "searchLogId": null, "servedAt": "16:53:00" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/intimacoes": { "get": { "tags": [ "Intimações" ], "summary": "Consultar intimações por OAB", "description": "Consulta intimações recentes para uma ou mais OABs. Use o formato oabs=SP:123456,SP:987654 e uma janela desde=YYYY-MM-DD; salve o id de cada intimacao para deduplicação. O conteúdo é resumido nesta operação; quando precisar do texto integral, siga o link para /publicacoes/{diarioId}.\n\n**Valor para a operação:** entrega uma fila estruturada de intimações para deduplicação, distribuição de trabalho e criação de tarefas.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarIntimacoes", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "oabs", "in": "query", "required": true, "description": "Lista de OABs no formato UF:NÚMERO, separadas por vírgula.", "schema": { "type": "string" } }, { "name": "desde", "in": "query", "required": false, "description": "Data inicial da janela de intimações no formato YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1 }, "example": 20 }, { "name": "historico", "in": "query", "required": false, "description": "Quando suportado pela rota, indica consulta histórica em vez da janela corrente.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarIntimacoesResponse" }, "example": { "data": { "oabs": [ { "estado": "SP", "numero": "123456" }, { "estado": "SP", "numero": "987654" } ], "intimacoes": [ { "id": "123", "oab": { "estado": "SP", "numero": "123456" }, "dataPublicacao": "2026-04-24", "diario": { "nome": "Diário da Justiça de São Paulo", "sigla": "DJSP" }, "processo": { "numeroCnj": "0000000-00.2026.8.26.0000", "titulo": null }, "titulo": "Intimacao publicada em Diario de Justica", "conteudo": "Conteúdo demonstrativo fictício.", "conteudoCompletoHtml": "Conteúdo demonstrativo fictício.", "linkPublicacaoTribunal": "https://esaj.tjsp.jus.br/cpo/sg/search.do?conversationId=publicacao-123" } ], "total": 1, "missingMonitorings": [], "filters": { "desde": "2026-04-24" }, "billing": { "billableOabs": 2, "pricePerOab": 0.1 } }, "meta": { "creditsRemaining": 198, "requestId": "mo3cl10x-4cgq1n", "searchLogId": "uuid", "servedAt": "16:52:41" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/intimacoes/historico": { "get": { "tags": [ "Intimações" ], "summary": "Consultar histórico de intimações", "description": "Executa backfill histórico de intimações por OAB. Use apenas quando necessário porque a consulta histórica pode consumir créditos por página. Avance manualmente pelas páginas, persista IDs já processados e use o link da publicação para obter o conteúdo completo sem repetir o backfill.\n\n**Valor para a operação:** substitui parte do acompanhamento disperso por um fluxo centralizado, deduplicável e conectado à operação jurídica.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarHistoricoDeIntimacoes", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "oabs", "in": "query", "required": true, "description": "Lista de OABs no formato UF:NÚMERO, separadas por vírgula.", "schema": { "type": "string" } }, { "name": "desde", "in": "query", "required": false, "description": "Data inicial da janela de intimações no formato YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1 }, "example": 20 } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarHistoricoDeIntimacoesResponse" }, "example": { "data": { "mode": "historico", "oabs": [ { "estado": "SP", "numero": "123456" }, { "estado": "SP", "numero": "987654" } ], "historico": [ { "id": "4236069:31", "oab": { "estado": "SP", "numero": "123456" }, "dataPublicacao": "2026-04-24", "diario": { "sigla": "DJSP", "nome": "Diário da Justiça de São Paulo", "estado": "SP" }, "pagina": 31, "caderno": "Judicial", "processo": { "numeroCnj": "0000000-00.2026.8.26.0000" }, "titulo": "Publicação encontrada em Diário Oficial", "conteudo": "Conteúdo demonstrativo fictício.", "link": "https://api.buscaprocessos.app.br/v1/intimacoes/publicacoes/4236069?page=31", "linkApi": "https://api.buscaprocessos.app.br/v1/intimacoes/publicacoes/4236069?page=31", "linkPublicacaoTribunal": "https://esaj.tjsp.jus.br/cpo/sg/search.do?conversationId=publicacao-4236069", "termoPesquisado": "(\"OAB/SP 123456\" OR \"OAB SP 123456\" OR \"123456/SP\")" } ], "intimacoes": [ { "id": "4236069:31", "dataPublicacao": "2026-04-24", "processo": { "numeroCnj": "0000000-00.2026.8.26.0000" }, "conteudo": "Conteúdo demonstrativo fictício." } ], "total": 1, "filters": { "desde": "2025-04-24" }, "billing": { "billableOabs": 2, "billablePages": 2, "pricePerPage": 0.12, "creditsCharged": 0.24, "paginationIncluded": false, "chargedThisPage": true }, "links": "Os links retornados usam domínio próprio do BuscaProcessos e exigem a mesma autenticação `x-api-key`." }, "meta": { "creditsRemaining": 187.28, "requestId": "mo3hist-1a2b3c", "searchLogId": "uuid", "servedAt": "16:53:20" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/intimacoes/publicacoes/{diarioId}": { "get": { "tags": [ "Intimações" ], "summary": "Obter conteúdo de uma publicação", "description": "Obtém o conteúdo completo de uma publicação de diário oficial a partir do diarioId e, opcionalmente, da página. O endpoint é destinado ao segundo nível de profundidade da consulta de intimações e pode retornar HTML/PDF conforme o formato e a fonte; respeite redirects e não faça download em massa sem necessidade.\n\n**Valor para a operação:** substitui parte do acompanhamento disperso por um fluxo centralizado, deduplicável e conectado à operação jurídica.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "obterConteudoDaPublicacao", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "diarioId", "in": "path", "required": true, "description": "Identificador da publicação no Diário Oficial retornado pela consulta de intimações.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, { "name": "format", "in": "query", "required": false, "description": "Formato solicitado para a publicação, quando disponível. A API também pode redirecionar para o PDF.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/obterConteudoDaPublicacaoResponse" }, "example": { "id": 4236069, "descricao": "Diário de Justiça do Estado de São Paulo", "data_publicacao": "2026-04-24", "link_publicacao_tribunal": "https://esaj.tjsp.jus.br/cpo/sg/search.do?conversationId=publicacao-4236069", "paginas": { "paginator": { "current_page": 31, "per_page": 1 }, "items": { "conteudo": "Conteúdo demonstrativo fictício." } }, "movimentacoes": [ { "id": 1599220678, "data": "2026-04-24T00:00:00.000000Z", "secao": "14ª CÂMARA CÍVEL", "conteudo": "Conteúdo demonstrativo fictício.", "link": "https://api.buscaprocessos.app.br/v1/intimacoes/publicacoes/4236069?page=31", "link_api": "https://api.buscaprocessos.app.br/v1/intimacoes/publicacoes/4236069?page=31", "link_publicacao_tribunal": "https://esaj.tjsp.jus.br/cpo/sg/search.do?conversationId=publicacao-4236069" } ] } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/stf/publicacoes": { "get": { "tags": [ "STF e Justiça Eleitoral" ], "summary": "Pesquisar publicações no DJe do STF", "description": "Pesquisa o Diário da Justiça Eletrônico próprio do STF por termo, número de processo, período e filtros da fonte. O período máximo é de 31 dias; tipo_data aceita PUBLICACAO e DIVULGACAO. A consulta custa R$ 0,10 e retorna texto normalizado, identificadores e paginação.\n\n**Valor para a operação:** cobre em uma única integração o DJe próprio do STF, o DJe do TSE e TREs e o Mural Eletrônico da Justiça Eleitoral.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "pesquisarPublicacoesStf", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "termo", "in": "query", "required": false, "description": "Texto a pesquisar na publicação.", "schema": { "type": "string" } }, { "name": "processo", "in": "query", "required": false, "description": "Número do processo. No Mural Eletrônico, envie uma numeração CNJ com 20 dígitos.", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "Data inicial no formato YYYY-MM-DD. O limite é de 31 dias no STF/DJe Eleitoral e 7 dias no Mural Eletrônico; a listagem de edições aceita até 62 dias.", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "Data final no formato YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "tipo_data", "in": "query", "required": false, "description": "Campo de data da pesquisa. Os valores aceitos dependem da fonte e são descritos na operação.", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "Filtro de tipo da publicação do STF; pode ser repetido.", "schema": { "type": "string" } }, { "name": "relator", "in": "query", "required": false, "description": "Filtro de relator do STF; pode ser repetido.", "schema": { "type": "string" } }, { "name": "sessao", "in": "query", "required": false, "description": "Filtro de sessão do STF; pode ser repetido.", "schema": { "type": "string" } }, { "name": "colegiado", "in": "query", "required": false, "description": "Filtro de colegiado do STF; pode ser repetido.", "schema": { "type": "string" } }, { "name": "incluir_html", "in": "query", "required": false, "description": "Quando true, inclui o HTML original quando a fonte o disponibilizar.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1 }, "example": 20 } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pesquisarPublicacoesStfResponse" }, "example": { "data": { "items": [ { "id": "123456", "tribunal": "STF", "processo": "ADI 1234", "tipo": "PUBLICACAO", "relator": "Ministro Exemplo", "data_publicacao": "2026-09-02", "texto": "Conteúdo demonstrativo fictício." } ], "paginator": { "total": 1, "total_pages": 1, "current_page": 1, "per_page": 20 }, "filtros": { "termo": "Empresa Exemplo", "data_inicio": "2026-09-01", "data_fim": "2026-09-02" } }, "meta": { "creditsCharged": 0.1, "creditsRemaining": 99.9, "requestId": "req_stf_exemplo", "searchLogId": "log_stf_exemplo", "servedAt": "14:32:10" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/stf/publicacoes/{id}": { "get": { "tags": [ "STF e Justiça Eleitoral" ], "summary": "Consultar uma publicação do STF", "description": "Obtém uma publicação específica do DJe próprio do STF pelo identificador retornado na pesquisa. incluir_html=true preserva também o conteúdo HTML quando disponível. A consulta custa R$ 0,05.\n\n**Valor para a operação:** cobre em uma única integração o DJe próprio do STF, o DJe do TSE e TREs e o Mural Eletrônico da Justiça Eleitoral.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "consultarPublicacaoStf", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do recurso retornado pela API. Não confundir com o número CNJ.", "schema": { "type": "string" } }, { "name": "incluir_html", "in": "query", "required": false, "description": "Quando true, inclui o HTML original quando a fonte o disponibilizar.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarPublicacaoStfResponse" }, "example": { "data": { "id": "stf-publicacao-123", "processo": "ADI 1234", "tipo": "PUBLICACAO", "data_publicacao": "2026-09-02", "texto": "Conteúdo demonstrativo fictício.", "html": null }, "meta": { "creditsCharged": 0.05, "creditsRemaining": 99.85, "requestId": "req_stf_detalhe", "searchLogId": "log_stf_detalhe", "servedAt": "14:32:10" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/dje-eleitoral/edicoes": { "get": { "tags": [ "STF e Justiça Eleitoral" ], "summary": "Listar edições do DJe Eleitoral", "description": "Lista edições oficiais do DJe do TSE ou de um TRE. tribunal aceita TSE ou uma sigla como TRE-SP; o período opcional máximo é de 62 dias. A consulta custa R$ 0,12.\n\n**Valor para a operação:** cobre em uma única integração o DJe próprio do STF, o DJe do TSE e TREs e o Mural Eletrônico da Justiça Eleitoral.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarEdicoesDjeEleitoral", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "tribunal", "in": "query", "required": false, "description": "Uma sigla de tribunal, como TJSP, TRF2, TRT1 ou TRT15. Na busca por termos, o filtro é aplicado com ano_publicacao ou com as duas datas de publicação; não existe filtro de UF separado.", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "Data inicial no formato YYYY-MM-DD. O limite é de 31 dias no STF/DJe Eleitoral e 7 dias no Mural Eletrônico; a listagem de edições aceita até 62 dias.", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "Data final no formato YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1 }, "example": 20 } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarEdicoesDjeEleitoralResponse" }, "example": { "data": { "items": [ { "id": "123456", "tribunal": "TSE", "numero": 150, "ano": 2026, "data_publicacao": "2026-09-02", "tipo": "ORDINARIA", "documento": { "status": "DISPONIVEL_NO_PORTAL_OFICIAL", "download_automatizado": true, "endpoint": "/v1/dje-eleitoral/edicoes/123456/pdf" } } ], "total": 1, "filtros": { "tribunal": "TSE" } }, "meta": { "creditsCharged": 0.12, "creditsRemaining": 99.73, "requestId": "req_dje_edicoes", "searchLogId": "log_dje_edicoes", "servedAt": "14:32:10" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/dje-eleitoral/edicoes/{id}/pdf": { "get": { "tags": [ "STF e Justiça Eleitoral" ], "summary": "Baixar PDF de uma edição do DJe Eleitoral", "description": "Baixa o PDF original de uma edição do DJe Eleitoral pelo identificador retornado na listagem. A resposta é binária e inclui Content-Type, Content-Disposition e headers de saldo/consumo. O download custa R$ 0,08.\n\n**Valor para a operação:** cobre em uma única integração o DJe próprio do STF, o DJe do TSE e TREs e o Mural Eletrônico da Justiça Eleitoral.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "baixarPdfDjeEleitoral", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do recurso retornado pela API. Não confundir com o número CNJ.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Arquivo oficial retornado pela fonte judicial.", "headers": { "Content-Disposition": { "description": "Nome sugerido para o arquivo.", "schema": { "type": "string" } }, "X-BuscaProcessos-Credits-Remaining": { "description": "Saldo após o download.", "schema": { "type": "number" } }, "X-BuscaProcessos-Search-Log-Id": { "description": "Identificador do consumo.", "schema": { "type": "string" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/dje-eleitoral/publicacoes": { "get": { "tags": [ "STF e Justiça Eleitoral" ], "summary": "Pesquisar publicações no DJe Eleitoral", "description": "Pesquisa matérias no DJe do TSE ou dos TREs por termo, edição, período, seção e tipo. O período máximo é de 31 dias; tipo_data aceita DISPONIBILIZACAO ou PUBLICACAO. Cada página custa R$ 0,12.\n\n**Valor para a operação:** cobre em uma única integração o DJe próprio do STF, o DJe do TSE e TREs e o Mural Eletrônico da Justiça Eleitoral.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "pesquisarPublicacoesDjeEleitoral", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "tribunal", "in": "query", "required": false, "description": "Uma sigla de tribunal, como TJSP, TRF2, TRT1 ou TRT15. Na busca por termos, o filtro é aplicado com ano_publicacao ou com as duas datas de publicação; não existe filtro de UF separado.", "schema": { "type": "string" } }, { "name": "termo", "in": "query", "required": false, "description": "Texto a pesquisar na publicação.", "schema": { "type": "string" } }, { "name": "numero_edicao", "in": "query", "required": false, "description": "Número da edição do DJe Eleitoral.", "schema": { "type": "string" } }, { "name": "ano", "in": "query", "required": false, "description": "Ano do início do processo, com quatro dígitos. Não combine com data_minima/data_maxima.", "schema": { "type": "integer", "minimum": 1 }, "example": 2026 }, { "name": "data_inicio", "in": "query", "required": false, "description": "Data inicial no formato YYYY-MM-DD. O limite é de 31 dias no STF/DJe Eleitoral e 7 dias no Mural Eletrônico; a listagem de edições aceita até 62 dias.", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "Data final no formato YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "tipo_data", "in": "query", "required": false, "description": "Campo de data da pesquisa. Os valores aceitos dependem da fonte e são descritos na operação.", "schema": { "type": "string" } }, { "name": "secao", "in": "query", "required": false, "description": "Seção do DJe Eleitoral.", "schema": { "type": "string" } }, { "name": "subsecao", "in": "query", "required": false, "description": "Subseção do DJe Eleitoral.", "schema": { "type": "string" } }, { "name": "tipo_edicao", "in": "query", "required": false, "description": "Tipo da edição: ORDINARIA, EXTRAORDINARIA ou ELEITORAL.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1 }, "example": 20 } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pesquisarPublicacoesDjeEleitoralResponse" }, "example": { "data": { "items": [ { "id": "123456", "tribunal": "TRE-SP", "titulo": "Edital", "data_publicacao": "2026-09-02", "trecho": "Conteúdo demonstrativo fictício." } ], "paginator": { "total": 1, "total_pages": 1, "current_page": 1, "per_page": 25 }, "filtros": { "tribunal": "TRE-SP", "termo": "Empresa Exemplo" } }, "meta": { "creditsCharged": 0.12, "creditsRemaining": 99.61, "requestId": "req_dje_publicacoes", "searchLogId": "log_dje_publicacoes", "servedAt": "14:32:10" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/dje-eleitoral/publicacoes/{id}": { "get": { "tags": [ "STF e Justiça Eleitoral" ], "summary": "Consultar uma publicação do DJe Eleitoral", "description": "Obtém o conteúdo normalizado de uma matéria do DJe Eleitoral pelo identificador retornado na pesquisa. A consulta custa R$ 0,05.\n\n**Valor para a operação:** cobre em uma única integração o DJe próprio do STF, o DJe do TSE e TREs e o Mural Eletrônico da Justiça Eleitoral.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "consultarPublicacaoDjeEleitoral", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do recurso retornado pela API. Não confundir com o número CNJ.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarPublicacaoDjeEleitoralResponse" }, "example": { "data": { "id": "materia-123", "tribunal": "TRE-SP", "titulo": "Edital", "texto": "Conteúdo demonstrativo fictício." }, "meta": { "creditsCharged": 0.05, "creditsRemaining": 99.56, "requestId": "req_dje_materia", "searchLogId": "log_dje_materia", "servedAt": "14:32:10" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/mural-eleitoral/publicacoes": { "get": { "tags": [ "STF e Justiça Eleitoral" ], "summary": "Pesquisar publicações no Mural Eletrônico", "description": "Pesquisa o Mural Eletrônico da Justiça Eleitoral no TSE e em até cinco TREs por período, parte, advogado, unidade, documento, localidade ou processo. O intervalo máximo é de 7 dias. Cada página custa R$ 0,15 e a API resolve o hCaptcha da fonte no servidor.\n\n**Valor para a operação:** elimina a consulta manual ao Mural Eletrônico e entrega publicações eleitorais estruturadas ao produto do cliente.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "pesquisarPublicacoesMuralEleitoral", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "tribunal", "in": "query", "required": false, "description": "Uma sigla de tribunal, como TJSP, TRF2, TRT1 ou TRT15. Na busca por termos, o filtro é aplicado com ano_publicacao ou com as duas datas de publicação; não existe filtro de UF separado.", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "Data inicial no formato YYYY-MM-DD. O limite é de 31 dias no STF/DJe Eleitoral e 7 dias no Mural Eletrônico; a listagem de edições aceita até 62 dias.", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "Data final no formato YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "parte", "in": "query", "required": false, "description": "Nome da parte pesquisada no Mural Eletrônico.", "schema": { "type": "string" } }, { "name": "advogado", "in": "query", "required": false, "description": "Nome do advogado pesquisado no Mural Eletrônico.", "schema": { "type": "string" } }, { "name": "unidade", "in": "query", "required": false, "description": "Unidade publicadora do Mural Eletrônico.", "schema": { "type": "string" } }, { "name": "tipo_documento", "in": "query", "required": false, "description": "Tipo de documento do Mural Eletrônico.", "schema": { "type": "string" } }, { "name": "uf", "in": "query", "required": false, "description": "UF com duas letras.", "schema": { "type": "string" } }, { "name": "municipio", "in": "query", "required": false, "description": "Município da publicação.", "schema": { "type": "string" } }, { "name": "origem", "in": "query", "required": false, "description": "Origem do processo no Mural: E para eletrônico ou F para físico.", "schema": { "type": "string" } }, { "name": "processo", "in": "query", "required": false, "description": "Número do processo. No Mural Eletrônico, envie uma numeração CNJ com 20 dígitos.", "schema": { "type": "string" } }, { "name": "prazo_mp", "in": "query", "required": false, "description": "Quando true, filtra publicações com prazo do Ministério Público.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pesquisarPublicacoesMuralEleitoralResponse" }, "example": { "data": { "items": [ { "id": "123456", "decisao_id": "654321", "tribunal": "TRE-SP", "processo": "0000000-00.2026.8.26.0000", "data_publicacao": "2026-09-02T13:00:00.000Z", "texto": "Conteúdo demonstrativo fictício.", "documento_disponivel": true, "certidao_disponivel": true } ], "paginator": { "total": 1, "total_pages": 1, "current_page": 1, "per_page": 1 }, "filtros": { "tribunais": [ "TRE-SP" ], "data_inicio": "2026-09-02", "data_fim": "2026-09-02" } }, "meta": { "creditsCharged": 0.15, "creditsRemaining": 99.41, "requestId": "req_mural", "searchLogId": "log_mural", "servedAt": "14:32:10" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/mural-eleitoral/publicacoes/{id}/{documentKind}": { "get": { "tags": [ "STF e Justiça Eleitoral" ], "summary": "Baixar documento ou certidão do Mural Eletrônico", "description": "Baixa o documento ou a certidão oficial de uma publicação do Mural Eletrônico. Use documentKind=documento ou documentKind=certidao. A resposta é binária e cada download custa R$ 0,08.\n\n**Valor para a operação:** cobre em uma única integração o DJe próprio do STF, o DJe do TSE e TREs e o Mural Eletrônico da Justiça Eleitoral.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "baixarDocumentoMuralEleitoral", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do recurso retornado pela API. Não confundir com o número CNJ.", "schema": { "type": "string" } }, { "name": "documentKind", "in": "path", "required": true, "description": "Tipo do arquivo do Mural Eletrônico: documento ou certidao.", "schema": { "type": "string", "enum": [ "documento", "certidao" ] }, "example": "documento" } ], "responses": { "200": { "description": "Arquivo oficial retornado pela fonte judicial.", "headers": { "Content-Disposition": { "description": "Nome sugerido para o arquivo.", "schema": { "type": "string" } }, "X-BuscaProcessos-Credits-Remaining": { "description": "Saldo após o download.", "schema": { "type": "number" } }, "X-BuscaProcessos-Search-Log-Id": { "description": "Identificador do consumo.", "schema": { "type": "string" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/integrador": { "get": { "tags": [ "Referências" ], "summary": "Listar cobertura dos 92 tribunais do Brasil", "description": "Listar cobertura dos 92 tribunais do Brasil\n\n**Valor para a operação:** permite validar requisitos e opções antes de disparar consultas, reduzindo tentativas inválidas e trabalho corretivo.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarTribunaisIntegrador", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "enable", "in": "query", "required": false, "description": "Parâmetro de consulta enable.", "schema": { "type": "string" } }, { "name": "tribunais", "in": "query", "required": false, "description": "Lista de até cinco siglas de tribunais separadas por vírgula ou pelo parâmetro repetido. Em GET /v1/processos, a primeira página custa R$ 0,25 por tribunal informado que retornar ao menos um processo; tribunais sem resultado e páginas seguintes não geram nova cobrança.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarTribunaisIntegradorResponse" }, "example": { "data": { "summary": { "total": 92, "habilitados": 61, "desabilitados": 31, "percentualCobertura": "66.3%" }, "filtros": { "enable": true, "segmento": null, "uf": null, "tribunais": null, "sistema": null }, "tribunais": [ { "sigla": "TJSP", "nome": "Tribunal de Justiça do Estado de São Paulo", "segmento": "Estadual", "uf": "SP", "enable": true, "enabled": true, "sistemas": [ "e-SAJ", "eproc" ] }, { "sigla": "TRF3", "nome": "Tribunal Regional Federal da 3ª Região", "segmento": "Federal", "uf": "SP", "enable": true, "enabled": true, "sistemas": [ "PJe" ] } ], "total": 61 }, "meta": { "creditsRemaining": 200, "requestId": "mo5aa10m-s1g3j0", "searchLogId": "uuid", "servedAt": "10:02:11" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/sistemas": { "get": { "tags": [ "Referências" ], "summary": "Listar sistemas dos tribunais", "description": "Lista sistemas de tribunais e seus requisitos operacionais. Use os filtros disponíveis para validar a cobertura antes de integrar uma consulta.\n\n**Valor para a operação:** permite validar requisitos e opções antes de disparar consultas, reduzindo tentativas inválidas e trabalho corretivo.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarSistemasDosTribunais", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "tribunais", "in": "query", "required": false, "description": "Lista de até cinco siglas de tribunais separadas por vírgula ou pelo parâmetro repetido. Em GET /v1/processos, a primeira página custa R$ 0,25 por tribunal informado que retornar ao menos um processo; tribunais sem resultado e páginas seguintes não geram nova cobrança.", "schema": { "type": "string" } }, { "name": "utiliza_certificado_digital", "in": "query", "required": false, "description": "Filtra sistemas de tribunais que utilizam certificado digital.", "schema": { "type": "string" } }, { "name": "utiliza_2fa", "in": "query", "required": false, "description": "Filtra sistemas de tribunais que exigem autenticação de dois fatores.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarSistemasDosTribunaisResponse" }, "example": { "data": { "filtros": { "tribunais": [ "TJSP", "TRF3" ], "utilizaCertificadoDigital": true, "utiliza2fa": null }, "sistemas": [ { "sistemaNome": "PJE", "tribunalSigla": "TRF3", "tribunalNome": "Tribunal Regional Federal da 3ª Região", "utilizaCertificadoDigital": true, "utiliza2fa": true } ], "total": 1 }, "meta": { "creditsRemaining": 200, "requestId": "mo5aa10m-s1g3j0", "searchLogId": "uuid", "servedAt": "10:02:11" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/mandados": { "get": { "tags": [ "Mandados de prisão" ], "summary": "Consultar mandados de prisão no BNMP", "description": "Consulta mandados de prisão por CPF ou número da peça na base BNMP/CNJ. Em uma resposta concluída, data.status é CONSTA quando a fonte retorna ao menos um mandado e NADA_CONSTA quando retorna zero registros. Falha, timeout ou indisponibilidade da fonte são retornados como erro e nunca como NADA_CONSTA. Ausência de mandado é um resultado válido e gera débito; indisponibilidade da fonte não gera débito. Se a consulta ultrapassar a janela síncrona, a API responde 202 e o trabalho continua no servidor. O resultado descreve os registros disponíveis naquele instante e não substitui certidão oficial.\n\n**Valor para a operação:** traz mandados públicos do BNMP para triagem cadastral, compliance e due diligence, separados dos processos judiciais comuns.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente. O fluxo pode retornar uma solicitação pendente; consulte a URL/status retornado quando fornecido.", "operationId": "consultarMandadosBnmp", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "cpf", "in": "query", "required": false, "description": "CPF com 11 dígitos. A API aceita pontuação, mas recomenda enviar somente números. Informe cpf ou numero_peca.", "schema": { "type": "string" }, "example": "00000000000" }, { "name": "nome", "in": "query", "required": false, "description": "Nome opcional para refinar a consulta de mandados.", "schema": { "type": "string" }, "example": "Fulano de Tal" }, { "name": "numero_peca", "in": "query", "required": false, "description": "Número da peça/mandado no BNMP, somente dígitos quando possível.", "schema": { "type": "string" }, "example": "00000000000000000000" }, { "name": "incluir_detalhes", "in": "query", "required": false, "description": "Quando true, complementa até 10 mandados com o detalhe da peça quando disponível.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1 }, "example": 20 } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarMandadosBnmpResponse" }, "examples": { "consta": { "summary": "Mandado localizado", "value": { "data": { "cpf": "00000000000", "nome": null, "numero_peca": null, "status": "CONSTA", "exists": true, "count": 1, "mandados": [ { "id": "1234567", "numero": "0000000-00.2026.8.26.0000", "nome": "Parte fictícia", "situacao": "Pendente de cumprimento", "tipo": "Mandado de Prisão", "data_expedicao": "2024-03-12T00:00:00.000Z", "orgao": "1ª Vara Criminal", "peca_tipo_id": 1 } ], "consultado_em": "2026-09-03T20:00:00.000Z", "paginator": { "page": 1, "limit": 20, "total": 1 } }, "meta": { "creditsCharged": 0.25, "creditsRemaining": 199.75, "requestId": "req_bnmp_exemplo", "searchLogId": "log_bnmp_exemplo", "servedAt": "17:00:00", "source": "CNJ/BNMP", "definitiveNegative": false } } }, "nadaConsta": { "summary": "Nenhum mandado localizado", "value": { "data": { "cpf": "00000000000", "nome": null, "numero_peca": null, "status": "NADA_CONSTA", "exists": false, "count": 0, "mandados": [], "consultado_em": "2026-09-04T15:30:00.000Z", "paginator": { "page": 1, "limit": 20, "total": 0 } }, "meta": { "creditsCharged": 0.25, "creditsRemaining": 199.75, "requestId": "req_bnmp_exemplo", "searchLogId": "log_bnmp_exemplo", "servedAt": "12:30:00", "source": "CNJ/BNMP", "definitiveNegative": false } } } } } } }, "202": { "description": "Solicitação aceita para processamento assíncrono.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarMandadosBnmpResponse" }, "example": { "data": { "cpf": "00000000000", "nome": null, "numero_peca": null, "status": "CONSTA", "exists": true, "count": 1, "mandados": [ { "id": "1234567", "numero": "0000000-00.2026.8.26.0000", "nome": "Parte fictícia", "situacao": "Pendente de cumprimento", "tipo": "Mandado de Prisão", "data_expedicao": "2024-03-12T00:00:00.000Z", "orgao": "1ª Vara Criminal", "peca_tipo_id": 1 } ], "consultado_em": "2026-09-03T20:00:00.000Z", "paginator": { "page": 1, "limit": 20, "total": 1 } }, "meta": { "creditsCharged": 0.25, "creditsRemaining": 199.75, "requestId": "req_bnmp_exemplo", "searchLogId": "log_bnmp_exemplo", "servedAt": "17:00:00", "source": "CNJ/BNMP", "definitiveNegative": false } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/orgaos-administrativos": { "get": { "tags": [ "Processos administrativos" ], "summary": "Listar órgãos administrativos cobertos", "description": "Lista os órgãos administrativos efetivamente cobertos para pesquisas por NUP. ATIVO identifica uma integração homologada com NUP real; BETA identifica cobertura disponível pela fonte oficial ainda não homologada individualmente. A resposta informa fonte, capacidades, escopo e restrições. Órgãos apenas planejados não aparecem no catálogo.\n\n**Valor para a operação:** mostra a cobertura vigente por órgão antes de consultar um NUP, evitando tentativas em origens inexistentes.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarOrgaosAdministrativos", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "fonte", "in": "query", "required": false, "description": "Fonte administrativa. No catálogo de órgãos, aceita PROTOCOLO_INTEGRADO ou IBAMA_SEI. Na consulta por NUP, também aceita AUTO, que roteia NUPs 02001 para o IBAMA e os demais para o Protocolo Integrado.", "schema": { "type": "string", "enum": [ "PROTOCOLO_INTEGRADO", "IBAMA_SEI" ] }, "example": "IBAMA_SEI" }, { "name": "status", "in": "query", "required": false, "description": "Filtro de status. No catálogo administrativo, use ATIVO ou BETA; em /v1/processos, use ATIVO, INATIVO ou TODOS; na consulta por OAB, use RECENTE ou HISTORICO.", "schema": { "type": "string", "enum": [ "ATIVO", "BETA" ] }, "example": "ATIVO" }, { "name": "q", "in": "query", "required": false, "description": "Texto, nome, empresa, tema, CNJ ou OAB pesquisado. No índice local, palavras são combinadas por AND implícito; use aspas para frase exata.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarOrgaosAdministrativosResponse" }, "example": { "data": { "summary": { "total_covered": 80, "returned": 80, "active": 2, "beta": 78, "by_source": { "PROTOCOLO_INTEGRADO": 79, "IBAMA_SEI": 1 } }, "filters": { "fonte": null, "status": null, "q": null }, "sources": [ { "source": "PROTOCOLO_INTEGRADO", "name": "Protocolo Integrado do Governo Federal", "scope": "Órgãos e entidades federais aderentes, incluindo a ANAC", "query_by_nup": true, "movements": true, "document_index": false, "document_contents": false, "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "source": "IBAMA_SEI", "name": "Pesquisa Pública do SEI/IBAMA", "scope": "Processos administrativos públicos do IBAMA", "query_by_nup": true, "movements": true, "document_index": true, "document_contents": false, "catalog_url": "https://sei.ibama.gov.br/sei/modulos/pesquisa/md_pesq_processo_pesquisar.php?acao_externa=protocolo_pesquisar&acao_origem_externa=protocolo_pesquisar&id_orgao_acesso_externo=0" } ], "orgaos": [ { "sigla": "ANA", "nome": "Agência Nacional de Águas e Saneamento Básico", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "ANAC", "nome": "Agência Nacional de Aviação Civil", "fonte": "PROTOCOLO_INTEGRADO", "status": "ATIVO", "homologado_em": "2026-09-02", "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "ANS", "nome": "Agência Nacional de Saúde Suplementar", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "ANTAQ", "nome": "Agência Nacional de Transportes Aquaviários", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "BCB", "nome": "Banco Central do Brasil", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Andamentos dos documentos enviados pelo Protocolo Digital do Banco Central.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "CCEE", "nome": "Câmara de Comercialização de Energia Elétrica", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "CDTN", "nome": "Centro de Desenvolvimento da Tecnologia Nuclear", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "CEAGESP", "nome": "Companhia de Entrepostos e Armazéns Gerais de São Paulo", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Protocolos gerais enviados ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "CGU", "nome": "Controladoria-Geral da União", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "CONFEA", "nome": "Conselho Federal de Engenharia e Agronomia", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "CONFEA e conselhos regionais incluídos no SEI multi-órgãos.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "DATAPREV", "nome": "Empresa de Tecnologia e Informações da Previdência", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "EMBRATUR", "nome": "Agência Brasileira de Promoção Internacional do Turismo", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "EMGEA", "nome": "Empresa Gestora de Ativos", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "ENAP", "nome": "Escola Nacional de Administração Pública", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "ENBPAR", "nome": "Empresa Brasileira de Participações em Energia Nuclear e Binacional", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "EPE", "nome": "Empresa de Pesquisa Energética", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "FUNAI", "nome": "Fundação Nacional dos Povos Indígenas", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Andamentos públicos e restritos disponibilizados pelo SEI/FUNAI.", "restricoes": [ "A fonte oficial não habilita acesso à íntegra dos documentos.", "A visibilidade de cada processo continua sujeita às regras da origem." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "HEMOBRAS", "nome": "Empresa Brasileira de Hemoderivados e Biotecnologia", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "IBAMA", "nome": "Instituto Brasileiro do Meio Ambiente e dos Recursos Naturais Renováveis", "fonte": "IBAMA_SEI", "status": "ATIVO", "homologado_em": "2026-09-02", "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": true, "integra_documentos": false, "escopo": "Processos administrativos públicos disponíveis no SEI/IBAMA.", "restricoes": [ "Documentos sigilosos, restritos ou não publicados não são retornados.", "A API devolve o índice público de documentos, não o conteúdo integral." ], "catalog_url": "https://sei.ibama.gov.br/sei/modulos/pesquisa/md_pesq_processo_pesquisar.php?acao_externa=protocolo_pesquisar&acao_origem_externa=protocolo_pesquisar&id_orgao_acesso_externo=0" }, { "sigla": "ICMBIO", "nome": "Instituto Chico Mendes de Conservação da Biodiversidade", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "IFAL", "nome": "Instituto Federal de Alagoas", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "IFAM", "nome": "Instituto Federal do Amazonas", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "IFFAR", "nome": "Instituto Federal Farroupilha", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos disponíveis na origem a partir de 01/01/2016.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "IFMG", "nome": "Instituto Federal de Minas Gerais", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "IFNMG", "nome": "Instituto Federal do Norte de Minas Gerais", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "IFPR", "nome": "Instituto Federal do Paraná", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "IFRS", "nome": "Instituto Federal do Rio Grande do Sul", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "IFS", "nome": "Instituto Federal de Sergipe", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "IFSC", "nome": "Instituto Federal de Santa Catarina", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "IFSUDESTEMG", "nome": "Instituto Federal do Sudeste de Minas Gerais", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos disponíveis no SIG/SIPAC a partir de 04/01/2016.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "IFTM", "nome": "Instituto Federal do Triângulo Mineiro", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "IMBEL", "nome": "Indústria de Material Bélico do Brasil", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "INEP", "nome": "Instituto Nacional de Estudos e Pesquisas Educacionais Anísio Teixeira", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "IPHAN", "nome": "Instituto do Patrimônio Histórico e Artístico Nacional", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "JBRJ", "nome": "Instituto de Pesquisas Jardim Botânico do Rio de Janeiro", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "MAPA", "nome": "Ministério da Agricultura e Pecuária", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "MCTI", "nome": "Ministério da Ciência, Tecnologia e Inovação", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "MD", "nome": "Ministério da Defesa", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Documentos ostensivos disponíveis na origem a partir de janeiro de 2016.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "MDS", "nome": "Ministério do Desenvolvimento e Assistência Social, Família e Combate à Fome", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "MEC", "nome": "Ministério da Educação", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "MINC", "nome": "Ministério da Cultura", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "MJSP", "nome": "Ministério da Justiça e Segurança Pública", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "MMA", "nome": "Ministério do Meio Ambiente e Mudança do Clima", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "MME", "nome": "Ministério de Minas e Energia", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "MRE", "nome": "Ministério das Relações Exteriores", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Cobertura parcial das unidades integradas ao SEI em caráter piloto.", "restricoes": [ "A adesão informada pela fonte oficial é parcial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "MS", "nome": "Ministério da Saúde", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "Processos mantidos pelo SISAI não integram a cobertura declarada.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "MTE", "nome": "Ministério do Trabalho e Emprego", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "NUCLEP", "nome": "Nuclebrás Equipamentos Pesados", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "PPSA", "nome": "Empresa Brasileira de Administração de Petróleo e Gás Natural — Pré-Sal Petróleo", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "PRF", "nome": "Polícia Rodoviária Federal", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFAC", "nome": "Universidade Federal do Acre", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFAM", "nome": "Universidade Federal do Amazonas", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFBA", "nome": "Universidade Federal da Bahia", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFCA", "nome": "Universidade Federal do Cariri", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFDPAR", "nome": "Universidade Federal do Delta do Parnaíba", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFERSA", "nome": "Universidade Federal Rural do Semi-Árido", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFF", "nome": "Universidade Federal Fluminense", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFFS", "nome": "Universidade Federal da Fronteira Sul", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFGD", "nome": "Universidade Federal da Grande Dourados", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFLA", "nome": "Universidade Federal de Lavras", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFMS", "nome": "Universidade Federal de Mato Grosso do Sul", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFOB", "nome": "Universidade Federal do Oeste da Bahia", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFOPA", "nome": "Universidade Federal do Oeste do Pará", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFPA", "nome": "Universidade Federal do Pará", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFRN", "nome": "Universidade Federal do Rio Grande do Norte", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFRRJ", "nome": "Universidade Federal Rural do Rio de Janeiro", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos disponíveis na origem a partir de 01/09/2016.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFS", "nome": "Universidade Federal de Sergipe", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Documentos protocolados na origem a partir de 01/01/2013.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFSB", "nome": "Universidade Federal do Sul da Bahia", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFSC", "nome": "Universidade Federal de Santa Catarina", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos produzidos a partir de dezembro de 2017.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFSJ", "nome": "Universidade Federal de São João del-Rei", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFSM", "nome": "Universidade Federal de Santa Maria", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "NUPs com movimentação na origem a partir de 01/01/2015.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UFU", "nome": "Universidade Federal de Uberlândia", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos administrativos públicos gerados a partir de 2016.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UNB", "nome": "Universidade de Brasília", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UNIFAL-MG", "nome": "Universidade Federal de Alfenas", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UNIFAP", "nome": "Universidade Federal do Amapá", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UNIFEI", "nome": "Universidade Federal de Itajubá", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos disponíveis na origem a partir de 2013.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UNIFESSPA", "nome": "Universidade Federal do Sul e Sudeste do Pará", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UNILAB", "nome": "Universidade da Integração Internacional da Lusofonia Afro-Brasileira", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UNIPAMPA", "nome": "Universidade Federal do Pampa", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" }, { "sigla": "UTFPR", "nome": "Universidade Tecnológica Federal do Paraná", "fonte": "PROTOCOLO_INTEGRADO", "status": "BETA", "homologado_em": null, "consulta_nup": true, "capa": true, "movimentacoes": true, "indice_documentos": false, "integra_documentos": false, "escopo": "Processos públicos enviados pelo órgão ao Protocolo Integrado.", "restricoes": [ "A cobertura depende da atualização do órgão na fonte oficial.", "Documentos integrais não são fornecidos pelo Protocolo Integrado." ], "catalog_url": "https://www.protocolointegrado.gov.br/Protocolo/orgaos_integrados.jsf?todos=true" } ], "routing": { "automatic": true, "ibama_nup_prefix": "02001", "default_source": "PROTOCOLO_INTEGRADO" }, "notes": [ "ATIVO identifica órgãos homologados com NUP real; BETA identifica cobertura disponível pela integração oficial ainda não homologada individualmente.", "A cobertura do Protocolo Integrado depende da adesão e atualização de cada órgão federal.", "A consulta do IBAMA usa diretamente a Pesquisa Pública do SEI/IBAMA.", "Documentos sigilosos, restritos ou não publicados pela origem não são retornados." ] }, "meta": { "creditsCharged": 0, "creditsRemaining": 200, "requestId": "req_orgaos_exemplo", "searchLogId": null, "servedAt": "14:32:10" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/processos/administrativos/nup/{nup}": { "get": { "tags": [ "Processos administrativos" ], "summary": "Consultar processo administrativo por NUP", "description": "Consulta um processo administrativo pelo NUP nas fontes oficiais. fonte=AUTO roteia NUPs iniciados por 02001 para o SEI/IBAMA e os demais para o Protocolo Integrado. A resposta inclui capa, movimentações e, quando a origem publicar, o índice de documentos. Não encontrado ou indisponibilidade temporária da fonte não geram débito.\n\n**Valor para a operação:** traz capa e tramitações oficiais de um NUP para o mesmo fluxo técnico já usado nos processos judiciais.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente. O fluxo pode retornar uma solicitação pendente; consulte a URL/status retornado quando fornecido.", "operationId": "consultarProcessoAdministrativoPorNup", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "nup", "in": "path", "required": true, "description": "Número Único de Processo administrativo. No segmento da URL, prefira enviar somente os dígitos; a API também aceita a barra percent-encoded.", "schema": { "type": "string" } }, { "name": "fonte", "in": "query", "required": false, "description": "Fonte administrativa. No catálogo de órgãos, aceita PROTOCOLO_INTEGRADO ou IBAMA_SEI. Na consulta por NUP, também aceita AUTO, que roteia NUPs 02001 para o IBAMA e os demais para o Protocolo Integrado.", "schema": { "type": "string", "enum": [ "AUTO", "PROTOCOLO_INTEGRADO", "IBAMA_SEI" ] }, "example": "AUTO" }, { "name": "incluir_documentos", "in": "query", "required": false, "description": "Quando true, inclui o índice de documentos se a fonte oficial o disponibilizar.", "schema": { "type": "boolean", "default": true }, "example": true }, { "name": "limite_documentos", "in": "query", "required": false, "description": "Quantidade máxima de documentos retornados, entre 1 e 500.", "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 }, "example": 100 }, { "name": "limite_movimentacoes", "in": "query", "required": false, "description": "Quantidade máxima de movimentações retornadas, entre 1 e 500.", "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 }, "example": 100 } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarProcessoAdministrativoPorNupResponse" }, "example": { "data": { "nup": "02001.003002/2021-17", "nup_digits": "02001003002202117", "source": "IBAMA_SEI", "organ": "IBAMA", "type": "Licenciamento ambiental", "subject": "Licença prévia de empreendimento", "produced_at": "2021-03-17", "interested_parties": [ "Empresa Exemplo Ltda" ], "related_protocols": [ "02001.000111/2020-00" ], "latest_movement_at": "2026-08-20T14:12:00.000Z", "movements": [ { "id": "mov-1", "date_time": "2026-08-20T14:12:00.000Z", "unit": "Coordenação de Licenciamento", "description": "Juntada de documento", "status": "Tramitando" } ], "documents": [ { "id": "doc-1", "number": "12", "type": "Despacho", "date": "2026-08-20", "included_at": "2026-08-20T14:12:00.000Z", "unit": "Coordenação de Licenciamento" } ], "documents_complete": true, "source_url": "https://sei.ibama.gov.br/sei/modulos/pesquisa/md_pesq_processo_pesquisar.php", "coverage": { "metadata": true, "movements": true, "document_index": true, "document_contents": false } }, "meta": { "creditsCharged": 0.25, "creditsRemaining": 199.75, "requestId": "req_nup_exemplo", "searchLogId": "log_nup_exemplo", "servedAt": "14:32:10" } } } } }, "202": { "description": "Solicitação aceita para processamento assíncrono.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarProcessoAdministrativoPorNupResponse" }, "example": { "data": { "nup": "02001.003002/2021-17", "nup_digits": "02001003002202117", "source": "IBAMA_SEI", "organ": "IBAMA", "type": "Licenciamento ambiental", "subject": "Licença prévia de empreendimento", "produced_at": "2021-03-17", "interested_parties": [ "Empresa Exemplo Ltda" ], "related_protocols": [ "02001.000111/2020-00" ], "latest_movement_at": "2026-08-20T14:12:00.000Z", "movements": [ { "id": "mov-1", "date_time": "2026-08-20T14:12:00.000Z", "unit": "Coordenação de Licenciamento", "description": "Juntada de documento", "status": "Tramitando" } ], "documents": [ { "id": "doc-1", "number": "12", "type": "Despacho", "date": "2026-08-20", "included_at": "2026-08-20T14:12:00.000Z", "unit": "Coordenação de Licenciamento" } ], "documents_complete": true, "source_url": "https://sei.ibama.gov.br/sei/modulos/pesquisa/md_pesq_processo_pesquisar.php", "coverage": { "metadata": true, "movements": true, "document_index": true, "document_contents": false } }, "meta": { "creditsCharged": 0.25, "creditsRemaining": 199.75, "requestId": "req_nup_exemplo", "searchLogId": "log_nup_exemplo", "servedAt": "14:32:10" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } }, "post": { "tags": [ "Processos administrativos" ], "summary": "Consultar processo administrativo por NUP com opções", "description": "Mesma consulta por NUP do GET, com opções enviadas em JSON: fonte, incluir_documentos, limite_documentos e limite_movimentacoes. Use quando o cliente preferir body em vez de query string. Se a fonte ultrapassar a janela síncrona, a API responde 202 e a consulta continua no servidor.\n\n**Valor para a operação:** permite a mesma consulta por NUP com opções no body, útil para clientes que montam a requisição em JSON.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente. O fluxo pode retornar uma solicitação pendente; consulte a URL/status retornado quando fornecido.", "operationId": "consultarProcessoAdministrativoPorNupComOpcoes", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "nup", "in": "path", "required": true, "description": "Número Único de Processo administrativo. No segmento da URL, prefira enviar somente os dígitos; a API também aceita a barra percent-encoded.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarProcessoAdministrativoPorNupComOpcoesResponse" }, "example": { "data": { "nup": "02001.003002/2021-17", "nup_digits": "02001003002202117", "source": "IBAMA_SEI", "organ": "IBAMA", "type": "Licenciamento ambiental", "subject": "Licença prévia de empreendimento", "produced_at": "2021-03-17", "interested_parties": [ "Empresa Exemplo Ltda" ], "related_protocols": [ "02001.000111/2020-00" ], "latest_movement_at": "2026-08-20T14:12:00.000Z", "movements": [ { "id": "mov-1", "date_time": "2026-08-20T14:12:00.000Z", "unit": "Coordenação de Licenciamento", "description": "Juntada de documento", "status": "Tramitando" } ], "documents": [ { "id": "doc-1", "number": "12", "type": "Despacho", "date": "2026-08-20", "included_at": "2026-08-20T14:12:00.000Z", "unit": "Coordenação de Licenciamento" } ], "documents_complete": true, "source_url": "https://sei.ibama.gov.br/sei/modulos/pesquisa/md_pesq_processo_pesquisar.php", "coverage": { "metadata": true, "movements": true, "document_index": true, "document_contents": false } }, "meta": { "creditsCharged": 0.25, "creditsRemaining": 199.75, "requestId": "req_nup_post_exemplo", "searchLogId": "log_nup_post_exemplo", "servedAt": "14:32:10" } } } } }, "202": { "description": "Solicitação aceita para processamento assíncrono.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarProcessoAdministrativoPorNupComOpcoesResponse" }, "example": { "data": { "nup": "02001.003002/2021-17", "nup_digits": "02001003002202117", "source": "IBAMA_SEI", "organ": "IBAMA", "type": "Licenciamento ambiental", "subject": "Licença prévia de empreendimento", "produced_at": "2021-03-17", "interested_parties": [ "Empresa Exemplo Ltda" ], "related_protocols": [ "02001.000111/2020-00" ], "latest_movement_at": "2026-08-20T14:12:00.000Z", "movements": [ { "id": "mov-1", "date_time": "2026-08-20T14:12:00.000Z", "unit": "Coordenação de Licenciamento", "description": "Juntada de documento", "status": "Tramitando" } ], "documents": [ { "id": "doc-1", "number": "12", "type": "Despacho", "date": "2026-08-20", "included_at": "2026-08-20T14:12:00.000Z", "unit": "Coordenação de Licenciamento" } ], "documents_complete": true, "source_url": "https://sei.ibama.gov.br/sei/modulos/pesquisa/md_pesq_processo_pesquisar.php", "coverage": { "metadata": true, "movements": true, "document_index": true, "document_contents": false } }, "meta": { "creditsCharged": 0.25, "creditsRemaining": 199.75, "requestId": "req_nup_post_exemplo", "searchLogId": "log_nup_post_exemplo", "servedAt": "14:32:10" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrativeProcessRequest" }, "examples": { "exemplo": { "summary": "Exemplo fictício", "value": { "fonte": "AUTO", "incluir_documentos": true, "limite_documentos": 100, "limite_movimentacoes": 100 } } } } } } } }, "/v1/processos/cnj/{cnj}": { "get": { "tags": [ "Processos" ], "summary": "Consultar capa de processo por CNJ", "description": "Obtém a capa/dados principais de um processo por seu número CNJ. O número é normalizado e validado; use esta operação depois de identificar o processo e antes de solicitar movimentações, documentos públicos ou resumo por IA. Use data.valor_causa como atalho estável; data.fontes[0].capa.valor_causa permanece compatível. Quando o valor ainda não estiver no cache, a resposta permanece rápida e o enriquecimento é agendado em segundo plano. A resposta segue o envelope data/meta e pode indicar saldo e requestId.\n\n**Valor para a operação:** consolida a visão principal do processo para abastecer telas, cadastros, análises e decisões sobre os próximos dados a consultar.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "consultarProcessoPorCnj", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "cnj", "in": "path", "required": true, "description": "Alias de numero_cnj.", "schema": { "type": "string" }, "example": "0000000-00.2026.8.26.0000" } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarProcessoPorCnjResponse" }, "example": { "data": { "numeroCnj": "0000000-00.2026.8.26.0000", "poloAtivo": "Parte fictícia", "poloPassivo": "Parte fictícia", "numero_cnj": "0000000-00.2026.8.26.0000", "titulo_polo_ativo": "Parte fictícia", "titulo_polo_passivo": "Parte fictícia", "ano_inicio": 2015, "data_inicio": "2015-11-21", "data_ultima_movimentacao": "2018-07-25", "quantidade_movimentacoes": 103, "fontes_tribunais_estao_arquivadas": false, "data_ultima_verificacao": "2023-02-09T14:30:11+00:00", "tempo_desde_ultima_verificacao": "há 1 mês", "valor_causa": { "valor": "50000.0000", "moeda": "R$", "valor_formatado": "R$ 50.000,00" }, "valorCausa": { "valor": "50000.0000", "moeda": "R$", "valor_formatado": "R$ 50.000,00" }, "processos_relacionados": [ { "numero": "0000000-00.2026.8.26.0000" }, { "numero": "0000000-00.2026.8.26.0000" } ], "fontes": [ { "id": 3, "processo_fonte_id": 14626, "descricao": "TJSP - 1º grau", "nome": "Tribunal de Justiça de São Paulo", "sigla": "TJSP", "tipo": "TRIBUNAL", "grau": 1, "grau_formatado": "Primeiro Grau", "sistema": "ESAJ", "capa": { "classe": "PROCEDIMENTO COMUM CIVEL", "assunto": "RESPONSABILIDADE CIVIL", "area": "CIVEL", "orgao_julgador": "01 VARA JUIZADO ESPECIAL CIVEL DE CAMPINAS", "situacao": "Baixado", "valor_causa": { "valor": "50000.0000", "moeda": "R$", "valor_formatado": "R$ 50.000,00" }, "data_distribuicao": "2015-11-27" }, "audiencias": [ { "tipo": "Instrução", "data": "2024-10-17", "quantidade_pessoas": 2, "situacao": "Cancelada" } ], "tribunal": { "id": 102, "nome": "Tribunal de Justiça de São Paulo", "sigla": "TJSP", "categoria": null }, "envolvidos": [ { "nome": "Parte fictícia", "tipo": "REQUERENTE", "tipo_normalizado": "Requerente", "polo": "ATIVO", "advogados": [ { "nome": "Parte fictícia" } ] }, { "nome": "Parte fictícia", "tipo": "REQUERIDO", "tipo_normalizado": "Requerido", "polo": "PASSIVO", "advogados": [ { "nome": "Parte fictícia" } ] } ] } ], "raw": { "numero_cnj": "0000000-00.2026.8.26.0000", "titulo_polo_ativo": "Parte fictícia", "titulo_polo_passivo": "Parte fictícia", "ano_inicio": 2015, "data_inicio": "2015-11-21", "estado_origem": { "nome": "São Paulo", "sigla": "SP" }, "unidade_origem": { "nome": "01 VARA JUIZADO ESPECIAL CIVEL DE CAMPINAS", "endereco": "Endereço demonstrativo", "classificacao": "JE - Juizado Especial", "cidade": "São Paulo", "estado": { "nome": "São Paulo", "sigla": "SP" }, "tribunal_sigla": "TJSP" }, "data_ultima_movimentacao": "2018-07-25", "quantidade_movimentacoes": 103, "fontes_tribunais_estao_arquivadas": false, "data_ultima_verificacao": "2023-02-09T14:30:11+00:00", "tempo_desde_ultima_verificacao": "há 1 mês", "processos_relacionados": [ { "numero": "0000000-00.2026.8.26.0000" }, { "numero": "0000000-00.2026.8.26.0000" } ], "fontes": [ { "id": 3, "processo_fonte_id": 14626, "descricao": "TJSP - 1º grau", "nome": "Tribunal de Justiça de São Paulo", "sigla": "TJSP", "tipo": "TRIBUNAL", "data_inicio": "2015-11-27", "data_ultima_movimentacao": "2018-07-25", "segredo_justica": null, "arquivado": null, "status_predito": "INATIVO", "grau": 1, "grau_formatado": "Primeiro Grau", "fisico": false, "sistema": "ESAJ", "capa": { "classe": "PROCEDIMENTO COMUM CIVEL", "assunto": "RESPONSABILIDADE CIVIL", "assuntos_normalizados": [ { "id": 3642, "nome": "Responsabilidade Civil", "nome_com_pai": "DIREITO CIVIL > Responsabilidade Civil", "path_completo": "DIREITO CIVIL | Responsabilidade Civil", "bloqueado": false } ], "assunto_principal_normalizado": { "id": 3642, "nome": "Responsabilidade Civil", "nome_com_pai": "DIREITO CIVIL > Responsabilidade Civil", "path_completo": "DIREITO CIVIL | Responsabilidade Civil", "bloqueado": false }, "area": "CIVEL", "orgao_julgador": "01 VARA JUIZADO ESPECIAL CIVEL DE CAMPINAS", "orgao_julgador_normalizado": { "nome": "01 VARA JUIZADO ESPECIAL CIVEL DE CAMPINAS", "endereco": "Endereço demonstrativo", "classificacao": "JE - Juizado Especial", "cidade": "São Paulo", "estado": { "nome": "São Paulo", "sigla": "SP" }, "tribunal_sigla": "TJSP" }, "situacao": "Baixado", "valor_causa": { "valor": "50000.0000", "moeda": "R$", "valor_formatado": "R$ 50.000,00" }, "data_distribuicao": "2015-11-27", "data_arquivamento": null, "informacoes_complementares": null }, "audiencias": [ { "tipo": "Instrução", "data": "2024-10-17", "quantidade_pessoas": 2, "situacao": "Cancelada" } ], "url": "https://esaj.tjsp.jus.br/cpopg/search.do?conversationId=&dadosConsulta.localPesquisa.cdLocal=-1&cbPesquisa=NUMPROC&dadosConsulta.tipoNuProcesso=UNIFICADO&numeroDigitoAnoUnificado=1024000-20.2015&foroNumeroUnificado=0000&dadosConsulta.valorConsultaNuUnificado=0000000-00.2026.8.26.0000&dadosConsulta.valorConsulta=", "tribunal": { "id": 102, "nome": "Tribunal de Justiça de São Paulo", "sigla": "TJSP", "categoria": null }, "quantidade_movimentacoes": 68, "quantidade_envolvidos": 7, "data_ultima_verificacao": "2023-02-09T14:30:11+00:00", "envolvidos": [ { "nome": "Parte fictícia", "quantidade_processos": 1, "tipo_pessoa": "FISICA", "advogados": [ { "nome": "Parte fictícia", "quantidade_processos": 21, "tipo_pessoa": "FISICA", "prefixo": null, "sufixo": null, "tipo": "ADVOGADO", "tipo_normalizado": "Advogado", "polo": "ADVOGADO", "cpf": "00000000000", "nome_normalizado": "Parte fictícia", "oabs": [ { "uf": "SP", "tipo": "ADVOGADO", "numero": 123123 } ] }, { "nome": "Parte fictícia", "quantidade_processos": 10, "tipo_pessoa": "FISICA", "prefixo": null, "sufixo": null, "tipo": "ADVOGADO", "tipo_normalizado": "Advogado", "polo": "ADVOGADO", "cpf": "00000000000", "nome_normalizado": "Parte fictícia", "oabs": [ { "uf": "SP", "tipo": "ADVOGADO", "numero": 123123 } ] } ], "prefixo": null, "sufixo": null, "tipo": "REQUERENTE", "tipo_normalizado": "Requerente", "polo": "ATIVO", "cpf": "00000000000", "nome_normalizado": "Parte fictícia" }, { "nome": "Parte fictícia", "quantidade_processos": 97, "tipo_pessoa": "FISICA", "advogados": [ { "nome": "Parte fictícia", "quantidade_processos": 37, "tipo_pessoa": "FISICA", "prefixo": null, "sufixo": null, "tipo": "ADVOGADO", "tipo_normalizado": "Advogado", "polo": "ADVOGADO", "cpf": "00000000000", "nome_normalizado": "Parte fictícia", "oabs": [ { "uf": "SP", "tipo": "ADVOGADO", "numero": 123123 } ] }, { "nome": "Parte fictícia", "quantidade_processos": 33, "tipo_pessoa": "FISICA", "prefixo": null, "sufixo": null, "tipo": "ADVOGADO", "tipo_normalizado": "Advogado", "polo": "ADVOGADO", "cpf": "00000000000", "nome_normalizado": "Parte fictícia", "oabs": [ { "uf": "SP", "tipo": "ADVOGADO", "numero": 123123 } ] } ], "prefixo": null, "sufixo": null, "tipo": "REQUERIDO", "tipo_normalizado": "Requerido", "polo": "PASSIVO", "cpf": "00000000000", "nome_normalizado": "Parte fictícia" }, { "nome": "Parte fictícia", "quantidade_processos": 126, "tipo_pessoa": "FISICA", "prefixo": null, "sufixo": null, "tipo": "JUIZ", "tipo_normalizado": "Juiz", "polo": "NENHUM" } ] }, { "id": 6, "processo_fonte_id": 14566, "descricao": "TJSP - 2º grau", "nome": "Tribunal de Justiça de São Paulo", "sigla": "TJSP", "tipo": "TRIBUNAL", "data_inicio": "2017-06-01", "data_ultima_movimentacao": "2018-04-26", "segredo_justica": null, "arquivado": null, "status_predito": "INATIVO", "grau": 2, "grau_formatado": "Segundo Grau", "fisico": false, "sistema": "ESAJ", "capa": { "classe": "APELACAO CIVEL", "assunto": "DIREITO CIVIL-RESPONSABILIDADE CIVIL-INDENIZACAO POR DANO MORAL", "assuntos_normalizados": [ { "id": 3644, "nome": "Indenização por Dano Moral", "nome_com_pai": "Responsabilidade Civil > Indenização por Dano Moral", "path_completo": "DIREITO CIVIL | Responsabilidade Civil | Indenização por Dano Moral", "bloqueado": false } ], "assunto_principal_normalizado": { "id": 3644, "nome": "Indenização por Dano Moral", "nome_com_pai": "Responsabilidade Civil > Indenização por Dano Moral", "path_completo": "DIREITO CIVIL | Responsabilidade Civil | Indenização por Dano Moral", "bloqueado": false }, "area": "CIVEL", "orgao_julgador": "01 VARA JUIZADO ESPECIAL CIVEL DE CAMPINAS", "orgao_julgador_normalizado": { "nome": "01 VARA JUIZADO ESPECIAL CIVEL DE CAMPINAS", "endereco": "Endereço demonstrativo", "classificacao": "JE - Juizado Especial", "cidade": "São Paulo", "estado": { "nome": "São Paulo", "sigla": "SP" }, "tribunal_sigla": "TJSP" }, "situacao": "Baixado", "valor_causa": { "valor": "50000.0000", "moeda": "R$", "valor_formatado": "R$ 50.000,00" }, "data_distribuicao": "2017-06-01", "data_arquivamento": null, "informacoes_complementares": null }, "audiencias": [], "url": "https://esaj.tjsp.jus.br/cposg/search.do?conversationId=&paginaConsulta=0&cbPesquisa=NUMPROC&numeroDigitoAnoUnificado=1024000-20.2015&foroNumeroUnificado=0000&dePesquisaNuUnificado=0000000-00.2026.8.26.0000&dePesquisaNuUnificado=UNIFICADO&dePesquisa=&tipoNuProcesso=UNIFICADO&uuidCaptcha=sajcaptcha_e6c6a295c5404a6887d81483bdd96048&g-recaptcha-response=", "tribunal": { "id": 102, "nome": "Tribunal de Justiça de São Paulo", "sigla": "TJSP", "categoria": null }, "quantidade_movimentacoes": 35, "quantidade_envolvidos": 7, "data_ultima_verificacao": "2023-02-09T14:30:00+00:00", "envolvidos": [ { "nome": "Parte fictícia", "quantidade_processos": 1, "tipo_pessoa": "FISICA", "advogados": [ { "nome": "Parte fictícia", "quantidade_processos": 21, "tipo_pessoa": "FISICA", "prefixo": null, "sufixo": null, "tipo": "ADVOGADO", "tipo_normalizado": "Advogado", "polo": "ADVOGADO", "cpf": "00000000000", "nome_normalizado": "Parte fictícia", "oabs": [ { "uf": "SP", "tipo": "ADVOGADO", "numero": 123123 } ] }, { "nome": "Parte fictícia", "quantidade_processos": 10, "tipo_pessoa": "FISICA", "prefixo": null, "sufixo": null, "tipo": "ADVOGADO", "tipo_normalizado": "Advogado", "polo": "ADVOGADO", "cpf": "00000000000", "nome_normalizado": "Parte fictícia", "oabs": [ { "uf": "SP", "tipo": "ADVOGADO", "numero": 123123 } ] } ], "prefixo": null, "sufixo": null, "tipo": "APELANTE", "tipo_normalizado": "Apelante", "polo": "ATIVO", "cpf": "00000000000", "nome_normalizado": "Parte fictícia" }, { "nome": "Parte fictícia", "quantidade_processos": 97, "tipo_pessoa": "FISICA", "advogados": [ { "nome": "Parte fictícia", "quantidade_processos": 37, "tipo_pessoa": "FISICA", "prefixo": null, "sufixo": null, "tipo": "ADVOGADO", "tipo_normalizado": "Advogado", "polo": "ADVOGADO", "cpf": "00000000000", "nome_normalizado": "Parte fictícia", "oabs": [ { "uf": "SP", "tipo": "ADVOGADO", "numero": 123123 } ] }, { "nome": "Parte fictícia", "quantidade_processos": 33, "tipo_pessoa": "FISICA", "prefixo": null, "sufixo": null, "tipo": "ADVOGADO", "tipo_normalizado": "Advogado", "polo": "ADVOGADO", "cpf": "00000000000", "nome_normalizado": "Parte fictícia", "oabs": [ { "uf": "SP", "tipo": "ADVOGADO", "numero": 123123 } ] } ], "prefixo": null, "sufixo": null, "tipo": "APELADO", "tipo_normalizado": "Apelado", "polo": "PASSIVO", "cpf": "00000000000", "nome_normalizado": "Parte fictícia" }, { "nome": "Parte fictícia", "quantidade_processos": 86, "tipo_pessoa": "FISICA", "prefixo": null, "sufixo": null, "tipo": "RELATOR", "tipo_normalizado": "Juiz", "polo": "NENHUM", "cpf": "00000000000", "nome_normalizado": "Parte fictícia" } ] } ] } }, "meta": { "creditsRemaining": 199.88, "requestId": "mo3brf2a-lx1mec", "searchLogId": "uuid", "servedAt": "16:50:01" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/processos/cnj/{cnj}/pdf": { "get": { "tags": [ "Processos" ], "summary": "Baixar espelho de capa em PDF", "description": "Gera e faz o download direto do espelho de capa do processo em formato PDF A4 executivo (com layout Primer DS e Octicons), contendo dados do tribunal, órgão julgador, partes ativas/passivas, valor da causa, linha do tempo e tabela de envolvidos com OABs. A operação não cobra créditos adicionais caso a capa já tenha sido consultada.\n\n**Valor para a operação:** leva informações processuais ao seu sistema e reduz coleta, transcrição e conferência manual.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "baixarCapaProcessoPdf", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "cnj", "in": "path", "required": true, "description": "Alias de numero_cnj.", "schema": { "type": "string" }, "example": "0000000-00.2026.8.26.0000" }, { "name": "format", "in": "query", "required": false, "description": "Formato solicitado para a publicação, quando disponível. A API também pode redirecionar para o PDF.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/processos/cnj/{cnj}/movimentacoes": { "get": { "tags": [ "Processos" ], "summary": "Listar movimentações de processo", "description": "Lista movimentações do processo por CNJ. É uma operação independente da capa e deve ser chamada somente quando a tela realmente precisar do histórico. Pode usar page/limit ou cursor/li; siga data.links.next.href quando disponível para evitar páginas duplicadas.\n\n**Valor para a operação:** automatiza a atualização do histórico processual e permite acionar regras, tarefas ou alertas a partir das movimentações encontradas.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarMovimentacoesDoProcesso", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "cnj", "in": "path", "required": true, "description": "Alias de numero_cnj.", "schema": { "type": "string" }, "example": "0000000-00.2026.8.26.0000" }, { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1 }, "example": 20 }, { "name": "cursor", "in": "query", "required": false, "description": "Cursor retornado nos links de próxima página. Prefira seguir data.links.next.href quando esse link existir.", "schema": { "type": "string" } }, { "name": "li", "in": "query", "required": false, "description": "Marcador complementar de paginação retornado pelo provedor; envie junto com cursor quando a próxima URL o incluir.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarMovimentacoesDoProcessoResponse" }, "example": { "data": { "numeroCnj": "0000000-00.2026.8.26.0000", "movimentacoes": [ { "data": "2026-04-17", "conteudo": "Conteúdo demonstrativo fictício.", "classificacao_predita": { "nome": "Conclusão", "descricao": "Indica que os autos estão aguardando posicionamento.", "hierarquia": "Movimentações do Serventuário > Conclusão" }, "fonte": { "sigla": "TJSP", "grau": "1º Grau" }, "pagina": null, "tipo_publicacao": null, "link_publicacao_tribunal": null }, { "data": "2026-04-18", "conteudo": "Conteúdo demonstrativo fictício.", "classificacao_predita": null, "fonte": { "sigla": "DJSP", "grau": "1º Grau" }, "pagina": 14862, "tipo_publicacao": "APELAÇÃO CÍVEL", "link_publicacao_tribunal": "https://dje.tjsp.jus.br/cdje/consultaSimples.do?cdVolume=1&nuDiario=4000&cdCaderno=10&nuSeqpagina=14862" } ], "total": 2, "pagination": { "per_page": 20 }, "links": { "next": { "href": "https://api.buscaprocessos.app.br/v1/processos/cnj//movimentacoes?cursor=CURSOR&li=LI", "cursor": "CURSOR", "li": "LI" } }, "query": { "cursor": null, "li": null } }, "meta": { "creditsRemaining": 199.76, "requestId": "mo3bs1tp-e6an3v", "searchLogId": "uuid", "servedAt": "16:50:23" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/processos/numero/{numero}/diarios-oficiais": { "get": { "tags": [ "Processos" ], "summary": "Consultar diários oficiais por número", "description": "Localiza publicações em diários oficiais usando o número do processo, com opção de correspondência exata. Use para complementar a capa quando for necessário rastrear publicações; match_exato controla a precisão da busca e a paginação limita o volume retornado.\n\n**Valor para a operação:** leva informações processuais ao seu sistema e reduz coleta, transcrição e conferência manual.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "consultarDiariosPorNumeroDoProcesso", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "numero", "in": "path", "required": true, "description": "Número do processo usado para localizar publicações em diários oficiais.", "schema": { "type": "string" } }, { "name": "match_exato", "in": "query", "required": false, "description": "Indica se a busca em diários oficiais deve exigir correspondência exata do número.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1 }, "example": 20 } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarDiariosPorNumeroDoProcessoResponse" }, "example": { "data": { "numero": "0000000-00.2026.8.26.0000", "matchExato": true, "processos": [ { "id": 1, "numeroAntigo": null, "numeroNovo": "0000000-00.2026.8.26.0000", "isCnj": true, "diario": { "sigla": "TJSP", "nome": "Tribunal de Justiça de São Paulo", "estado": "SP" }, "dataMovimentacoes": "30/10/2018 a 08/08/2022", "quantidadeMovimentacoes": 20, "ultimasMovimentacoes": [ { "id": 1, "data": "2022-08-08T00:00:00.000000Z", "conteudoResumo": "Conteúdo demonstrativo fictício.", "quantidadeEnvolvidos": 2, "envolvidos": [ { "id": 10, "nome": "Parte fictícia", "tipo": "Advogado", "papel": "ADVOGADO", "oab": "123456/SP" } ] } ] } ], "total": 1 }, "meta": { "creditsRemaining": 199.9, "requestId": "mo4abc12-z81wqp", "searchLogId": "uuid", "servedAt": "09:14:20" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/processos/cnj/{cnj}/solicitar-atualizacao": { "post": { "tags": [ "Atualizações" ], "summary": "Solicitar atualização de processo", "description": "Solicita atualização assíncrona própria dos dados processuais e, quando suportado pelo tribunal, de documentos públicos. Para incluir documentos públicos, envie documentos_publicos=true.\n\n**Valor para a operação:** atualiza dados e documentos públicos sob demanda pela infraestrutura própria.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente. O fluxo pode retornar uma solicitação pendente; consulte a URL/status retornado quando fornecido.", "operationId": "solicitarAtualizacaoDoProcesso", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "cnj", "in": "path", "required": true, "description": "Alias de numero_cnj.", "schema": { "type": "string" }, "example": "0000000-00.2026.8.26.0000" } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/solicitarAtualizacaoDoProcessoResponse" }, "example": { "data": { "numeroCnj": "0000000-00.2026.8.26.0000", "state": "pending", "status": "PENDENTE", "providerRequestId": 900, "criadoEm": "2026-04-22T12:29:51+00:00", "concluidoEm": null, "opcoes": { "documentosPublicos": true }, "pollAfterMs": 15000, "message": "A solicitação de atualização própria do processo foi registrada. Consulte capa, movimentações ou documentos públicos após o processamento." }, "meta": { "creditsRemaining": 199.63, "requestId": "mo3bss7a-xdf2r9", "searchLogId": "uuid", "servedAt": "16:50:37" } } } } }, "202": { "description": "Solicitação aceita para processamento assíncrono.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/solicitarAtualizacaoDoProcessoResponse" }, "example": { "data": { "numeroCnj": "0000000-00.2026.8.26.0000", "state": "pending", "status": "PENDENTE", "providerRequestId": 900, "criadoEm": "2026-04-22T12:29:51+00:00", "concluidoEm": null, "opcoes": { "documentosPublicos": true }, "pollAfterMs": 15000, "message": "A solicitação de atualização própria do processo foi registrada. Consulte capa, movimentações ou documentos públicos após o processamento." }, "meta": { "creditsRemaining": 199.63, "requestId": "mo3bss7a-xdf2r9", "searchLogId": "uuid", "servedAt": "16:50:37" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessUpdateRequest" }, "examples": { "exemplo": { "summary": "Exemplo fictício", "value": { "documentos_publicos": true } } } } } } } }, "/v1/processos/cnj/{cnj}/status-atualizacao": { "get": { "tags": [ "Atualizações" ], "summary": "Consultar status da atualização de processo", "description": "Consulta o status de uma atualização solicitada para o CNJ. Use polling finito e respeite pollAfterMs quando retornado; somente depois de concluída faça nova leitura de capa, movimentações ou documentos públicos.\n\n**Valor para a operação:** mantém dados e conteúdos sob demanda dentro de um fluxo assíncrono controlado, sem bloquear a experiência do usuário.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente. O fluxo pode retornar uma solicitação pendente; consulte a URL/status retornado quando fornecido.", "operationId": "consultarStatusDaAtualizacaoDoProcesso", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "cnj", "in": "path", "required": true, "description": "Alias de numero_cnj.", "schema": { "type": "string" }, "example": "0000000-00.2026.8.26.0000" } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarStatusDaAtualizacaoDoProcessoResponse" }, "example": { "data": { "numeroCnj": "0000000-00.2026.8.26.0000", "dataUltimaVerificacao": "2026-04-23T12:31:56+00:00", "tempoDesdeUltimaVerificacao": "há 2 minutos", "ultimaVerificacao": { "id": 900, "status": "SUCESSO", "criadoEm": "2026-04-23T12:29:51+00:00", "concluidoEm": "2026-04-23T12:31:55+00:00" } }, "meta": { "creditsRemaining": 199.51, "requestId": "mo5aa3dm-h2p4vr", "searchLogId": "uuid", "servedAt": "10:02:33" } } } } }, "202": { "description": "Solicitação aceita para processamento assíncrono.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarStatusDaAtualizacaoDoProcessoResponse" }, "example": { "data": { "numeroCnj": "0000000-00.2026.8.26.0000", "dataUltimaVerificacao": "2026-04-23T12:31:56+00:00", "tempoDesdeUltimaVerificacao": "há 2 minutos", "ultimaVerificacao": { "id": 900, "status": "SUCESSO", "criadoEm": "2026-04-23T12:29:51+00:00", "concluidoEm": "2026-04-23T12:31:55+00:00" } }, "meta": { "creditsRemaining": 199.51, "requestId": "mo5aa3dm-h2p4vr", "searchLogId": "uuid", "servedAt": "10:02:33" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/processos/cnj/{cnj}/documentos-publicos": { "get": { "tags": [ "Documentos" ], "summary": "Listar documentos públicos do processo", "description": "Lista documentos públicos disponíveis para o processo após uma atualização concluída. Use page/limit e baixe um documento específico somente por ação explícita do usuário. O campo downloadUrl é um link assinado temporário que pode ser aberto diretamente no navegador, sem reenviar a API key; preserve o URL completo, inclusive a query string.\n\n**Valor para a operação:** leva conteúdo processual ao seu produto somente quando necessário, apoiando análise, dossiês e rotinas documentais.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarDocumentosPublicos", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "cnj", "in": "path", "required": true, "description": "Alias de numero_cnj.", "schema": { "type": "string" }, "example": "0000000-00.2026.8.26.0000" }, { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "50 documentos por página por padrão; envie 100 para ampliar. Outros valores são normalizados para 50.", "schema": { "type": "integer", "enum": [ 50, 100 ], "default": 50 }, "example": 50 } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarDocumentosPublicosResponse" }, "example": { "data": { "numeroCnj": "0000000-00.2026.8.26.0000", "documentos": [ { "id": "11404", "titulo": "Despacho", "descricao": "Despacho | Despacho", "data": "2024-06-17 18:02:36", "tipo": "PUBLICO", "extensaoArquivo": "pdf", "quantidadePaginas": 2, "downloadUrl": "https://api.buscaprocessos.app.br/v1/processos/cnj/0000000-00.2026.8.26.0000/documentos/11404/download?source=publicos" } ], "pagination": { "currentPage": 1, "perPage": 50, "total": 1, "totalPages": 1, "hasNextPage": false, "hasPreviousPage": false }, "total": 1 }, "meta": { "creditsRemaining": 199.35, "requestId": "mo3bt8ca-6j1p3f", "searchLogId": "uuid", "servedAt": "16:51:20" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/processos/cnj/{cnj}/documentos/{documentId}/download": { "get": { "tags": [ "Documentos" ], "summary": "Baixar documento público", "description": "Baixa pela infraestrutura própria o conteúdo binário de um documento público identificado pelo CNJ e documentId. A operação aceita a API key normalmente ou o download_token temporário presente no downloadUrl retornado pela listagem. O link assinado pode ser aberto diretamente no navegador, é vinculado ao documento exato e expira em poucos minutos. Trate a resposta como arquivo e preserve Content-Type e Content-Disposition.\n\n**Valor para a operação:** leva conteúdo processual ao seu produto somente quando necessário, apoiando análise, dossiês e rotinas documentais.\n\n**Autenticação e resposta:** envie a chave em x-api-key/Authorization: Bearer ou abra o downloadUrl assinado retornado pela listagem. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "baixarDocumentoProcessual", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] }, { "downloadTokenAuth": [] } ], "parameters": [ { "name": "cnj", "in": "path", "required": true, "description": "Alias de numero_cnj.", "schema": { "type": "string" }, "example": "0000000-00.2026.8.26.0000" }, { "name": "documentId", "in": "path", "required": true, "description": "Identificador do documento retornado em documentos públicos.", "schema": { "type": "string" } }, { "name": "download_token", "in": "query", "required": false, "description": "Token temporário já incluído no downloadUrl retornado pela listagem de documentos públicos. Não precisa ser montado pelo cliente.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/baixarDocumentoProcessualResponse" }, "example": { "headers": { "Content-Type": "application/pdf", "Content-Disposition": "attachment; filename=\"processo-00000000000000000000-documento-11404-despacho.pdf\"", "X-BuscaProcessos-Credits-Remaining": "195.6", "X-BuscaProcessos-Request-Id": "mo3bu2u6-c32h2k" }, "body": "%PDF-1.4 ..." } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/processos/cnj/{cnj}/resumo-ia": { "get": { "tags": [ "Inteligência Artificial" ], "summary": "Obter resumo do processo por IA", "description": "Retorna o resumo inteligente disponível para o processo. Se não houver resumo ou ele estiver desatualizado, o endpoint pode indicar que uma solicitação assíncrona é necessária; use request_id quando precisar consultar uma execução específica. O resumo é apoio informativo e não substitui decisão judicial ou parecer profissional.\n\n**Valor para a operação:** reduz o tempo de leitura inicial e ajuda equipes a identificar rapidamente contexto e prioridade antes da análise detalhada.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "obterResumoIaDoProcesso", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "cnj", "in": "path", "required": true, "description": "Alias de numero_cnj.", "schema": { "type": "string" }, "example": "0000000-00.2026.8.26.0000" }, { "name": "request_id", "in": "query", "required": false, "description": "Identificador de uma solicitação de resumo assíncrono específica.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/obterResumoIaDoProcessoResponse" }, "example": { "data": { "numeroCnj": "0000000-00.2026.8.26.0000", "classificacao": { "tipo_processo": "CIVEL", "fase_processual": "CONHECIMENTO", "grau": "PRIMEIRO_GRAU", "dias_sem_movimentacao": 42 }, "sinais": { "prazo_aberto": { "valor": true, "motivo": "INTIMACAO_RECENTE_SEM_MANIFESTACAO" }, "decisao_pendente": { "valor": false, "motivo": "DECISAO_APOS_A_CONCLUSAO" }, "urgencia": { "valor": true, "motivo": "MEDIDA_DE_URGENCIA_REGISTRADA" } }, "conteudo": "Conteúdo demonstrativo fictício.", "atualizadoEm": "2026-04-17T19:30:00+00:00", "cached": false, "state": "success" }, "meta": { "creditsRemaining": 199.88, "requestId": "mo3bsh8u-wi903h", "searchLogId": null, "servedAt": "16:50:42" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/processos/cnj/{cnj}/resumo-ia/solicitar-atualizacao": { "post": { "tags": [ "Inteligência Artificial" ], "summary": "Solicitar atualização de resumo por IA", "description": "Solicita geração ou atualização do resumo por IA para um CNJ. A resposta normal é 202 com identificador da solicitação, status e pollAfterMs; consulte o resumo novamente após a conclusão. Evite chamadas repetidas porque esta operação consome créditos.\n\n**Valor para a operação:** acelera a leitura inicial e a priorização de casos, mantendo o resumo como apoio à análise profissional.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente. O fluxo pode retornar uma solicitação pendente; consulte a URL/status retornado quando fornecido.", "operationId": "solicitarAtualizacaoDoResumoIa", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "cnj", "in": "path", "required": true, "description": "Alias de numero_cnj.", "schema": { "type": "string" }, "example": "0000000-00.2026.8.26.0000" } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/solicitarAtualizacaoDoResumoIaResponse" }, "example": { "data": { "numeroCnj": "00000000000000000000", "state": "pending", "status": "PENDENTE", "providerRequestId": 123456, "pollAfterMs": 3200, "message": "O resumo inteligente está sendo preparado. Consulte novamente em instantes." }, "meta": { "creditsRemaining": 199.88, "requestId": "mo3bt0e1-xi9kd4", "searchLogId": null, "servedAt": "16:51:01" } } } } }, "202": { "description": "Solicitação aceita para processamento assíncrono.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/solicitarAtualizacaoDoResumoIaResponse" }, "example": { "data": { "numeroCnj": "00000000000000000000", "state": "pending", "status": "PENDENTE", "providerRequestId": 123456, "pollAfterMs": 3200, "message": "O resumo inteligente está sendo preparado. Consulte novamente em instantes." }, "meta": { "creditsRemaining": 199.88, "requestId": "mo3bt0e1-xi9kd4", "searchLogId": null, "servedAt": "16:51:01" } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } } } }, "/v1/processos/cnj/{cnj}/resumo-ia/status": { "get": { "tags": [ "Inteligência Artificial" ], "summary": "Consultar status de resumo por IA", "description": "Consulta o andamento de uma solicitação de resumo por IA. Informe request_id com o providerRequestId retornado na criação quando quiser acompanhar uma execução específica; faça polling finito e pare em FINALIZADO ou ERRO. Esta consulta não consome créditos.\n\n**Valor para a operação:** permite acompanhar a geração assíncrona sem recriar uma solicitação paga e sem consumir créditos durante o polling.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "consultarStatusDoResumoIa", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "cnj", "in": "path", "required": true, "description": "Alias de numero_cnj.", "schema": { "type": "string" }, "example": "0000000-00.2026.8.26.0000" }, { "name": "request_id", "in": "query", "required": false, "description": "Identificador de uma solicitação de resumo assíncrono específica.", "schema": { "type": "integer", "minimum": 1 }, "example": 2001596 } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/consultarStatusDoResumoIaResponse" }, "example": { "data": { "id": 123456, "providerRequestId": 123456, "numeroCnj": "0000000-00.2026.8.26.0000", "status": "FINALIZADO", "state": "success", "criadoEm": "2026-07-15T14:00:00+00:00", "concluidoEm": "2026-07-15T14:00:08+00:00" }, "meta": { "creditsRemaining": 199.88, "requestId": "summary-status-001", "searchLogId": null, "servedAt": "11:00:08" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "502": { "description": "Resumo indisponível ou geração não concluída.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/v1/monitoramentos/processos": { "get": { "tags": [ "Monitoramento" ], "summary": "Listar monitoramentos de processos", "description": "Lista monitoramentos contínuos de processos da conta, paginados por page/limit. O retorno informa CNJ, frequência, status, valor mensal e próxima cobrança. Use para reconciliar o estado local com a cobrança recorrente antes de criar ou remover monitoramentos.\n\n**Valor para a operação:** transforma verificações periódicas em acompanhamento contínuo, com resultados prontos para alertas, tarefas e webhooks.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarMonitoramentosDeProcessos", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1 }, "example": 20 } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarMonitoramentosDeProcessosResponse" }, "example": { "data": { "items": [ { "id": "uuid-interno", "numeroCnj": "0000000-00.2026.8.26.0000", "numero_cnj": "0000000-00.2026.8.26.0000", "tribunal": "TJSP", "frequencia": "DIARIA", "frequency": "DIARIA", "valorMensal": 2, "valor_mensal": 2, "moeda": "BRL", "cobranca": { "recorrencia": "MENSAL", "valorMensal": 2, "valor_mensal": 2, "proximoDebitoEm": "2026-06-27T14:00:00.000Z", "proximo_debito_em": "2026-06-27T14:00:00.000Z", "ultimoDebitoEm": null, "ultimo_debito_em": null, "status": "ACTIVE", "observacao": "Este valor é debitado mensalmente enquanto o monitoramento estiver ativo." }, "status": "ENCONTRADO", "customerEmail": null, "ativo": true, "criadoEm": "2026-05-27T14:00:00.000Z", "atualizadoEm": "2026-05-27T14:05:00.000Z", "desativadoEm": null } ], "pagination": { "currentPage": 1, "perPage": 20, "hasNextPage": false, "totalItems": 1 } }, "meta": { "creditsRemaining": 197.9, "requestId": "mp4process-monitor-list", "searchLogId": null, "servedAt": "14:05:00" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } }, "post": { "tags": [ "Monitoramento" ], "summary": "Criar monitoramento de processo", "description": "Cria monitoramento contínuo por CNJ. frequencia aceita DIARIA, SEMANAL ou MENSAL; a cobrança recorrente permanece ativa enquanto o monitoramento estiver ativo e os valores retornados pela API são a fonte do contrato vigente. O endpoint rejeita CNJs inválidos, duplicidade ativa e falta de saldo, retornando o recurso criado em 201.\n\n**Valor para a operação:** reduz conferências manuais de uma carteira e permite reagir a mudanças nos processos que realmente precisam de acompanhamento.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "criarMonitoramentoDeProcesso", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/criarMonitoramentoDeProcessoResponse" }, "example": { "data": { "id": "uuid-interno", "numeroCnj": "0000000-00.2026.8.26.0000", "numero_cnj": "0000000-00.2026.8.26.0000", "tribunal": "TJSP", "frequencia": "DIARIA", "frequency": "DIARIA", "valorMensal": 2, "valor_mensal": 2, "moeda": "BRL", "cobranca": { "recorrencia": "MENSAL", "valorMensal": 2, "valor_mensal": 2, "proximoDebitoEm": "2026-06-27T14:00:00.000Z", "proximo_debito_em": "2026-06-27T14:00:00.000Z", "ultimoDebitoEm": null, "ultimo_debito_em": null, "status": "ACTIVE", "observacao": "Este valor é debitado mensalmente enquanto o monitoramento estiver ativo." }, "status": "PENDENTE", "customerEmail": null, "ativo": true, "criadoEm": "2026-05-27T14:00:00.000Z", "atualizadoEm": "2026-05-27T14:00:00.000Z", "desativadoEm": null }, "meta": { "creditsRemaining": 197.9, "requestId": "mp4process-monitor-create", "searchLogId": "uuid", "servedAt": "14:00:00" } } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/criarMonitoramentoDeProcessoResponse" }, "example": { "data": { "id": "uuid-interno", "numeroCnj": "0000000-00.2026.8.26.0000", "numero_cnj": "0000000-00.2026.8.26.0000", "tribunal": "TJSP", "frequencia": "DIARIA", "frequency": "DIARIA", "valorMensal": 2, "valor_mensal": 2, "moeda": "BRL", "cobranca": { "recorrencia": "MENSAL", "valorMensal": 2, "valor_mensal": 2, "proximoDebitoEm": "2026-06-27T14:00:00.000Z", "proximo_debito_em": "2026-06-27T14:00:00.000Z", "ultimoDebitoEm": null, "ultimo_debito_em": null, "status": "ACTIVE", "observacao": "Este valor é debitado mensalmente enquanto o monitoramento estiver ativo." }, "status": "PENDENTE", "customerEmail": null, "ativo": true, "criadoEm": "2026-05-27T14:00:00.000Z", "atualizadoEm": "2026-05-27T14:00:00.000Z", "desativadoEm": null }, "meta": { "creditsRemaining": 197.9, "requestId": "mp4process-monitor-create", "searchLogId": "uuid", "servedAt": "14:00:00" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessMonitoringRequest" }, "examples": { "exemplo": { "summary": "Exemplo fictício", "value": { "numero_cnj": "0000000-00.2026.8.26.0000", "frequencia": "DIARIA", "customer_email": "cliente@example.com" } } } } } } } }, "/v1/monitoramentos/processos/{id}": { "get": { "tags": [ "Monitoramento" ], "summary": "Consultar monitoramento de processo", "description": "Consulta um monitoramento contínuo específico da conta autenticada. Use para verificar status, frequência, cobrança e datas de ativação/desativação sem disparar nova busca judicial.\n\n**Valor para a operação:** transforma verificações periódicas em acompanhamento contínuo, com resultados prontos para alertas, tarefas e webhooks.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "obterMonitoramentoDeProcesso", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do recurso retornado pela API. Não confundir com o número CNJ.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/obterMonitoramentoDeProcessoResponse" }, "example": { "data": { "id": "uuid-interno", "numeroCnj": "0000000-00.2026.8.26.0000", "numero_cnj": "0000000-00.2026.8.26.0000", "tribunal": "TJSP", "frequencia": "DIARIA", "frequency": "DIARIA", "valorMensal": 2, "valor_mensal": 2, "moeda": "BRL", "cobranca": { "recorrencia": "MENSAL", "valorMensal": 2, "valor_mensal": 2, "proximoDebitoEm": "2026-06-27T14:00:00.000Z", "proximo_debito_em": "2026-06-27T14:00:00.000Z", "ultimoDebitoEm": null, "ultimo_debito_em": null, "status": "ACTIVE", "observacao": "Este valor é debitado mensalmente enquanto o monitoramento estiver ativo." }, "status": "ENCONTRADO", "customerEmail": null, "ativo": true, "criadoEm": "2026-05-27T14:00:00.000Z", "atualizadoEm": "2026-05-27T14:05:00.000Z", "desativadoEm": null }, "meta": { "creditsRemaining": 197.9, "requestId": "mp4process-monitor-one", "searchLogId": null, "servedAt": "14:05:00" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } }, "delete": { "tags": [ "Monitoramento" ], "summary": "Remover monitoramento de processo", "description": "Desativa o monitoramento contínuo e interrompe cobranças futuras. A operação é idempotente do ponto de vista do uso esperado: confirme o status retornado e não recrie o monitoramento sem decisão explícita do usuário.\n\n**Valor para a operação:** transforma verificações periódicas em acompanhamento contínuo, com resultados prontos para alertas, tarefas e webhooks.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "removerMonitoramentoDeProcesso", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do recurso retornado pela API. Não confundir com o número CNJ.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removerMonitoramentoDeProcessoResponse" }, "example": { "data": { "id": "uuid-interno", "numeroCnj": "0000000-00.2026.8.26.0000", "numero_cnj": "0000000-00.2026.8.26.0000", "tribunal": "TJSP", "frequencia": "DIARIA", "frequency": "DIARIA", "valorMensal": 2, "valor_mensal": 2, "moeda": "BRL", "cobranca": { "recorrencia": "MENSAL", "valorMensal": 2, "valor_mensal": 2, "proximoDebitoEm": null, "proximo_debito_em": null, "ultimoDebitoEm": null, "ultimo_debito_em": null, "status": "CANCELED", "observacao": "Monitoramento inativo. Não haverá novas cobranças." }, "status": "INATIVO", "customerEmail": null, "ativo": false, "criadoEm": "2026-05-27T14:00:00.000Z", "atualizadoEm": "2026-05-27T14:08:00.000Z", "desativadoEm": "2026-05-27T14:08:00.000Z" }, "meta": { "creditsRemaining": 197.9, "requestId": "mp4process-monitor-delete", "searchLogId": null, "servedAt": "14:08:00" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/monitoramentos/novos-processos": { "get": { "tags": [ "Monitoramento" ], "summary": "Listar radares de novos processos", "description": "Lista radares de novos processos, incluindo termo, variações, filtros auxiliares, tribunais, webhook e cobrança recorrente. Use page/limit e persista o ID do radar para consultar resultados posteriormente.\n\n**Valor para a operação:** transforma verificações periódicas em acompanhamento contínuo, com resultados prontos para alertas, tarefas e webhooks.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarRadaresDeNovosProcessos", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1 }, "example": 20 } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarRadaresDeNovosProcessosResponse" }, "example": { "data": { "items": [ { "id": "uuid-interno", "termo": "BANCO BRADESCO S.A.", "variacoes": [ "BRADESCO", "BANCO BRADESCO" ], "termosAuxiliares": [ { "condicao": "CONTEM_ALGUMA", "termo": "execução" } ], "tribunais": [ "TJSP", "TJRJ" ], "status": "ATIVO", "webhookUrl": "https://cliente.com.br/webhook/leads", "valorMensal": 2.5, "valor_mensal": 2.5, "moeda": "BRL", "cobranca": { "recorrencia": "MENSAL", "valorMensal": 2.5, "valor_mensal": 2.5, "proximoDebitoEm": "2026-06-21T10:00:00.000Z", "proximo_debito_em": "2026-06-21T10:00:00.000Z", "ultimoDebitoEm": null, "ultimo_debito_em": null, "status": "ACTIVE", "observacao": "Este valor é debitado mensalmente enquanto o radar estiver ativo." }, "resultadosPersistidos": 14, "criadoEm": "2026-05-21T10:00:00.000Z", "atualizadoEm": "2026-05-21T10:00:00.000Z" } ], "pagination": { "currentPage": 1, "perPage": 20, "hasNextPage": false, "totalItems": 1 } }, "meta": { "creditsRemaining": 199.1, "requestId": "mp4monitor-list", "searchLogId": null, "servedAt": "10:00:00" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } }, "post": { "tags": [ "Monitoramento" ], "summary": "Criar radar de novos processos", "description": "Cria radar por termo para localizar novos processos. termo é obrigatório, variacoes aceita no máximo dois itens, termos_auxiliares usam condições CONTEM, NAO_CONTEM ou CONTEM_ALGUMA e webhook_url deve ser HTTPS. O radar gera cobrança recorrente enquanto ativo e pode entregar eventos de novo processo no webhook configurado.\n\n**Valor para a operação:** automatiza a descoberta de novos processos por termo e transforma resultados em oportunidades de análise e qualificação.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "criarRadarDeNovosProcessos", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/criarRadarDeNovosProcessosResponse" }, "example": { "data": { "id": "uuid-interno", "termo": "BANCO BRADESCO S.A.", "variacoes": [ "BRADESCO", "BANCO BRADESCO" ], "termosAuxiliares": [ { "condicao": "CONTEM_ALGUMA", "termo": "execução" } ], "tribunais": [ "TJSP", "TJRJ" ], "status": "ATIVO", "webhookUrl": "https://cliente.com.br/webhook/leads", "valorMensal": 2.5, "valor_mensal": 2.5, "moeda": "BRL", "cobranca": { "recorrencia": "MENSAL", "valorMensal": 2.5, "valor_mensal": 2.5, "proximoDebitoEm": "2026-06-21T10:00:00.000Z", "proximo_debito_em": "2026-06-21T10:00:00.000Z", "ultimoDebitoEm": null, "ultimo_debito_em": null, "status": "ACTIVE", "observacao": "Este valor é debitado mensalmente enquanto o radar estiver ativo." }, "criadoEm": "2026-05-21T10:00:00.000Z" }, "meta": { "creditsRemaining": 199.1, "requestId": "mp4monitor-abc123", "searchLogId": "uuid", "servedAt": "10:00:00" } } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/criarRadarDeNovosProcessosResponse" }, "example": { "data": { "id": "uuid-interno", "termo": "BANCO BRADESCO S.A.", "variacoes": [ "BRADESCO", "BANCO BRADESCO" ], "termosAuxiliares": [ { "condicao": "CONTEM_ALGUMA", "termo": "execução" } ], "tribunais": [ "TJSP", "TJRJ" ], "status": "ATIVO", "webhookUrl": "https://cliente.com.br/webhook/leads", "valorMensal": 2.5, "valor_mensal": 2.5, "moeda": "BRL", "cobranca": { "recorrencia": "MENSAL", "valorMensal": 2.5, "valor_mensal": 2.5, "proximoDebitoEm": "2026-06-21T10:00:00.000Z", "proximo_debito_em": "2026-06-21T10:00:00.000Z", "ultimoDebitoEm": null, "ultimo_debito_em": null, "status": "ACTIVE", "observacao": "Este valor é debitado mensalmente enquanto o radar estiver ativo." }, "criadoEm": "2026-05-21T10:00:00.000Z" }, "meta": { "creditsRemaining": 199.1, "requestId": "mp4monitor-abc123", "searchLogId": "uuid", "servedAt": "10:00:00" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProcessMonitoringRequest" }, "examples": { "exemplo": { "summary": "Exemplo fictício", "value": { "termo": "Empresa Exemplo", "webhook_url": "https://cliente.example/webhooks/monitoramento" } } } } } }, "callbacks": { "webhook": { "$ref": "#/components/callbacks/ClientWebhook" } } } }, "/v1/monitoramentos/novos-processos/{id}": { "get": { "tags": [ "Monitoramento" ], "summary": "Consultar radar de novos processos", "description": "Consulta um radar específico e seu estado de cobrança, configuração de webhook e quantidade de resultados persistidos. Use antes de editar ou remover a configuração no painel e para diagnosticar se a entrega automática está ativa.\n\n**Valor para a operação:** transforma verificações periódicas em acompanhamento contínuo, com resultados prontos para alertas, tarefas e webhooks.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "obterRadarDeNovosProcessos", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do recurso retornado pela API. Não confundir com o número CNJ.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/obterRadarDeNovosProcessosResponse" }, "example": { "data": { "id": "uuid-interno", "termo": "BANCO BRADESCO S.A.", "variacoes": [ "BRADESCO", "BANCO BRADESCO" ], "termosAuxiliares": [ { "condicao": "CONTEM_ALGUMA", "termo": "execução" } ], "tribunais": [ "TJSP", "TJRJ" ], "status": "ATIVO", "webhookUrl": "https://cliente.com.br/webhook/leads", "valorMensal": 2.5, "valor_mensal": 2.5, "moeda": "BRL", "cobranca": { "recorrencia": "MENSAL", "valorMensal": 2.5, "valor_mensal": 2.5, "proximoDebitoEm": "2026-06-21T10:00:00.000Z", "proximo_debito_em": "2026-06-21T10:00:00.000Z", "ultimoDebitoEm": null, "ultimo_debito_em": null, "status": "ACTIVE", "observacao": "Este valor é debitado mensalmente enquanto o radar estiver ativo." }, "resultadosPersistidos": 14, "criadoEm": "2026-05-21T10:00:00.000Z", "atualizadoEm": "2026-05-21T10:00:00.000Z" }, "meta": { "creditsRemaining": 199.1, "requestId": "mp4monitor-one", "searchLogId": null, "servedAt": "10:00:00" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } }, "delete": { "tags": [ "Monitoramento" ], "summary": "Remover radar de novos processos", "description": "Desativa um radar de novos processos e interrompe novas cobranças. Os resultados persistidos podem continuar disponíveis para consulta conforme o estado armazenado; não assuma exclusão física sem confirmação no retorno.\n\n**Valor para a operação:** transforma verificações periódicas em acompanhamento contínuo, com resultados prontos para alertas, tarefas e webhooks.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "removerRadarDeNovosProcessos", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do recurso retornado pela API. Não confundir com o número CNJ.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removerRadarDeNovosProcessosResponse" }, "example": { "data": { "id": "uuid-interno", "termo": "BANCO BRADESCO S.A.", "variacoes": [ "BRADESCO", "BANCO BRADESCO" ], "termosAuxiliares": [ { "condicao": "CONTEM_ALGUMA", "termo": "execução" } ], "tribunais": [ "TJSP", "TJRJ" ], "status": "INATIVO", "webhookUrl": "https://cliente.com.br/webhook/leads", "valorMensal": 2.5, "valor_mensal": 2.5, "moeda": "BRL", "cobranca": { "recorrencia": "MENSAL", "valorMensal": 2.5, "valor_mensal": 2.5, "proximoDebitoEm": null, "proximo_debito_em": null, "ultimoDebitoEm": null, "ultimo_debito_em": null, "status": "CANCELED", "observacao": "Radar inativo. Não haverá novas cobranças." }, "criadoEm": "2026-05-21T10:00:00.000Z", "atualizadoEm": "2026-05-21T10:00:00.000Z" }, "meta": { "creditsRemaining": 199.1, "requestId": "mp4monitor-delete", "searchLogId": null, "servedAt": "10:00:00" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } }, "patch": { "operationId": "refinarRadarDeNovosProcessos", "summary": "Refinar filtros de um radar", "tags": [ "Monitoramento" ], "description": "Atualiza tribunais e termosAuxiliares de um radar ativo da conta autenticada. O campo termo não é editável: enviá-lo retorna HTTP 422 TERM_NOT_EDITABLE; para monitorar outro termo, desative o radar atual e crie um novo. Envie pelo menos tribunais ou termosAuxiliares, caso contrário retorna 422 NOTHING_TO_REFINE. O retorno contém somente id, termo, tribunais e termosAuxiliares, além de meta. Esta operação não executa uma nova consulta nem cria outro radar.", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do recurso retornado pela API. Não confundir com o número CNJ.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "required": [ "tribunais" ] }, { "required": [ "termosAuxiliares" ] } ], "properties": { "tribunais": { "type": "array", "items": { "type": "string" }, "description": "Siglas normalizadas para maiúsculas. Lista vazia remove o filtro de tribunais." }, "termosAuxiliares": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Lista de condições auxiliares; use os formatos do guia de monitoramento. Lista vazia remove as condições." } } }, "example": { "tribunais": [ "TJSP" ], "termosAuxiliares": [ { "condicao": "CONTEM", "termo": "execução" } ] } } } }, "responses": { "200": { "description": "Filtros atualizados.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "termo": { "type": "string" }, "tribunais": { "type": "array", "items": { "type": "string" } }, "termosAuxiliares": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "meta": { "type": "object", "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "servedAt": { "type": "string" } } } } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/monitoramentos/novos-processos/{id}/resultados": { "get": { "tags": [ "Monitoramento" ], "summary": "Listar resultados de radar", "description": "Lista resultados persistidos de um radar por página. sincronizar=true solicita atualização dos resultados antes da listagem e pode provocar consulta ao provedor; use com parcimônia. Cada resultado pode ser qualificado posteriormente pelo CNJ.\n\n**Valor para a operação:** transforma verificações periódicas em acompanhamento contínuo, com resultados prontos para alertas, tarefas e webhooks.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarResultadosDoRadar", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do recurso retornado pela API. Não confundir com o número CNJ.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1 }, "example": 20 }, { "name": "sincronizar", "in": "query", "required": false, "description": "Solicita sincronização dos resultados persistidos antes da listagem quando true.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarResultadosDoRadarResponse" }, "example": { "data": { "items": [ { "numeroCnj": "0000000-00.2026.8.26.0000", "dataInicio": "2026-05-21", "tribunal": "TJSP", "match": "Trecho encontrado com o termo monitorado", "estadoOrigem": { "nome": "São Paulo", "sigla": "SP" }, "qualificacao": { "status": "NAO_ENRIQUECIDO", "bancoNoPoloAtivo": null, "classe": null, "assunto": null, "matchedAlias": null, "reason": null } } ], "pagination": { "currentPage": 1, "perPage": 20, "hasNextPage": false, "totalItems": 1 } }, "meta": { "creditsRemaining": 199.1, "requestId": "mp4monitor-results", "searchLogId": null, "servedAt": "10:00:00" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/monitoramentos/novos-processos/{id}/resultados/{numeroCnj}/qualificar": { "post": { "tags": [ "Monitoramento" ], "summary": "Qualificar resultado de radar", "description": "Enriquece e qualifica um resultado de radar como lead, vinculando-o ao monitoramento e ao CNJ. A operação pode consumir créditos e retorna o status de qualificação e campos encontrados, como classe, assunto e indicação de banco no polo ativo.\n\n**Valor para a operação:** enriquece o resultado encontrado para que a operação possa priorizar o que merece abordagem ou investigação adicional.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "qualificarResultadoDoRadar", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do recurso retornado pela API. Não confundir com o número CNJ.", "schema": { "type": "string" } }, { "name": "numeroCnj", "in": "path", "required": true, "description": "Parâmetro de caminho numeroCnj.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/qualificarResultadoDoRadarResponse" }, "example": { "data": { "monitoramentoId": "uuid-interno", "resultado": { "numeroCnj": "0000000-00.2026.8.26.0000", "dataInicio": "2026-05-21", "tribunal": "TJSP", "match": "Trecho encontrado com o termo monitorado", "estadoOrigem": { "nome": "São Paulo", "sigla": "SP" }, "qualificacao": { "status": "QUALIFICADO", "bancoNoPoloAtivo": true, "classe": "Execução de Título Extrajudicial", "assunto": "Cobrança", "matchedAlias": "BANCO BRADESCO S.A.", "reason": "O termo monitorado foi localizado no polo ativo do processo." } } }, "meta": { "creditsRemaining": 198.98, "requestId": "mp4monitor-qualify", "searchLogId": "uuid", "servedAt": "10:00:00" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } } } }, "/v1/monitoramentos/publicacoes": { "get": { "tags": [ "Monitoramento" ], "summary": "Listar monitoramentos de publicações judiciais", "description": "Lista gratuitamente os monitoramentos de publicações do STF e da Justiça Eleitoral da conta, incluindo fontes, tribunais, filtros, próxima execução, próxima cobrança e configuração de webhook.\n\n**Valor para a operação:** transforma verificações periódicas em acompanhamento contínuo, com resultados prontos para alertas, tarefas e webhooks.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarMonitoramentosDePublicacoes", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1 }, "example": 20 } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarMonitoramentosDePublicacoesResponse" }, "example": { "data": { "items": [ { "id": "mon_publicacoes_123", "nome": "Publicações eleitorais", "fontes": [ "TSE_DJE", "TRE_DJE", "MURAL_ELEITORAL" ], "tribunais": [ "TSE", "TRE-SP" ], "filtros": { "termo": "Empresa Exemplo", "processo": null, "oab": null }, "evento": "publicacao_judicial_nova", "status": "ACTIVE", "intervalo_minutos": 15, "valor_mensal": 1.8, "cobranca": { "recorrencia": "MENSAL", "valor_mensal": 1.8, "proximo_debito_em": "2026-10-02T13:00:00.000Z", "status": "ACTIVE" } } ], "pagination": { "page": 1, "limit": 20, "total": 1, "totalPages": 1 } }, "meta": { "creditsCharged": 0, "creditsRemaining": 99.41, "requestId": "req_monitoramentos_publicacoes", "searchLogId": null, "servedAt": "14:32:10" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } }, "post": { "tags": [ "Monitoramento" ], "summary": "Criar monitoramento de publicações judiciais", "description": "Cria um monitoramento recorrente para STF_DJE, TSE_DJE, TRE_DJE e/ou MURAL_ELEITORAL. Informe ao menos um filtro entre termo, processo ou OAB; para fontes eleitorais, informe de um a cinco tribunais. A primeira mensalidade é debitada na criação: R$ 0,90 para a configuração base e R$ 0,30 por fonte ou tribunal adicional. Novas correspondências geram o evento publicacao_judicial_nova no webhook HTTPS informado.\n\n**Valor para a operação:** transforma consultas ao STF e à Justiça Eleitoral em vigilância contínua, com deduplicação e entrega imediata por webhook.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "criarMonitoramentoDePublicacoes", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/criarMonitoramentoDePublicacoesResponse" }, "example": { "data": { "id": "mon_publicacoes_123", "nome": "Publicações eleitorais", "fontes": [ "STF_DJE", "TSE_DJE", "TRE_DJE", "MURAL_ELEITORAL" ], "tribunais": [ "TSE", "TRE-SP" ], "filtros": { "termo": "Empresa Exemplo", "processo": null, "oab": null }, "evento": "publicacao_judicial_nova", "status": "ACTIVE", "intervalo_minutos": 15, "webhook_url": "https://cliente.example/webhooks/publicacoes", "valor_mensal": 2.1, "cobranca": { "recorrencia": "MENSAL", "valor_mensal": 2.1, "proximo_debito_em": "2026-10-02T13:00:00.000Z", "status": "ACTIVE" } }, "meta": { "creditsCharged": 2.1, "creditsRemaining": 97.9, "requestId": "req_criar_monitoramento_publicacoes", "searchLogId": "log_criar_monitoramento_publicacoes", "servedAt": "14:32:10" } } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/criarMonitoramentoDePublicacoesResponse" }, "example": { "data": { "id": "mon_publicacoes_123", "nome": "Publicações eleitorais", "fontes": [ "STF_DJE", "TSE_DJE", "TRE_DJE", "MURAL_ELEITORAL" ], "tribunais": [ "TSE", "TRE-SP" ], "filtros": { "termo": "Empresa Exemplo", "processo": null, "oab": null }, "evento": "publicacao_judicial_nova", "status": "ACTIVE", "intervalo_minutos": 15, "webhook_url": "https://cliente.example/webhooks/publicacoes", "valor_mensal": 2.1, "cobranca": { "recorrencia": "MENSAL", "valor_mensal": 2.1, "proximo_debito_em": "2026-10-02T13:00:00.000Z", "status": "ACTIVE" } }, "meta": { "creditsCharged": 2.1, "creditsRemaining": 97.9, "requestId": "req_criar_monitoramento_publicacoes", "searchLogId": "log_criar_monitoramento_publicacoes", "servedAt": "14:32:10" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JudicialPublicationMonitoringRequest" }, "examples": { "exemplo": { "summary": "Exemplo fictício", "value": { "nome": "Publicações eleitorais do cliente", "fontes": [ "STF_DJE", "TSE_DJE", "TRE_DJE", "MURAL_ELEITORAL" ], "tribunais": [ "TSE", "TRE-SP" ], "termo": "Empresa Exemplo", "intervalo_minutos": 15, "webhook_url": "https://cliente.example/webhooks/publicacoes", "notificar_existentes": false } } } } } }, "callbacks": { "webhook": { "$ref": "#/components/callbacks/ClientWebhook" } } } }, "/v1/monitoramentos/publicacoes/{id}": { "get": { "tags": [ "Monitoramento" ], "summary": "Consultar monitoramento de publicações judiciais", "description": "Consulta gratuitamente um monitoramento de publicações específico e suas correspondências recentes, estado operacional e datas de execução e cobrança.\n\n**Valor para a operação:** transforma verificações periódicas em acompanhamento contínuo, com resultados prontos para alertas, tarefas e webhooks.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "obterMonitoramentoDePublicacoes", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do recurso retornado pela API. Não confundir com o número CNJ.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } }, "delete": { "tags": [ "Monitoramento" ], "summary": "Desativar monitoramento de publicações judiciais", "description": "Desativa gratuitamente o monitoramento de publicações e interrompe futuras coletas, webhooks e cobranças recorrentes. O histórico persistido não é apagado.\n\n**Valor para a operação:** transforma verificações periódicas em acompanhamento contínuo, com resultados prontos para alertas, tarefas e webhooks.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "removerMonitoramentoDePublicacoes", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do recurso retornado pela API. Não confundir com o número CNJ.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/monitoramentos/processos-administrativos": { "get": { "tags": [ "Monitoramento" ], "summary": "Listar monitoramentos de processos administrativos", "description": "Lista os monitoramentos de processos administrativos da conta, com NUP, fonte, cobrança mensal, próxima sincronização e webhook. A listagem é gratuita.\n\n**Valor para a operação:** transforma verificações periódicas em acompanhamento contínuo, com resultados prontos para alertas, tarefas e webhooks.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "listarMonitoramentosAdministrativos", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1 }, "example": 20 } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarMonitoramentosAdministrativosResponse" }, "example": { "data": { "items": [ { "id": "mon_admin_123", "nome": "Licenciamento IBAMA", "nup": "02001.003002/2021-17", "fonte": "IBAMA_SEI", "evento": "movimentacao_processo_administrativo_nova", "webhook_url": "https://cliente.example/webhooks/processos-administrativos", "intervalo_minutos": 1440, "notificar_existentes": false, "valor_mensal": 0.8, "moeda": "BRL", "cobranca": { "recorrencia": "MENSAL", "proximo_debito_em": "2026-10-02T13:00:00.000Z", "ultimo_debito_em": "2026-09-02T13:00:00.000Z", "ciclo": 1, "status": "ACTIVE", "ultimo_erro": null }, "status": "ACTIVE", "sincronizacao": { "baseline_em": "2026-09-02T13:00:00.000Z", "ultima_tentativa_em": "2026-09-02T13:00:00.000Z", "ultimo_sucesso_em": "2026-09-02T13:00:00.000Z", "proxima_tentativa_em": "2026-09-03T13:00:00.000Z", "falhas_consecutivas": 0, "ultimo_erro": null }, "correspondencias": 1, "criado_em": "2026-09-02T13:00:00.000Z", "atualizado_em": "2026-09-02T13:00:00.000Z" } ], "pagination": { "current_page": 1, "per_page": 20, "total": 1, "total_pages": 1 } }, "meta": { "creditsCharged": 0, "creditsRemaining": 199.2, "requestId": "req_listar_monitoramentos_admin", "searchLogId": null, "servedAt": "14:32:10" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } }, "post": { "tags": [ "Monitoramento" ], "summary": "Criar monitoramento de processo administrativo", "description": "Cria monitoramento recorrente de um NUP no Protocolo Integrado ou no SEI/IBAMA. O primeiro ciclo de R$ 0,80 é cobrado na criação e os seguintes enquanto o monitoramento permanecer ativo. Novas tramitações geram o evento movimentacao_processo_administrativo_nova.\n\n**Valor para a operação:** substitui conferências manuais de um NUP por sincronização recorrente e alerta de nova tramitação.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "criarMonitoramentoAdministrativo", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/criarMonitoramentoAdministrativoResponse" }, "example": { "data": { "id": "mon_admin_123", "nome": "Licenciamento IBAMA", "nup": "02001.003002/2021-17", "fonte": "IBAMA_SEI", "evento": "movimentacao_processo_administrativo_nova", "webhook_url": "https://cliente.example/webhooks/processos-administrativos", "intervalo_minutos": 1440, "notificar_existentes": false, "valor_mensal": 0.8, "moeda": "BRL", "cobranca": { "recorrencia": "MENSAL", "proximo_debito_em": "2026-10-02T13:00:00.000Z", "ultimo_debito_em": "2026-09-02T13:00:00.000Z", "ciclo": 1, "status": "ACTIVE", "ultimo_erro": null }, "status": "ACTIVE", "sincronizacao": { "baseline_em": "2026-09-02T13:00:00.000Z", "ultima_tentativa_em": "2026-09-02T13:00:00.000Z", "ultimo_sucesso_em": "2026-09-02T13:00:00.000Z", "proxima_tentativa_em": "2026-09-03T13:00:00.000Z", "falhas_consecutivas": 0, "ultimo_erro": null }, "correspondencias": 0, "criado_em": "2026-09-02T13:00:00.000Z", "atualizado_em": "2026-09-02T13:00:00.000Z" }, "meta": { "creditsCharged": 0.8, "creditsRemaining": 199.2, "requestId": "req_criar_monitoramento_admin", "searchLogId": "log_criar_monitoramento_admin", "servedAt": "14:32:10" } } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/criarMonitoramentoAdministrativoResponse" }, "example": { "data": { "id": "mon_admin_123", "nome": "Licenciamento IBAMA", "nup": "02001.003002/2021-17", "fonte": "IBAMA_SEI", "evento": "movimentacao_processo_administrativo_nova", "webhook_url": "https://cliente.example/webhooks/processos-administrativos", "intervalo_minutos": 1440, "notificar_existentes": false, "valor_mensal": 0.8, "moeda": "BRL", "cobranca": { "recorrencia": "MENSAL", "proximo_debito_em": "2026-10-02T13:00:00.000Z", "ultimo_debito_em": "2026-09-02T13:00:00.000Z", "ciclo": 1, "status": "ACTIVE", "ultimo_erro": null }, "status": "ACTIVE", "sincronizacao": { "baseline_em": "2026-09-02T13:00:00.000Z", "ultima_tentativa_em": "2026-09-02T13:00:00.000Z", "ultimo_sucesso_em": "2026-09-02T13:00:00.000Z", "proxima_tentativa_em": "2026-09-03T13:00:00.000Z", "falhas_consecutivas": 0, "ultimo_erro": null }, "correspondencias": 0, "criado_em": "2026-09-02T13:00:00.000Z", "atualizado_em": "2026-09-02T13:00:00.000Z" }, "meta": { "creditsCharged": 0.8, "creditsRemaining": 199.2, "requestId": "req_criar_monitoramento_admin", "searchLogId": "log_criar_monitoramento_admin", "servedAt": "14:32:10" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdministrativeProcessMonitoringRequest" }, "examples": { "exemplo": { "summary": "Exemplo fictício", "value": { "nome": "Processo IBAMA", "nup": "02001.003002/2021-17", "fonte": "AUTO", "intervalo_minutos": 1440, "webhook_url": "https://cliente.example/webhooks/processos-administrativos", "notificar_existentes": false } } } } } }, "callbacks": { "webhook": { "$ref": "#/components/callbacks/ClientWebhook" } } } }, "/v1/monitoramentos/processos-administrativos/{id}": { "get": { "tags": [ "Monitoramento" ], "summary": "Consultar monitoramento de processo administrativo", "description": "Consulta gratuitamente um monitoramento de processo administrativo, incluindo estado de sincronização, cobrança e quantidade de correspondências.\n\n**Valor para a operação:** transforma verificações periódicas em acompanhamento contínuo, com resultados prontos para alertas, tarefas e webhooks.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "obterMonitoramentoAdministrativo", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do recurso retornado pela API. Não confundir com o número CNJ.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/obterMonitoramentoAdministrativoResponse" }, "example": { "data": { "id": "mon_admin_123", "nome": "Licenciamento IBAMA", "nup": "02001.003002/2021-17", "fonte": "IBAMA_SEI", "evento": "movimentacao_processo_administrativo_nova", "webhook_url": "https://cliente.example/webhooks/processos-administrativos", "intervalo_minutos": 1440, "notificar_existentes": false, "valor_mensal": 0.8, "moeda": "BRL", "cobranca": { "recorrencia": "MENSAL", "proximo_debito_em": "2026-10-02T13:00:00.000Z", "ultimo_debito_em": "2026-09-02T13:00:00.000Z", "ciclo": 1, "status": "ACTIVE", "ultimo_erro": null }, "status": "ACTIVE", "sincronizacao": { "baseline_em": "2026-09-02T13:00:00.000Z", "ultima_tentativa_em": "2026-09-02T13:00:00.000Z", "ultimo_sucesso_em": "2026-09-02T13:00:00.000Z", "proxima_tentativa_em": "2026-09-03T13:00:00.000Z", "falhas_consecutivas": 0, "ultimo_erro": null }, "correspondencias": 1, "criado_em": "2026-09-02T13:00:00.000Z", "atualizado_em": "2026-09-02T13:00:00.000Z" }, "meta": { "creditsCharged": 0, "creditsRemaining": 199.2, "requestId": "req_obter_monitoramento_admin", "searchLogId": null, "servedAt": "14:32:10" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } }, "delete": { "tags": [ "Monitoramento" ], "summary": "Desativar monitoramento de processo administrativo", "description": "Desativa o monitoramento de processo administrativo e interrompe novas sincronizações, webhooks e cobranças recorrentes. O histórico persistido não é apagado.\n\n**Valor para a operação:** transforma verificações periódicas em acompanhamento contínuo, com resultados prontos para alertas, tarefas e webhooks.\n\n**Autenticação e resposta:** envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.\n\n**SLA e HTTP 202:** a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente.", "operationId": "removerMonitoramentoAdministrativo", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do recurso retornado pela API. Não confundir com o número CNJ.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removerMonitoramentoAdministrativoResponse" }, "example": { "data": { "id": "mon_admin_123", "nome": "Licenciamento IBAMA", "nup": "02001.003002/2021-17", "fonte": "IBAMA_SEI", "evento": "movimentacao_processo_administrativo_nova", "webhook_url": "https://cliente.example/webhooks/processos-administrativos", "intervalo_minutos": 1440, "notificar_existentes": false, "valor_mensal": 0.8, "moeda": "BRL", "cobranca": { "recorrencia": "MENSAL", "proximo_debito_em": null, "ultimo_debito_em": "2026-09-02T13:00:00.000Z", "ciclo": 1, "status": "CANCELED", "ultimo_erro": null }, "status": "INACTIVE", "sincronizacao": { "baseline_em": "2026-09-02T13:00:00.000Z", "ultima_tentativa_em": "2026-09-02T13:00:00.000Z", "ultimo_sucesso_em": "2026-09-02T13:00:00.000Z", "proxima_tentativa_em": null, "falhas_consecutivas": 0, "ultimo_erro": null }, "correspondencias": 1, "criado_em": "2026-09-02T13:00:00.000Z", "atualizado_em": "2026-09-02T14:00:00.000Z" }, "meta": { "creditsCharged": 0, "creditsRemaining": 199.2, "requestId": "req_remover_monitoramento_admin", "searchLogId": null, "servedAt": "14:32:10" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/monitoramentos/novos-processos/resultados": { "get": { "operationId": "listarFeedDeResultadosDosRadares", "summary": "Listar resultados de todos os radares por dia", "tags": [ "Monitoramento" ], "description": "Lista os achados dos radares da conta autenticada, agrupados por dia. A paginação é por dias, não por processos. Não executa uma nova busca nem qualificação. O parâmetro amostra limita a quantidade de resultados exibidos por radar. Cada item da amostra inclui id, classificação e datas de descoberta/arquivamento. Campos processuais adicionais variam conforme os dados encontrados.", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Página do feed." }, { "name": "dias", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 31, "default": 3 }, "description": "Quantidade de dias por página." }, { "name": "desde", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Data inicial em YYYY-MM-DD." }, { "name": "ate", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Data final em YYYY-MM-DD." }, { "name": "data", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "descoberta", "distribuicao" ], "default": "descoberta" }, "description": "Eixo de data usado no agrupamento." }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Termo de filtro." }, { "name": "radar", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Identificador do monitoramento." }, { "name": "arquivados", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "excluir", "incluir", "somente" ], "default": "excluir" }, "description": "Seleção de resultados arquivados." }, { "name": "somenteNovos", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Exibir somente novos achados." }, { "name": "amostra", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 8 }, "description": "Itens de amostra por radar." } ], "responses": { "200": { "description": "Feed agrupado por dia.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "dias": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "string", "format": "date" }, "totais": { "type": "object", "properties": { "encontrados": { "type": "integer" }, "novos": { "type": "integer" } } }, "radares": { "type": "array", "items": { "type": "object", "properties": { "monitoramentoId": { "type": "string" }, "termo": { "type": "string" }, "encontrados": { "type": "integer" }, "novos": { "type": "integer" }, "amostra": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } } } }, "paginacao": { "type": "object", "properties": { "pagina": { "type": "integer" }, "diasPorPagina": { "type": "integer" }, "totalDias": { "type": "integer" } } } } }, "meta": { "type": "object", "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "servedAt": { "type": "string" } } } } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/monitoramentos/novos-processos/resultados/arquivar": { "post": { "operationId": "arquivarResultadosDosRadares", "summary": "Arquivar resultados dos radares", "tags": [ "Monitoramento" ], "description": "Altera o estado de arquivamento dos achados da conta autenticada, preservando o registro. Envie ids (até 500 são processados) ou monitoramentoId para delimitar a operação; dia pode restringir os achados do monitoramento a uma data no fuso de São Paulo. Arquivar não exclui processos nem desativa o radar. Sem ids ou monitoramentoId, retorna HTTP 422 ARCHIVE_SCOPE_REQUIRED. Esta operação não realiza uma nova consulta processual.", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "required": [ "ids" ] }, { "required": [ "monitoramentoId" ] } ], "properties": { "ids": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "IDs de achados. A operação considera no máximo 500 por chamada." }, "monitoramentoId": { "type": "string", "description": "ID do radar; isoladamente aplica a ação aos seus achados." }, "dia": { "type": "string", "format": "date", "description": "Data YYYY-MM-DD para restringir o radar a um dia." } } }, "example": { "ids": [ "resultado_exemplo" ] } } } }, "responses": { "200": { "description": "Quantidade de achados alterados.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "arquivados": { "type": "integer", "minimum": 0 } } }, "meta": { "type": "object", "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "servedAt": { "type": "string" } } } } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/monitoramentos/novos-processos/resultados/desarquivar": { "post": { "operationId": "desarquivarResultadosDosRadares", "summary": "Desarquivar resultados dos radares", "tags": [ "Monitoramento" ], "description": "Altera o estado de arquivamento dos achados da conta autenticada, preservando o registro. Envie ids (até 500 são processados) ou monitoramentoId para delimitar a operação; dia pode restringir os achados do monitoramento a uma data no fuso de São Paulo. Arquivar não exclui processos nem desativa o radar. Sem ids ou monitoramentoId, retorna HTTP 422 ARCHIVE_SCOPE_REQUIRED. Esta operação não realiza uma nova consulta processual.", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "required": [ "ids" ] }, { "required": [ "monitoramentoId" ] } ], "properties": { "ids": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "IDs de achados. A operação considera no máximo 500 por chamada." }, "monitoramentoId": { "type": "string", "description": "ID do radar; isoladamente aplica a ação aos seus achados." }, "dia": { "type": "string", "format": "date", "description": "Data YYYY-MM-DD para restringir o radar a um dia." } } }, "example": { "ids": [ "resultado_exemplo" ] } } } }, "responses": { "200": { "description": "Quantidade de achados alterados.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "desarquivados": { "type": "integer", "minimum": 0 } } }, "meta": { "type": "object", "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "servedAt": { "type": "string" } } } } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/tribunais/sistemas": { "get": { "tags": [ "Compatibilidade" ], "summary": "Listar sistemas dos tribunais", "description": "Caminho histórico da listagem de sistemas. Prefira GET /v1/sistemas em novas integrações. Retorna filtros, sistemas, total e metadados; autenticação e cobrança seguem a listagem de sistemas.", "operationId": "listarSistemasDosTribunaisLegado", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "tribunais", "in": "query", "required": false, "description": "Lista de até cinco siglas de tribunais separadas por vírgula ou pelo parâmetro repetido. Em GET /v1/processos, a primeira página custa R$ 0,25 por tribunal informado que retornar ao menos um processo; tribunais sem resultado e páginas seguintes não geram nova cobrança.", "schema": { "type": "string" } }, { "name": "utiliza_certificado_digital", "in": "query", "required": false, "description": "Filtra sistemas de tribunais que utilizam certificado digital.", "schema": { "type": "string" } }, { "name": "utiliza_2fa", "in": "query", "required": false, "description": "Filtra sistemas de tribunais que exigem autenticação de dois fatores.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listarSistemasDosTribunaisResponse" }, "example": { "data": { "filtros": { "tribunais": [ "TJSP", "TRF3" ], "utilizaCertificadoDigital": true, "utiliza2fa": null }, "sistemas": [ { "sistemaNome": "PJE", "tribunalSigla": "TRF3", "tribunalNome": "Tribunal Regional Federal da 3ª Região", "utilizaCertificadoDigital": true, "utiliza2fa": true } ], "total": 1 }, "meta": { "creditsRemaining": 200, "requestId": "mo5aa10m-s1g3j0", "searchLogId": "uuid", "servedAt": "10:02:11" } } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "deprecated": true } }, "/v1/busca": { "get": { "tags": [ "Compatibilidade" ], "summary": "Buscar por termo", "description": "Caminho histórico da busca por termo. Prefira GET /v1/busca/termo. Recebe q e qo, mas retorna o payload de busca diretamente, sem o envelope data/meta do endpoint principal. Créditos e identificadores ficam nos headers X-BuscaProcessos-*. Erros legados podem usar error como texto e saldo insuficiente retorna HTTP 402. Possui limite de 30 requisições por minuto por IP e por chave.", "operationId": "buscarPorTermoLegado", "security": [ { "apiKeyAuth": [] }, { "bearerAuth": [] } ], "parameters": [ { "name": "q", "in": "query", "required": true, "description": "Texto, nome, empresa, tema, CNJ ou OAB pesquisado. No índice local, palavras são combinadas por AND implícito; use aspas para frase exata.", "schema": { "type": "string" }, "example": "Empresa Exemplo banco de horas" }, { "name": "qo", "in": "query", "required": true, "description": "Escopo obrigatório da busca: t (todos), p (pessoas), c (pessoas com identificadores estruturados), i (instituições), d (publicações e Diários Oficiais) ou en (envolvidos). Use d para empresa + tema em publicações judiciais.", "schema": { "type": "string", "enum": [ "t", "p", "c", "i", "d", "en" ] }, "example": "d" }, { "name": "ano_publicacao", "in": "query", "required": false, "description": "Atalho para pesquisar um ano completo de publicação oficial, como 2026. Não combine com datas. Não representa ano orçamentário nem previsão de pagamento.", "schema": { "type": "integer", "minimum": 1900, "maximum": 2100 }, "example": 2026 }, { "name": "data_publicacao_inicio", "in": "query", "required": false, "description": "Data inicial da publicação oficial no formato YYYY-MM-DD. Envie junto com data_publicacao_fim; o intervalo síncrono máximo é de 366 dias.", "schema": { "type": "string", "format": "date" }, "example": "2026-01-01" }, { "name": "data_publicacao_fim", "in": "query", "required": false, "description": "Data final da publicação oficial no formato YYYY-MM-DD. Envie junto com data_publicacao_inicio.", "schema": { "type": "string", "format": "date" }, "example": "2026-09-02" }, { "name": "ano_orcamentario", "in": "query", "required": false, "description": "Exercício em que o precatório consta para inclusão no orçamento oficial. Em GET /v1/precatorios, sem recorte estadual ou com tribunal federal (TRF/TRT e superiores), seleciona o acervo orçamentário federal, inclusive sem CNJ, com mode=PRECATORIO_BUDGET. Com TJ/TRE ou somente UF, filtra o índice processual enriquecido pelas listas do tribunal. Não equivale a data ou confirmação de pagamento.", "schema": { "type": "integer", "minimum": 2008, "maximum": 2100 }, "example": 2026 }, { "name": "ano_orcamentario_inicio", "in": "query", "required": false, "description": "Primeiro exercício orçamentário da busca de precatórios. Envie junto com ano_orcamentario_fim.", "schema": { "type": "integer", "minimum": 2008, "maximum": 2100 }, "example": 2026 }, { "name": "ano_orcamentario_fim", "in": "query", "required": false, "description": "Último exercício orçamentário da busca de precatórios. O intervalo máximo é de 11 exercícios.", "schema": { "type": "integer", "minimum": 2008, "maximum": 2100 }, "example": 2027 }, { "name": "tribunal", "in": "query", "required": false, "description": "Uma sigla de tribunal, como TJSP, TRF2, TRT1 ou TRT15. Na busca por termos, o filtro é aplicado com ano_publicacao ou com as duas datas de publicação; não existe filtro de UF separado.", "schema": { "type": "string" }, "example": "TRT1" }, { "name": "ente_devedor", "in": "query", "required": false, "description": "Código ou parte do nome da Unidade Orçamentária executada/devedora.", "schema": { "type": "string" }, "example": "Fundo do Regime Geral de Previdência Social" }, { "name": "uf_tribunal_expedidor", "in": "query", "required": false, "description": "UF do Tribunal de Justiça estadual expedidor, quando informada. Não representa o estado do ente devedor federal.", "schema": { "type": "string" }, "example": "SP" }, { "name": "valor_minimo", "in": "query", "required": false, "description": "Valor mínimo do precatório em reais, usando ponto como separador decimal.", "schema": { "type": "number", "format": "double", "minimum": 0 }, "example": 100000 }, { "name": "valor_maximo", "in": "query", "required": false, "description": "Valor máximo do precatório em reais, usando ponto como separador decimal.", "schema": { "type": "number", "format": "double", "minimum": 0 }, "example": 1000000 }, { "name": "tributario", "in": "query", "required": false, "description": "Filtra a classificação tributária do registro orçamentário. Disponível conforme o exercício.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "fundef", "in": "query", "required": false, "description": "Filtra registros classificados como FUNDEF ou não FUNDEF.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "incluir_correspondencias", "in": "query", "required": false, "description": "Quando true, inclui vínculos processuais e correspondências auditáveis com seu nível de confiança. Não confirma pagamento ou beneficiário.", "schema": { "type": "boolean", "default": true }, "example": true }, { "name": "incluir_partes", "in": "query", "required": false, "description": "Quando true em buscas por precatório, inclui as partes e os CPF/CNPJ completos que estiverem publicamente disponíveis nos processos vinculados.", "schema": { "type": "boolean", "default": true }, "example": true }, { "name": "somente_processos_vinculados", "in": "query", "required": false, "description": "Quando true no modo orçamentário, retorna somente registros com número CNJ confirmado pelo índice de vinculação ou por publicação auditável.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "ordenar", "in": "query", "required": false, "description": "Ordenação dos precatórios. Sem UF/tribunal, analise_desc prioriza registros com CNJ, documentos do credor e do devedor, ano orçamentário, situação de pagamento analisada e valor. As demais opções aplicam a ordenação solicitada.", "schema": { "type": "string", "enum": [ "valor_desc", "valor_asc", "ano_desc", "ano_asc", "autuacao_desc" ], "default": "valor_desc" }, "example": "valor_desc" }, { "name": "classe_processual", "in": "query", "required": false, "description": "Classe processual exata, comparada sem diferença de caixa ou acento. Use PRECATÓRIO para remover resultados que apenas mencionam o termo em outra classe.", "schema": { "type": "string" }, "example": "PRECATÓRIO" }, { "name": "deduplicar_por_processo", "in": "query", "required": false, "description": "Quando true, retorna um item por CNJ e consolida a quantidade de publicações relacionadas. Registros sem CNJ não são mesclados.", "schema": { "type": "boolean", "default": false }, "example": true }, { "name": "qs", "in": "query", "required": false, "description": "Ordenação das publicações: d para as mais recentes primeiro ou a para as mais antigas primeiro.", "schema": { "type": "string", "enum": [ "d", "a" ], "default": "d" }, "example": "d" }, { "name": "utilizar_operadores_logicos", "in": "query", "required": false, "description": "Habilita AND, OR, NOT e parênteses no índice local. Aceita true/false; não pode ser combinado com a busca oficial por período.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "page", "in": "query", "required": false, "description": "Página iniciando em 1. Quando omitida, a API usa a primeira página.", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "example": 1 }, { "name": "limit", "in": "query", "required": false, "description": "Quantidade de itens por página. Cada operação aplica seu próprio limite máximo; em geral, até 100.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "example": 20 } ], "responses": { "200": { "description": "Payload de busca legado, sem envelope data/meta.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "202": { "$ref": "#/components/responses/AsyncAccepted" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "description": "Saldo insuficiente.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } } } } } }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "deprecated": true } } }, "components": { "securitySchemes": { "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "Chave de API fornecida pelo BuscaProcessos." }, "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API key", "description": "Alternativa aceita à chave x-api-key." }, "downloadTokenAuth": { "type": "apiKey", "in": "query", "name": "download_token", "description": "Token temporário incluído automaticamente no downloadUrl de documentos públicos." } }, "schemas": { "GenericObject": { "type": "object", "additionalProperties": true, "description": "Objeto de resposta específico do endpoint; consulte os campos retornados pela operação." }, "PublicApiMeta": { "type": "object", "additionalProperties": false, "required": [ "creditsCharged", "creditsRemaining", "requestId", "searchLogId", "servedAt" ], "properties": { "creditsCharged": { "type": "number", "description": "Créditos debitados por esta chamada." }, "creditsRemaining": { "type": "number", "description": "Saldo disponível após a chamada." }, "requestId": { "type": "string", "description": "Identificador da requisição para suporte e auditoria." }, "searchLogId": { "type": [ "string", "null" ], "description": "Identificador do registro de consumo." }, "servedAt": { "type": "string", "pattern": "^\\d{2}:\\d{2}:\\d{2}$", "description": "Horário brasileiro de geração da resposta, no formato HH:mm:ss." }, "search": { "type": [ "object", "null" ], "additionalProperties": false, "description": "Cobertura aplicada pela busca textual quando disponível.", "properties": { "mode": { "type": "string", "enum": [ "LOCAL_INDEX", "OFFICIAL_DATE_RANGE" ] }, "period": { "type": [ "object", "null" ], "additionalProperties": false, "properties": { "field": { "type": "string", "enum": [ "data_publicacao" ] }, "start": { "type": "string", "format": "date" }, "end": { "type": "string", "format": "date" } } }, "tribunal": { "type": [ "string", "null" ] }, "partial": { "type": "boolean" }, "cacheHit": { "type": "boolean" } } } } }, "AsyncProcessingResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "type": "object", "additionalProperties": false, "required": [ "status", "requestId", "statusUrl", "pollAfterMs", "pollAfterSeconds", "nextPollAt", "submittedAt" ], "properties": { "status": { "type": "string", "enum": [ "PROCESSANDO" ] }, "requestId": { "type": "string", "format": "uuid", "description": "Identificador do job HTTP usado na statusUrl." }, "message": { "type": "string" }, "statusUrl": { "type": "string", "format": "uri" }, "pollAfterMs": { "type": "integer", "minimum": 1000, "description": "Intervalo recomendado antes do próximo polling, em milissegundos." }, "pollAfterSeconds": { "type": "integer", "minimum": 1, "description": "Intervalo recomendado antes do próximo polling, em segundos." }, "nextPollAt": { "type": "string", "format": "date-time", "description": "Instante ISO 8601 recomendado para a próxima tentativa." }, "submittedAt": { "type": "string", "format": "date-time" } } }, "meta": { "type": "object", "additionalProperties": true, "required": [ "creditsCharged" ], "properties": { "creditsCharged": { "type": "number", "enum": [ 0 ], "description": "O estado pendente não gera débito adicional." } } } } }, "ApiError": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "example": "API_KEY_REQUIRED" }, "message": { "type": "string", "example": "Envie a chave em x-api-key ou Authorization: Bearer." }, "retryable": { "type": [ "boolean", "null" ] }, "availableCredits": { "type": [ "number", "null" ] }, "requiredCredits": { "type": [ "number", "null" ] } } }, "OabTribunalSearchRequest": { "type": "object", "required": [ "tribunal", "oab_estado", "oab_numero" ], "properties": { "tribunal": { "type": "string", "example": "TJSP" }, "oab_estado": { "type": "string", "minLength": 2, "maxLength": 2, "example": "SP" }, "oab_numero": { "type": "string", "example": "123456" }, "permitir_parcial": { "type": "boolean" }, "enviar_callback": { "type": "boolean" } } }, "IntimacaoOabRequest": { "type": "object", "properties": { "oabs": { "type": "array", "items": { "type": "object" } }, "oab_estado": { "type": "string", "example": "SP" }, "oab_numero": { "type": "string", "example": "123456" }, "termos_auxiliares": { "type": "array", "items": { "type": "string" } }, "origens_ids": { "type": "array", "items": { "type": "integer" } }, "webhook_url": { "type": [ "string", "null" ], "format": "uri" } } }, "ProcessMonitoringRequest": { "type": "object", "required": [ "numero_cnj" ], "properties": { "numero_cnj": { "type": "string", "example": "0000000-00.2026.8.26.0000" }, "tribunal": { "type": [ "string", "null" ] }, "frequencia": { "type": "string", "enum": [ "DIARIA", "SEMANAL", "MENSAL" ] }, "customer_email": { "type": [ "string", "null" ], "format": "email", "maxLength": 254, "description": "Destinatário adicional dos alertas. Quando omitido, o e-mail da conta responsável continua recebendo as notificações." } } }, "NewProcessMonitoringRequest": { "type": "object", "properties": { "termo": { "type": "string" }, "nome": { "type": "string" }, "variacoes": { "type": "array", "items": { "type": "string" } }, "webhook_url": { "type": [ "string", "null" ], "format": "uri" } } }, "JudicialPublicationMonitoringRequest": { "type": "object", "additionalProperties": false, "anyOf": [ { "required": [ "termo" ] }, { "required": [ "processo" ] }, { "required": [ "oab_numero", "oab_uf" ] } ], "properties": { "nome": { "type": [ "string", "null" ], "maxLength": 120 }, "fontes": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "STF_DJE", "TSE_DJE", "TRE_DJE", "MURAL_ELEITORAL" ] }, "default": [ "STF_DJE", "TSE_DJE", "TRE_DJE", "MURAL_ELEITORAL" ] }, "tribunais": { "type": "array", "maxItems": 5, "uniqueItems": true, "items": { "type": "string", "pattern": "^(TSE|TRE-[A-Z]{2})$", "example": "TRE-SP" }, "description": "Obrigatório para fontes eleitorais. Inclua TSE para TSE_DJE e ao menos um TRE para TRE_DJE." }, "termo": { "type": [ "string", "null" ], "maxLength": 200 }, "processo": { "type": [ "string", "null" ], "description": "Número CNJ com 20 dígitos, com ou sem pontuação." }, "oab_numero": { "type": [ "string", "null" ], "maxLength": 20 }, "oab_uf": { "type": [ "string", "null" ], "minLength": 2, "maxLength": 2 }, "webhook_url": { "type": [ "string", "null" ], "format": "uri", "description": "URL HTTPS que receberá publicacao_judicial_nova." }, "intervalo_minutos": { "type": "integer", "minimum": 5, "maximum": 1440, "default": 15 }, "notificar_existentes": { "type": "boolean", "default": false } } }, "AdministrativeProcessRequest": { "type": "object", "additionalProperties": false, "properties": { "fonte": { "type": "string", "enum": [ "AUTO", "PROTOCOLO_INTEGRADO", "IBAMA_SEI" ], "default": "AUTO" }, "incluir_documentos": { "type": "boolean", "default": true }, "limite_documentos": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 }, "limite_movimentacoes": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 } } }, "AdministrativeProcessMonitoringRequest": { "type": "object", "additionalProperties": false, "required": [ "nup" ], "properties": { "nome": { "type": [ "string", "null" ], "maxLength": 120 }, "nup": { "type": "string", "minLength": 13, "maxLength": 40, "example": "02001.003002/2021-17" }, "fonte": { "type": "string", "enum": [ "AUTO", "PROTOCOLO_INTEGRADO", "IBAMA_SEI" ], "default": "AUTO" }, "webhook_url": { "type": [ "string", "null" ], "format": "uri", "description": "URL HTTPS que receberá movimentacao_processo_administrativo_nova." }, "intervalo_minutos": { "type": "integer", "minimum": 60, "maximum": 10080, "default": 1440 }, "notificar_existentes": { "type": "boolean", "default": false } } }, "ProcessUpdateRequest": { "type": "object", "additionalProperties": false, "properties": { "documentos_publicos": { "type": "boolean", "description": "Solicita captura de documentos públicos quando o tribunal tiver suporte próprio." } } }, "WebhookEvent": { "type": "object", "required": [ "id", "event", "source", "created_at", "data" ], "properties": { "id": { "type": "string", "example": "evt_01HXYZ1234567890" }, "event": { "type": "string", "description": "Nome do evento habilitado para a conta ou monitoramento, incluindo publicacao_judicial_nova e movimentacao_processo_administrativo_nova.", "example": "publicacao_judicial_nova" }, "source": { "type": "string", "enum": [ "BUSCAPROCESSOS" ] }, "created_at": { "type": "string", "format": "date-time" }, "data": { "type": "object", "additionalProperties": true }, "raw": { "type": "object", "additionalProperties": true, "description": "Incluído quando o formato do webhook estiver BOTH." } } }, "CallbackAcknowledgement": { "type": "object", "description": "O endpoint do cliente deve responder rapidamente com qualquer status HTTP 2xx. O corpo da resposta não é usado como contrato de negócio." }, "verificarSaudeApiResponse": { "type": "object", "additionalProperties": false, "properties": { "service": { "type": "string" }, "version": { "type": "string" }, "authentication": { "type": "object", "additionalProperties": false, "properties": { "header": { "type": "string" }, "fallback": { "type": "string" } } }, "endpoints": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "method": { "type": "string" }, "path": { "type": "string" }, "description": { "type": "string" } } } } } }, "consultarSaldoDaContaResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "credits": { "type": "number" }, "currency": { "type": "string" }, "accountStatus": { "type": "string" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "buscarPorTermoResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "paginator": { "type": "object", "additionalProperties": false, "properties": { "total": { "type": "integer" }, "total_pages": { "type": "integer" }, "current_page": { "type": "integer" }, "per_page": { "type": "integer" } } }, "links": { "type": "object", "additionalProperties": false, "properties": { "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } } }, "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "resumo": { "type": [ "string", "null" ] }, "quantidade_processos": { "type": [ "integer", "null" ] }, "quantidade_publicacoes": { "type": "integer", "minimum": 1, "description": "Quantidade de publicações consolidadas no item. Pode ser maior que 1 quando a deduplicação por processo está ativa." }, "tipo_resultado": { "type": "string" }, "link": { "type": [ "string", "null" ] }, "link_api": { "type": [ "string", "null" ] }, "data_publicacao": { "type": [ "string", "null" ] }, "tribunal": { "type": [ "string", "null" ] }, "orgao": { "type": [ "string", "null" ] }, "classe": { "type": [ "string", "null" ] }, "numero_processo": { "type": [ "string", "null" ] }, "tipo_comunicacao": { "type": [ "string", "null" ] }, "texto": { "type": [ "string", "null" ] }, "assuntos": { "type": "array", "description": "Assuntos processuais encontrados no enriquecimento, quando disponíveis.", "items": { "type": "string" } }, "movimentacoes": { "type": "array", "description": "Movimentações processuais encontradas no enriquecimento, quando disponíveis.", "items": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": [ "string", "null" ] }, "descricao": { "type": [ "string", "null" ] }, "codigo": { "type": [ "integer", "null" ] } } } } } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "number" }, "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" }, "search": { "type": "object", "additionalProperties": false, "properties": { "mode": { "type": "string" }, "period": { "type": [ "object", "null" ], "additionalProperties": false, "properties": { "field": { "type": "string" }, "start": { "type": "string" }, "end": { "type": "string" } } }, "tribunal": { "type": [ "string", "null" ] }, "partial": { "type": "boolean" }, "cacheHit": { "type": "boolean" }, "totalExact": { "type": "boolean" }, "filters": { "type": "object", "additionalProperties": false, "properties": { "publicationYear": { "type": "integer" }, "requestedTribunal": { "type": "string" }, "className": { "type": "string" }, "deduplicateByProcess": { "type": "boolean" } } }, "quality": { "type": "object", "additionalProperties": false, "properties": { "rawResults": { "type": "integer" }, "classFilteredOut": { "type": "integer" }, "duplicatesRemoved": { "type": "integer" }, "returnedResults": { "type": "integer" }, "uniqueProcesses": { "type": "integer" }, "itemsWithoutProcessNumber": { "type": "integer" } } }, "warnings": { "type": "array", "items": { "type": "string" } } } } } } } }, "listarPrecatoriosResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "paginator": { "type": "object", "additionalProperties": false, "properties": { "total": { "type": "integer" }, "total_pages": { "type": "integer" }, "current_page": { "type": "integer" }, "per_page": { "type": "integer" } } }, "links": { "type": "object", "additionalProperties": false, "properties": { "prev": { "type": "null" }, "next": { "type": "string" } } }, "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "numero_processo": { "type": "string" }, "numero_processo_sem_mascara": { "type": "string" }, "tribunal": { "type": "string" }, "uf": { "type": "string" }, "classe": { "type": "string" }, "codigo_classe": { "type": "integer" }, "data_ajuizamento": { "type": "string" }, "atualizado_na_fonte": { "type": "string" }, "valor_causa": { "type": "number" }, "valor_original": { "type": "null" }, "valor_atualizado": { "type": "number" }, "valor_requisitado": { "type": "number" }, "saldo_individual": { "type": "null" }, "posicao_ordem_cronologica": { "type": "integer" }, "nivel_sigilo": { "type": "integer" }, "parte_credora": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "documento": { "type": "string" } } }, "devedor": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "documento": { "type": "string" } } }, "ente_devedor": { "type": "string" }, "cnpj_ente_devedor": { "type": "string" }, "referencia_orcamentaria": { "type": "string" }, "ano_orcamentario": { "type": "integer" }, "natureza_credito": { "type": "string" }, "natureza_credito_detalhada": { "type": "string" }, "preferencia": { "type": "string" }, "preferencia_pagamento": { "type": "string" }, "superpreferencial": { "type": "boolean" }, "fundamento_preferencia": { "type": "string" }, "fonte_natureza": { "type": "string" }, "consultado_em": { "type": "string" }, "evidencia": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "requisicao_id": { "type": "string" }, "signal": { "type": "string" }, "excerpt": { "type": "string" }, "at": { "type": "string" } } } }, "classificacao_credito": { "type": "object", "additionalProperties": false, "properties": { "natureza": { "type": "string" }, "natureza_detalhada": { "type": "string" }, "preferencia": { "type": "string" }, "preferencia_pagamento": { "type": "string" }, "superpreferencial": { "type": "boolean" }, "fundamento_preferencia": { "type": "string" }, "fonte_natureza": { "type": "string" }, "consultado_em": { "type": "string" }, "evidencias": { "type": "array", "items": { "type": "string" } }, "criterio": { "type": "string" } } }, "confianca_correspondencia": { "type": "number" }, "partes": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "polo": { "type": "string" }, "tipo": { "type": "string" }, "cpf": { "type": "string" }, "cnpj": { "type": "null" }, "documento": { "type": "string" }, "tipo_pessoa": { "type": "string" } } } }, "orcamentos": { "type": "array", "items": { "type": "string" } }, "quantidade_requisicoes": { "type": "integer" }, "requisicoes_retornadas": { "type": "integer" }, "requisicoes_truncadas": { "type": "boolean" }, "requisicoes": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "parte_credora": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "documento": { "type": "string" } } }, "devedor": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "documento": { "type": "string" } } }, "identificadores": { "type": "object", "additionalProperties": false, "properties": { "identificador_origem": { "type": "string" }, "numero_historico": { "type": "null" }, "numero_proprio_requisicao": { "type": "null" }, "oficio_requisitorio": { "type": "null" } } }, "pagamento": { "type": "object", "additionalProperties": false, "properties": { "estagio": { "type": "string" }, "data_pagamento": { "type": "null" }, "criterio_data_pagamento": { "type": "string" }, "data_evidencia_pagamento": { "type": "null" }, "desagio_percentual": { "type": "null" }, "grupo_acordo": { "type": "null" }, "posicao_no_grupo": { "type": "null" }, "posicao_ordem_cronologica": { "type": "integer" }, "valor_pago": { "type": "null" }, "evidencias": { "type": "array", "items": { "type": "string" } } } }, "especie": { "type": "string" }, "classificacao": { "type": "object", "additionalProperties": false, "properties": { "natureza_processual": { "type": "string" }, "natureza_credito": { "type": "string" }, "natureza_credito_padronizada": { "type": "string" }, "preferencia": { "type": "string" }, "categoria_credito": { "type": "string" }, "preferencia_pagamento": { "type": "string" }, "prioridade_informada": { "type": "null" }, "superpreferencial": { "type": "boolean" }, "fundamento_preferencia": { "type": "string" }, "fonte_natureza": { "type": "string" }, "consultado_em": { "type": "string" }, "fonte_classificacao": { "type": "string" }, "evidencias": { "type": "array", "items": { "type": "string" } } } }, "situacao_processual": { "type": "object", "additionalProperties": false, "properties": { "codigo": { "type": "integer" }, "descricao": { "type": "string" }, "desde": { "type": "string" }, "ultimo_movimento": { "type": "object", "additionalProperties": false, "properties": { "codigo": { "type": "integer" }, "descricao": { "type": "string" }, "data": { "type": "string" } } } } }, "ordem_pagamento": { "type": "object", "additionalProperties": false, "properties": { "posicao_cronologica": { "type": "integer" }, "posicao_superpreferencia": { "type": "null" }, "total_na_fila": { "type": "integer" }, "ano_orcamentario": { "type": "integer" }, "fonte_individual_disponivel": { "type": "boolean" } } }, "financeiro": { "type": "object", "additionalProperties": false, "properties": { "valor_causa": { "type": "number" }, "valor_requisitado": { "type": "number" }, "valor_atualizado": { "type": "number" }, "saldo_individual": { "type": "null" }, "valor_liquido": { "type": "null" }, "valor_pago": { "type": "null" }, "pagamentos_parciais": { "type": "null" }, "data_base": { "type": "null" }, "indice_atualizacao": { "type": "null" }, "juros": { "type": "null" }, "ausencias": { "type": "object", "additionalProperties": false, "properties": { "saldo_individual": { "type": "object", "additionalProperties": false, "properties": { "codigo": { "type": "string" }, "mensagem": { "type": "string" } } } } } } }, "eventos_juridicos": { "type": "object", "additionalProperties": false, "properties": { "bloqueio": { "type": "object", "additionalProperties": false, "properties": { "identificado": { "type": "null" }, "evidencias": { "type": "array", "items": { "type": "string" } } } }, "cessao": { "type": "object", "additionalProperties": false, "properties": { "identificado": { "type": "null" }, "evidencias": { "type": "array", "items": { "type": "string" } } } }, "penhora": { "type": "object", "additionalProperties": false, "properties": { "identificado": { "type": "null" }, "evidencias": { "type": "array", "items": { "type": "string" } } } }, "habilitacao": { "type": "object", "additionalProperties": false, "properties": { "identificado": { "type": "null" }, "evidencias": { "type": "array", "items": { "type": "string" } } } }, "sucessao": { "type": "object", "additionalProperties": false, "properties": { "identificado": { "type": "null" }, "evidencias": { "type": "array", "items": { "type": "string" } } } }, "impugnacao": { "type": "object", "additionalProperties": false, "properties": { "identificado": { "type": "null" }, "evidencias": { "type": "array", "items": { "type": "string" } } } }, "suspensao": { "type": "object", "additionalProperties": false, "properties": { "identificado": { "type": "null" }, "evidencias": { "type": "array", "items": { "type": "string" } } } }, "reserva_honorarios": { "type": "object", "additionalProperties": false, "properties": { "identificado": { "type": "null" }, "evidencias": { "type": "array", "items": { "type": "string" } } } }, "transito_em_julgado": { "type": "object", "additionalProperties": false, "properties": { "identificado": { "type": "null" }, "evidencias": { "type": "array", "items": { "type": "string" } } } } } }, "risco_cessao": { "type": "object", "additionalProperties": false, "properties": { "classificacao": { "type": "string" }, "fatores_identificados": { "type": "array", "items": { "type": "string" } } } }, "confiabilidade_dados": { "type": "object", "additionalProperties": false, "properties": { "score": { "type": "integer" }, "nivel": { "type": "string" }, "escopo": { "type": "string" }, "nao_representa": { "type": "array", "items": { "type": "string" } } } }, "qualidade": { "type": "object", "additionalProperties": false, "properties": { "completude_cadastral": { "type": "object", "additionalProperties": false, "properties": { "score": { "type": "integer" }, "nivel": { "type": "string" }, "pendencias": { "type": "array", "items": { "type": "string" } } } }, "confianca_evidencia": { "type": "object", "additionalProperties": false, "properties": { "score": { "type": "integer" }, "criterio": { "type": "string" } } }, "atualidade": { "type": "object", "additionalProperties": false, "properties": { "idade_dias": { "type": "integer" }, "rotulo": { "type": "string" }, "score": { "type": "integer" } } }, "risco_aquisicao": { "type": "object", "additionalProperties": false, "properties": { "classificacao": { "type": "string" }, "fatores": { "type": "array", "items": { "type": "string" } } } } } }, "proxima_acao_recomendada": { "type": "string" }, "completude": { "type": "object", "additionalProperties": false, "properties": { "nivel": { "type": "string" }, "campos_obtidos": { "type": "integer" }, "campos_criticos_pendentes": { "type": "array", "items": { "type": "string" } }, "atualizado_na_fonte": { "type": "string" } } } } } }, "confiabilidade_dados": { "type": "object", "additionalProperties": false, "properties": { "score": { "type": "integer" }, "nivel": { "type": "string" }, "escopo": { "type": "string" }, "fatores_positivos": { "type": "array", "items": { "type": "string" } }, "pendencias": { "type": "array", "items": { "type": "string" } }, "nao_representa": { "type": "array", "items": { "type": "string" } } } }, "status_pagamento": { "type": "string" }, "pagamento_verificado_em": { "type": "string" }, "cobertura": { "type": "object", "additionalProperties": false, "properties": { "categoria": { "type": "string" }, "fonte": { "type": "string" }, "tribunal": { "type": "object", "additionalProperties": false, "properties": { "tribunal": { "type": "string" }, "campos_disponiveis": { "type": "array", "items": { "type": "string" } } } } } }, "qualidade": { "type": "object", "additionalProperties": false, "properties": { "completude_cadastral": { "type": "object", "additionalProperties": false, "properties": { "score": { "type": "integer" }, "nivel": { "type": "string" }, "escopo": { "type": "string" }, "fatores_positivos": { "type": "array", "items": { "type": "string" } }, "pendencias": { "type": "array", "items": { "type": "string" } }, "nao_representa": { "type": "array", "items": { "type": "string" } } } }, "confianca_evidencia": { "type": "object", "additionalProperties": false, "properties": { "score": { "type": "integer" }, "criterio": { "type": "string" } } }, "atualidade": { "type": "object", "additionalProperties": false, "properties": { "idade_dias": { "type": "integer" }, "rotulo": { "type": "string" }, "score": { "type": "integer" } } }, "risco_aquisicao": { "type": "object", "additionalProperties": false, "properties": { "classificacao": { "type": "string" }, "fatores": { "type": "array", "items": { "type": "string" } } } } } }, "proxima_acao_recomendada": { "type": "string" } } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "number" }, "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" }, "search": { "type": "object", "additionalProperties": false, "properties": { "mode": { "type": "string" }, "source": { "type": "string" }, "totalExactWithinIndex": { "type": "boolean" }, "prioritization": { "type": "object", "additionalProperties": false, "properties": { "strategy": { "type": "string" }, "completeForProspecting": { "type": "integer" }, "completeForDecision": { "type": "integer" }, "criteria": { "type": "array", "items": { "type": "string" } } } }, "coverage": { "type": "object", "additionalProperties": false, "properties": { "status": { "type": "string" }, "indexedProcesses": { "type": "integer" }, "upstreamTotal": { "type": "integer" }, "percent": { "type": "number" }, "lastSuccessfulSync": { "type": "string" }, "lastErrorCode": { "type": "null" } } }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "listarProcessosPorDocumentoResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "document": { "type": "string" }, "documentType": { "type": "string" }, "envolvido": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "quantidade_processos": { "type": "integer" }, "tipoPessoa": { "type": "string" }, "quantidadeProcessos": { "type": "integer" }, "raw": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "quantidade_processos": { "type": "integer" } } } } }, "processos": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "numero_cnj": { "type": "string" }, "titulo_polo_ativo": { "type": "string" }, "titulo_polo_passivo": { "type": "string" }, "ano_inicio": { "type": "integer" }, "data_inicio": { "type": "string" }, "data_ultima_movimentacao": { "type": "string" }, "quantidade_movimentacoes": { "type": "integer" }, "fontes": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer" }, "processo_fonte_id": { "type": "integer" }, "descricao": { "type": "string" }, "nome": { "type": "string" }, "sigla": { "type": "string" }, "tipo": { "type": "string" }, "grau": { "type": "integer" }, "grau_formatado": { "type": "string" }, "sistema": { "type": "string" }, "capa": { "type": "object", "additionalProperties": false, "properties": { "classe": { "type": "string" }, "assunto": { "type": "string" }, "area": { "type": "string" }, "valor_causa": { "type": "object", "additionalProperties": false, "properties": { "valor": { "type": "string" }, "moeda": { "type": "string" }, "valor_formatado": { "type": "string" } } }, "data_distribuicao": { "type": "string" } } }, "tribunal": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "sigla": { "type": "string" }, "categoria": { "type": "null" } } }, "envolvidos": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "tipo": { "type": "string" }, "polo": { "type": "string" }, "advogados": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" } } } }, "cnpj": { "type": "string" } } } } } } }, "numeroCnj": { "type": "string" }, "poloAtivo": { "type": "string" }, "poloPassivo": { "type": "string" }, "raw": { "type": "object", "additionalProperties": false, "properties": { "...": { "type": "string" } } } } } }, "total": { "type": "integer" }, "pagination": { "type": "object", "additionalProperties": false, "properties": { "per_page": { "type": "integer" } } }, "links": { "type": "object", "additionalProperties": false, "properties": { "next": { "type": "object", "additionalProperties": false, "properties": { "href": { "type": "string" }, "cursor": { "type": "string" }, "li": { "type": "string" } } } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "obterResumoDoEnvolvidoResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "tipoPessoa": { "type": "string" }, "quantidadeProcessos": { "type": "integer" }, "query": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "null" }, "cpfCnpj": { "type": "string" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "listarProcessosPorOabResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "advogado": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "tipo": { "type": "string" }, "quantidadeProcessos": { "type": "integer" }, "quantidadeRecentes": { "type": "integer" }, "quantidadeHistoricos": { "type": "integer" }, "quantidadeAtivosConfirmados": { "type": "integer" } } }, "processos": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "numeroCnj": { "type": "string" }, "poloAtivo": { "type": [ "string", "null" ], "description": "Nome do polo ativo quando disponível ou enriquecido de fonte oficial." }, "poloPassivo": { "type": [ "string", "null" ], "description": "Nome do polo passivo quando disponível ou enriquecido de fonte oficial." }, "anoInicio": { "type": "integer" }, "dataUltimaPublicacao": { "type": "string" }, "quantidadePublicacoes": { "type": "integer" }, "classificacao": { "type": "string" }, "ativo": { "type": "null" }, "statusProcessual": { "type": "string" }, "classe": { "type": "string" }, "orgaoJulgador": { "type": "string" }, "fontes": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "tribunal": { "type": "string" }, "sigla": { "type": "string" }, "tipo": { "type": "string" }, "origem": { "type": "string" }, "ultimaPublicacao": { "type": "string" }, "quantidadePublicacoes": { "type": "integer" } } } }, "evidencia": { "type": "object", "additionalProperties": false, "properties": { "tipo": { "type": "string" }, "oab": { "type": "string" }, "publicacoes": { "type": "integer" }, "ultimaPublicacao": { "type": "string" }, "link": { "type": "null" } } }, "raw": { "type": "object", "additionalProperties": false, "properties": { "numero_cnj": { "type": "string" }, "ano_inicio": { "type": "integer" }, "data_ultima_movimentacao": { "type": "string" }, "quantidade_movimentacoes": { "type": "integer" }, "origem": { "type": "string" } } } } } }, "total": { "type": "integer" }, "totalDisponivel": { "type": "integer" }, "totalPortfolio": { "type": "integer" }, "pagination": { "type": "object", "additionalProperties": false, "properties": { "currentPage": { "type": "integer" }, "perPage": { "type": "integer" }, "totalPages": { "type": "integer" }, "total": { "type": "integer" } } }, "links": { "type": "object", "additionalProperties": false, "properties": { "next": { "type": "object", "additionalProperties": false, "properties": { "href": { "type": "string" }, "page": { "type": "integer" } } } } }, "cobertura": { "type": "object", "additionalProperties": false, "properties": { "fonte": { "type": "string" }, "origens": { "type": "array", "items": { "type": "string" } }, "vinculo": { "type": "string" }, "statusProcessual": { "type": "string" }, "completa": { "type": "boolean", "description": "Quando true, a cobertura histórica terminou e a paginação pode ser percorrida como uma coleta completa." }, "parcial": { "type": "boolean", "description": "Quando true, os totais e a quantidade de páginas ainda são provisórios e podem crescer." }, "motivoParcial": { "type": [ "string", "null" ], "description": "Motivo ou progresso da cobertura parcial." }, "comunicacoesEncontradas": { "type": "integer" }, "paginasConsultadas": { "type": "integer", "description": "Quantidade de páginas da fonte oficial já incorporadas ao índice." }, "totalPaginasFonte": { "type": [ "integer", "null" ], "description": "Total conhecido de páginas da fonte oficial; pode ser null antes da primeira página." }, "atualizadoEm": { "type": "string", "description": "Versão temporal da coleta. Se mudar durante uma importação, reinicie ou reconcilie por numeroCnj." }, "servidoDoCache": { "type": "boolean" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "obterResumoDoAdvogadoResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "advogado": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "tipo": { "type": "string" }, "quantidadeProcessos": { "type": "integer" }, "quantidadeRecentes": { "type": "integer" }, "quantidadeHistoricos": { "type": "integer" }, "quantidadeAtivosConfirmados": { "type": "integer" } } }, "cobertura": { "type": "object", "additionalProperties": false, "properties": { "fonte": { "type": "string" }, "origens": { "type": "array", "items": { "type": "string" } }, "vinculo": { "type": "string" }, "statusProcessual": { "type": "string" }, "completa": { "type": "boolean", "description": "Quando true, as contagens representam a cobertura histórica concluída naquele momento." }, "parcial": { "type": "boolean", "description": "Quando true, quantidadeProcessos, quantidadeRecentes e quantidadeHistoricos ainda são provisórios." }, "motivoParcial": { "type": [ "string", "null" ], "description": "Motivo ou progresso da cobertura parcial." }, "comunicacoesEncontradas": { "type": "integer" }, "paginasConsultadas": { "type": "integer", "description": "Quantidade de páginas da fonte oficial já incorporadas ao índice." }, "totalPaginasFonte": { "type": [ "integer", "null" ] }, "atualizadoEm": { "type": "string", "description": "Versão temporal da coleta usada para produzir as contagens." }, "servidoDoCache": { "type": "boolean" } } }, "query": { "type": "object", "additionalProperties": false, "properties": { "oabEstado": { "type": "string" }, "oabNumero": { "type": "string" }, "oabTipo": { "type": "null" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "listarDiariosOficiaisPorOabResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "oabEstado": { "type": "string" }, "oabNumero": { "type": "string" }, "processos": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "numeroNovo": { "type": "string" }, "diario": { "type": "object", "additionalProperties": false, "properties": { "sigla": { "type": "string" }, "nome": { "type": "string" }, "estado": { "type": "string" } } }, "dataMovimentacoes": { "type": "string" }, "quantidadeMovimentacoes": { "type": "integer" }, "ultimasMovimentacoes": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "string" }, "conteudoResumo": { "type": "string" }, "envolvidos": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "papel": { "type": "string" }, "oab": { "type": "string" } } } }, "link": { "type": "string" }, "linkPublicacaoTribunal": { "type": "string" } } } } } } }, "total": { "type": "integer" }, "pagination": { "type": "object", "additionalProperties": false, "properties": { "current_page": { "type": "integer" }, "last_page": { "type": "integer" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "solicitarBuscaPorOabEmTribunalResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "monitoramento": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "tribunal": { "type": "object", "additionalProperties": false, "properties": { "sigla": { "type": "string" }, "nome": { "type": "string" }, "buscaOab": { "type": "boolean" } } }, "statusUrl": { "type": "string" } } }, "query": { "type": "object", "additionalProperties": false, "properties": { "tribunal": { "type": "string" }, "oabEstado": { "type": "string" }, "oabNumero": { "type": "string" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "consultarStatusBuscaPorOabResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "monitoramento": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "tribunal": { "type": "object", "additionalProperties": false, "properties": { "sigla": { "type": "string" }, "nome": { "type": "string" } } }, "resposta": { "type": "object", "additionalProperties": false, "properties": { "processos": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "numero_cnj": { "type": "string" }, "sistema": { "type": "string" } } } } } } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "listarMonitoramentosDeIntimacoesResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "oab": { "type": "object", "additionalProperties": false, "properties": { "estado": { "type": "string" }, "numero": { "type": "string" } } }, "termo": { "type": "string" }, "status": { "type": "string" }, "webhookUrl": { "type": "string" }, "criadoEm": { "type": "string" }, "atualizadoEm": { "type": "string" } } } }, "pagination": { "type": "object", "additionalProperties": false, "properties": { "currentPage": { "type": "integer" }, "perPage": { "type": "integer" }, "hasNextPage": { "type": "boolean" }, "totalItems": { "type": "integer" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "criarMonitoramentoDeIntimacoesResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "oabs": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "estado": { "type": "string" }, "numero": { "type": "string" } } } }, "monitoramentos": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "estado": { "type": "string" }, "numero": { "type": "string" }, "termo": { "type": "string" }, "status": { "type": "string" }, "callbackEnabled": { "type": "boolean" }, "reused": { "type": "boolean" } } } }, "callback": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string" } } }, "billing": { "type": "object", "additionalProperties": false, "properties": { "billableOabs": { "type": "integer" }, "pricePerNewOab": { "type": "number" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "atualizarMonitoramentoDeIntimacoesResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "oab": { "type": "object", "additionalProperties": false, "properties": { "estado": { "type": "string" }, "numero": { "type": "string" } } }, "status": { "type": "string" }, "webhookUrl": { "type": "string" }, "message": { "type": "string" }, "billing": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "integer" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "integer" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "removerMonitoramentoDeIntimacoesResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "oab": { "type": "object", "additionalProperties": false, "properties": { "estado": { "type": "string" }, "numero": { "type": "string" } } }, "status": { "type": "string" }, "message": { "type": "string" }, "billing": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "integer" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "integer" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "listarIntimacoesResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "oabs": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "estado": { "type": "string" }, "numero": { "type": "string" } } } }, "intimacoes": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "oab": { "type": "object", "additionalProperties": false, "properties": { "estado": { "type": "string" }, "numero": { "type": "string" } } }, "dataPublicacao": { "type": "string" }, "diario": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "sigla": { "type": "string" } } }, "processo": { "type": "object", "additionalProperties": false, "properties": { "numeroCnj": { "type": "string" }, "titulo": { "type": "null" } } }, "titulo": { "type": "string" }, "conteudo": { "type": "string" }, "conteudoCompletoHtml": { "type": "string" }, "linkPublicacaoTribunal": { "type": "string" } } } }, "total": { "type": "integer" }, "missingMonitorings": { "type": "array", "items": { "type": "string" } }, "filters": { "type": "object", "additionalProperties": false, "properties": { "desde": { "type": "string" } } }, "billing": { "type": "object", "additionalProperties": false, "properties": { "billableOabs": { "type": "integer" }, "pricePerOab": { "type": "number" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "integer" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "listarHistoricoDeIntimacoesResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "mode": { "type": "string" }, "oabs": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "estado": { "type": "string" }, "numero": { "type": "string" } } } }, "historico": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "oab": { "type": "object", "additionalProperties": false, "properties": { "estado": { "type": "string" }, "numero": { "type": "string" } } }, "dataPublicacao": { "type": "string" }, "diario": { "type": "object", "additionalProperties": false, "properties": { "sigla": { "type": "string" }, "nome": { "type": "string" }, "estado": { "type": "string" } } }, "pagina": { "type": "integer" }, "caderno": { "type": "string" }, "processo": { "type": "object", "additionalProperties": false, "properties": { "numeroCnj": { "type": "string" } } }, "titulo": { "type": "string" }, "conteudo": { "type": "string" }, "link": { "type": "string" }, "linkApi": { "type": "string" }, "linkPublicacaoTribunal": { "type": "string" }, "termoPesquisado": { "type": "string" } } } }, "intimacoes": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "dataPublicacao": { "type": "string" }, "processo": { "type": "object", "additionalProperties": false, "properties": { "numeroCnj": { "type": "string" } } }, "conteudo": { "type": "string" } } } }, "total": { "type": "integer" }, "filters": { "type": "object", "additionalProperties": false, "properties": { "desde": { "type": "string" } } }, "billing": { "type": "object", "additionalProperties": false, "properties": { "billableOabs": { "type": "integer" }, "billablePages": { "type": "integer" }, "pricePerPage": { "type": "number" }, "creditsCharged": { "type": "number" }, "paginationIncluded": { "type": "boolean" }, "chargedThisPage": { "type": "boolean" } } }, "links": { "type": "string" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "obterConteudoDaPublicacaoResponse": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer" }, "descricao": { "type": "string" }, "data_publicacao": { "type": "string" }, "link_publicacao_tribunal": { "type": "string" }, "paginas": { "type": "object", "additionalProperties": false, "properties": { "paginator": { "type": "object", "additionalProperties": false, "properties": { "current_page": { "type": "integer" }, "per_page": { "type": "integer" } } }, "items": { "type": "object", "additionalProperties": false, "properties": { "conteudo": { "type": "string" } } } } }, "movimentacoes": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer" }, "data": { "type": "string" }, "secao": { "type": "string" }, "conteudo": { "type": "string" }, "link": { "type": "string" }, "link_api": { "type": "string" }, "link_publicacao_tribunal": { "type": "string" } } } } } }, "pesquisarPublicacoesStfResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "tribunal": { "type": "string" }, "processo": { "type": "string" }, "tipo": { "type": "string" }, "relator": { "type": "string" }, "data_publicacao": { "type": "string" }, "texto": { "type": "string" } } } }, "paginator": { "type": "object", "additionalProperties": false, "properties": { "total": { "type": "integer" }, "total_pages": { "type": "integer" }, "current_page": { "type": "integer" }, "per_page": { "type": "integer" } } }, "filtros": { "type": "object", "additionalProperties": false, "properties": { "termo": { "type": "string" }, "data_inicio": { "type": "string" }, "data_fim": { "type": "string" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "number" }, "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "consultarPublicacaoStfResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "processo": { "type": "string" }, "tipo": { "type": "string" }, "data_publicacao": { "type": "string" }, "texto": { "type": "string" }, "html": { "type": "null" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "number" }, "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "listarEdicoesDjeEleitoralResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "tribunal": { "type": "string" }, "numero": { "type": "integer" }, "ano": { "type": "integer" }, "data_publicacao": { "type": "string" }, "tipo": { "type": "string" }, "documento": { "type": "object", "additionalProperties": false, "properties": { "status": { "type": "string" }, "download_automatizado": { "type": "boolean" }, "endpoint": { "type": "string" } } } } } }, "total": { "type": "integer" }, "filtros": { "type": "object", "additionalProperties": false, "properties": { "tribunal": { "type": "string" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "number" }, "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "pesquisarPublicacoesDjeEleitoralResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "tribunal": { "type": "string" }, "titulo": { "type": "string" }, "data_publicacao": { "type": "string" }, "trecho": { "type": "string" } } } }, "paginator": { "type": "object", "additionalProperties": false, "properties": { "total": { "type": "integer" }, "total_pages": { "type": "integer" }, "current_page": { "type": "integer" }, "per_page": { "type": "integer" } } }, "filtros": { "type": "object", "additionalProperties": false, "properties": { "tribunal": { "type": "string" }, "termo": { "type": "string" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "number" }, "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "consultarPublicacaoDjeEleitoralResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "tribunal": { "type": "string" }, "titulo": { "type": "string" }, "texto": { "type": "string" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "number" }, "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "pesquisarPublicacoesMuralEleitoralResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "decisao_id": { "type": "string" }, "tribunal": { "type": "string" }, "processo": { "type": "string" }, "data_publicacao": { "type": "string" }, "texto": { "type": "string" }, "documento_disponivel": { "type": "boolean" }, "certidao_disponivel": { "type": "boolean" } } } }, "paginator": { "type": "object", "additionalProperties": false, "properties": { "total": { "type": "integer" }, "total_pages": { "type": "integer" }, "current_page": { "type": "integer" }, "per_page": { "type": "integer" } } }, "filtros": { "type": "object", "additionalProperties": false, "properties": { "tribunais": { "type": "array", "items": { "type": "string" } }, "data_inicio": { "type": "string" }, "data_fim": { "type": "string" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "number" }, "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "listarTribunaisIntegradorResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "summary": { "type": "object", "additionalProperties": false, "properties": { "total": { "type": "integer" }, "habilitados": { "type": "integer" }, "desabilitados": { "type": "integer" }, "percentualCobertura": { "type": "string" } } }, "filtros": { "type": "object", "additionalProperties": false, "properties": { "enable": { "type": "boolean" }, "segmento": { "type": "null" }, "uf": { "type": "null" }, "tribunais": { "type": "null" }, "sistema": { "type": "null" } } }, "tribunais": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "sigla": { "type": "string" }, "nome": { "type": "string" }, "segmento": { "type": "string" }, "uf": { "type": "string" }, "enable": { "type": "boolean" }, "enabled": { "type": "boolean" }, "sistemas": { "type": "array" } } } }, "total": { "type": "integer" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "integer" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "listarSistemasDosTribunaisResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "filtros": { "type": "object", "additionalProperties": false, "properties": { "tribunais": { "type": "array", "items": { "type": "string" } }, "utilizaCertificadoDigital": { "type": "boolean" }, "utiliza2fa": { "type": "null" } } }, "sistemas": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "sistemaNome": { "type": "string" }, "tribunalSigla": { "type": "string" }, "tribunalNome": { "type": "string" }, "utilizaCertificadoDigital": { "type": "boolean" }, "utiliza2fa": { "type": "boolean" } } } }, "total": { "type": "integer" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "integer" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "consultarMandadosBnmpResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "cpf": { "type": "string" }, "nome": { "type": "null" }, "numero_peca": { "type": "null" }, "status": { "type": "string", "enum": [ "CONSTA", "NADA_CONSTA" ], "description": "CONSTA quando a fonte retorna ao menos um mandado; NADA_CONSTA quando a consulta válida retorna zero registros." }, "exists": { "type": "boolean" }, "count": { "type": "integer" }, "mandados": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "numero": { "type": "string" }, "nome": { "type": "string" }, "situacao": { "type": "string" }, "tipo": { "type": "string" }, "data_expedicao": { "type": "string" }, "orgao": { "type": "string" }, "peca_tipo_id": { "type": "integer" } } } }, "consultado_em": { "type": "string" }, "paginator": { "type": "object", "additionalProperties": false, "properties": { "page": { "type": "integer" }, "limit": { "type": "integer" }, "total": { "type": "integer" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "number" }, "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" }, "source": { "type": "string" }, "definitiveNegative": { "type": "boolean" } } } } }, "listarOrgaosAdministrativosResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "summary": { "type": "object", "additionalProperties": false, "properties": { "total_covered": { "type": "integer" }, "returned": { "type": "integer" }, "active": { "type": "integer" }, "beta": { "type": "integer" }, "by_source": { "type": "object", "additionalProperties": false, "properties": { "PROTOCOLO_INTEGRADO": { "type": "integer" }, "IBAMA_SEI": { "type": "integer" } } } } }, "filters": { "type": "object", "additionalProperties": false, "properties": { "fonte": { "type": "null" }, "status": { "type": "null" }, "q": { "type": "null" } } }, "sources": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "source": { "type": "string" }, "name": { "type": "string" }, "scope": { "type": "string" }, "query_by_nup": { "type": "boolean" }, "movements": { "type": "boolean" }, "document_index": { "type": "boolean" }, "document_contents": { "type": "boolean" }, "catalog_url": { "type": "string" } } } }, "orgaos": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "sigla": { "type": "string" }, "nome": { "type": "string" }, "fonte": { "type": "string" }, "status": { "type": "string" }, "homologado_em": { "type": [ "null", "string" ] }, "consulta_nup": { "type": "boolean" }, "capa": { "type": "boolean" }, "movimentacoes": { "type": "boolean" }, "indice_documentos": { "type": "boolean" }, "integra_documentos": { "type": "boolean" }, "escopo": { "type": "string" }, "restricoes": { "type": "array" }, "catalog_url": { "type": "string" } } } }, "routing": { "type": "object", "additionalProperties": false, "properties": { "automatic": { "type": "boolean" }, "ibama_nup_prefix": { "type": "string" }, "default_source": { "type": "string" } } }, "notes": { "type": "array", "items": { "type": "string" } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "integer" }, "creditsRemaining": { "type": "integer" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "consultarProcessoAdministrativoPorNupResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "nup": { "type": "string" }, "nup_digits": { "type": "string" }, "source": { "type": "string" }, "organ": { "type": "string" }, "type": { "type": "string" }, "subject": { "type": "string" }, "produced_at": { "type": "string" }, "interested_parties": { "type": "array", "items": { "type": "string" } }, "related_protocols": { "type": "array", "items": { "type": "string" } }, "latest_movement_at": { "type": "string" }, "movements": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "date_time": { "type": "string" }, "unit": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" } } } }, "documents": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "number": { "type": "string" }, "type": { "type": "string" }, "date": { "type": "string" }, "included_at": { "type": "string" }, "unit": { "type": "string" } } } }, "documents_complete": { "type": "boolean" }, "source_url": { "type": "string" }, "coverage": { "type": "object", "additionalProperties": false, "properties": { "metadata": { "type": "boolean" }, "movements": { "type": "boolean" }, "document_index": { "type": "boolean" }, "document_contents": { "type": "boolean" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "number" }, "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "consultarProcessoAdministrativoPorNupComOpcoesResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "nup": { "type": "string" }, "nup_digits": { "type": "string" }, "source": { "type": "string" }, "organ": { "type": "string" }, "type": { "type": "string" }, "subject": { "type": "string" }, "produced_at": { "type": "string" }, "interested_parties": { "type": "array", "items": { "type": "string" } }, "related_protocols": { "type": "array", "items": { "type": "string" } }, "latest_movement_at": { "type": "string" }, "movements": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "date_time": { "type": "string" }, "unit": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" } } } }, "documents": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "number": { "type": "string" }, "type": { "type": "string" }, "date": { "type": "string" }, "included_at": { "type": "string" }, "unit": { "type": "string" } } } }, "documents_complete": { "type": "boolean" }, "source_url": { "type": "string" }, "coverage": { "type": "object", "additionalProperties": false, "properties": { "metadata": { "type": "boolean" }, "movements": { "type": "boolean" }, "document_index": { "type": "boolean" }, "document_contents": { "type": "boolean" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "number" }, "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "consultarProcessoPorCnjResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "numeroCnj": { "type": "string" }, "poloAtivo": { "type": "string" }, "poloPassivo": { "type": "string" }, "numero_cnj": { "type": "string" }, "titulo_polo_ativo": { "type": "string" }, "titulo_polo_passivo": { "type": "string" }, "ano_inicio": { "type": "integer" }, "data_inicio": { "type": "string" }, "data_ultima_movimentacao": { "type": "string" }, "quantidade_movimentacoes": { "type": "integer" }, "fontes_tribunais_estao_arquivadas": { "type": "boolean" }, "data_ultima_verificacao": { "type": "string" }, "tempo_desde_ultima_verificacao": { "type": "string" }, "valor_causa": { "type": "object", "additionalProperties": false, "properties": { "valor": { "type": "string" }, "moeda": { "type": "string" }, "valor_formatado": { "type": "string" } } }, "valorCausa": { "type": "object", "additionalProperties": false, "properties": { "valor": { "type": "string" }, "moeda": { "type": "string" }, "valor_formatado": { "type": "string" } } }, "processos_relacionados": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "numero": { "type": "string" } } } }, "fontes": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer" }, "processo_fonte_id": { "type": "integer" }, "descricao": { "type": "string" }, "nome": { "type": "string" }, "sigla": { "type": "string" }, "tipo": { "type": "string" }, "grau": { "type": "integer" }, "grau_formatado": { "type": "string" }, "sistema": { "type": "string" }, "capa": { "type": "object", "additionalProperties": false, "properties": { "classe": { "type": "string" }, "assunto": { "type": "string" }, "area": { "type": "string" }, "orgao_julgador": { "type": "string" }, "situacao": { "type": "string" }, "valor_causa": { "type": "object", "additionalProperties": false, "properties": { "valor": { "type": "string" }, "moeda": { "type": "string" }, "valor_formatado": { "type": "string" } } }, "data_distribuicao": { "type": "string" } } }, "audiencias": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "tipo": { "type": "string" }, "data": { "type": "string" }, "quantidade_pessoas": { "type": "integer" }, "situacao": { "type": "string" } } } }, "tribunal": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "sigla": { "type": "string" }, "categoria": { "type": "null" } } }, "envolvidos": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "tipo": { "type": "string" }, "tipo_normalizado": { "type": "string" }, "polo": { "type": "string" }, "advogados": { "type": "array" } } } } } } }, "raw": { "type": "object", "additionalProperties": false, "properties": { "numero_cnj": { "type": "string" }, "titulo_polo_ativo": { "type": "string" }, "titulo_polo_passivo": { "type": "string" }, "ano_inicio": { "type": "integer" }, "data_inicio": { "type": "string" }, "estado_origem": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "sigla": { "type": "string" } } }, "unidade_origem": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "endereco": { "type": "string" }, "classificacao": { "type": "string" }, "cidade": { "type": "string" }, "estado": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "sigla": { "type": "string" } } }, "tribunal_sigla": { "type": "string" } } }, "data_ultima_movimentacao": { "type": "string" }, "quantidade_movimentacoes": { "type": "integer" }, "fontes_tribunais_estao_arquivadas": { "type": "boolean" }, "data_ultima_verificacao": { "type": "string" }, "tempo_desde_ultima_verificacao": { "type": "string" }, "processos_relacionados": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "numero": { "type": "string" } } } }, "fontes": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer" }, "processo_fonte_id": { "type": "integer" }, "descricao": { "type": "string" }, "nome": { "type": "string" }, "sigla": { "type": "string" }, "tipo": { "type": "string" }, "data_inicio": { "type": "string" }, "data_ultima_movimentacao": { "type": "string" }, "segredo_justica": { "type": "null" }, "arquivado": { "type": "null" }, "status_predito": { "type": "string" }, "grau": { "type": "integer" }, "grau_formatado": { "type": "string" }, "fisico": { "type": "boolean" }, "sistema": { "type": "string" }, "capa": { "type": "object", "additionalProperties": false, "properties": { "classe": { "type": "string" }, "assunto": { "type": "string" }, "assuntos_normalizados": { "type": "array" }, "assunto_principal_normalizado": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "nome_com_pai": { "type": "string" }, "path_completo": { "type": "string" }, "bloqueado": { "type": "boolean" } } }, "area": { "type": "string" }, "orgao_julgador": { "type": "string" }, "orgao_julgador_normalizado": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "endereco": { "type": "string" }, "classificacao": { "type": "string" }, "cidade": { "type": "string" }, "estado": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "sigla": { "type": "string" } } }, "tribunal_sigla": { "type": "string" } } }, "situacao": { "type": "string" }, "valor_causa": { "type": "object", "additionalProperties": false, "properties": { "valor": { "type": "string" }, "moeda": { "type": "string" }, "valor_formatado": { "type": "string" } } }, "data_distribuicao": { "type": "string" }, "data_arquivamento": { "type": "null" }, "informacoes_complementares": { "type": "null" } } }, "audiencias": { "type": "array" }, "url": { "type": "string" }, "tribunal": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "sigla": { "type": "string" }, "categoria": { "type": "null" } } }, "quantidade_movimentacoes": { "type": "integer" }, "quantidade_envolvidos": { "type": "integer" }, "data_ultima_verificacao": { "type": "string" }, "envolvidos": { "type": "array" } } } } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "listarMovimentacoesDoProcessoResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "numeroCnj": { "type": "string" }, "movimentacoes": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "string" }, "conteudo": { "type": "string" }, "classificacao_predita": { "type": [ "object", "null" ], "additionalProperties": false, "properties": { "nome": { "type": "string" }, "descricao": { "type": "string" }, "hierarquia": { "type": "string" } } }, "fonte": { "type": "object", "additionalProperties": false, "properties": { "sigla": { "type": "string" }, "grau": { "type": "string" } } }, "pagina": { "type": [ "null", "integer" ] }, "tipo_publicacao": { "type": [ "null", "string" ] }, "link_publicacao_tribunal": { "type": [ "null", "string" ] } } } }, "total": { "type": "integer" }, "pagination": { "type": "object", "additionalProperties": false, "properties": { "per_page": { "type": "integer" } } }, "links": { "type": "object", "additionalProperties": false, "properties": { "next": { "type": "object", "additionalProperties": false, "properties": { "href": { "type": "string" }, "cursor": { "type": "string" }, "li": { "type": "string" } } } } }, "query": { "type": "object", "additionalProperties": false, "properties": { "cursor": { "type": "null" }, "li": { "type": "null" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "consultarDiariosPorNumeroDoProcessoResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "numero": { "type": "string" }, "matchExato": { "type": "boolean" }, "processos": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer" }, "numeroAntigo": { "type": "null" }, "numeroNovo": { "type": "string" }, "isCnj": { "type": "boolean" }, "diario": { "type": "object", "additionalProperties": false, "properties": { "sigla": { "type": "string" }, "nome": { "type": "string" }, "estado": { "type": "string" } } }, "dataMovimentacoes": { "type": "string" }, "quantidadeMovimentacoes": { "type": "integer" }, "ultimasMovimentacoes": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer" }, "data": { "type": "string" }, "conteudoResumo": { "type": "string" }, "quantidadeEnvolvidos": { "type": "integer" }, "envolvidos": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "papel": { "type": "string" }, "oab": { "type": "string" } } } } } } } } } }, "total": { "type": "integer" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "solicitarAtualizacaoDoProcessoResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "numeroCnj": { "type": "string" }, "state": { "type": "string" }, "status": { "type": "string" }, "providerRequestId": { "type": "integer" }, "criadoEm": { "type": "string" }, "concluidoEm": { "type": "null" }, "opcoes": { "type": "object", "additionalProperties": false, "properties": { "documentosPublicos": { "type": "boolean" } } }, "pollAfterMs": { "type": "integer" }, "message": { "type": "string" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "consultarStatusDaAtualizacaoDoProcessoResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "numeroCnj": { "type": "string" }, "dataUltimaVerificacao": { "type": "string" }, "tempoDesdeUltimaVerificacao": { "type": "string" }, "ultimaVerificacao": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer" }, "status": { "type": "string" }, "criadoEm": { "type": "string" }, "concluidoEm": { "type": "string" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "listarDocumentosPublicosResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "numeroCnj": { "type": "string" }, "documentos": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "titulo": { "type": "string" }, "descricao": { "type": "string" }, "data": { "type": "string" }, "tipo": { "type": "string" }, "extensaoArquivo": { "type": "string" }, "quantidadePaginas": { "type": "integer" }, "downloadUrl": { "type": "string" } } } }, "pagination": { "type": "object", "additionalProperties": false, "properties": { "currentPage": { "type": "integer" }, "perPage": { "type": "integer" }, "total": { "type": "integer" }, "totalPages": { "type": "integer" }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } } }, "total": { "type": "integer" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "baixarDocumentoProcessualResponse": { "type": "object", "additionalProperties": false, "properties": { "headers": { "type": "object", "additionalProperties": false, "properties": { "Content-Type": { "type": "string" }, "Content-Disposition": { "type": "string" }, "X-BuscaProcessos-Credits-Remaining": { "type": "string" }, "X-BuscaProcessos-Request-Id": { "type": "string" } } }, "body": { "type": "string" } } }, "obterResumoIaDoProcessoResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "numeroCnj": { "type": "string" }, "classificacao": { "type": "object", "additionalProperties": false, "properties": { "tipo_processo": { "type": "string" }, "fase_processual": { "type": "string" }, "grau": { "type": "string" }, "dias_sem_movimentacao": { "type": "integer" } } }, "sinais": { "type": "object", "additionalProperties": false, "properties": { "prazo_aberto": { "type": "object", "additionalProperties": false, "properties": { "valor": { "type": "boolean" }, "motivo": { "type": "string" } } }, "decisao_pendente": { "type": "object", "additionalProperties": false, "properties": { "valor": { "type": "boolean" }, "motivo": { "type": "string" } } }, "urgencia": { "type": "object", "additionalProperties": false, "properties": { "valor": { "type": "boolean" }, "motivo": { "type": "string" } } } } }, "conteudo": { "type": "string" }, "atualizadoEm": { "type": "string" }, "cached": { "type": "boolean" }, "state": { "type": "string" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "solicitarAtualizacaoDoResumoIaResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "numeroCnj": { "type": "string" }, "state": { "type": "string" }, "status": { "type": "string" }, "providerRequestId": { "type": "integer" }, "pollAfterMs": { "type": "integer" }, "message": { "type": "string" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "consultarStatusDoResumoIaResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer" }, "providerRequestId": { "type": "integer" }, "numeroCnj": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDENTE", "FINALIZADO", "ERRO" ], "description": "Situação atual da geração do resumo." }, "state": { "type": "string", "enum": [ "pending", "success", "error" ], "description": "Estado normalizado para controle de polling." }, "criadoEm": { "type": "string" }, "concluidoEm": { "type": "string" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "listarMonitoramentosDeProcessosResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "numeroCnj": { "type": "string" }, "numero_cnj": { "type": "string" }, "tribunal": { "type": "string" }, "frequencia": { "type": "string" }, "frequency": { "type": "string" }, "valorMensal": { "type": "integer" }, "valor_mensal": { "type": "integer" }, "moeda": { "type": "string" }, "cobranca": { "type": "object", "additionalProperties": false, "properties": { "recorrencia": { "type": "string" }, "valorMensal": { "type": "integer" }, "valor_mensal": { "type": "integer" }, "proximoDebitoEm": { "type": "string" }, "proximo_debito_em": { "type": "string" }, "ultimoDebitoEm": { "type": "null" }, "ultimo_debito_em": { "type": "null" }, "status": { "type": "string" }, "observacao": { "type": "string" } } }, "status": { "type": "string" }, "customerEmail": { "type": "null" }, "ativo": { "type": "boolean" }, "criadoEm": { "type": "string" }, "atualizadoEm": { "type": "string" }, "desativadoEm": { "type": "null" } } } }, "pagination": { "type": "object", "additionalProperties": false, "properties": { "currentPage": { "type": "integer" }, "perPage": { "type": "integer" }, "hasNextPage": { "type": "boolean" }, "totalItems": { "type": "integer" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "criarMonitoramentoDeProcessoResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "numeroCnj": { "type": "string" }, "numero_cnj": { "type": "string" }, "tribunal": { "type": "string" }, "frequencia": { "type": "string" }, "frequency": { "type": "string" }, "valorMensal": { "type": "integer" }, "valor_mensal": { "type": "integer" }, "moeda": { "type": "string" }, "cobranca": { "type": "object", "additionalProperties": false, "properties": { "recorrencia": { "type": "string" }, "valorMensal": { "type": "integer" }, "valor_mensal": { "type": "integer" }, "proximoDebitoEm": { "type": "string" }, "proximo_debito_em": { "type": "string" }, "ultimoDebitoEm": { "type": "null" }, "ultimo_debito_em": { "type": "null" }, "status": { "type": "string" }, "observacao": { "type": "string" } } }, "status": { "type": "string" }, "customerEmail": { "type": "null" }, "ativo": { "type": "boolean" }, "criadoEm": { "type": "string" }, "atualizadoEm": { "type": "string" }, "desativadoEm": { "type": "null" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "obterMonitoramentoDeProcessoResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "numeroCnj": { "type": "string" }, "numero_cnj": { "type": "string" }, "tribunal": { "type": "string" }, "frequencia": { "type": "string" }, "frequency": { "type": "string" }, "valorMensal": { "type": "integer" }, "valor_mensal": { "type": "integer" }, "moeda": { "type": "string" }, "cobranca": { "type": "object", "additionalProperties": false, "properties": { "recorrencia": { "type": "string" }, "valorMensal": { "type": "integer" }, "valor_mensal": { "type": "integer" }, "proximoDebitoEm": { "type": "string" }, "proximo_debito_em": { "type": "string" }, "ultimoDebitoEm": { "type": "null" }, "ultimo_debito_em": { "type": "null" }, "status": { "type": "string" }, "observacao": { "type": "string" } } }, "status": { "type": "string" }, "customerEmail": { "type": "null" }, "ativo": { "type": "boolean" }, "criadoEm": { "type": "string" }, "atualizadoEm": { "type": "string" }, "desativadoEm": { "type": "null" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "removerMonitoramentoDeProcessoResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "numeroCnj": { "type": "string" }, "numero_cnj": { "type": "string" }, "tribunal": { "type": "string" }, "frequencia": { "type": "string" }, "frequency": { "type": "string" }, "valorMensal": { "type": "integer" }, "valor_mensal": { "type": "integer" }, "moeda": { "type": "string" }, "cobranca": { "type": "object", "additionalProperties": false, "properties": { "recorrencia": { "type": "string" }, "valorMensal": { "type": "integer" }, "valor_mensal": { "type": "integer" }, "proximoDebitoEm": { "type": "null" }, "proximo_debito_em": { "type": "null" }, "ultimoDebitoEm": { "type": "null" }, "ultimo_debito_em": { "type": "null" }, "status": { "type": "string" }, "observacao": { "type": "string" } } }, "status": { "type": "string" }, "customerEmail": { "type": "null" }, "ativo": { "type": "boolean" }, "criadoEm": { "type": "string" }, "atualizadoEm": { "type": "string" }, "desativadoEm": { "type": "string" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "listarRadaresDeNovosProcessosResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "termo": { "type": "string" }, "variacoes": { "type": "array", "items": { "type": "string" } }, "termosAuxiliares": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "condicao": { "type": "string" }, "termo": { "type": "string" } } } }, "tribunais": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "webhookUrl": { "type": "string" }, "valorMensal": { "type": "number" }, "valor_mensal": { "type": "number" }, "moeda": { "type": "string" }, "cobranca": { "type": "object", "additionalProperties": false, "properties": { "recorrencia": { "type": "string" }, "valorMensal": { "type": "number" }, "valor_mensal": { "type": "number" }, "proximoDebitoEm": { "type": "string" }, "proximo_debito_em": { "type": "string" }, "ultimoDebitoEm": { "type": "null" }, "ultimo_debito_em": { "type": "null" }, "status": { "type": "string" }, "observacao": { "type": "string" } } }, "resultadosPersistidos": { "type": "integer" }, "criadoEm": { "type": "string" }, "atualizadoEm": { "type": "string" } } } }, "pagination": { "type": "object", "additionalProperties": false, "properties": { "currentPage": { "type": "integer" }, "perPage": { "type": "integer" }, "hasNextPage": { "type": "boolean" }, "totalItems": { "type": "integer" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "criarRadarDeNovosProcessosResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "termo": { "type": "string" }, "variacoes": { "type": "array", "items": { "type": "string" } }, "termosAuxiliares": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "condicao": { "type": "string" }, "termo": { "type": "string" } } } }, "tribunais": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "webhookUrl": { "type": "string" }, "valorMensal": { "type": "number" }, "valor_mensal": { "type": "number" }, "moeda": { "type": "string" }, "cobranca": { "type": "object", "additionalProperties": false, "properties": { "recorrencia": { "type": "string" }, "valorMensal": { "type": "number" }, "valor_mensal": { "type": "number" }, "proximoDebitoEm": { "type": "string" }, "proximo_debito_em": { "type": "string" }, "ultimoDebitoEm": { "type": "null" }, "ultimo_debito_em": { "type": "null" }, "status": { "type": "string" }, "observacao": { "type": "string" } } }, "criadoEm": { "type": "string" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "obterRadarDeNovosProcessosResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "termo": { "type": "string" }, "variacoes": { "type": "array", "items": { "type": "string" } }, "termosAuxiliares": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "condicao": { "type": "string" }, "termo": { "type": "string" } } } }, "tribunais": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "webhookUrl": { "type": "string" }, "valorMensal": { "type": "number" }, "valor_mensal": { "type": "number" }, "moeda": { "type": "string" }, "cobranca": { "type": "object", "additionalProperties": false, "properties": { "recorrencia": { "type": "string" }, "valorMensal": { "type": "number" }, "valor_mensal": { "type": "number" }, "proximoDebitoEm": { "type": "string" }, "proximo_debito_em": { "type": "string" }, "ultimoDebitoEm": { "type": "null" }, "ultimo_debito_em": { "type": "null" }, "status": { "type": "string" }, "observacao": { "type": "string" } } }, "resultadosPersistidos": { "type": "integer" }, "criadoEm": { "type": "string" }, "atualizadoEm": { "type": "string" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "removerRadarDeNovosProcessosResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "termo": { "type": "string" }, "variacoes": { "type": "array", "items": { "type": "string" } }, "termosAuxiliares": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "condicao": { "type": "string" }, "termo": { "type": "string" } } } }, "tribunais": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "webhookUrl": { "type": "string" }, "valorMensal": { "type": "number" }, "valor_mensal": { "type": "number" }, "moeda": { "type": "string" }, "cobranca": { "type": "object", "additionalProperties": false, "properties": { "recorrencia": { "type": "string" }, "valorMensal": { "type": "number" }, "valor_mensal": { "type": "number" }, "proximoDebitoEm": { "type": "null" }, "proximo_debito_em": { "type": "null" }, "ultimoDebitoEm": { "type": "null" }, "ultimo_debito_em": { "type": "null" }, "status": { "type": "string" }, "observacao": { "type": "string" } } }, "criadoEm": { "type": "string" }, "atualizadoEm": { "type": "string" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "listarResultadosDoRadarResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "numeroCnj": { "type": "string" }, "dataInicio": { "type": "string" }, "tribunal": { "type": "string" }, "match": { "type": "string" }, "estadoOrigem": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "sigla": { "type": "string" } } }, "qualificacao": { "type": "object", "additionalProperties": false, "properties": { "status": { "type": "string" }, "bancoNoPoloAtivo": { "type": "null" }, "classe": { "type": "null" }, "assunto": { "type": "null" }, "matchedAlias": { "type": "null" }, "reason": { "type": "null" } } } } } }, "pagination": { "type": "object", "additionalProperties": false, "properties": { "currentPage": { "type": "integer" }, "perPage": { "type": "integer" }, "hasNextPage": { "type": "boolean" }, "totalItems": { "type": "integer" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "qualificarResultadoDoRadarResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "monitoramentoId": { "type": "string" }, "resultado": { "type": "object", "additionalProperties": false, "properties": { "numeroCnj": { "type": "string" }, "dataInicio": { "type": "string" }, "tribunal": { "type": "string" }, "match": { "type": "string" }, "estadoOrigem": { "type": "object", "additionalProperties": false, "properties": { "nome": { "type": "string" }, "sigla": { "type": "string" } } }, "qualificacao": { "type": "object", "additionalProperties": false, "properties": { "status": { "type": "string" }, "bancoNoPoloAtivo": { "type": "boolean" }, "classe": { "type": "string" }, "assunto": { "type": "string" }, "matchedAlias": { "type": "string" }, "reason": { "type": "string" } } } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "listarMonitoramentosDePublicacoesResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "fontes": { "type": "array", "items": { "type": "string" } }, "tribunais": { "type": "array", "items": { "type": "string" } }, "filtros": { "type": "object", "additionalProperties": false, "properties": { "termo": { "type": "string" }, "processo": { "type": "null" }, "oab": { "type": "null" } } }, "evento": { "type": "string" }, "status": { "type": "string" }, "intervalo_minutos": { "type": "integer" }, "valor_mensal": { "type": "number" }, "cobranca": { "type": "object", "additionalProperties": false, "properties": { "recorrencia": { "type": "string" }, "valor_mensal": { "type": "number" }, "proximo_debito_em": { "type": "string" }, "status": { "type": "string" } } } } } }, "pagination": { "type": "object", "additionalProperties": false, "properties": { "page": { "type": "integer" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "totalPages": { "type": "integer" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "integer" }, "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "criarMonitoramentoDePublicacoesResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "fontes": { "type": "array", "items": { "type": "string" } }, "tribunais": { "type": "array", "items": { "type": "string" } }, "filtros": { "type": "object", "additionalProperties": false, "properties": { "termo": { "type": "string" }, "processo": { "type": "null" }, "oab": { "type": "null" } } }, "evento": { "type": "string" }, "status": { "type": "string" }, "intervalo_minutos": { "type": "integer" }, "webhook_url": { "type": "string" }, "valor_mensal": { "type": "number" }, "cobranca": { "type": "object", "additionalProperties": false, "properties": { "recorrencia": { "type": "string" }, "valor_mensal": { "type": "number" }, "proximo_debito_em": { "type": "string" }, "status": { "type": "string" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "number" }, "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "listarMonitoramentosAdministrativosResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "nup": { "type": "string" }, "fonte": { "type": "string" }, "evento": { "type": "string" }, "webhook_url": { "type": "string" }, "intervalo_minutos": { "type": "integer" }, "notificar_existentes": { "type": "boolean" }, "valor_mensal": { "type": "number" }, "moeda": { "type": "string" }, "cobranca": { "type": "object", "additionalProperties": false, "properties": { "recorrencia": { "type": "string" }, "proximo_debito_em": { "type": "string" }, "ultimo_debito_em": { "type": "string" }, "ciclo": { "type": "integer" }, "status": { "type": "string" }, "ultimo_erro": { "type": "null" } } }, "status": { "type": "string" }, "sincronizacao": { "type": "object", "additionalProperties": false, "properties": { "baseline_em": { "type": "string" }, "ultima_tentativa_em": { "type": "string" }, "ultimo_sucesso_em": { "type": "string" }, "proxima_tentativa_em": { "type": "string" }, "falhas_consecutivas": { "type": "integer" }, "ultimo_erro": { "type": "null" } } }, "correspondencias": { "type": "integer" }, "criado_em": { "type": "string" }, "atualizado_em": { "type": "string" } } } }, "pagination": { "type": "object", "additionalProperties": false, "properties": { "current_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "total_pages": { "type": "integer" } } } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "integer" }, "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "criarMonitoramentoAdministrativoResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "nup": { "type": "string" }, "fonte": { "type": "string" }, "evento": { "type": "string" }, "webhook_url": { "type": "string" }, "intervalo_minutos": { "type": "integer" }, "notificar_existentes": { "type": "boolean" }, "valor_mensal": { "type": "number" }, "moeda": { "type": "string" }, "cobranca": { "type": "object", "additionalProperties": false, "properties": { "recorrencia": { "type": "string" }, "proximo_debito_em": { "type": "string" }, "ultimo_debito_em": { "type": "string" }, "ciclo": { "type": "integer" }, "status": { "type": "string" }, "ultimo_erro": { "type": "null" } } }, "status": { "type": "string" }, "sincronizacao": { "type": "object", "additionalProperties": false, "properties": { "baseline_em": { "type": "string" }, "ultima_tentativa_em": { "type": "string" }, "ultimo_sucesso_em": { "type": "string" }, "proxima_tentativa_em": { "type": "string" }, "falhas_consecutivas": { "type": "integer" }, "ultimo_erro": { "type": "null" } } }, "correspondencias": { "type": "integer" }, "criado_em": { "type": "string" }, "atualizado_em": { "type": "string" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "number" }, "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "string" }, "servedAt": { "type": "string" } } } } }, "obterMonitoramentoAdministrativoResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "nup": { "type": "string" }, "fonte": { "type": "string" }, "evento": { "type": "string" }, "webhook_url": { "type": "string" }, "intervalo_minutos": { "type": "integer" }, "notificar_existentes": { "type": "boolean" }, "valor_mensal": { "type": "number" }, "moeda": { "type": "string" }, "cobranca": { "type": "object", "additionalProperties": false, "properties": { "recorrencia": { "type": "string" }, "proximo_debito_em": { "type": "string" }, "ultimo_debito_em": { "type": "string" }, "ciclo": { "type": "integer" }, "status": { "type": "string" }, "ultimo_erro": { "type": "null" } } }, "status": { "type": "string" }, "sincronizacao": { "type": "object", "additionalProperties": false, "properties": { "baseline_em": { "type": "string" }, "ultima_tentativa_em": { "type": "string" }, "ultimo_sucesso_em": { "type": "string" }, "proxima_tentativa_em": { "type": "string" }, "falhas_consecutivas": { "type": "integer" }, "ultimo_erro": { "type": "null" } } }, "correspondencias": { "type": "integer" }, "criado_em": { "type": "string" }, "atualizado_em": { "type": "string" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "integer" }, "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } }, "removerMonitoramentoAdministrativoResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "nup": { "type": "string" }, "fonte": { "type": "string" }, "evento": { "type": "string" }, "webhook_url": { "type": "string" }, "intervalo_minutos": { "type": "integer" }, "notificar_existentes": { "type": "boolean" }, "valor_mensal": { "type": "number" }, "moeda": { "type": "string" }, "cobranca": { "type": "object", "additionalProperties": false, "properties": { "recorrencia": { "type": "string" }, "proximo_debito_em": { "type": "null" }, "ultimo_debito_em": { "type": "string" }, "ciclo": { "type": "integer" }, "status": { "type": "string" }, "ultimo_erro": { "type": "null" } } }, "status": { "type": "string" }, "sincronizacao": { "type": "object", "additionalProperties": false, "properties": { "baseline_em": { "type": "string" }, "ultima_tentativa_em": { "type": "string" }, "ultimo_sucesso_em": { "type": "string" }, "proxima_tentativa_em": { "type": "null" }, "falhas_consecutivas": { "type": "integer" }, "ultimo_erro": { "type": "null" } } }, "correspondencias": { "type": "integer" }, "criado_em": { "type": "string" }, "atualizado_em": { "type": "string" } } }, "meta": { "type": "object", "additionalProperties": false, "properties": { "creditsCharged": { "type": "integer" }, "creditsRemaining": { "type": "number" }, "requestId": { "type": "string" }, "searchLogId": { "type": "null" }, "servedAt": { "type": "string" } } } } } }, "callbacks": { "ClientWebhook": { "{$request.body#/webhook_url}": { "post": { "summary": "Evento enviado para o webhook do cliente", "operationId": "receberEventoNoWebhookDoCliente", "description": "A BuscaProcessos envia POST JSON para a webhook_url configurada. Use Content-Type application/json, responda com HTTP 2xx rapidamente e processe o trabalho pesado em fila. O envio inclui X-BuscaProcessos-Event, X-BuscaProcessos-Delivery-Id e X-BuscaProcessos-Timestamp; quando o segredo estiver configurado, inclui X-BuscaProcessos-Signature no formato sha256=HMAC-SHA256(payload).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" }, "example": { "id": "evt_01HXYZ1234567890", "event": "novo_processo", "source": "BUSCAPROCESSOS", "created_at": "2026-07-10T13:00:00.000Z", "data": { "numeroCnj": "0000000-00.2026.8.26.0000", "tribunal": "TJSP" } } } } }, "responses": { "2XX": { "description": "Evento recebido pelo cliente.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallbackAcknowledgement" } } } }, "4XX": { "description": "O cliente rejeitou o evento; a entrega pode ser marcada como falha." }, "5XX": { "description": "O cliente não processou o evento; a entrega pode ser reprocessada." } } } } } }, "responses": { "AsyncAccepted": { "description": "A operação ultrapassou a janela síncrona e continua no servidor. Faça polling da URL informada.", "headers": { "Location": { "description": "URL absoluta de acompanhamento.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "description": "Espera mínima recomendada antes do próximo polling, em segundos.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncProcessingResponse" }, "example": { "data": { "status": "PROCESSANDO", "requestId": "5f5342bf-8a4f-47e9-a13c-1fe20b879ca2", "message": "A consulta continua em segundo plano. Consulte a statusUrl até receber a resposta final.", "statusUrl": "https://api.buscaprocessos.app.br/v1/requests/5f5342bf-8a4f-47e9-a13c-1fe20b879ca2", "pollAfterMs": 5000, "pollAfterSeconds": 5, "nextPollAt": "2026-08-14T14:32:15.000Z", "submittedAt": "2026-08-14T14:32:10.000Z" }, "meta": { "creditsCharged": 0 } } } } }, "BadRequest": { "description": "JSON inválido ou parâmetros ausentes/inválidos.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "Unauthorized": { "description": "API key ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "Forbidden": { "description": "Conta inativa, saldo insuficiente ou operação não permitida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "NotFound": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "UnprocessableEntity": { "description": "Parâmetros válidos sintaticamente, mas rejeitados por regra de negócio.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "TooManyRequests": { "description": "Limite de requisições excedido. A API aplica limites por classe de rota.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "InternalServerError": { "description": "Erro interno não especificado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }