Monitoramento de CPF/CNPJ#

O módulo de Monitoramento de CPF/CNPJ permite acompanhar, de forma contínua, novos processos judiciais associados a documentos CPF ou CNPJ cadastrados pela sua empresa. Quando um processo novo é detectado para um documento monitorado, a API envia um evento via webhook contendo os dados do processo.

Como funciona#

  1. Configurar webhook — registre a URL onde sua empresa receberá as notificações.

  2. Cadastrar documentos — adicione os CPFs/CNPJs que deseja monitorar.

  3. Definir filtros — escolha quais tipos de processo deseja monitorar: cível, trabalhista ou criminal. Essa configuração é feita junto ao time de CS.

  4. Receber eventos — quando um novo processo é detectado para um documento monitorado, a API envia um HTTP POST ao seu webhook com os dados do processo.

Importante

O webhook deve ser configurado antes de cadastrar documentos. Tentativas de criar monitoramentos sem webhook retornam 422 Unprocessable Entity.

Nota

O campo data dos eventos de webhook tem a mesma estrutura de resposta da seção Como consultar, com uma diferença: não inclui o campo pagination, pois o evento já se refere a um processo específico. Empresas com o motor de decisão habilitado recebem outro formato, descrito em Alertas com motor de decisão.

Configurar webhook#

Registra a URL de webhook da empresa para recebimento de eventos de monitoramento. Na primeira chamada retorna 201; chamadas subsequentes para atualizar a URL retornam 200.

cURL

curl -X POST 'https://api.consulta-pro.jusbrasil.com.br/monitoring/webhook-config' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: <sua_api_key>' \
  -H 'X-Request-ID: <uuid-v4>' \
  -d '{
    "url": "https://meu-sistema.com.br/webhook/monitoramento"
  }'
Corpo da requisição#

Parâmetro

Tipo

Descrição

url

string

URL de webhook válida (https://). Será chamada via HTTP POST quando houver eventos.

Resposta (201 Created ou 200 OK)

{
  "webhook_url": "https://meu-sistema.com.br/webhook/monitoramento",
  "created_at": "2026-04-08T14:30:00Z"
}

Consultar webhook configurado#

cURL

curl -X GET 'https://api.consulta-pro.jusbrasil.com.br/monitoring/webhook-config' \
  -H 'X-API-KEY: <sua_api_key>' \
  -H 'X-Request-ID: <uuid-v4>'

Resposta (200 OK)

{
  "webhook_url": "https://meu-sistema.com.br/webhook/monitoramento",
  "created_at": "2026-04-08T14:30:00Z"
}

Se o webhook não estiver configurado, retorna 404 Not Found.

Cadastrar documento para monitoramento#

Registra um CPF ou CNPJ para monitoramento contínuo. O webhook deve estar configurado antes desta chamada.

cURL

curl -X POST 'https://api.consulta-pro.jusbrasil.com.br/monitoring' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: <sua_api_key>' \
  -H 'X-Request-ID: <uuid-v4>' \
  -d '{
    "document_number": "12345678909",
    "external_id": "cliente-8812"
  }'
Corpo da requisição#

Parâmetro

Tipo

Descrição

document_number

string

CPF (11 dígitos) ou CNPJ (14 dígitos), apenas números.

external_id

string (opcional)

Identificador que sua empresa usa para essa pessoa no seu sistema, com até 100 caracteres. É devolvido no cadastro, nas consultas do monitoramento e em todos os eventos de webhook desse monitoramento. Quando não é enviado, o campo não aparece nas respostas nem nos eventos.

Resposta (201 Created)

HTTP/1.1 201 Created
Content-Type: application/json
Location: /monitoring/019d6a59-f499-7e7b-871f-742a5067a5e7

{
  "data": {
    "id_monitoramento": "019d6a59-f499-7e7b-871f-742a5067a5e7",
    "numero_documento": "12345678909",
    "external_id": "cliente-8812",
    "status": "ATIVO",
    "data_criacao": "2026-04-08T15:00:00Z",
    "data_remocao": null
  }
}

Erros comuns:

Código

Descrição

400

Documento inválido (não é CPF/CNPJ válido).

409

Documento já está sendo monitorado.

422

Webhook não configurado. Chame POST /monitoring/webhook-config antes.

Consultar monitoramento por ID#

cURL

curl -X GET 'https://api.consulta-pro.jusbrasil.com.br/monitoring/019d6a59-f499-7e7b-871f-742a5067a5e7' \
  -H 'X-API-KEY: <sua_api_key>' \
  -H 'X-Request-ID: <uuid-v4>'

Resposta (200 OK)

{
  "data": {
    "id_monitoramento": "019d6a59-f499-7e7b-871f-742a5067a5e7",
    "numero_documento": "12345678909",
    "external_id": "cliente-8812",
    "status": "ATIVO",
    "data_criacao": "2026-04-08T15:00:00Z",
    "data_remocao": null
  }
}

Se o ID não existir, retorna 404 Not Found.

Listar monitoramentos#

Lista os documentos monitorados pela empresa com paginação baseada em cursor.

cURL

curl -X GET 'https://api.consulta-pro.jusbrasil.com.br/monitoring?status=ATIVO&limit=20' \
  -H 'X-API-KEY: <sua_api_key>' \
  -H 'X-Request-ID: <uuid-v4>'
Query params#

Parâmetro

Tipo

Descrição

document_number

string (opcional)

Filtrar pelos monitoramentos de um CPF (11 dígitos) ou CNPJ (14 dígitos), apenas números. Pode ser combinado com status.

status

string (opcional)

Filtrar por ATIVO ou INATIVO.

limit

integer (opcional)

Itens por página (1–100, padrão 20).

last_id_value

string (opcional)

Cursor: último ID da página anterior.

last_sort_value

string (opcional)

Cursor: último valor de ordenação da página anterior.

Nota

O mesmo CPF/CNPJ pode ter vários monitoramentos ao longo do tempo (por exemplo, ATIVO → INATIVO → ATIVO novamente), cada um com seu próprio id_monitoramento. Por isso o document_number é um atributo filtrável, e não a chave do recurso — o identificador continua sendo o id_monitoramento.

Filtrando por documento

Use document_number para verificar se um CPF/CNPJ está sendo monitorado sem manter controle paralelo do lado do cliente. O filtro é combinável com status:

# Monitoramento ativo de um CPF (se houver)
curl -X GET 'https://api.consulta-pro.jusbrasil.com.br/monitoring?document_number=12345678909&status=ATIVO' \
  -H 'X-API-KEY: <sua_api_key>' \
  -H 'X-Request-ID: <uuid-v4>'

# Histórico completo do CPF (ATIVO + INATIVO) — sem filtro de status
curl -X GET 'https://api.consulta-pro.jusbrasil.com.br/monitoring?document_number=12345678909' \
  -H 'X-API-KEY: <sua_api_key>' \
  -H 'X-Request-ID: <uuid-v4>'

Sem o filtro de status, são retornados todos os monitoramentos do documento (ATIVO e INATIVO), útil para consultar o histórico.

Resposta (200 OK)

{
  "data": [
    {
      "id_monitoramento": "019d6a59-f499-7e7b-871f-742a5067a5e7",
      "numero_documento": "12345678909",
      "external_id": "cliente-8812",
      "status": "ATIVO",
      "data_criacao": "2026-04-08T15:00:00Z",
      "data_remocao": null
    }
  ],
  "_meta": {
    "total": 42,
    "limit": 20,
    "cursor": {
      "last_id_value": "019d6a59-f499-7e7b-871f-742a5067a5e7",
      "last_sort_value": "2026-04-08T15:00:00Z"
    }
  }
}

Para obter a próxima página, envie last_id_value e last_sort_value da resposta anterior como query params.

Erros comuns:

Código

Descrição

400

document_number inválido: não possui 11 ou 14 dígitos, ou falhou na validação de checksum do CPF/CNPJ.

Remover monitoramento#

Encerra o monitoramento de um documento. O documento passa para o status INATIVO e deixa de gerar eventos de webhook.

Nota

Para retomar o monitoramento do mesmo CPF/CNPJ, basta cadastrá-lo novamente via POST /monitoring. Um novo id_monitoramento será gerado.

cURL

curl -X DELETE 'https://api.consulta-pro.jusbrasil.com.br/monitoring/019d6a59-f499-7e7b-871f-742a5067a5e7' \
  -H 'X-API-KEY: <sua_api_key>' \
  -H 'X-Request-ID: <uuid-v4>'

Resposta (200 OK)

{
  "data": {
    "id_monitoramento": "019d6a59-f499-7e7b-871f-742a5067a5e7",
    "numero_documento": "12345678909",
    "status": "INATIVO",
    "data_criacao": "2026-04-08T15:00:00Z",
    "data_remocao": "2026-04-09T10:00:00Z"
  }
}

Erros comuns:

Código

Descrição

404

Monitoramento não encontrado.

409

Monitoramento já está inativo.

Parâmetros de resposta do monitoramento#

Parâmetro

Tipo

Descrição

id_monitoramento

string

Identificador único do monitoramento (UUID).

numero_documento

string

CPF ou CNPJ monitorado.

external_id

string

Identificador enviado no cadastro. Omitido quando não foi enviado.

status

string

Status atual: ATIVO ou INATIVO.

data_criacao

string

Data de criação (ISO 8601).

data_remocao

string/null

Data de remoção (ISO 8601) ou null se ativo.

Eventos de webhook#

Quando um novo processo judicial é detectado para um CPF/CNPJ monitorado, a API envia um HTTP POST ao webhook cadastrado. O corpo da chamada é sempre uma lista de eventos.

Formato do evento#

Cada evento na lista é um objeto JSON com os seguintes atributos:

Campo

Tipo

Descrição

id

number

Identificador numérico único do evento.

evt_type

number

Tipo do evento. Para monitoramento de CPF/CNPJ o valor é 21.

created_at

string

Data de criação do evento (ISO 8601).

target_url

string

URN opaca que identifica o evento. Formato: urn:cpro:bgc-monitoring:<hash>.

target_number

string

ID do documento monitorado (UUID).

source_url

array

Lista com a URL do recurso de monitoramento que originou o evento.

api_name

string

Identificador da API de origem (consulta-pro).

data

object

Dados detalhados do evento (ver estrutura abaixo).

Estrutura do campo data#

O campo data segue a mesma estrutura de resposta da consulta por CPF/CNPJ (nome, identificacao, processos), sem o campo pagination. Quando o monitoramento foi cadastrado com external_id, o campo data traz também o external_id.

Cada processo dentro de processos contém os mesmos campos descritos em Parâmetros de resposta processos: tipo_processo, numero_processo, tribunal, UF, comarca, forum, natureza, assunto, classe_processual, valor_causa, ano_do_processo, ano_distribuicao, data_ultima_atualizacao, data_andamento_mais_recente, confianca_associacao, polo_passivo, processo_principal, papel, nome_na_capa, link, partes, advogados, status, tipificacao_identificada, tipificacao e processos_relacionados.

Exemplo de evento recebido via webhook#

[
  {
    "id": 1232782833,
    "evt_type": 21,
    "created_at": "2026-04-08T21:39:06.947967+00:00",
    "api_name": "digesto",
    "target_url": "urn:cpro:bgc-monitoring:a1b2c3d4e5f6a1b2c3d4e5f6",
    "target_number": "019d6a59-f499-7e7b-871f-742a5067a5e7",
    "source_url": [
      "https://api.jusbrasil.com.br/background-check/monitoring/019d6a59-f499-7e7b-871f-742a5067a5e7"
    ],
    "source_user_custom": null,
    "data": {
      "nome": "EMPRESA EXEMPLO S/A",
      "identificacao": {
        "tipo": "CNPJ",
        "valor": "00000000000191"
      },
      "processos": [
        {
          "numero_processo": "0000001-00.2023.8.00.0000",
          "tipo_processo": "CRIMINAL",
          "tribunal": "TJRJ",
          "UF": "RJ",
          "comarca": "Rio de Janeiro",
          "forum": "Vara Criminal",
          "natureza": "Ação Penal",
          "classe_processual": "OUTROS",
          "assunto": "Estelionato",
          "valor_causa": null,
          "ano_do_processo": "2023",
          "ano_distribuicao": "2023",
          "data_ultima_atualizacao": "2026-04-08",
          "data_andamento_mais_recente": "2026-04-06",
          "confianca_associacao": "ALTA",
          "polo_passivo": true,
          "processo_principal": false,
          "papel": "Parte passiva",
          "nome_na_capa": "Empresa Exemplo S/A",
          "link": "https://www.jusbrasil.com.br/consulta-pro/processos/0000001-00.2023.8.00.0000",
          "status": {
            "tribunal": null,
            "inferido": "Ativo",
            "data": "2026-04-08",
            "normalizado": null
          },
          "partes": [
            { "papel": "RÉU", "nome": "João da Silva" },
            { "papel": "POLO PASSIVO (PRINCIPAL)", "nome": "Empresa Exemplo S/A" }
          ],
          "advogados": [
            { "oab": "000000", "nome": "Maria Oliveira" }
          ],
          "processos_relacionados": []
        }
      ],
      "external_id": "cliente-8812"
    }
  }
]

Alertas com motor de decisão#

Empresas que usam o Motor de Decisão podem receber os alertas de monitoramento já avaliados pelo critério de risco da empresa. Cada novo processo detectado é avaliado pelo motor, e o evento traz a criticidade calculada em vez da lista de processos.

Importante

O motor de decisão no monitoramento é habilitado pelo time Jusbrasil para cada empresa, com o criteria_slug definido junto ao seu time. Não há configuração pela API. Para habilitar, entre em contato com o time de CS.

O evento continua com evt_type 21 e com os mesmos atributos descritos em Formato do evento. Muda apenas o campo data, que traz os mesmos campos da resposta de POST /background-check/assessments (veja Parâmetros de Resposta), sem repetir o data que o evento já tem:

  • data: a avaliação, com id_avaliacao, criticidade (motores numéricos) ou criticidades (motores por lista) e data_criacao.

  • data._meta: criteria_slug, criteria_version, identificacao e external_id, quando o monitoramento foi cadastrado com ele. Traz também numero_processo, o número CNJ do processo que gerou o alerta.

A avaliação de cada alerta considera apenas o processo que gerou o alerta, e não todo o histórico do documento.

Campo adicional em _meta#

Campo

Tipo

Descrição

numero_processo

string

Número CNJ do processo que gerou o alerta e que foi avaliado pelo motor.

Exemplo de evento recebido via webhook (motor numérico)

[
  {
    "id": 1232782833,
    "evt_type": 21,
    "created_at": "2026-11-03T12:00:01.123456+00:00",
    "api_name": "digesto",
    "target_url": "urn:cpro:bgc-monitoring:a1b2c3d4e5f6a1b2c3d4e5f6",
    "target_number": "019d6a59-f499-7e7b-871f-742a5067a5e7",
    "source_url": [
      "https://api.jusbrasil.com.br/background-check/monitoring/019d6a59-f499-7e7b-871f-742a5067a5e7"
    ],
    "source_user_custom": null,
    "data": {
      "id_avaliacao": "5b1e0c9a-3f4d-5e21-9a77-0c1d2e3f4a5b",
      "criticidade": "2",
      "data_criacao": "2026-11-03T12:00:00Z",
      "_meta": {
        "external_id": "cliente-8812",
        "criteria_slug": "fluxo_onboarding",
        "criteria_version": "1.0",
        "identificacao": {
          "numero_documento": "12345678900",
          "tipo_documento": "CPF"
        },
        "numero_processo": "0001234-56.2026.8.26.0050"
      }
    }
  }
]

Campo data (motor por lista)

{
  "id_avaliacao": "5b1e0c9a-3f4d-5e21-9a77-0c1d2e3f4a5b",
  "criticidades": ["3", "1"],
  "data_criacao": "2026-11-03T12:00:00Z",
  "_meta": {
    "criteria_slug": "fluxo_compliance",
    "criteria_version": "1.0",
    "identificacao": {
      "numero_documento": "12345678900",
      "tipo_documento": "CPF"
    },
    "numero_processo": "0001234-56.2026.8.26.0050"
  }
}

Nota

Empresas sem o motor de decisão habilitado continuam recebendo o formato descrito em Estrutura do campo data, sem nenhuma mudança.

Consultar a justificativa de um alerta#

O alerta traz a criticidade, mas não as justificativas. Para entender por que o processo recebeu aquela criticidade, use o id_avaliacao do alerta no endpoint de auditoria do motor, descrito em Listar justificativas e processos de uma avaliação.

cURL

curl -X GET 'https://api.jusbrasil.com.br/background-check/assessments/5b1e0c9a-3f4d-5e21-9a77-0c1d2e3f4a5b/audit' \
  -H 'Accept: application/json' \
  -H 'X-API-KEY: <sua_api_key>' \
  -H 'X-Request-ID: <uuid-v4>'

Boas práticas#

  1. Resposta rápida — retorne 200 OK rapidamente e processe os dados de forma assíncrona. Timeouts prolongados podem ser interpretados como falha de entrega.

  2. Link do processo — utilize o campo link dentro de cada processo para acessar a página pública com detalhes completos no Consulta PRO.