Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

O que é

Na consulta SICAF - Consulta Restrição Contratar Administração é possível verificar a situação de uma  pessoa na participação de licitações publicas para compras realizadas pelos órgãos públicos.

Veja mais informações em nossa central de ajuda: SICAF - Consulta Restrição Contratar Administração

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/sicaf/consulta-restricao-contratar-administracao-publica

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

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

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

Status 422

{
  "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

idoneo

Documento está com a situação idônea

Resposta com documento encontrado

{
    "status": "idoneo",
    "cpfCnpj": "00.111.222/3333-44",
    "razaoSocial": "FUNDACAO DE APOIO A EMPRESA X",
    "nomeFantasia": "FAEX",
    "situacaoCadastral": "Credenciado",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8P...",
}
{
    "status": "idoneo",
    "cpfCnpj": "999.999.999-99",
    "nome": "FULANO DA SILVA",
    "situacaoCadastral": "Credenciado",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8P..."
}

Resposta com erro

{
    "status": "erro",
    "mensagem": "Não credenciado",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8P..."
}

  • No labels