Cadastrar processo
POST · API de Integração v2
/v2/processosCadastrar processo
Cria um processo vinculado ao seu escritório.
Identidade: o escritório é resolvido a partir da sua chave de API — não vai no corpo. Em partes.clientes[].clienteId vão as pessoas (partes do processo), não o escritório.
Seções do corpo: dadosBasicos (obrigatório), detalhesComplementares, camposPersonalizados, partes e controleAcesso.
| dadosBasicos | |||
|---|---|---|---|
| Campo | Validação | Descrição | Regras |
| tribunalId | @NotNull @Positive | Tribunal. O tipo (judicial/administrativo) é resolvido na UI: judicial usa o tribunal escolhido; administrativo usa o id do tribunal administrativo. | Obrigatório. |
| numeroProcesso | @NotBlank | Número do processo. Validado conforme formatoNumero. | Obrigatório. Em CNJ: NNNNNNN-DD.AAAA.J.TR.OOOO (20 dígitos, com ou sem máscara; o dígito verificador não é conferido). Em OUTRO: texto livre. |
| formatoNumero | enum | Como o número deve ser lido/validado. | Opcional (default CNJ). Use OUTRO para numeração própria — administrativo, STF/STJ e tribunais fora do padrão CNJ. |
| classeJudicial | texto livre | Classe judicial (rótulo, ex.: "Procedimento Comum Cível"). Não é id de catálogo. | Opcional. |
| numeroInterno | - | Número próprio do escritório (a UI legada só o exibe para alguns tribunais). | Opcional. |
| assuntoIds | lista @Positive | Assuntos do processo (pode ter mais de um). | Opcional. |
| marcadorIds | lista @Positive | Marcadores/etiquetas. | Opcional. |
| pasta, protocolo | - | Organização/identificação. | Opcional. |
| areaId | @Positive | Área de atuação. | Opcional. |
| valorCausa, valorCondenacao | decimal | Valores monetários. | Opcional. |
| situacao | texto livre | Situação processual. | Opcional; texto livre (ex.: PROCESSO_DISTRIBUIDO). |
| statusProcesso | enum | Estado do processo. | Um de: ATIVO, ENCERRADO. |
| emGrauRecurso, segredoJustica | boolean | Flags. | Opcional (default false). |
| monitoramentoAtivo | boolean | Liga a captura automática do tribunal para este processo. | Opcional (default false). Consome vaga do plano: se o limite de processos monitorados estiver esgotado, o cadastro é recusado com 409. Para cadastrar de todo modo, envie false e ligue depois. |
detalhesComplementares: órgão/vara; risco/resultado/êxito/natureza/tipo de ação (texto livre); faseId (id de uma fase cadastrada do escritório); datas (requerimento, autuação, distribuição, fechamento, trânsito em julgado, arquivamento), honorários e observações. Todos opcionais.
camposPersonalizados: lista de { campoId, valores[] } definidos pelo escritório (1 valor para campo único; vários para múltipla escolha).
partes: dois lados — clientes (quem o escritório representa) e partesContrarias (o lado adverso), cada um com { tipoPolo, clienteIds[], advogadoIds[], testemunhaIds[] }. Advogados e testemunhas pertencem ao lado, não a uma pessoa específica.
tipoPolo: a posição processual do lado — ATIVO, PASSIVO ou TERCEIRO. É declarado, não deduzido do bloco: quando o seu cliente é réu, clientes.tipoPolo = "PASSIVO" e partesContrarias.tipoPolo = "ATIVO". Opcional (omitido = não informado); valor desconhecido devolve 400. Não confundir com o campo polo das testemunhas no banco, que indica apenas de que lado da ficha elas estão.
controleAcesso: responsavelIds[] e equipeIds[].
Processo já cadastrado
A identidade de um processo é número + tribunal dentro do seu escritório. Se já existir:
- ativo →
409. É o mesmo processo; para alterá-lo usePUT. - excluído → o processo é reativado e recebe os dados enviados. A resposta traz
"reativado": true.
⚠️ Na reativação, o que voltou não é uma casca vazia: andamentos, documentos, audiências e compromissos de agenda continuam ligados àquele processo, porque nunca foram apagados. Os campos e vínculos que você enviou substituem os antigos; o histórico permanece. Vale avisar o usuário — ele pode não esperar encontrar anexos que não subiu.
Autenticação
X-API-Key no cabeçalho. Como autenticar
Corpo da requisiçãoobrigatório
Dados do processo a cadastrar (ver seções na descrição).
application/json
camposPersonalizadosCampoPersonalizado[]Ver propriedades
campoIdintegerobrigatóriovaloresstring[]controleAcessoControleAcessoVer propriedades
equipeIdsinteger[]responsavelIdsinteger[]dadosBasicosDadosBasicosobrigatórioVer propriedades
areaIdintegerassuntoIdsinteger[]classeJudicialstringemGrauRecursobooleanformatoNumerostringmarcadorIdsinteger[]monitoramentoAtivobooleannumeroInternostringnumeroProcessostringobrigatóriopastastringprotocolostringsegredoJusticabooleansituacaostringstatusProcessostringobrigatóriotipoProcessointegertribunalIdintegerobrigatóriovalorCausanumbervalorCondenacaonumberdetalhesComplementaresDetalhesComplementaresVer propriedades
dataArquivamentostringdataAutuacaostringdataDistribuicaostringdataFechamentostringdataRequerimentostringdataTransitoJulgadostringdescricaoHonorariosstringexitoIdstringfaseIdintegernaturezaAcaoIdstringobservacoesstringorgaoVarastringresultadoIdstringriscoIdstringtipoAcaoIdstringpartesPartesobrigatórioVer propriedades
clientesPoloVer propriedades
advogadoIdsinteger[]clienteIdsinteger[]testemunhaIdsinteger[]tipoPolostringpartesContrariasPoloVer propriedades
advogadoIdsinteger[]clienteIdsinteger[]testemunhaIdsinteger[]tipoPolostringRespostas5
Exemplos ilustrativos · nenhuma requisição é enviada
200 · Sucesso
- Quando acontece
- A operação foi concluída.
- Como tratar
- Leia os dados retornados; em listagens, confira também a paginação.
Exemplo declarado no OpenAPI · application/json
{
"id": 45210,
"numeroProcesso": "0001234-96.2026.8.17.0001",
"reativado": false
}Contrato de respostas
200Processo cadastrado.
Processo cadastrado.
application/json
idintegernumeroProcessostringreativadoboolean400Payload inválido (ex.: número CNJ fora do padrão, faseId que não é do escritório).
Payload inválido (ex.: número CNJ fora do padrão, faseId que não é do escritório).
O contrato não declara um corpo para esta resposta.
401Não autenticado (token ausente/inválido).
Não autenticado (token ausente/inválido).
O contrato não declara um corpo para esta resposta.
403Usuário sem permissão de adicionar processo.
Usuário sem permissão de adicionar processo.
O contrato não declara um corpo para esta resposta.
409Já existe processo ativo com o mesmo número e tribunal neste escritório; ou o limite de processos monitorados do plano foi atingid
Já existe processo ativo com o mesmo número e tribunal neste escritório; ou o limite de processos monitorados do plano foi atingido (este só com monitoramentoAtivo = true). Distinga pelo campo code.
O contrato não declara um corpo para esta resposta.
