BNMP - Consulta mandados

O que é#

A consulta BNMP - Consulta mandados verifica se uma pessoa possui mandados de medidas penais em aberto no Banco Nacional de Medidas Penais e prisões.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/bnmp/consulta-mandados

URL Base: https://api.plexi.com.br/

Parâmetros do header#

Nome	Tipo	Obrigatório?	Descrição
Authorization	String	Sim	Chave de API gerada no cadastro no Plexi, prefixada com `Bearer`
Callback	String	Não	URL para onde o resultado da requisição será enviado via HTTP POST.

Parâmetros do body#

Nome	Tipo	Obrigatório?	Descrição
cpf	string	Sim quando não presente nome	CPF a ser pesquisado
nome	string	Sim quando não presente cpf	Nome a ser pesquisado

Estrutura da resposta#

Status	Significado	Descrição	Informações retornadas
201	Created	Solicitação criada	Campo requestId, com o ID da requisição criada.
422	Unprocessable Entity	A solicitação contém erro	Em quais campos houve erro.

Exemplos de retornos quando você faz a requisição#

Status 201

A consulta recebida com sucesso e será processada. Com o ID retornado você pode consultar se já houve resposta.

JSON

{
  "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}

Status 422

Significa que ocorreu um erro de validação dos dados enviados.

JSON

{
  "message": "The given data was invalid.",
  "errors": {
    "cpf": [
      "O campo cpf é obrigatório."
    ],
    "nome": [
      "O campo nome é obrigatório."
    ]
  }
}

Exemplos de retornos do resultado da pesquisa#

Valores possíveis do campo "status"

Status	Significado
indefinido	Não foi possível determinar se existem mandados em face da pessoa pesquisada.
negativo	Existem mandados em face da pessoa pesquisada

Respostas com registro encontrado

JSON

{
  "status": "indefinido",
  "mandados": [],
  "numeroPaginas": 0,
  "totalMandados": 0,
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

JSON

{
  "status": "positivo",
  "mandados": [
    {
      "id": 11111111,
      "numeroPeca": "000000000000011111111111111",
      "numeroProcesso": "00000000011111111111",
      "nomePessoa": "FULANO DE TAL",
      "alcunha": "NÃO INFORMADO",
      "descricaoStatus": "Pendente de Cumprimento",
      "dataExpedicao": "2020-01-01",
      "nomeOrgao": "1ª Vara Criminal da Comarca Exemplo",
      "descricaoPeca": "Mandado de Prisão",
      "idTipoPeca": 1,
      "nomeMae": "FULANA DE TAL",
      "nomePai": "FULANO DE TAL",
      "descricaoSexo": "Masculino",
      "descricaoProfissao": null,
      "dataNascimento": null,
      "numeroPecaAnterior": null
    }
  ],
  "numeroPaginas": 1,
  "totalMandados": 1,
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}