O que é#

Na consulta Banco do Brasil - Relação de Pessoas Impedidas de Licitar e Contratar, você pode verificar se uma devida pessoa sofreu as sanções administrativa de impedimento de licitar e contratar pelo Banco do Brasil.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/bb/relacao-pessoas-impedidas-licitar-contratar

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
cpfCnpj string Sim CPF ou CNPJ a ser pesquisado, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99

Retornos possíveis da requisição#

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#

Status 201

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

Status 422

JSON
{
  "message": "The given data was invalid.",
  "errors": {
    "cpfCnpj": [
        "CPF ou CNPJ inválido"
    ]
  }
}

Resultados da pesquisa (retornados no callback ou fazendo requisição à API de respostas)#

Valores possíveis do campo "status"

Status Significado
positivo Documento está presente na listagem de pessoas impedidas de licitar e contratar.
negativo Não consta o documento na listagem de pessoas impedidas de licitar e contratar.

Resposta com documento encontrado

JSON
{
    "status": "positivo",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

Resposta com documento não encontrado

JSON
{
    "status": "negativo",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}