Pessoas

Arquivar pessoas (em lote)

POST · API de Integração v2

POST/v2/pessoas/arquivar

Arquivar pessoas

Arquiva uma ou mais pessoas do seu escritório: elas somem das listagens ativas mas continuam na base (histórico/auditoria) — diferente de excluir.

Identidade: o escritório vem da sua chave de API — só os ids vão no corpo.

Em lote: mande { "ids": [123, 124] }. Arquivar uma só é uma lista de 1.

Best-effort: a resposta separa arquivados de ignorados (não encontrados, de outro escritório, ou já excluídos). Reversível via /desarquivar.

Processos (opcional): envie { "processos": { "removerMonitoramento": true, "encerrar": true } }. As opções são independentes: removerMonitoramento desativa somente processos ativos, monitorados e vinculados exclusivamente à pessoa arquivada; encerrar encerra somente processos ativos sob a mesma regra. Processos compartilhados são preservados e retornam no relatório.

Autenticação

X-API-Key no cabeçalho. Como autenticar

Corpo da requisiçãoobrigatório

IDs das pessoas a arquivar.

application/json

idsinteger[]obrigatório

IDs das pessoas a arquivar (1..1000).

exemplo: [123,124,125]
processosProcessosArquivamentoRequest
Ver propriedades
encerrarboolean

Encerra somente processos vinculados exclusivamente à pessoa arquivada.

exemplo: false
removerMonitoramentoboolean

Desativa o monitoramento somente de processos vinculados exclusivamente à pessoa arquivada.

exemplo: false

Respostas3

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 ilustrativo gerado do schema · application/json

Exemplo · HTTP 200
{
  "arquivados": [
    123,
    124
  ],
  "ignorados": [
    {
      "id": 125,
      "motivo": "string"
    }
  ],
  "processos": {
    "encerramentoIgnorado": [
      {
        "motivo": "string",
        "numeroProcesso": "1011214-58.2024.8.26.0477",
        "processoId": 26540878
      }
    ],
    "encerramentoSolicitado": true,
    "monitoramentoDesativado": [
      {
        "numeroProcesso": "1011214-58.2024.8.26.0477",
        "processoId": 26540878
      }
    ],
    "monitoramentoIgnorado": [
      {
        "motivo": "string",
        "numeroProcesso": "1011214-58.2024.8.26.0477",
        "processoId": 26540878
      }
    ],
    "monitoramentoSolicitado": true,
    "processosEncerrados": [
      {
        "numeroProcesso": "1011214-58.2024.8.26.0477",
        "processoId": 26540878
      }
    ]
  },
  "solicitados": 3
}

Contrato de respostas

200Lote processado (ver arquivados/ignorados).

Lote processado (ver arquivados/ignorados).

application/json

arquivadosinteger[]

IDs das pessoas arquivadas

exemplo: [123,124]
ignoradosPessoaIgnoradaResponse[]

Pessoas não processadas e seus motivos

Ver propriedades
idinteger

ID da pessoa não processada

formato: int64exemplo: 125
motivostring

Motivo seguro pelo qual a pessoa foi ignorada

processosProcessosArquivamentoResponse
Ver propriedades
encerramentoIgnoradoProcessoEncerramentoIgnoradoResponse[]

Processos cujo encerramento não foi aplicado

Ver propriedades
motivostring

Motivo pelo qual o encerramento ou a reabertura não foi aplicado

numeroProcessostring

Número do processo

exemplo: 1011214-58.2024.8.26.0477
processoIdinteger

ID interno do processo

formato: int64exemplo: 26540878
encerramentoSolicitadoboolean

Indica se foi solicitado o encerramento

exemplo: true
monitoramentoDesativadoProcessoResumoResponse[]

Processos com monitoramento desativado

Ver propriedades
numeroProcessostring

Número do processo

exemplo: 1011214-58.2024.8.26.0477
processoIdinteger

ID interno do processo

formato: int64exemplo: 26540878
monitoramentoIgnoradoProcessoMonitoramentoIgnoradoResponse[]

Processos cujo monitoramento não foi desativado

Ver propriedades
motivostring

Motivo pelo qual o monitoramento não foi alterado

numeroProcessostring

Número do processo

exemplo: 1011214-58.2024.8.26.0477
processoIdinteger

ID interno do processo

formato: int64exemplo: 26540878
monitoramentoSolicitadoboolean

Indica se foi solicitada a desativação de monitoramento

exemplo: true
processosEncerradosProcessoResumoResponse[]

Processos encerrados

Ver propriedades
numeroProcessostring

Número do processo

exemplo: 1011214-58.2024.8.26.0477
processoIdinteger

ID interno do processo

formato: int64exemplo: 26540878
solicitadosinteger

Quantidade de pessoas solicitadas

formato: int32exemplo: 3
400Payload inválido (lista vazia, mais de 1000 ids, nulo ou não positivo).

Payload inválido (lista vazia, mais de 1000 ids, nulo ou não positivo).

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.

© 2026 Expedit LawtechFeito para conectar.