Gerenciamento de OABs Monitoradas

Essa seção descreve os endpoints disponíveis para gerenciar as OABs cadastradas na API. Através desses endpoints é possível listar, consultar, atualizar e remover registros de OAB monitoradas, além de realizar buscas por número e região.

Listar todas as OABs monitoradas

Retorna a lista de OABs monitoradas no sistema.

cURL

curl -X 'GET' \
  'https://op.digesto.com.br/api/monitoramento/oab/acompanhamento/?page=0&per_page=100' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <api_token>'

Parâmetro	Tipo	Descrição
page	integer	Número de registros a pular (offset). Usado para paginação. Valor mínimo: 0.
per_page	integer	Número máximo de registros a retornar por página. Valor mínimo: 1. Valor máximo: 500.

Resposta

HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "id": 6,
    "name": "Maria da Silva",
    "number": 125914,
    "region": "SP",
    "supplementary_letter": null,
    "is_active": true,
    "correlation_id": "28a2961d-e3e8-42b1-917b-c5185a58153e",
    "created_at": "2025-03-28T17:14:00.854804",
    "updated_at": null,
    "archived_at": null
  },
  {
    "id": 7,
    "name": "João da Silva",
    "number": 249203,
    "region": "SP",
    "supplementary_letter": null,
    "is_active": true,
    "correlation_id": "58059194-e786-4133-ad60-0b37b3428dbb",
    "created_at": "2025-03-28T17:14:43.111499",
    "updated_at": null,
    "archived_at": null
  }
]

Atributo	Tipo	Descrição
id	integer	Identificador único da OAB monitorada.
name	string	Nome do advogado(a) vinculado à OAB.
number	integer	Número de inscrição da OAB.
region	string	Unidade federativa (UF) da OAB.
supplementary_letter	string ou null	Letra suplementar da OAB, se aplicável.
is_active	boolean	Indica se a OAB está ativa no sistema de monitoramento.
correlation_id	string (UUID)	Identificador da requisição, usado para rastreamento.
created_at	datetime	Data e hora em que a OAB foi cadastrada no sistema.
updated_at	datetime ou null	Data da última atualização da OAB, se houver.
archived_at	datetime ou null	Data de arquivamento da OAB, se aplicável.

Buscar uma OAB por ID de correlação

Busca um monitoramento de OAB específica pelo ID de correlação.

cURL

curl -X 'GET' \
'https://op.digesto.com.br/api/monitoramento/oab/acompanhamento/<correlation_id>' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <api_token>'

Parâmetro	Tipo	Descrição
correlation_id	string (UUID)	Identificador da requisição, usado para rastreamento. Obrigatório.

Exemplo de chamada

curl -X 'GET' \
'https://op.digesto.com.br/api/monitoramento/oab/acompanhamento/58059194-e786-4133-ad60-0b37b3428dbb' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <api_token>'

Resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 7,
  "name": "João da Silva",
  "number": 249203,
  "region": "SP",
  "supplementary_letter": null,
  "is_active": true,
  "correlation_id": "58059194-e786-4133-ad60-0b37b3428dbb",
  "created_at": "2025-03-28T17:14:43.111499",
  "updated_at": null,
  "archived_at": null
}

Atributo	Tipo	Descrição
id	integer	Identificador único da OAB monitorada.
name	string	Nome do advogado(a) vinculado à OAB.
number	integer	Número de inscrição da OAB.
region	string	Unidade federativa (UF) da OAB.
supplementary_letter	string ou null	Letra suplementar da OAB, se aplicável.
is_active	boolean	Indica se a OAB está ativa no sistema de monitoramento.
correlation_id	string (UUID)	Identificador da requisição, usado para rastreamento.
created_at	datetime	Data e hora em que a OAB foi cadastrada no sistema.
updated_at	datetime ou null	Data da última atualização da OAB, se houver.
archived_at	datetime ou null	Data de arquivamento da OAB, se aplicável.

Atualizar uma OAB monitorada

Atualiza uma OAB existente no sistema.

curl -X 'PATCH' \
'https://op.digesto.com.br/api/monitoramento/oab/acompanhamento/<oab_id>' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <api_token>' \
-H 'Content-Type: application/json' \
-d '{
    "is_active": true,
}'

Parâmetro	Tipo	Descrição
id	integer	Identificador da OAB a ser atualizada (passado na URL). Obrigatório.
is_active	boolean	Indica se a OAB permanece ativa no sistema de monitoramento.
name	string	Nome atualizado do advogado(a) vinculado à OAB.

Exemplo de chamada

curl -X 'PATCH' \
  'https://op.digesto.com.br/api/monitoramento/oab/acompanhamento/41' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "is_active": true,
  "name": "Maria dos Santos"
}'

Resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 41,
  "name": "Maria dos Santos",
  "number": 12828,
  "region": "RO",
  "supplementary_letter": null,
  "is_active": true,
  "correlation_id": "a954b994-90ec-4127-8895-b5f8bc24e625",
  "created_at": "2025-03-31T18:45:34.145155",
  "updated_at": null,
  "archived_at": null
}

Atributo	Tipo	Descrição
id	integer	Identificador único da OAB monitorada.
name	string	Nome do advogado(a) vinculado à OAB.
number	integer	Número de inscrição da OAB.
region	string	Unidade federativa (UF) da OAB.
supplementary_letter	string ou null	Letra suplementar da OAB, se aplicável.
is_active	boolean	Indica se a OAB está ativa no sistema de monitoramento.
correlation_id	string (UUID)	Identificador da requisição, usado para rastreamento.
created_at	datetime	Data e hora em que a OAB foi cadastrada no sistema.
updated_at	datetime ou null	Data da última atualização da OAB, se houver.
archived_at	datetime ou null	Data de arquivamento da OAB, se aplicável.

Deletar uma OAB monitorada

Arquiva um monitoramento de OAB

cURL

curl -X 'DELETE' \
'https://op.digesto.com.br/api/monitoramento/oab/acompanhamento/<oab_id>' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <api_token>'

Parâmetro	Tipo	Descrição
oab_id	integer	Identificador da OAB a ser arquivada (passado na URL). Obrigatório.

Exemplo de chamada

curl -X 'DELETE' \
'https://op.digesto.com.br/api/monitoramento/oab/acompanhamento/41' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <api_token>'

Resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  true
}

Buscar OAB por número e região

Busca uma OAB específica pelo número e região, com opção de incluir uma letra suplementar. Permite localizar um monitoramento ativo através dos dados de identificação da OAB.

cURL

curl -X 'GET' \
  'https://op.digesto.com.br/api/monitoramento/oab/acompanhamento/<region>/<oab_number>' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <api_token>'

Parâmetro	Tipo	Descrição
region	string	Unidade federativa (UF) da OAB. Obrigatório.
oab_number	integer	Número de inscrição da OAB. Obrigatório.
supplementary_letter	string	Letra suplementar da OAB, se aplicável.

Exemplo de chamada

curl -X 'GET' \
  'https://op.digesto.com.br/api/monitoramento/oab/acompanhamento/SP/249203' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <api_token>'

Resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 7,
  "name": "João da Silva",
  "number": 249203,
  "region": "SP",
  "supplementary_letter": null,
  "is_active": true,
  "correlation_id": "58059194-e786-4133-ad60-0b37b3428dbb",
  "created_at": "2025-03-28T17:14:43.111499",
  "updated_at": null,
  "archived_at": null
}

Atributo	Tipo	Descrição
id	integer	Identificador único da OAB monitorada.
name	string	Nome do advogado(a) vinculado à OAB.
number	integer	Número de inscrição da OAB.
region	string	Unidade federativa (UF) da OAB.
supplementary_letter	string ou null	Letra suplementar da OAB, se aplicável.
is_active	boolean	Indica se a OAB está ativa no sistema de monitoramento.
correlation_id	string (UUID)	Identificador da requisição, usado para rastreamento.
created_at	datetime	Data e hora em que a OAB foi cadastrada no sistema.
updated_at	datetime ou null	Data da última atualização da OAB, se houver.
archived_at	datetime ou null	Data de arquivamento da OAB, se aplicável.